Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::WaveformControllerFunction Class Reference

Predefined controller function based on a waveform. More...

#include <OgrePredefinedControllers.h>

Inheritance diagram for Ogre::WaveformControllerFunction:

Ogre::ControllerFunction List of all members.

Public Methods

 WaveformControllerFunction (WaveformType wType, Real base=0, Real frequency=1, Real phase=0, Real amplitude=1, bool deltaInput=true)
 Default contructor, requires at least a wave type, other parameters can be defaulted unless required. More...

Real calculate (Real source)
 Overriden function. More...


Protected Methods

Real getAdjustedInput (Real input)
 Overridden from ControllerFunction. More...


Protected Attributes

WaveformType mWaveType
Real mBase
Real mFrequency
Real mPhase
Real mAmplitude
bool mDeltaInput
 If true, function will add imput values together and wrap at 1.0 before evaluating. More...

Real mDeltaCount

Detailed Description

Predefined controller function based on a waveform.

Remarks:
A waveform function translates parametric intput to parametric output based on a wave. The factors affecting the function are:

Note that for simplicity of integration with the rest of the controller insfrastructure, the output of the wave is parametric i.e. 0..1, rather than the typical wave output of [-1,1]. To compensate for this, the traditional output of the wave is scaled by the following function before output:

output = (waveoutput + 1) * 0.5

Hence a wave output of -1 becomes 0, a wave ouput of 1 becomes 1, and a wave output of 0 becomes 0.5.


Constructor & Destructor Documentation

Ogre::WaveformControllerFunction::WaveformControllerFunction WaveformType    wType,
Real    base = 0,
Real    frequency = 1,
Real    phase = 0,
Real    amplitude = 1,
bool    deltaInput = true
 

Default contructor, requires at least a wave type, other parameters can be defaulted unless required.

Parameters:
deltaInput  If true, signifies that the input will be a delta value such that the function should add it to an internal counter before calculating the output.


Member Function Documentation

Real Ogre::WaveformControllerFunction::calculate Real    source [virtual]
 

Overriden function.

Implements Ogre::ControllerFunction.

Real Ogre::WaveformControllerFunction::getAdjustedInput Real    input [protected]
 

Overridden from ControllerFunction.

Reimplemented from Ogre::ControllerFunction.


Member Data Documentation

Real Ogre::WaveformControllerFunction::mAmplitude [protected]
 

Real Ogre::WaveformControllerFunction::mBase [protected]
 

Real Ogre::ControllerFunction::mDeltaCount [protected, inherited]
 

bool Ogre::ControllerFunction::mDeltaInput [protected, inherited]
 

If true, function will add imput values together and wrap at 1.0 before evaluating.

Real Ogre::WaveformControllerFunction::mFrequency [protected]
 

Real Ogre::WaveformControllerFunction::mPhase [protected]
 

WaveformType Ogre::WaveformControllerFunction::mWaveType [protected]
 

Copyright © 2002 by The OGRE Team