class AnimChannel

An animation channel represents a single channel of an Animation.

File location: framework/cauldron/framework/inc/render/animation.h

Enumerations

Name

Description

ComponentSampler
The types of components that can be found in an “AnimChannel“
Translation = 0 – “AnimChannel“ represents a Translation animation component.
Rotation – AnimChannel represents a Rotation animation component.
Scale – AnimChannel represents a Scale animation component.
Count

Construction

Return type

Description
AnimChannel ()
AnimChannel construction with default behavior.
AnimChannel (const AnimChannel&)
AnimChannel copy construction with default behavior.

Methods

Return type

Description

AnimChannel&
operator = (const AnimChannel&)
AnimChannel assignment operator with default behavior.

bool
HasComponentSampler (ComponentSampler samplerID) const
Query if the animation channels contains a “ComponentSampler“ of the requested type.

void
SampleAnimComponent ( ComponentSampler samplerID, float time, float* frac, float** pCurr, float** pNext ) const
Samples the requested “ComponentSampler“ at a specific time to get the animation data.

void
CreateComponentSampler ( ComponentSampler samplerID, AnimInterpolants * timeInterpolants, AnimInterpolants * valueInterpolants )
Creates a “ComponentSampler“ and populates it with data.

float
GetComponentSamplerDuration (ComponentSampler samplerID) const
Queries the “ComponentSampler“ animation duration.

Detailed description

An animation channel represents a single channel of an Animation. Each channel can have multiple components to it, such as Translation, Rotation, and Scale components.

Construction

AnimChannel

Copied!

AnimChannel ()

AnimChannel construction with default behavior.

AnimChannel

Copied!

AnimChannel (const AnimChannel&)

AnimChannel copy construction with default behavior.

Methods

operator=

Copied!

AnimChannel& operator =  (const AnimChannel&)

AnimChannel assignment operator with default behavior.

HasComponentSampler

Copied!

bool HasComponentSampler (ComponentSampler  samplerID) const

Query if the animation channels contains a ComponentSampler of the requested type.

SampleAnimComponent

Copied!

void SampleAnimComponent (
    ComponentSampler  samplerID,
    float time,
    float* frac,
    float** pCurr,
    float** pNext
) const

Samples the requested ComponentSampler at a specific time to get the animation data.

CreateComponentSampler

Copied!

void CreateComponentSampler (
    ComponentSampler  samplerID,
    AnimInterpolants * timeInterpolants,
    AnimInterpolants * valueInterpolants
)

Creates a ComponentSampler and populates it with data.

GetComponentSamplerDuration

Copied!

float GetComponentSamplerDuration (ComponentSampler  samplerID) const

Queries the ComponentSampler animation duration.