SoPackedColor(3IV)

SoPackedColor (SoPCol) - node that defines base colors using packed representation

Showing IRIX 6.5.30 (default release). Added in IRIX 6.5.22.

NAME
     SoPackedColor (SoPCol) - node that defines base colors using packed
     representation

INHERITS FROM
     SoBase > SoFieldContainer > SoNode > SoPackedColor

SYNOPSIS
     #include <Inventor_c/nodes/SoPackedColor.h>

     typedef SoPackedColor  SoPCol

          Fields from class SoPackedColor:

     SoMFUInt32          orderedRGBA

          Functions from class SoPackedColor:

     SoPackedColor *     SoPColCreate()
     SoType              SoPColGetClassTypeId()

          Functions from class SoNode:

     void                SoPColSetOverride(SoPCol *this, SbBool state)
     SbBool              SoPColIsOverride(const SoPCol *this)
     SoNode *            SoPColCopy(const SoPCol *this, SbBool copyConnections
                              = FALSE)
     SbBool              SoPColAffectsState(const SoPCol *this)
     SoNode *            SoPColGetByName(const char *name)
     int                 SoPColGetByNameList(const char *name, SoNodeList
                              *list)

          Functions from class SoFieldContainer:

     void                SoPColSetToDflts(SoPCol *this)
     SbBool              SoPColHasDfltVals(const SoPCol *this)
     SbBool              SoPColFldsAreEq(const SoPCol *this, const
                              SoFieldContainer *fc)
     void                SoPColCopyFieldVals(SoPCol *this, const
                              SoFieldContainer *fc, SbBool copyConnections =
                              FALSE)
     SbBool              SoPColSet(SoPCol *this, const char *fieldDataString)
     void                SoPColGet(SoPCol *this, SbString *fieldDataString)
     int                 SoPColGetFields(const SoPCol *this, SoFieldList
                              *resultList)
     SoField *           SoPColGetField(const SoPCol *this, const char
                              *fieldName)
     SbBool              SoPColGetFieldName(const SoPCol *this, const SoField
                              *field, SbName *fieldName)
     SbBool              SoPColIsNotifyEnabled(const SoPCol *this)
     SbBool              SoPColEnableNotify(SoPCol *this, SbBool flag)

          Functions from class SoBase:

     void                SoPColRef(SoPCol *this)
     void                SoPColUnref(const SoPCol *this)
     void                SoPColUnrefNoDelete(const SoPCol *this)
     void                SoPColTouch(SoPCol *this)
     SoType              SoPColGetTypeId(const SoPCol *this)
     SbBool              SoPColIsOfType(const SoPCol *this, SoType type)
     void                SoPColSetName(SoPCol *this, const char *name)
     SbName              SoPColGetName(const SoPCol *this)


DESCRIPTION
     SoPackedColor is similar to SoBaseColor in that it sets the diffuse color
     component of the current material. However, it also changes the
     transparency component. The color and transparency information is packed
     into unsigned 32-bit integers: 0xrrggbbaa, where aa represents the alpha
     (0x00 = fully transparent, 0xff = opaque), and rr, gg, and bb represent
     the red, blue, and green components of the color, respectively. Note that
     the order (r,g,b,a) of these components is reversed from the ordering in
     releases of Inventor prior to 2.1.

     If the transparency type is SoGLRenderAction::SCREEN_DOOR, only the first
     transparency value will be used. With other transparency types, multiple
     transparencies will be used.

     SoPackedColor uses less memory than SoBaseColor or SoMaterial to store
     multiple color and transparency values. It can be used in cases where
     space is critical.

FIELDS
     SoMFUInt32          orderedRGBA
          Defines the packed colors.


FUNCTIONS
     SoPackedColor *     SoPColCreate()
          Creates a packed color node with default settings.

     SoType              SoPColGetClassTypeId()
          Returns type identifier for this class.


ACTION BEHAVIOR
     SoGLRenderAction, SoCallbackAction
          Sets the current base (diffuse) color(s) in the state.


FILE FORMAT/DEFAULTS
     PackedColor {
          orderedRGBA  0xccccccff
     }
SEE ALSO
     SoBaseColor, SoMaterial