SoPackedColor(3iv)

1SoPackedColor(3IV)()                                      SoPackedColor(3IV)()
2
3
4

NAME

6       SoPackedColor  — node that defines base colors using packed representa‐
7       tion
8

INHERITS FROM

10       SoBase > SoFieldContainer > SoNode > SoPackedColor
11

SYNOPSIS

13       #include <Inventor/nodes/SoPackedColor.h>
14
15          Fields from class SoPackedColor:
16
17     SoMFUInt32          orderedRGBA
18
19          Methods from class SoPackedColor:
20
21                         SoPackedColor()
22     static SoType       getClassTypeId()
23
24          Methods from class SoNode:
25
26     void                setOverride(SbBool state)
27     SbBool              isOverride() const
28     SoNode *            copy(SbBool copyConnections = FALSE) const
29     virtual SbBool      affectsState() const
30     static SoNode *     getByName(const SbName &name)
31     static int          getByName(const SbName &name, SoNodeList &list)
32
33          Methods from class SoFieldContainer:
34
35     void                setToDefaults()
36     SbBool              hasDefaultValues() const
37     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
38     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
39                              copyConnections = FALSE)
40     SbBool              set(const char *fieldDataString)
41     void                get(SbString &fieldDataString)
42     virtual int         getFields(SoFieldList &resultList) const
43     virtual SoField *   getField(const SbName &fieldName) const
44     SbBool              getFieldName(const SoField *field, SbName &fieldName)
45                              const
46     SbBool              isNotifyEnabled() const
47     SbBool              enableNotify(SbBool flag)
48
49          Methods from class SoBase:
50
51     void                ref()
52     void                unref() const
53     void                unrefNoDelete() const
54     void                touch()
55     virtual SoType      getTypeId() const
56     SbBool              isOfType(SoType type) const
57     virtual void        setName(const SbName &name)
58     virtual SbName      getName() const
59
60

DESCRIPTION

62       SoPackedColor is similar to SoBaseColor in that  it  sets  the  diffuse
63       color  component  of the current material. However, it also changes the
64       transparency component.  The  color  and  transparency  information  is
65       packed  into  unsigned 32-bit integers: 0xrrggbbaa, where aa represents
66       the alpha (0x00 = fully transparent, 0xff = opaque), and rr, gg, and bb
67       represent  the  red,  blue,  and green components of the color, respec‐
68       tively. Note that the order (r,g,b,a) of these components  is  reversed
69       from the ordering in releases of Inventor prior to 2.1.
70
71       If  the  transparency  type  is SoGLRenderAction::SCREEN_DOOR, only the
72       first transparency value will be used. With other  transparency  types,
73       multiple transparencies will be used.
74
75       SoPackedColor  uses less memory than SoBaseColor or SoMaterial to store
76       multiple color and transparency values. It can be used in  cases  where
77       space is critical.
78

FIELDS

80     SoMFUInt32          orderedRGBA
81          Defines the packed colors.
82
83

METHODS

85                         SoPackedColor()
86          Creates a packed color node with default settings.
87
88     static SoType       getClassTypeId()
89          Returns type identifier for this class.
90
91

ACTION BEHAVIOR

93       SoGLRenderAction, SoCallbackAction
94          Sets the current base (diffuse) color(s) in the state.
95
96

FILE FORMAT/DEFAULTS

98       PackedColor {
99          orderedRGBA  0xccccccff
100     }
101