RAMSES Documentation  27.0.130
Information for RAMSES users and developers
Public Member Functions | List of all members
ramses::SceneObjectIterator Class Reference

The SceneObjectIterator traverses objects in a Scene. More...

#include <SceneObjectIterator.h>

Public Member Functions

 SceneObjectIterator (const Scene &scene, ERamsesObjectType objectType=ERamsesObjectType_RamsesObject)
 A SceneObjectIterator can iterate through objects of given type within a scene. More...
 
 ~SceneObjectIterator ()
 Destructor. More...
 
RamsesObjectgetNext ()
 Iterate through all objects of given type. More...
 

Detailed Description

The SceneObjectIterator traverses objects in a Scene.

It provides a way to traverse all objects owned by a given scene.

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

Constructor & Destructor Documentation

◆ SceneObjectIterator()

ramses::SceneObjectIterator::SceneObjectIterator ( const Scene scene,
ERamsesObjectType  objectType = ERamsesObjectType_RamsesObject 
)
explicit

A SceneObjectIterator can iterate through objects of given type within a scene.

Parameters
[in]sceneScene whose objects to iterate through
[in]objectTypeOptional type of objects to iterate through.

◆ ~SceneObjectIterator()

ramses::SceneObjectIterator::~SceneObjectIterator ( )

Destructor.

Member Function Documentation

◆ getNext()

RamsesObject* ramses::SceneObjectIterator::getNext ( )

Iterate through all objects of given type.

Returns
next object, null if no more objects available

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

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

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