SoBaseColor(3)

NAME
SoBaseColor - The SoBaseColor class provides a node type for convenient setting of the base material color.

If you want to just set the diffuse color of the following geometry, you can use this node for simplicity.

SYNOPSIS

#include <Inventor/nodes/SoBaseColor.h>

Inherits SoNode.

  Public Member Functions
virtual SoType getTypeId (void) const
SoBaseColor (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)

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

  Public Attributes
SoMFColor rgb

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

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

  Additional Inherited Members

Detailed Description

The SoBaseColor class provides a node type for convenient setting of the base material color.

If you want to just set the diffuse color of the following geometry, you can use this node for simplicity. FILE FORMAT/DEFAULTS:

BaseColor {
    rgb 0.8 0.8 0.8
}

See also:
    SoMaterial

Constructor & Destructor Documentation

  SoBaseColor::SoBaseColor (void)
Constructor.

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

Member Function Documentation

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

Reimplemented from SoNode.

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

Member Data Documentation

  SoMFColor SoBaseColor::rgb
Color values. Default value of field is to have a single grey color.

Author

Generated automatically by Doxygen for Coin from the source code.