ramses::Animation Class Reference

The Animation combines spline with one or more AnimatedProperty instances and allows control of the animation. More...

#include <Animation.h>

Inheritance diagram for ramses::Animation:

Collaboration diagram for ramses::Animation:

Public Member Functions
globalTimeStamp_t	getStartTime () const
	Gets global time stamp for when animation is set to start. More...
globalTimeStamp_t	getStopTime () const
	Gets global time stamp for when animation is set to stop. More...
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...
StatusObject &	operator= (const StatusObject &other)=delete
	Deleted copy assignment. More...

Public Attributes
class AnimationImpl &	impl
	Stores internal data for implementation specifics of Animation. More...
Public Attributes inherited from ramses::AnimationObject
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
	Animation (AnimationImpl &pimpl)
	Constructor of the Animation. More...
	Animation (const Animation &other)
	Copy constructor of Animation. More...
Animation &	operator= (const Animation &other)
	Assignment operator of Animation. More...
virtual	~Animation ()
	Destructor of the Animation. More...
Protected Member Functions inherited from ramses::AnimationObject
	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 Animation. More...

Detailed Description

The Animation combines spline with one or more AnimatedProperty instances and allows control of the animation.

Examples

ramses-example-basic-animation-realtime/src/main.cpp, ramses-example-basic-animation/src/main.cpp, ramses-example-basic-file-loading/src/main.cpp, ramses-example-local-client-dcsm/src/main.cpp, ramses-example-local-client/src/main.cpp, ramses-example-local-displays/src/main.cpp, ramses-example-local-geometry-shaders/src/main.cpp, and ramses-example-local-viewport-link/src/main.cpp.

Constructor & Destructor Documentation

Animation() [1/2]

ramses::Animation::Animation ( AnimationImpl &  pimpl )

explicitprotected

Constructor of the Animation.

Parameters

[in]

pimpl

Internal data for implementation specifics of Animation (sink - instance becomes owner)

Animation() [2/2]

ramses::Animation::Animation ( const Animation &  other )

protected

Copy constructor of Animation.

Parameters

[in]

other

Other instance of Animation class

~Animation()

virtual ramses::Animation::~Animation ( )

protectedvirtual

Destructor of the Animation.

Member Function Documentation

getStartTime()

globalTimeStamp_t ramses::Animation::getStartTime

(

)

const

Gets global time stamp for when animation is set to start.

Returns

Start global time stamp.

getStopTime()

globalTimeStamp_t ramses::Animation::getStopTime

(

)

const

Gets global time stamp for when animation is set to stop.

Returns

Stop global time stamp.

operator=()

Animation& ramses::Animation::operator= ( const Animation &  other )

protected

Assignment operator of Animation.

Parameters

[in]

other

Other instance of Animation class

Returns

This instance after assignment

Friends And Related Function Documentation

AnimationSystemData

friend class AnimationSystemData

friend

AnimationSystemData is the factory for creating Animation.

Member Data Documentation

impl

class AnimationImpl& ramses::Animation::impl

Stores internal data for implementation specifics of Animation.

---

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

• /home/runner/work/ramses/ramses/client/ramses-client/ramses-client-api/include/ramses-client-api/Animation.h