trusty (3) SoAnnotation.3.gz

NAME

       SoAnnotation -

       The SoAnnotation node draws all its child geometry on top of other geometry.

       This group-type node uses delayed rendering in combination with Z-buffer disabling to let its children
       transparently render their geometry on top of the other geometry in the scene.

SYNOPSIS

       #include <Inventor/nodes/SoAnnotation.h>

       Inherits SoSeparator.

   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.
       SoAnnotation (void)
       virtual void GLRender (SoGLRenderAction *action)
       virtual void GLRenderBelowPath (SoGLRenderAction *action)
       virtual void GLRenderInPath (SoGLRenderAction *action)
       virtual void GLRenderOffPath (SoGLRenderAction *action)

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

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

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

   Additional Inherited Members

Detailed Description

       The SoAnnotation node draws all its child geometry on top of other geometry.

       This group-type node uses delayed rendering in combination with Z-buffer disabling to let its children
       transparently render their geometry on top of the other geometry in the scene.

       Since the Z-buffer needs to be disabled, the childrens' geometry will not be rendered back-to-front
       sorted, but rather in the order they are present in the scenegraph.

       FILE FORMAT/DEFAULTS:

       Annotation {
           renderCaching AUTO
           boundingBoxCaching AUTO
           renderCulling AUTO
           pickCulling AUTO
       }

Constructor & Destructor Documentation

   SoAnnotation::SoAnnotation (void)
       Constructor.

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

Member Function Documentation

   SoType SoAnnotation::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.

       Reimplemented from SoSeparator.

   const SoFieldData * SoAnnotation::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 SoSeparator.

   void SoAnnotation::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 SoSeparator.

   void SoAnnotation::GLRenderBelowPath (SoGLRenderAction *action) [virtual]
       SGI Open Inventor v2.1 obsoleted support for SoGLRenderAction::addMethod(). Instead, GLRender() might be
       called directly, and to optimize traversal, the SoSeparator node calls GLRenderBelowPath whenever the
       path code is BELOW_PATH or NO_PATH (path code is guaranteed not to change). To be compatible with SGI's
       Inventor (and thereby also TGS') we have chosen to follow their implementation in this respect.

       SoSeparator::GLRenderBelowPath() do not traverse its children using SoChildList::traverse(), but calls
       GLRenderBelowPath() directly for all its children.

       Reimplemented from SoSeparator.

   void SoAnnotation::GLRenderInPath (SoGLRenderAction *action) [virtual]
       Implements the SoAction::IN_PATH traversal method for the rendering action.

       Reimplemented from SoSeparator.

   void SoAnnotation::GLRenderOffPath (SoGLRenderAction *action) [virtual]
       Implements the SoAction::OFF_PATH traversal method for the rendering action.

       Reimplemented from SoSeparator.

Author

       Generated automatically by Doxygen for Coin from the source code.