trusty (3) SoColorIndex.3.gz

NAME

       SoColorIndex -

       The SoColorIndex class is used to specify color indices for subsequent shapes.

       This node should only be used in OpenGL color-index mode, and only when the current light model is set to
       SoLightModel::BASE_COLOR.

SYNOPSIS

       #include <Inventor/nodes/SoColorIndex.h>

       Inherits SoNode.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase. This is used for
           run-time type checking and 'downward' casting.
       SoColorIndex (void)
       virtual void GLRender (SoGLRenderAction *action)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoMFInt32 index

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoColorIndex ()

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoColorIndex class is used to specify color indices for subsequent shapes.

       This node should only be used in OpenGL color-index mode, and only when the current light model is set to
       SoLightModel::BASE_COLOR.

       OpenGL colorindex mode is where the colors for individual pixels are fetched from a color lookup table
       ('CLUT'). The usual thing to do is to set up a canvas in RGBA truecolor mode.

       One common use for colorindex mode OpenGL canvases is to use one in the overlay planes (which are usually
       limited to only 2 or 4 available colors), if supported by the OpenGL hardware and / or driver.

       FILE FORMAT/DEFAULTS:

       ColorIndex {
           index 1
       }

Constructor & Destructor Documentation

   SoColorIndex::SoColorIndex (void)
       Constructor.

   SoColorIndex::~SoColorIndex () [protected],  [virtual]
       Destructor.

Member Function Documentation

   SoType SoColorIndex::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This is used for
       run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or
       others: this method needs to be overridden in all subclasses. This is typically done as part of setting
       up the full type system for extension classes, which is usually accomplished by using the pre-defined
       macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and
       SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the toplevel superclasses
       for the various class groups.

       Implements SoBase.

   const SoFieldData * SoColorIndex::getFieldData (void) const [protected],  [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no fields are
       present, returns NULL.

       Reimplemented from SoFieldContainer.

   void SoColorIndex::GLRender (SoGLRenderAction *action) [virtual]
       Action method for the SoGLRenderAction.

       This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants
       to throw geometry primitives at OpenGL overrides this method.

       Reimplemented from SoNode.

Member Data Documentation

   SoMFInt32 SoColorIndex::index
       Color indices which can be used by shapes.

Author

       Generated automatically by Doxygen for Coin from the source code.