Computes a distribution of the scene graph for use in depth compositing in ScaleViz. More...

#include <Inventor/actions/SoDistributeAction.h>

Inheritance diagram for SoDistributeAction:

Public Types
enum	DistributeMethod { ROUND_ROBIN , TRIANGLE_COUNT }
	Algorithms for scene graph distribution. More...

Public Types inherited from SoAction
enum	DistribMode { LOCAL_ONLY , CLUSTER_ONLY , ALL }
	This is used to define the way an action is distributed across a cluster. More...

enum	AppliedCode { NODE , PATH , PATH_LIST }
	This enum is used to determine what the action is being applied to. More...

enum	PathCode { NO_PATH , IN_PATH , BELOW_PATH , OFF_PATH }
	This enum may be used during traversal of nodes to indicate where the node is with respect to the path being traversed. More...

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoDistributeAction ()
	Constructor.

void	setDistributeMethod (DistributeMethod distribMethod)
	Destructor.

DistributeMethod	getDistributeMethod ()
	Returns the algorithm used to distribute the scene graph.

Public Member Functions inherited from SoAction
virtual	~SoAction ()
	Destructor.

virtual void	apply (SoNode *node)
	Initiates an action on the graph defined by a node.

virtual void	apply (SoPath *path)
	Initiates an action on the graph defined by a path.

virtual void	apply (const SoPathList &pathList, SbBool obeysRules=FALSE)
	Initiates an action on the graph defined by a list of paths.

virtual void	clearApplyResult ()
	When applied, an action may reference nodes or create objects (e.g.

virtual void	invalidateState ()
	Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied.

void	stopActionInBranch ()
	This function stops the action in the current Scene Graph branch.

SbBool	getContinueActionInBranchFlag () const
	This function indicates if the action must stop in the current branch.

void	resetContinueActionInBranchFlag ()
	This function resets the continue action flag.

void	useAlternateRep (const SbBool enable)
	Tell the action to use alternate representations during traversal when available.

SbBool	isUsingAlternateRep () const
	Returns TRUE if current action is using alternate representations.

void	setSceneManager (SoSceneManager *mgr)
	Set the scene manager associated with this action (if any ).

SoSceneManager *	getSceneManager () const
	Return the SoSceneManager associated with this action.

virtual void	forwardTraversal (SoNode *node)
	Traverse a node that is not part of the current scenegraph.

virtual void	forwardTraversal (SoPath *path)
	Traverse a path that is not part of the current scenegraph.

DistribMode	getDistribMode () const
	Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only).

AppliedCode	getWhatAppliedTo () const
	Returns code indicating what action is being applied to.

SoNode *	getNodeAppliedTo () const
	Returns the node the action is being applied to.

SoPath *	getPathAppliedTo () const
	Returns the path the action is being applied to.

const SoPathList *	getPathListAppliedTo () const
	Returns the path list the action is being applied to.

const SoPathList *	getOriginalPathListAppliedTo () const
	Returns the original path list the action is being applied to.

SbBool	isLastPathListAppliedTo () const
	Returns TRUE if the current list is the last one from the original.

PathCode	getPathCode (int &numIndices, const int *&indices)
	Returns path code based on where current node (the node at the end of the current path) lies with respect to the path(s) the action is being applied to.

PathCode	getPathCodeMI (int &numIndices, const int &indices, const int &instanceIndices)
	Extender API: available to programmers who wish to extend the toolkit

void	traverse (SoNode *node)
	Does traversal of a graph rooted by a node.

SbBool	hasTerminated () const
	Returns TRUE if the traversal has reached a termination condition.

const SoPath *	getCurPath ()
	Returns the path accumulated during traversal, i.e., the chain of nodes from the root of the traversed graph to the current node being traversed.

SoState *	getState () const
	Gets the state from the action.

virtual void	setUpState ()
	Creates state if it is NULL or it is no longer valid because new elements have been enabled since it was created.

void	setPipeId (int id)
	Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

int	getPipeId () const
	Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

bool	isBeingApplied ()
	Returns TRUE if this action is currently being applied.

virtual bool	preDelayedTraversal ()
	Method called by SoMultiPassManager before delayed pass traversals.

virtual void	postDelayedTraversal ()
	Method called by SoMultiPassManager after delayed pass traversals.

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 SoAction
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static void	nullAction (SoAction , SoNode )
	Null action method that can be stored in lookup table when desired.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Computes a distribution of the scene graph for use in depth compositing in ScaleViz.

This class is used to compute a distribution of the scene graph for use in depth compositing in ScaleViz.

In order to simplify the distribution of the scene graph, two different algorithms are supported for the automatic allocation of render unit IDs of each separator in a scene graph:

ROUND_ROBIN, which implements a round robin algorithm, does static allocation based on the number of running OIRUs. This algorithm is the fastest way to distribute a scene graph between all running OIRUs, but as it does not take in account the weight of the sub scene graph assigned to each OIRU, it can potentially result in an unbalanced distribution.
TRIANGLE_COUNT is a dynamic algorithm that takes in account the weight of each separator, and tries to distribute the scene graph as equally as possible between OIRUs. Compared with the first algorithm, it is more time consuming, but the result is a better balanced scene graph distribution. This is the default.

To specify the desired distribution algorithm, instantiate an SoDistributeAction, specify the the desired algorithm, and apply the action on the scene graph that you want to distribute.

Member Enumeration Documentation

◆ DistributeMethod

enum SoDistributeAction::DistributeMethod

Algorithms for scene graph distribution.

Enumerator
ROUND_ROBIN
TRIANGLE_COUNT

Definition at line 71 of file SoDistributeAction.h.

Constructor & Destructor Documentation

◆ SoDistributeAction()

SoDistributeAction::SoDistributeAction ( )

Constructor.

Member Function Documentation

◆ getClassTypeId()

static SoType SoDistributeAction::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getDistributeMethod()

SoDistributeAction::DistributeMethod SoDistributeAction::getDistributeMethod ( )

inline

Returns the algorithm used to distribute the scene graph.

Definition at line 195 of file SoDistributeAction.h.

◆ getTypeId()

virtual SoType SoDistributeAction::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

◆ setDistributeMethod()

void SoDistributeAction::setDistributeMethod ( SoDistributeAction::DistributeMethod distribMethod )

inline

Destructor.

Specifies the algorithm used to distribute the scene graph.
Default is TRIANGLE_COUNT.

Definition at line 189 of file SoDistributeAction.h.

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

Inventor/actions/SoDistributeAction.h

Open Inventor Release 2024.2.0

Public Types

Public Member Functions

Static Public Member Functions