NDEVR
API Documentation
SceneIterator

Allows quick iteration of all scene objects. More...

Public Member Functions

virtual bool onEffect (Effect &)
 Called for each Effect encountered during iteration.
virtual bool onGeometry (Geometry &)
 Called for each Geometry encountered during iteration.
virtual bool onLayer (Model &)
 Called for each layer Model encountered during iteration.
virtual bool onMaterial (Material &)
 Called for each Material encountered during iteration.
virtual bool onModel (Model &)
 Called for each Model encountered during iteration.

Public Attributes

bool include_deleted = false
 Whether to visit deleted objects during iteration.
bool include_scene = true
 Whether to include the Scene itself in iteration.
bool root_only = true
 Whether to iterate only root-level objects.

Detailed Description

Allows quick iteration of all scene objects.


Returning false aborts the iteration.

Definition at line 8 of file Scene.h.

Member Function Documentation

◆ onEffect()

virtual bool SceneIterator::onEffect ( Effect & )
inlinevirtual

Called for each Effect encountered during iteration.


Parameters
[in]effectThe Effect being visited.
Returns
True to continue iteration, false to abort.

Definition at line 40 of file Scene.h.

◆ onGeometry()

virtual bool SceneIterator::onGeometry ( Geometry & )
inlinevirtual

Called for each Geometry encountered during iteration.


Parameters
[in]geometryThe Geometry being visited.
Returns
True to continue iteration, false to abort.

Definition at line 28 of file Scene.h.

◆ onLayer()

virtual bool SceneIterator::onLayer ( Model & )
inlinevirtual

Called for each layer Model encountered during iteration.


Parameters
[in]modelThe layer Model being visited.
Returns
True to continue iteration, false to abort.

Definition at line 22 of file Scene.h.

◆ onMaterial()

virtual bool SceneIterator::onMaterial ( Material & )
inlinevirtual

Called for each Material encountered during iteration.


Parameters
[in]materialThe Material being visited.
Returns
True to continue iteration, false to abort.

Definition at line 34 of file Scene.h.

◆ onModel()

virtual bool SceneIterator::onModel ( Model & )
inlinevirtual

Called for each Model encountered during iteration.


Parameters
[in]modelThe Model being visited.
Returns
True to continue iteration, false to abort.

Definition at line 16 of file Scene.h.


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