trusty (3) SoLabel.3.gz

NAME

       SoLabel -

       The SoLabel class is a node for holding label information in a scene graph.

       Use this node as a convenient way of labeling nodes or subgraphs within a scene graph.

SYNOPSIS

       #include <Inventor/nodes/SoLabel.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.
       SoLabel (void)

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

   Public Attributes
       SoSFName label

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

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

   Additional Inherited Members

Detailed Description

       The SoLabel class is a node for holding label information in a scene graph.

       Use this node as a convenient way of labeling nodes or subgraphs within a scene graph.

       SoLabel nodes does not influence traversal in any way for any of the builtin actions.

       FILE FORMAT/DEFAULTS:

       Label {
           label "<Undefined label>"
       }

Constructor & Destructor Documentation

   SoLabel::SoLabel (void)
       Constructor.

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

Member Function Documentation

   SoType SoLabel::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 * SoLabel::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.

Member Data Documentation

   SoSFName SoLabel::label
       Label text.

Author

       Generated automatically by Doxygen for Coin from the source code.