ProtoTracer  1.0
Real-time 3D rendering and animation engine
Loading...
Searching...
No Matches
EffectChangeTrack< parameters > Class Template Reference

A template class for animating effect transitions using keyframes. More...

#include <EffectChangeTrack.h>

Inheritance diagram for EffectChangeTrack< parameters >:
Collaboration diagram for EffectChangeTrack< parameters >:

Public Member Functions

 EffectChangeTrack ()
 Default constructor.
 
- Public Member Functions inherited from AnimationTrack< parameters, 5 >
 AnimationTrack ()
 Default constructor.
 
 AnimationTrack (float min, float max, KeyFrameInterpolation::InterpolationMethod interpMethod)
 Parameterized constructor.
 
void Play ()
 Starts or resumes playback of the animation track.
 
void Pause ()
 Pauses playback of the animation track.
 
void RestartTime ()
 Restarts the animation track's time to the beginning.
 
void PrintTime ()
 Prints the current time of the animation track.
 
void Reset ()
 Resets the animation track to its initial state.
 
float GetParameterValue ()
 Retrieves the current parameter value of the animation track.
 
float Update ()
 Updates the animation track and returns the current parameter value.
 
void AddParameter (float *parameter)
 Adds a parameter to the animation track.
 

Private Member Functions

void AddKeyFrames ()
 Adds predefined keyframes for the effect animation.
 

Additional Inherited Members

- Protected Attributes inherited from AnimationTrack< parameters, 5 >
KeyFrameTrack< maxParameters, maxKeyFramestrack
 Internal track object for keyframe management.
 

Detailed Description

template<size_t parameters>
class EffectChangeTrack< parameters >

A template class for animating effect transitions using keyframes.

The EffectChangeTrack class inherits from AnimationTrack and provides a specific keyframe animation sequence to simulate the transition of effects. This includes changes in intensity over time.

Template Parameters
parametersThe number of parameters for the effect animation.

Definition at line 27 of file EffectChangeTrack.h.

Constructor & Destructor Documentation

◆ EffectChangeTrack()

template<size_t parameters>
EffectChangeTrack ( )
inline

Default constructor.

Constructs an EffectChangeTrack object and initializes the effect animation keyframes.

Definition at line 48 of file EffectChangeTrack.h.

References EffectChangeTrack< parameters >::AddKeyFrames().

Member Function Documentation

◆ AddKeyFrames()

template<size_t parameters>
void AddKeyFrames ( )
inlineprivatevirtual

Adds predefined keyframes for the effect animation.

This function initializes the keyframes to create the effect transition, including the timing for intensity changes.

< Effect off at time 0.0.

< Effect fully active at time 0.5.

< Effect turns off at time 1.0.

< Effect remains off indefinitely after time 1,000,000.0.

Implements AnimationTrack< parameters, 5 >.

Definition at line 35 of file EffectChangeTrack.h.

References AnimationTrack< parameters, 5 >::track.

Referenced by EffectChangeTrack< parameters >::EffectChangeTrack().


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