man SoSeparator () - group node that saves and restores traversal state

NAME

SoSeparator - group node that saves and restores traversal state

INHERITS FROM

SoBase > SoFieldContainer > SoNode > SoGroup > SoSeparator

SYNOPSIS

#include <Inventor/nodes/SoSeparator.h> enum CacheEnabled { c } c } Never build a cache

c } c } Always try to build a cache

c } c } Decide whether to cache based on some heuristic

} Fields from class SoSeparator: c } c } renderCaching

c } c } boundingBoxCaching

c } c } renderCulling

c } c } pickCulling Methods from class SoSeparator: c } c } SoSeparator()

c } c } SoSeparator(int nChildren)

c } c } setNumRenderCaches(int howMany)

c } c } getNumRenderCaches()

c } c } getClassTypeId() Methods from class SoGroup: c } c } addChild(SoNode *child)

c } c } insertChild(SoNode *child, int newChildIndex)

c } c } getChild(int index) const

c } c } findChild(const SoNode *child) const

c } c } getNumChildren() const

c } c } removeChild(int index)

c } c } removeChild(SoNode *child)

c } c } removeAllChildren()

c } c } replaceChild(int index, SoNode *newChild)

c } c } replaceChild(SoNode *oldChild, SoNode *newChild) Methods from class SoNode: c } c } setOverride(SbBool state)

c } c } isOverride() const

c } c } copy(SbBool copyConnections = FALSE) const

c } c } affectsState() const

c } c } getByName(const SbName &name)

c } c } getByName(const SbName &name, SoNodeList &list) Methods from class SoFieldContainer: c } c } setToDefaults()

c } c } hasDefaultValues() const

c } c } fieldsAreEqual(const SoFieldContainer *fc) const

c } c } copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)

c } c } set(const char *fieldDataString)

c } c } get(SbString &fieldDataString)

c } c } getFields(SoFieldList &resultList) const

c } c } getField(const SbName &fieldName) const

c } c } getFieldName(const SoField *field, SbName &fieldName) const

c } c } isNotifyEnabled() const

c } c } enableNotify(SbBool flag) Methods from class SoBase: c } c } ref()

c } c } unref() const

c } c } unrefNoDelete() const

c } c } touch()

c } c } getTypeId() const

c } c } isOfType(SoType type) const

c } c } setName(const SbName &name)

c } c } getName() const

DESCRIPTION

This group node performs a push (save) of the traversal state before traversing its children and a pop (restore) after traversing them. This isolates the separator's children from the rest of the scene graph. A separator can include lights, cameras, coordinates, normals, bindings, and all other properties. Separators are relatively inexpensive, so they can be used freely within scenes. The SoSeparator node provides caching of state during rendering and bounding box computation. This feature can be enabled by setting the renderCaching and boundingBoxCaching fields. By default, these are set to AUTO, which means that Inventor decides whether to build a cache based on internal heuristics. Separators can also perform culling during rendering and picking. Culling skips over traversal of the separator's children if they are not going to be rendered or picked, based on the comparison of the separator's bounding box with the current view volume. Culling is controlled by the renderCulling and pickCulling fields. These are also set to AUTO by default; however, render culling can be expensive (and can interfere with render caching), so the AUTO heuristics leave it disabled unless specified otherwise.

FIELDS

c } c } renderCaching

Whether to cache during rendering traversal. c } c } boundingBoxCaching

Whether to cache during bounding box traversal. c } c } renderCulling

Whether to cull during rendering traversal. c } c } pickCulling

Whether to cull during picking traversal.

METHODS

c } c } SoSeparator()

Creates a separator node with default settings. c } c } SoSeparator(int nChildren)

Constructor that takes approximate number of children. c } c } setNumRenderCaches(int howMany)

By default, each separator node maintains 2 render caches. (This is to allow two different representations, such as filled and wire-frame, to both be cached.) The setNumRenderCaches() method sets the number of render caches each separator will have. Each render cache uses memory, so increasing this number may increase the memory requirements of the application. This method affects only separators that are created after it is called, not separators that were created before. Setting the number of caches to 0 turns off render caching globally from then on. c } c } getNumRenderCaches()

Returns the current number of render caches. c } c } getClassTypeId()

Returns type identifier for this class.

ACTION BEHAVIOR

SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoHandleEventAction, SoRayPickAction, SoSearchAction

Saves the current traversal state, traverses all children, and restores the previous traversal state.

FILE FORMAT/DEFAULTS

Separator {
renderCaching	AUTO
boundingBoxCaching	AUTO
renderCulling	AUTO
pickCulling	AUTO
}

SEE ALSO

SoSelection, SoTransformSeparator