SoAnnotation

InventorModule

genre	InventorNodesAutomatic,InventorGroup
author	Silicon Graphics Inc
package	MeVisLab/Standard
definition	inventor.def

Purpose

The group node SoAnnotation 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 - 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.

Tips

Using this node below a SoViewportRegion requires that SoViewportRegion.renderDelayedPaths is enabled.

Input Fields

child

name: child, type: SoNode

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

boundingBoxCaching: Enum

clearDepthBuffer: Bool

disableDepthBuffer: Bool

pickCulling: Enum

renderCaching: Enum

renderCulling: Enum

Hidden Fields

renderCaching

name: renderCaching, type: Enum, default: AUTO

Defines how to cache during rendering traversal.

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

boundingBoxCaching

name: boundingBoxCaching, type: Enum, default: AUTO

Defines how to cache during bounding box traversal.

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

renderCulling

name: renderCulling, type: Enum, default: AUTO

Defines how to cull during rendering traversal.

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

pickCulling

name: pickCulling, type: Enum, default: AUTO

Defines how to cull during picking traversal.

Values:

Title	Name
​On	​ON
​Off	​OFF
​Auto	​AUTO

clearDepthBuffer

name: clearDepthBuffer, type: Bool, default: FALSE

disableDepthBuffer

name: disableDepthBuffer, type: Bool, default: TRUE