SoColorIndex(3iv)

1SoColorIndex(3IV)()                                        SoColorIndex(3IV)()
2
3
4

NAME

6       SoColorIndex — surface color index node
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoNode > SoColorIndex
10

SYNOPSIS

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

DESCRIPTION

61       This  node specifies the color to use for subsequent shapes as an index
62       into the current color table. This is used only for BASE_COLOR lighting
63       (see SoLightModel) in color index mode. Color index mode may be enabled
64       by the window in which rendering occurs.
65
66       Since color indices make sense only in the context of OpenGL rendering,
67       this node implements only a method for the SoGLRenderAction.
68

FIELDS

70     SoMFInt32           index
71          Color index.
72
73

METHODS

75                         SoColorIndex()
76          Creates a color index node with default settings.
77
78     static SoType       getClassTypeId()
79          Returns type identifier for this class.
80
81

ACTION BEHAVIOR

83       SoGLRenderAction
84          Sets  the color index for subsequent shapes rendered with BASE_COLOR
85          lighting.
86
87

FILE FORMAT/DEFAULTS

89       ColorIndex {
90          index  1
91     }
92