Audaspace  1.3.0
A high level audio library.
Classes | Public Member Functions | List of all members
AnimateableProperty Class Reference

This class saves animation data for float properties. More...

#include <AnimateableProperty.h>

Inheritance diagram for AnimateableProperty:
Inheritance graph
[legend]

Public Member Functions

 AnimateableProperty (int count=1)
 Creates a new animateable property. More...
 
 AnimateableProperty (int count, float value)
 Creates a new animateable property. More...
 
 ~AnimateableProperty ()
 Destroys the animateable property.
 
int getCount () const
 Returns the count of floats for a single property. More...
 
void write (const float *data)
 Writes the properties value and marks it non-animated. More...
 
void write (const float *data, int position, int count)
 Writes the properties value and marks it animated. More...
 
void read (float position, float *out)
 Reads the properties value. More...
 
bool isAnimated () const
 Returns whether the property is animated. More...
 

Detailed Description

This class saves animation data for float properties.

Constructor & Destructor Documentation

◆ AnimateableProperty() [1/2]

AnimateableProperty::AnimateableProperty ( int  count = 1)

Creates a new animateable property.

Parameters
countThe count of floats for a single property.

◆ AnimateableProperty() [2/2]

AnimateableProperty::AnimateableProperty ( int  count,
float  value 
)

Creates a new animateable property.

Parameters
countThe count of floats for a single property.
valueThe value that the property should get initialized with. All count floats will be initialized to the same value.

Member Function Documentation

◆ getCount()

int AnimateableProperty::getCount ( ) const

Returns the count of floats for a single property.

Returns
The count of floats stored per frame.

◆ isAnimated()

bool AnimateableProperty::isAnimated ( ) const

Returns whether the property is animated.

Returns
Whether the property is animated.

◆ read()

void AnimateableProperty::read ( float  position,
float *  out 
)

Reads the properties value.

Parameters
positionThe position in the animation in frames.
[out]outWhere to write the value to.

◆ write() [1/2]

void AnimateableProperty::write ( const float *  data)

Writes the properties value and marks it non-animated.

Parameters
dataThe new value.

◆ write() [2/2]

void AnimateableProperty::write ( const float *  data,
int  position,
int  count 
)

Writes the properties value and marks it animated.

Parameters
dataThe new value.
positionThe position in the animation in frames.
countThe count of frames to write.

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