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

The AnimationObject is a base class for all client API objects owned by an AnimationSystem. More...

#include <AnimationObject.h>

Inheritance diagram for ramses::AnimationObject:
[legend]
Collaboration diagram for ramses::AnimationObject:
[legend]

Public Attributes

class AnimationObjectImpl & impl
 
- Public Attributes inherited from ramses::SceneObject
class SceneObjectImpl & impl
 
- Public Attributes inherited from ramses::ClientObject
class ClientObjectImpl & impl
 
- Public Attributes inherited from ramses::RamsesObject
class RamsesObjectImpl & impl
 
- Public Attributes inherited from ramses::StatusObject
class StatusObjectImpl & impl
 

Protected Member Functions

 AnimationObject (AnimationObjectImpl &pimpl)
 Constructor for AnimationObject. More...
 
virtual ~AnimationObject ()
 Destructor of the AnimationObject. More...
 
- Protected Member Functions inherited from ramses::SceneObject
 SceneObject (SceneObjectImpl &pimpl)
 Constructor for SceneObject. More...
 
virtual ~SceneObject ()
 Destructor of the SceneObject. More...
 
- Protected Member Functions inherited from ramses::ClientObject
 ClientObject (ClientObjectImpl &pimpl)
 Constructor for ClientObject. More...
 
virtual ~ClientObject ()
 Destructor of the ClientObject. More...
 
- Protected Member Functions inherited from ramses::RamsesObject
 RamsesObject (RamsesObjectImpl &pimpl)
 Constructor for RamsesObject. More...
 
virtual ~RamsesObject ()
 Destructor of the RamsesObject. More...
 
- Protected Member Functions inherited from ramses::StatusObject
 StatusObject (StatusObjectImpl &pimpl)
 Constructor for StatusObject. More...
 
virtual ~StatusObject ()
 Destructor of the StatusObject. More...
 

Friends

class AnimationSystemData
 AnimationSystemData is the factory for creating animated properties. More...
 

Additional Inherited Members

- Public Member Functions inherited from ramses::SceneObject
sceneObjectId_t getSceneObjectId () const
 Returns scene object id which is automatically assigned at creation time of object and is unique within scope of one scene. More...
 
sceneId_t getSceneId () const
 Returns sceneid to which this object belongs to. More...
 
- Public Member Functions inherited from ramses::RamsesObject
const char * getName () const
 Returns the name of the object. More...
 
status_t setName (const char *name)
 Changes the name of the object. More...
 
ERamsesObjectType getType () const
 Gets type of the object. More...
 
bool isOfType (ERamsesObjectType type) const
 Checks if the object is of given type. More...
 
- Public Member Functions inherited from ramses::StatusObject
status_t validate () const
 Generates verbose validation of the object. More...
 
const char * getValidationReport (EValidationSeverity minSeverity=EValidationSeverity_Info) const
 Provides verbose report in human readable form generated by validate. More...
 
const char * getStatusMessage (status_t status) const
 Get the string description for a status provided by a RAMSES API function. More...
 
 StatusObject (const StatusObject &other)=delete
 Deleted copy constructor. More...
 
StatusObjectoperator= (const StatusObject &other)=delete
 Deleted copy assignment. More...
 

Detailed Description

The AnimationObject is a base class for all client API objects owned by an AnimationSystem.

Constructor & Destructor Documentation

◆ AnimationObject()

ramses::AnimationObject::AnimationObject ( AnimationObjectImpl &  pimpl)
explicitprotected

Constructor for AnimationObject.

Parameters
[in]pimplInternal data for implementation specifics of AnimationObject (sink - instance becomes owner)

◆ ~AnimationObject()

virtual ramses::AnimationObject::~AnimationObject ( )
protectedvirtual

Destructor of the AnimationObject.

Friends And Related Function Documentation

◆ AnimationSystemData

friend class AnimationSystemData
friend

AnimationSystemData is the factory for creating animated properties.

Member Data Documentation

◆ impl

class AnimationObjectImpl& ramses::AnimationObject::impl

Stores internal data for implementation specifics of AnimationObject.


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