ramses::SplineLinearFloat Class Reference

The SplineLinearFloat stores spline keys of type float that can be used for animation with linear interpolation. More...

#include <SplineLinearFloat.h>

Inheritance diagram for ramses::SplineLinearFloat:

Collaboration diagram for ramses::SplineLinearFloat:

Public Member Functions
status_t	setKey (splineTimeStamp_t timeStamp, float value)
	Sets a spline key at given time with given value. More...
status_t	getKeyValues (splineKeyIndex_t keyIndex, splineTimeStamp_t &timeStamp, float &value) const
	Gets key value and time stamp for a given key index. More...
Public Member Functions inherited from ramses::Spline
uint32_t	getNumberOfKeys () const
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...

Protected Member Functions
	SplineLinearFloat (SplineImpl &pimpl)
	Constructor of SplineLinearFloat. More...
virtual	~SplineLinearFloat ()
	Destructor of the SplineLinearFloat. More...
Protected Member Functions inherited from ramses::Spline
	Spline (SplineImpl &pimpl)
	Default constructor of Spline. More...
virtual	~Spline ()
	Destructor of Spline. 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 SplineLinearFloat instances. More...

Additional Inherited Members
Public Attributes inherited from ramses::Spline
class SplineImpl &	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

Detailed Description

The SplineLinearFloat stores spline keys of type float that can be used for animation with linear interpolation.

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

SplineLinearFloat()

ramses::SplineLinearFloat::SplineLinearFloat ( SplineImpl &  pimpl )

explicitprotected

Constructor of SplineLinearFloat.

Parameters

[in]

pimpl

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

~SplineLinearFloat()

virtual ramses::SplineLinearFloat::~SplineLinearFloat ( )

protectedvirtual

Destructor of the SplineLinearFloat.

Member Function Documentation

getKeyValues()

status_t ramses::SplineLinearFloat::getKeyValues	(	splineKeyIndex_t	keyIndex,
		splineTimeStamp_t &	timeStamp,
		float &	value
	)		const

Gets key value and time stamp for a given key index.

Parameters

[in]	keyIndex	Index of a key to get values from.
[out]	timeStamp	The time stamp of the key.
[out]	value	The value of the key data.

Returns

StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

setKey()

status_t ramses::SplineLinearFloat::setKey	(	splineTimeStamp_t	timeStamp,
		float	value
	)

Sets a spline key at given time with given value.

Parameters

[in]	timeStamp	The time stamp for the key to be set
[in]	value	The value for the key data.

Returns

StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

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.

Friends And Related Function Documentation

AnimationSystemData

friend class AnimationSystemData

friend

AnimationSystemData is the factory for creating SplineLinearFloat instances.

---

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