Package com.openinventor.inventor.nodes

Class SoAnnotation

java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.inventor.misc.SoBase
com.openinventor.inventor.fields.SoFieldContainer
com.openinventor.inventor.nodes.SoNode
com.openinventor.inventor.nodes.SoGroup
com.openinventor.inventor.nodes.SoSeparator
com.openinventor.inventor.nodes.SoAnnotation
All Implemented Interfaces:
SafeDisposable
Direct Known Subclasses:
Gnomon, SliceOrientationMarkers, SliceScaleBar, TextBox
public class SoAnnotation extends SoSeparator
Annotation group node. 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.

Rendering order:
Objects under an SoAnnotation node are rendered after "delayed" transparent objects. See SoGLRenderAction for more information about rendering order. Note that if more than one annotation node is present in a graph, the order in which they are traversed determines the stacking order - later nodes are rendered on top of earlier ones.

Note: Because depth buffer comparisons are disabled, complex 3D objects may not be rendered correctly when used under annotation nodes. Moreover, camera's exposure fields do not impact the scene graph of this node, since its rendering is delayed after everything at the very end.

Picking:
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:

Annotation {

    boundingBoxCaching AUTO
    renderCulling AUTO
    pickCulling AUTO
    fastEditing false
}

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

  • Constructor Details

    • SoAnnotation

      public SoAnnotation()
      Creates an annotation node with default settings.