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

The AnimationSystemObjectIterator iterates over objects of given type in an AnimationSystem. More...

#include <AnimationSystemObjectIterator.h>

Public Member Functions

 AnimationSystemObjectIterator (const AnimationSystem &animationSystem, ERamsesObjectType objectType=ERamsesObjectType_RamsesObject)
 A AnimationSystemObjectIterator can iterate through objects of given type within an animation system. More...
 
 ~AnimationSystemObjectIterator ()
 Destructor. More...
 
RamsesObjectgetNext ()
 Iterate through all objects of given type. More...
 

Detailed Description

The AnimationSystemObjectIterator iterates over objects of given type in an AnimationSystem.

It provides a way to traverse all objects of given type owned by a given animation system.

Constructor & Destructor Documentation

◆ AnimationSystemObjectIterator()

ramses::AnimationSystemObjectIterator::AnimationSystemObjectIterator ( const AnimationSystem animationSystem,
ERamsesObjectType  objectType = ERamsesObjectType_RamsesObject 
)
explicit

A AnimationSystemObjectIterator can iterate through objects of given type within an animation system.

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

◆ ~AnimationSystemObjectIterator()

ramses::AnimationSystemObjectIterator::~AnimationSystemObjectIterator ( )

Destructor.

Member Function Documentation

◆ getNext()

RamsesObject* ramses::AnimationSystemObjectIterator::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.


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