ramses::AnimatedProperty Class Reference

The AnimatedProperty holds a reference to data that can be animated. More...

#include <AnimatedProperty.h>

Inheritance diagram for ramses::AnimatedProperty:

Collaboration diagram for ramses::AnimatedProperty:

Public Member Functions
	AnimatedProperty (const AnimatedProperty &other)=delete
	Deleted copy constructor. More...
AnimatedProperty &	operator= (const AnimatedProperty &other)=delete
	Deleted copy assignment. 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 AnimatedPropertyImpl &	impl
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
	AnimatedProperty (AnimatedPropertyImpl &pimpl)
	Constructor of the animated property. More...
virtual	~AnimatedProperty () override
	Destructor of the animated property. 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	AnimatedPropertyFactory
	AnimatedPropertyFactory is the factory for creating animated properties. More...
class	AnimationSystemData
	AnimationSystemData is the factory for creating animated properties. More...

Detailed Description

The AnimatedProperty holds a reference to data that can be animated.

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

AnimatedProperty() [1/2]

ramses::AnimatedProperty::AnimatedProperty ( const AnimatedProperty &  other )

delete

Deleted copy constructor.

Parameters

other

unused

AnimatedProperty() [2/2]

ramses::AnimatedProperty::AnimatedProperty ( AnimatedPropertyImpl &  pimpl )

explicitprotected

Constructor of the animated property.

Parameters

[in]

pimpl

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

~AnimatedProperty()

virtual ramses::AnimatedProperty::~AnimatedProperty ( )

overrideprotectedvirtual

Destructor of the animated property.

Member Function Documentation

operator=()

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

delete

Deleted copy assignment.

Parameters

other

unused

Returns

unused

Friends And Related Function Documentation

AnimatedPropertyFactory

friend class AnimatedPropertyFactory

friend

AnimatedPropertyFactory is the factory for creating animated properties.

AnimationSystemData

friend class AnimationSystemData

friend

AnimationSystemData is the factory for creating animated properties.

Member Data Documentation

impl

class AnimatedPropertyImpl& ramses::AnimatedProperty::impl

Stores internal data for implementation specifics of AnimatedProperty.

---

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/AnimatedProperty.h