This documents an old version of bs::framework. Click here to see the latest release.
AnimationCurves Struct Reference

Description

A set of animation curves representing translation/rotation/scale and generic animation.

Methods

void addPositionCurve (const String &name, const TAnimationCurve< Vector3 > &curve)
 Registers a new curve used for animating position. More...
 
void addRotationCurve (const String &name, const TAnimationCurve< Quaternion > &curve)
 Registers a new curve used for animating rotation. More...
 
void addScaleCurve (const String &name, const TAnimationCurve< Vector3 > &curve)
 Registers a new curve used for animating scale. More...
 
void addGenericCurve (const String &name, const TAnimationCurve< float > &curve)
 Registers a new curve used for generic animation. More...
 
void removePositionCurve (const String &name)
 Removes an existing curve from the clip. More...
 
void removeRotationCurve (const String &name)
 Removes an existing curve from the clip. More...
 
void removeScaleCurve (const String &name)
 Removes an existing curve from the clip. More...
 
void removeGenericCurve (const String &name)
 Removes an existing curve from the clip. More...
 

Fields

Vector< TNamedAnimationCurve< Vector3 > > position
 Curves for animating scene object's position. More...
 
Vector< TNamedAnimationCurve< Quaternion > > rotation
 Curves for animating scene object's rotation. More...
 
Vector< TNamedAnimationCurve< Vector3 > > scale
 Curves for animating scene object's scale. More...
 
Vector< TNamedAnimationCurve< float > > generic
 Curves for animating generic component properties. More...
 

Method documentation

◆ addGenericCurve()

void addGenericCurve ( const String name,
const TAnimationCurve< float > &  curve 
)

Registers a new curve used for generic animation.

Parameters
[in]nameUnique name of the curve. This can be used for retrieving the value of the curve from animation.
[in]curveCurve to add to the clip.

◆ addPositionCurve()

void addPositionCurve ( const String name,
const TAnimationCurve< Vector3 > &  curve 
)

Registers a new curve used for animating position.

Parameters
[in]nameUnique name of the curve. This name will be used mapping the curve to the relevant bone in a skeleton, if any.
[in]curveCurve to add to the clip.

◆ addRotationCurve()

void addRotationCurve ( const String name,
const TAnimationCurve< Quaternion > &  curve 
)

Registers a new curve used for animating rotation.

Parameters
[in]nameUnique name of the curve. This name will be used mapping the curve to the relevant bone in a skeleton, if any.
[in]curveCurve to add to the clip.

◆ addScaleCurve()

void addScaleCurve ( const String name,
const TAnimationCurve< Vector3 > &  curve 
)

Registers a new curve used for animating scale.

Parameters
[in]nameUnique name of the curve. This name will be used mapping the curve to the relevant bone in a skeleton, if any.
[in]curveCurve to add to the clip.

◆ removeGenericCurve()

void removeGenericCurve ( const String name)

Removes an existing curve from the clip.

◆ removePositionCurve()

void removePositionCurve ( const String name)

Removes an existing curve from the clip.

◆ removeRotationCurve()

void removeRotationCurve ( const String name)

Removes an existing curve from the clip.

◆ removeScaleCurve()

void removeScaleCurve ( const String name)

Removes an existing curve from the clip.

Member Data Documentation

◆ generic

Vector<TNamedAnimationCurve<float> > generic

Curves for animating generic component properties.

◆ position

Curves for animating scene object's position.

◆ rotation

Curves for animating scene object's rotation.

◆ scale

Curves for animating scene object's scale.