OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Ogre::ControllerFunction< T > Class Template Referenceabstract
General

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

#include <OgreController.h>

+ Inheritance diagram for Ogre::ControllerFunction< T >:
+ Collaboration diagram for Ogre::ControllerFunction< T >:

Public Member Functions

 ControllerFunction (bool deltaInput)
 Constructor. More...
 
virtual ~ControllerFunction ()
 
virtual T calculate (T sourceValue)=0
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 

Protected Member Functions

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

Protected Attributes

T mDeltaCount
 
bool mDeltaInput
 If true, function will add input values together and wrap at 1.0 before evaluating. More...
 

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.

Definition at line 55 of file OgreController.h.

Constructor & Destructor Documentation

template<typename T>
Ogre::ControllerFunction< T >::ControllerFunction ( bool  deltaInput)
inline

Constructor.

Parameters
deltaInputIf 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.

Definition at line 89 of file OgreController.h.

template<typename T>
virtual Ogre::ControllerFunction< T >::~ControllerFunction ( )
inlinevirtual

Definition at line 95 of file OgreController.h.

Member Function Documentation

template<typename T>
virtual T Ogre::ControllerFunction< T >::calculate ( T  sourceValue)
pure virtual

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

template<typename T>
T Ogre::ControllerFunction< T >::getAdjustedInput ( T  input)
inlineprotected

Gets the input value as adjusted by any delta.

Definition at line 64 of file OgreController.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

Member Data Documentation

template<typename T>
T Ogre::ControllerFunction< T >::mDeltaCount
protected

Definition at line 60 of file OgreController.h.

Referenced by Ogre::ControllerFunction< Real >::ControllerFunction(), and Ogre::ControllerFunction< Real >::getAdjustedInput().

template<typename T>
bool Ogre::ControllerFunction< T >::mDeltaInput
protected

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

Definition at line 59 of file OgreController.h.

Referenced by Ogre::ControllerFunction< Real >::ControllerFunction(), and Ogre::ControllerFunction< Real >::getAdjustedInput().

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