Ogre::ControllerFunction< T > Class Template Reference

Subclasses of this class are responsible for performing a function on an input value for a Controller. More...

#include <OgrePrerequisites.h>

Inheritance diagram for Ogre::ControllerFunction< T >:

Public Member Functions
	ControllerFunction (bool deltaInput)
	Constructor. More...
virtual	~ControllerFunction ()
virtual T	calculate (T sourceValue)=0

Detailed Description

template<typename T>
class Ogre::ControllerFunction< T >

Subclasses of this class are responsible for performing a function on an input value for a Controller.

Remarks

This abstract class provides the interface that needs to be supported for a custom function which can be 'plugged in' to a Controller instance, which controls some object value based on an input value. For example, the WaveControllerFunction class provided by Ogre allows you to use various waveforms to translate an input value to an output value.

You are free to create your own subclasses in order to define any function you wish.

Constructor & Destructor Documentation

ControllerFunction()

template<typename T >

Ogre::ControllerFunction< T >::ControllerFunction ( bool  deltaInput )

inline

Constructor.

Parameters

deltaInput

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

~ControllerFunction()

template<typename T >

virtual Ogre::ControllerFunction< T >::~ControllerFunction ( )

inlinevirtual

Member Function Documentation

calculate()

template<typename T >

virtual T Ogre::ControllerFunction< T >::calculate ( T  sourceValue )

pure virtual

Implemented in Ogre::LinearControllerFunction, Ogre::WaveformControllerFunction, Ogre::ScaleControllerFunction, Ogre::AnimationControllerFunction, and Ogre::PassthroughControllerFunction.

---

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

• OgreController.h