---

SoSeparator Class Reference

The SoSeparator class is a state-preserving group node. More...

#include <Inventor/nodes/SoSeparator.h>

Inheritance diagram for SoSeparator::

List of all members.

Public Types
enum	CacheEnabled { OFF, ON, AUTO }
Public Methods
	SoSeparator (void)
	SoSeparator (const int nchildren)
virtual void	doAction (SoAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	GLRenderBelowPath (SoGLRenderAction *action)
virtual void	GLRenderInPath (SoGLRenderAction *action)
virtual void	GLRenderOffPath (SoGLRenderAction *action)
virtual void	callback (SoCallbackAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
virtual void	rayPick (SoRayPickAction *action)
virtual void	search (SoSearchAction *action)
virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void	notify (SoNotList *nl)
virtual SbBool	affectsState (void) const
Static Public Methods
void	initClass (void)
void	setNumRenderCaches (const int howmany)
int	getNumRenderCaches (void)
Public Attributes
SoSFEnum	renderCaching
SoSFEnum	boundingBoxCaching
SoSFEnum	renderCulling
SoSFEnum	pickCulling
Protected Methods
virtual	~SoSeparator ()
virtual SbBool	cullTest (SoState *state)
virtual SbBool	cullTest (SoGLRenderAction *action, int &cullresults)
virtual SbBool	readInstance (SoInput *in, unsigned short flags)

---

Detailed Description

The SoSeparator class is a state-preserving group node.

Subgraphs parented by SoSeparator nodes will not affect the state, as they push and pop the traversal state before and after traversal of its children.

SoSeparator nodes also provides options for traversal optimalization through the use of caching.

See also:

SoTransformSeparator

---

Member Enumeration Documentation

enum SoSeparator::CacheEnabled

Enumeration of flags for the fields deciding which optimalizations to do in SoSeparator nodes. There are two types of settings available: caching policies or culling policies. See doumentation of fields. Enumeration values: OFF   No caching. ON   Always try to cache state. AUTO   Use heuristics to try to figure out the optimal caching policy.

---

Constructor & Destructor Documentation

SoSeparator::SoSeparator (  void )

Default constructor.

SoSeparator::SoSeparator (  const int nchildren )

Constructor. The argument should be the approximate number of children which is expected to be inserted below this node. The number need not be exact, as it is only used as a hint for better memory resource allocation.

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

Destructor. Frees resources used to implement caches.

---

Member Function Documentation

void SoSeparator::initClass (  void )  [static]

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Reimplemented from SoGroup. Reimplemented in SoAnnotation, SoExtSelection, SoLocateHighlight, SoSelection, and SoWWWAnchor.

void SoSeparator::doAction (  SoAction * action )  [virtual]

This function performs the typical operation of a node for any action. Reimplemented from SoGroup.

void SoSeparator::GLRender (  SoGLRenderAction * action )  [virtual]

Action method for the SoGLRenderAction. This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method. Reimplemented from SoGroup. Reimplemented in SoAnnotation.

void SoSeparator::GLRenderBelowPath (  SoGLRenderAction * action )  [virtual]

SGI Open Inventor v2.1 obsoleted support for SoGLRenderAction::addMethod(). Instead, GLRender() might be called directly, and to optimize traversal, the SoSeparator node calls GLRenderBelowPath whenever the path code is BELOW_PATH or NO_PATH (path code is guaranteed not to change). To be compatible with SGI's Inventor (and thereby also TGS') we have chosen to follow their implementation in this respect. SoSeparator::GLRenderBelowPath() do not traverse its children using SoChildList::traverse(), but calls GLRenderBelowPath() directly for all its children. Reimplemented from SoNode. Reimplemented in SoAnnotation, SoExtSelection, and SoLocateHighlight.

void SoSeparator::GLRenderInPath (  SoGLRenderAction * action )  [virtual]

Implements the SoAction::IN_PATH traversal method for the rendering action. Reimplemented from SoNode. Reimplemented in SoAnnotation, and SoLocateHighlight.

void SoSeparator::GLRenderOffPath (  SoGLRenderAction * action )  [virtual]

Implements the SoAction::OFF_PATH traversal method for the rendering action. Reimplemented from SoNode. Reimplemented in SoAnnotation.

void SoSeparator::callback (  SoCallbackAction * action )  [virtual]

Action method for SoCallbackAction. Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph. Reimplemented from SoGroup.

void SoSeparator::getBoundingBox (  SoGetBoundingBoxAction * action )  [virtual]

Action method for the SoGetBoundingBoxAction. Calculates bounding box and center coordinates for node and modifies the values of the action to encompass the bounding box for this node and to shift the center point for the scene more towards the one for this node. Nodes influencing how geometry nodes calculates their bounding box also overrides this method to change the relevant state variables. Reimplemented from SoGroup.

void SoSeparator::getMatrix (  SoGetMatrixAction * action )  [virtual]

Action method for SoGetMatrixAction. Updates action by accumulating with the transformation matrix of this node (if any). Reimplemented from SoGroup.

void SoSeparator::handleEvent (  SoHandleEventAction * action )  [virtual]

Action method for SoHandleEventAction. Inspects the event data from action, and processes it if it is something which this node should react to. Nodes influencing relevant state variables for how event handling is done also overrides this method. Reimplemented from SoGroup. Reimplemented in SoExtSelection, SoLocateHighlight, SoSelection, and SoWWWAnchor.

void SoSeparator::rayPick (  SoRayPickAction * action )  [virtual]

Action method for SoRayPickAction. Checks the ray specification of the action and tests for intersection with the data of the node. Nodes influencing relevant state variables for how picking is done also overrides this method. Reimplemented from SoNode.

void SoSeparator::search (  SoSearchAction * action )  [virtual]

Action method for SoSearchAction. Compares the search criteria from the action to see if this node is a match. Searching is done by matching up all criteria set up in the SoSearchAction -- if any of the requested criteria is a miss, the search is not deemed successful for the node. See also: SoSearchAction Reimplemented from SoGroup.

void SoSeparator::getPrimitiveCount (  SoGetPrimitiveCountAction * action )  [virtual]

Action method for the SoGetPrimitiveCountAction. Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the action. Nodes influencing how geometry nodes calculates their primitive count also overrides this method to change the relevant state variables. Reimplemented from SoGroup.

void SoSeparator::notify (  SoNotList * nl )  [virtual]

Notifies all auditors for this instance when changes are made. Reimplemented from SoNode.

void SoSeparator::setNumRenderCaches (  const int howmany )  [static]

Set up number of caches SoSeparator nodes may allocate for render caching. More caches might give better performance, but will use more memory. Default value is 2.

int SoSeparator::getNumRenderCaches (  void )  [static]

Returns maximum number of caches SoSeparator nodes are allowed to use for render caching. See also: setNumRenderCaches()

SbBool SoSeparator::affectsState (  void )  const [virtual]

Returns TRUE if the node could have any effect on the state during traversal. If it returns FALSE, no data in the traversal-state will change from the pre-traversal state to the post-traversal state. The SoSeparator node will for instance return FALSE, as it pushes and pops the state before and after traversal of its children. All SoShape nodes will also return FALSE, as just pushing out geometry data to the rendering engine won't affect the actual rendering state. The default method returns TRUE, on a "better safe than sorry" philosophy. Reimplemented from SoNode.

SbBool SoSeparator::cullTest (  SoState * state )  [protected, virtual]

Internal method which do view frustum culling. For now, view frustum culling is performed if the renderCulling field is AUTO or ON, and the bounding box cache is valid. Returns TRUE if this separator is outside view frustum, FALSE if inside.

SbBool SoSeparator::cullTest (  SoGLRenderAction * action, int & cullresults )  [protected, virtual]

This is an internal Open Inventor method. We've implemented view frustum culling in a different manner. Let us know if you need this function, and we'll consider implementing it.

SbBool SoSeparator::readInstance (  SoInput * in, unsigned short flags )  [protected, virtual]

This method is mainly intended for internal use during file import operations. It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type. TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE. flags is used internally during binary import when reading user extension nodes, group nodes or engines. Reimplemented from SoGroup.

---

Member Data Documentation

SoSFEnum SoSeparator::renderCaching

Policy for caching of rendering instructions for faster execution. This will typically use the OpenGL renderlists mechanism. Default value is SoSeparator::AUTO. If you know that some parts of your scene will never change, rendering might happen faster if you explicitly set this field to SoSeparator::ON. If you on the other hand know that parts of the scene will change a lot (like for every redraw), it will be beneficial to set this field to SoSeparator::OFF for the top-level separator node of this (sub)graph. For now, render caching is in the beta stage. You can enable render caching by setting the environment variable COIN_RENDER_CACHING to 1. Separators will then use caching if the renderCaching field is set to ON.

SoSFEnum SoSeparator::boundingBoxCaching

Policy for caching bounding box calculations. Default value is SoSeparator::AUTO. See also documentation for SoSeparator::renderCaching.

SoSFEnum SoSeparator::renderCulling

Policy for doing viewport culling during rendering traversals. Default value is SoSeparator::AUTO. When the render culling is turned off for Coin, it will be left to be done for the underlying immediate mode rendering library. This will often be faster than doing culling from within Coin, so be careful to monitor the change in execution speed if setting this field to SoSeparator::ON. See also documentation for SoSeparator::renderCaching.

SoSFEnum SoSeparator::pickCulling

Policy for doing viewport culling during pick traversals. Default value is SoSeparator::AUTO. See documentation for SoSeparator::renderCulling.

---

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

• SoSeparator.cpp
• SoSeparator.h

---