CrystalSpace

Public API Reference

CS::Animation::SkeletonNoise Class Reference

A structure holding the noise components for a iSkeletonNoiseNode animation node. More...

#include <imesh/animnode/noise.h>

Inheritance diagram for CS::Animation::SkeletonNoise:

List of all members.

Public Member Functions

CS::Math::Noise::Module::ModuleGetComponent (size_t index)
 Get the noise component at the given index.
void SetComponent (size_t index, CS::Math::Noise::Module::Module *module)
 Set the noise component at the given index.
 SkeletonNoise ()
 Constructor.
virtual ~SkeletonNoise ()
 Destructor.

Detailed Description

A structure holding the noise components for a iSkeletonNoiseNode animation node.

The structure can hold up to three noise components. It is allowed to not define some of these components, in this case the corresponding animation channel axis won't be animated.

Definition at line 84 of file noise.h.


Constructor & Destructor Documentation

CS::Animation::SkeletonNoise::SkeletonNoise (  )  [inline]

Constructor.

Definition at line 89 of file noise.h.

virtual CS::Animation::SkeletonNoise::~SkeletonNoise (  )  [inline, virtual]

Destructor.

Definition at line 97 of file noise.h.


Member Function Documentation

CS::Math::Noise::Module::Module* CS::Animation::SkeletonNoise::GetComponent ( size_t  index  )  [inline]

Get the noise component at the given index.

Parameters:
index The index of the noise component. It must be smaller than 3.
Returns:
The noise component at the given index, or nullptr if this component is not defined.

Definition at line 116 of file noise.h.

void CS::Animation::SkeletonNoise::SetComponent ( size_t  index,
CS::Math::Noise::Module::Module module 
) [inline]

Set the noise component at the given index.

Parameters:
index The index of the noise component. It must be smaller than 3.
module The noise module controlling the given component.

Definition at line 104 of file noise.h.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1