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

Ogre::ScaleControllerFunction Class Reference

Predefined controller function which simply scales an input to an output value. More...

#include <OgrePredefinedControllers.h>

Inheritance diagram for Ogre::ScaleControllerFunction:

Ogre::ControllerFunction List of all members.

Public Methods

 ScaleControllerFunction (Real scalefactor, bool deltaInput)
 Constructor, requires a scale factor. More...

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


Protected Methods

Real getAdjustedInput (Real input)
 Gets the input value as adjusted by any delta. More...


Protected Attributes

Real mScale
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 which simply scales an input to an output value.


Constructor & Destructor Documentation

Ogre::ScaleControllerFunction::ScaleControllerFunction Real    scalefactor,
bool    deltaInput
 

Constructor, requires a scale factor.

Parameters:
scalefactor  The multipier applied to the input to produce the output.
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::ScaleControllerFunction::calculate Real    source [virtual]
 

Overriden method.

Implements Ogre::ControllerFunction.

Real Ogre::ControllerFunction::getAdjustedInput Real    input [inline, protected, inherited]
 

Gets the input value as adjusted by any delta.

Reimplemented in Ogre::WaveformControllerFunction.


Member Data Documentation

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::ScaleControllerFunction::mScale [protected]
 

Copyright © 2002 by The OGRE Team