The SplineBezierFloat stores spline keys of type float that can be used for animation with Bezier interpolation.
More...
#include <SplineBezierFloat.h>
|
status_t | setKey (splineTimeStamp_t timeStamp, float value, float tangentIn_x, float tangentIn_y, float tangentOut_x, float tangentOut_y) |
| Sets a spline key at given time with given value. More...
|
|
status_t | getKeyValues (splineKeyIndex_t keyIndex, splineTimeStamp_t &timeStamp, float &value, float &tangentIn_x, float &tangentIn_y, float &tangentOut_x, float &tangentOut_y) const |
| Gets key value and time stamp for a given key index. More...
|
|
uint32_t | getNumberOfKeys () const |
|
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...
|
|
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...
|
|
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...
|
|
|
class SplineImpl & | impl |
|
class AnimationObjectImpl & | impl |
|
class SceneObjectImpl & | impl |
|
class ClientObjectImpl & | impl |
|
class RamsesObjectImpl & | impl |
|
class StatusObjectImpl & | impl |
|
The SplineBezierFloat stores spline keys of type float that can be used for animation with Bezier interpolation.
◆ SplineBezierFloat()
ramses::SplineBezierFloat::SplineBezierFloat |
( |
SplineImpl & |
pimpl | ) |
|
|
explicitprotected |
Constructor of SplineBezierFloat.
- Parameters
-
[in] | pimpl | Internal data for implementation specifics of Spline (sink - instance becomes owner) |
◆ ~SplineBezierFloat()
virtual ramses::SplineBezierFloat::~SplineBezierFloat |
( |
| ) |
|
|
protectedvirtual |
◆ getKeyValues()
status_t ramses::SplineBezierFloat::getKeyValues |
( |
splineKeyIndex_t |
keyIndex, |
|
|
splineTimeStamp_t & |
timeStamp, |
|
|
float & |
value, |
|
|
float & |
tangentIn_x, |
|
|
float & |
tangentIn_y, |
|
|
float & |
tangentOut_x, |
|
|
float & |
tangentOut_y |
|
) |
| 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. |
[out] | tangentIn_x | The X component of incoming tangent vector. |
[out] | tangentIn_y | The Y component of incoming tangent vector. |
[out] | tangentOut_x | The X component of outgoing tangent vector. |
[out] | tangentOut_y | The Y component of outgoing tangent vector. |
- Returns
- StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().
◆ setKey()
status_t ramses::SplineBezierFloat::setKey |
( |
splineTimeStamp_t |
timeStamp, |
|
|
float |
value, |
|
|
float |
tangentIn_x, |
|
|
float |
tangentIn_y, |
|
|
float |
tangentOut_x, |
|
|
float |
tangentOut_y |
|
) |
| |
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. |
[in] | tangentIn_x | The X component of incoming tangent vector. |
[in] | tangentIn_y | The Y component of incoming tangent vector. |
[in] | tangentOut_x | The X component of outgoing tangent vector. |
[in] | tangentOut_y | The Y component of outgoing tangent vector. |
- Returns
- StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().
◆ AnimationSystemData
friend class AnimationSystemData |
|
friend |
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/SplineBezierFloat.h