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

The SceneIterator traverses scenes in a RamsesClient. More...

#include <SceneIterator.h>

Public Member Functions

 SceneIterator (const RamsesClient &client)
 A SceneIterator can iterate through scenes of the given client. More...
 
 ~SceneIterator ()
 
ScenegetNext ()
 Returns the next scene while iterating. More...
 

Detailed Description

The SceneIterator traverses scenes in a RamsesClient.

It provides a way to traverse all scenes created with a given client.

Constructor & Destructor Documentation

◆ SceneIterator()

ramses::SceneIterator::SceneIterator ( const RamsesClient client)
explicit

A SceneIterator can iterate through scenes of the given client.

Parameters
[in]clientRamsesClient whose scenes to iterate through

◆ ~SceneIterator()

ramses::SceneIterator::~SceneIterator ( )

Destructor

Member Function Documentation

◆ getNext()

Scene* ramses::SceneIterator::getNext ( )

Returns the next scene while iterating.

Returns
The next scene, null when no more scenes are available. The iterator is invalid and may not be used after any scenes are added or removed.

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