Open Inventor Reference
SoAnnotation Class Reference

Annotation group node. More...

#include <Inventor/nodes/SoAnnotation.h>

Inheritance diagram for SoAnnotation:
SoSeparator SoGroup SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

 SoAnnotation ()
 Creates an annotation node with default settings.
virtual void GLRenderBelowPath (SoGLRenderAction *action)
 Implement actions.
virtual void GLRenderInPath (SoGLRenderAction *action)

Static Public Member Functions

static void initClass ()
 Initializes base node class.

Protected Member Functions

virtual ~SoAnnotation ()
 Destructor.

Detailed Description

This group node delays rendering its children until all other nodes have been traversed, turning off depth buffer comparisons first. The result is that the shapes under the annotation node are rendered on top of the rest of the scene. This node is derived from SoSeparator, so it saves and restores traversal state for all actions.

Note that if more than one annotation node is present in a graph, the order in which they are traversed determines the stacking order em later nodes are rendered on top of earlier ones. Also note that since depth buffer comparisons are disabled, complex 3D objects may not be rendered correctly when used under annotation nodes.

Also note that the annotation node does nothing special when picking along a ray. That is, it does not modify the sorting order of intersected objects based on which ones are under annotation nodes. If your application uses annotation nodes and you want to ensure that objects under them are picked "in front of" other objects, you can tell the pick action that you want to pick all objects along the ray and then scan through the paths in the resulting picked point instances to see if any of them passes through an annotation node. Your program can then decide what to do in such a case.

File Format/Default
Action Behavior
SoGLRenderAction
Delays rendering its children until all other nodes have been traversed, turning off depth buffer comparisons first.
SoCallbackAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoRayPickAction, SoSearchAction
Same as SoSeparator

Definition at line 113 of file SoAnnotation.h.


Constructor & Destructor Documentation

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

Member Function Documentation

virtual void SoAnnotation::GLRenderBelowPath ( SoGLRenderAction action) [virtual]

Reimplemented from SoSeparator.

virtual void SoAnnotation::GLRenderInPath ( SoGLRenderAction action) [virtual]

Reimplemented from SoSeparator.

static void SoAnnotation::initClass ( ) [static]

Reimplemented from SoSeparator.


The documentation for this class was generated from the following file: