ramses::SceneGraphIterator Class Reference

A SceneObjectIterator can iterate through the nodes in the scene graph with the order specified as traversal style. More...

#include <SceneGraphIterator.h>

Public Member Functions
	SceneGraphIterator (Node &startNode, ETreeTraversalStyle traversalStyle, ERamsesObjectType objectType=ERamsesObjectType_Node)
	Constructor for SceneGraphIterator. A SceneObjectIterator can iterate through the nodes in the scene graph with the order specified as traversal style. More...
	~SceneGraphIterator ()
	Destructor. More...
Node *	getNext ()
	Returns the next node while iterating. More...

Protected Member Functions
	SceneGraphIterator (const SceneGraphIterator &other)
	Copy constructor of SceneGraphIterator. More...
SceneGraphIterator &	operator= (const SceneGraphIterator &other)
	Assignment operator of SceneGraphIterator. More...

Protected Attributes
class SceneGraphIteratorImpl *	impl
	Stores internal data for implementation specifics of SceneGraphIterator. More...

Detailed Description

A SceneObjectIterator can iterate through the nodes in the scene graph with the order specified as traversal style.

Examples

ramses-example-basic-scenegraph/src/main.cpp.

Constructor & Destructor Documentation

SceneGraphIterator() [1/2]

ramses::SceneGraphIterator::SceneGraphIterator	(	Node &	startNode,
		ETreeTraversalStyle	traversalStyle,
		ERamsesObjectType	objectType = ERamsesObjectType_Node
	)

Constructor for SceneGraphIterator. A SceneObjectIterator can iterate through the nodes in the scene graph with the order specified as traversal style.

Parameters

[in]	startNode	root node of the (sub)tree that should be traversed
[in]	traversalStyle	traversal style that should be used
[in]	objectType	Type of objects to iterate through

~SceneGraphIterator()

ramses::SceneGraphIterator::~SceneGraphIterator

(

)

Destructor.

SceneGraphIterator() [2/2]

ramses::SceneGraphIterator::SceneGraphIterator ( const SceneGraphIterator &  other )

protected

Copy constructor of SceneGraphIterator.

Parameters

[in]

other

Other instance of SceneGraphIterator class

Member Function Documentation

getNext()

Node* ramses::SceneGraphIterator::getNext

(

)

Returns the next node while iterating.

Returns

next node, null if no more objects available

Iterator is invalid and may no longer be used if any nodes are added or removed.

Examples

ramses-example-basic-scenegraph/src/main.cpp.

operator=()

SceneGraphIterator& ramses::SceneGraphIterator::operator= ( const SceneGraphIterator &  other )

protected

Assignment operator of SceneGraphIterator.

Parameters

[in]

other

Other instance of SceneGraphIterator class

Returns

This instance after assignment

Member Data Documentation

impl

class SceneGraphIteratorImpl* ramses::SceneGraphIterator::impl

protected

Stores internal data for implementation specifics of SceneGraphIterator.

---

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

• /home/runner/work/ramses/ramses/client/ramses-client/ramses-client-api/include/ramses-client-api/SceneGraphIterator.h