Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all bug

NAME

       SoPackedColor -

       The SoPackedColor class is a node for setting diffuse and transparency material values.

       This node provides a convenient way of setting diffuse colors and transparency values with
       packed 32-bit RGBA vectors.

SYNOPSIS

       #include <Inventor/nodes/SoPackedColor.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.
       SoPackedColor (void)
       virtual void doAction (SoAction *action)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void callback (SoCallbackAction *action)
       SbBool isTransparent (void)

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

   Public Attributes
       SoMFUInt32 orderedRGBA

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoPackedColor ()
       virtual void notify (SoNotList *list)

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

   Additional Inherited Members

Detailed Description

       The SoPackedColor class is a node for setting diffuse and transparency material values.

       This node provides a convenient way of setting diffuse colors and transparency values with
       packed 32-bit RGBA vectors.

       FILE FORMAT/DEFAULTS:

       PackedColor {
           orderedRGBA 0xccccccff
       }

       See Also:
           SoBaseColor

Constructor & Destructor Documentation

   SoPackedColor::SoPackedColor (void)
       Constructor.

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

Member Function Documentation

   SoType SoPackedColor::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 * SoPackedColor::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 SoPackedColor::doAction (SoAction *action) [virtual]
       This function performs the typical operation of a node for any action.

       Reimplemented from SoNode.

   void SoPackedColor::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.

   void SoPackedColor::callback (SoCallbackAction *action) [virtual]
       Action method for SoCallbackAction.

       Simply updates the state according to how the node behaves for the render action, so the
       application programmer can use the SoCallbackAction for extracting information about the
       scene graph.

       Reimplemented from SoNode.

   SbBool SoPackedColor::isTransparent (void)
       Returns TRUE if there is at least one RGBA vector in the set which is not completely
       opaque.

   void SoPackedColor::notify (SoNotList *l) [protected],  [virtual]
       Notifies all auditors for this instance when changes are made.

       Reimplemented from SoNode.

Member Data Documentation

   SoMFUInt32 SoPackedColor::orderedRGBA
       Set of packed 32-bit RGBA vectors.

       The most significant 24 bits specifies 8 bits each for the red, green and blue components.

       The least significant 8 bits specifies the transparency value, where 0x00 means completely
       transparent, and 0xff completely opaque.

Author

       Generated automatically by Doxygen for Coin from the source code.