SoSeparator Class Reference

Group node that saves and restores traversal state. More...

#include <Inventor/nodes/SoSeparator.h>

Inheritance diagram for SoSeparator:

Public Types
enum	CacheEnabled {   OFF ,   ON ,   AUTO }
	Possible values for caching. More...
enum	FastEditing {   DISABLE = 0x01 ,   KEEP_ZBUFFER = 0x02 ,   CLEAR_ZBUFFER = 0x03 }
	Fast editing policy enumeration values. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoSeparator ()
	Creates a separator node with default settings.
	SoSeparator (int nChildren)
	Constructor that takes approximate number of children.
Public Member Functions inherited from SoGroup
	SoGroup ()
	Creates an empty group node.
	SoGroup (int nChildren)
	Constructor that takes approximate number of children.
virtual void	addChild (SoNode *child)
	Adds a child as last one in group.
virtual void	insertChild (SoNode *child, int newChildIndex)
	Adds a child so that it becomes the one with the given index.
virtual SoNode *	getChild (int index) const
	Returns pointer the child node with the given index.
virtual int	findChild (const SoNode *child) const
	Finds index of given child within group.
virtual int	getNumChildren () const
	Returns number of children.
virtual void	removeChild (int index)
	Removes child with given index from group.
virtual void	removeChild (SoNode *child)
	Removes first instance of given child from group.
virtual void	removeAllChildren ()
	Removes all children from group.
virtual void	replaceChild (int index, SoNode *newChild)
	Replaces child with given index with new child.
virtual void	replaceChild (SoNode *oldChild, SoNode *newChild)
	Replaces first instance of given child with new child.
Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.
virtual SbBool	isOverride () const
	Returns the state of the override flag.
virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.
virtual void	touch ()
	Marks an instance as modified, simulating a change to it.
Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.
SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.
SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.
void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.
SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.
void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.
virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.
virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.
virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.
virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.
virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.
SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.
SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).
SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.
virtual void	setUserData (void *data)
	Sets application data.
void *	getUserData (void) const
	Gets user application data.
Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.
virtual void	setName (const SbName &name)
	Sets the name of an instance.
void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.
bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.
Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.
void	unref () const
	Removes a reference from an instance.
void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.
int	getRefCount () const
	Returns current reference count.
void	lock () const
	lock this instance.
void	unlock () const
	unlock this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoGroup
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().
static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().
Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.
Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFEnum	boundingBoxCaching
	Whether to cache during bounding box traversal.
SoSFEnum	renderCulling
	Whether to cull during rendering traversal.
SoSFEnum	pickCulling
	Whether to cull during picking traversal.
SoSFEnum	fastEditing
	Specifies the fast edit mode of the separator node.
SoSFInt32	renderUnitId
	Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.
Public Attributes inherited from SoGroup
SoSFBool	boundingBoxIgnoring
	Whether to ignore this node during bounding box traversal.

Deprecated
SoDEPRECATED SoSFEnum	renderCaching
	Whether to cache during rendering traversal.

Detailed Description

Group node that saves and restores traversal state.

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 (the push/pop operation is highly optimized), so they can be used freely within scenes.

Caching:

The SoSeparator node provides caching of state during bounding box computation. This feature can be explicitly enabled or disabled by setting the boundingBoxCaching field. By default, this field is set to AUTO, which means that Open Inventor decides whether to build a cache based on internal heuristics.

Culling:

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. Note that if renderCulling is ON, the SoSeparator will prohibit auto-caching, so that no SoSeparator (or other render caching node) above this node in the scene graph will automatically create a render cache.

Fast edit:

The fast editing feature allows you to modify parts of a scene without redrawing the entire scene. For example, you could use it to interactively move a small object in a large scene that takes a long time to redraw. Fast editing must be enabled using SoGLRenderAction::setFastEditSavePolicy.

The fastEditing field enables fast editing for the sub-graph under the SoSeparator. Possible values are DISABLE, KEEP_ZBUFFER, and CLEAR_ZBUFFER. Using KEEP_ZBUFFER means that the fast edit geometry is depth buffered against the other objects in the scene, and using CLEAR_ZBUFFER means that the fast edit geometry will be drawn on top of the other objects of the scene. If several SoSeparators have the CLEAR_ZBUFFER flag set, they are drawn in the order in which they appear in the scene. The last separator in the scene will be topmost on the screen.

Fast edit performance:

• This feature is most efficient when the parts of a scene graph to be fast edited contain a relatively small number of triangles.
• The topmost SoSeparator of your scene graph should not enable the fast editing feature. Otherwise, performance will be very poor.
• Currently, the entire viewport is saved and restored during fast editing. Therefore, fast editing performance is linked to the size of the viewport: the larger the viewport, the longer it will take to save and restore it.

Fast edit limitations:

• Hardware: Fast editing performance depends on your graphics hardware and driver. To use the fast editing feature, the ARB_bufferRegion OpenGL extension is required.
• Clip planes: When a fast edit object is moved outside the clip planes limit, fast editing is temporarily disabled and the entire scene is redrawn.
• All fast editing sub-graphs are rendered even if only one fast editing sub-graph has changed.
• Transparency: If the scene contains partially transparent objects, there is a possibility of visual artifacts regardless of what transparency algorithm is used. The fast edit shapes are necessarily rendered on top of the rest of the scene, which may not be the order required for correct transparency.
• Stereo rendering: Fast edit is not compatible with stereo rendering. Fast edit is disabled when switching to stereo rendering.

FILE FORMAT/DEFAULT

Separator {

boundingBoxCaching	AUTO
renderCulling	AUTO
pickCulling	AUTO
fastEditing	DISABLE
renderUnitID	-1

}

ACTION BEHAVIOR

SoGLRenderAction, SoCallbackAction, SoGetBoundingBoxAction, SoGetMatrixAction, SoHandleEventAction, SoRayPickAction, SoSearchAction
Saves the current traversal state, traverses all children, and restores the previous traversal state. Sets: SoCacheElement

SEE ALSO

SoSelection, SoTransformSeparator,

Definition at line 178 of file SoSeparator.h.

Member Enumeration Documentation

CacheEnabled

enum SoSeparator::CacheEnabled

Possible values for caching.

Enumerator
OFF	Never build a cache.
ON	Always try to build a cache.
AUTO	Decide whether to cache based on some heuristic.

Definition at line 186 of file SoSeparator.h.

FastEditing

enum SoSeparator::FastEditing

Fast editing policy enumeration values.

Enumerator
DISABLE	This SoSeparator node doesn't have Fast Edit behavior.
KEEP_ZBUFFER	This SoSeparator node has a Fast Edit behavior and the children nodes are drawn considering the depth Buffer.
CLEAR_ZBUFFER	This SoSeparator node has a Fast Edit behavior and the children nodes are drawn after the depth Buffer has been cleared.

Definition at line 229 of file SoSeparator.h.

Constructor & Destructor Documentation

SoSeparator() [1/2]

SoSeparator::SoSeparator

(

)

Creates a separator node with default settings.

SoSeparator() [2/2]

SoSeparator::SoSeparator

(

int

nChildren

)

Constructor that takes approximate number of children.

Member Function Documentation

getClassTypeId()

static SoType SoSeparator::getClassTypeId ( )

static

Returns the type identifier for this class.

getTypeId()

virtual SoType SoSeparator::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoGroup.

Reimplemented in SoAnnotation, SoBillboard, SoExtSelection, SoLocateHighlight, SoRenderToTarget, SoSelection, SoVertexAttribFeedback, SoWWWAnchor, SoMultiDataSeparator, DicomInfo, Gnomon, PlaneGeometryIntersection, Ruler, SceneView, SliceOrientationMarkers, SliceScaleBar, TextBox, and SoVolumeGroup.

Member Data Documentation

boundingBoxCaching

SoSFEnum SoSeparator::boundingBoxCaching

Whether to cache during bounding box traversal.

Use enum CacheEnabled. Default is AUTO.

Definition at line 214 of file SoSeparator.h.

fastEditing

SoSFEnum SoSeparator::fastEditing

Specifies the fast edit mode of the separator node.

Use enum FastEditing. Default is DISABLE.

NOTE: field available since Open Inventor 5.0

Definition at line 252 of file SoSeparator.h.

pickCulling

SoSFEnum SoSeparator::pickCulling

Whether to cull during picking traversal.

Use enum CacheEnabled. Default is AUTO.

Definition at line 226 of file SoSeparator.h.

renderCaching

SoDEPRECATED SoSFEnum SoSeparator::renderCaching

Whether to cache during rendering traversal.

Use enum CacheEnabled. Default is AUTO.

Definition at line 207 of file SoSeparator.h.

renderCulling

SoSFEnum SoSeparator::renderCulling

Whether to cull during rendering traversal.

Use enum CacheEnabled. Default is AUTO.

Definition at line 220 of file SoSeparator.h.

renderUnitId

SoSFInt32 SoSeparator::renderUnitId

Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator.

• 0, the sub scene graph is rendered on the local machine.
• > 0, the sub scene graph is rendered by the OIRU with the specified ID. If the specified renderUnitId is larger than the number of available render units, the sub scene graph is distributed to the specified render unit ID modulo the number of render units actually available. That is:
  
  RenderUnitUsed = ((renderUnitId-1)%(ActualNumberOfRenderUnits))+1
• -1 (SO_RENDERUNITID_NONE), this separator is not assigned to any OIRU.
  
  NOTE: This is the default value, which means that by default the sub scene graph is not distributed to any node. In order to use depth compositing, you must modify renderUnitId from the default, otherwise nothing will be rendered.
• -2 (SO_RENDERUNITID_INHERIT), this separator inherits its value from parent SoSeparator.
• -3 (SO_RENDERUNITID_ALL), the sub scene graph is rendered by all OIRUs.

NOTE: field available since Open Inventor 6.1

Definition at line 279 of file SoSeparator.h.

---

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

• Inventor/nodes/SoSeparator.h