OGRE  1.9.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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:
Inheritance graph
[legend]

Public Member Functions

 ScaleControllerFunction (Real scalefactor, bool deltaInput)
 Constructor, requires a scale factor.
 
Real calculate (Real source)
 Overridden method.
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
 
voidoperator new (size_t sz, void *ptr)
 placement operator new
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
 

Protected Member Functions

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

Protected Attributes

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

Detailed Description

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

Definition at line 218 of file OgrePredefinedControllers.h.

Constructor & Destructor Documentation

◆ ScaleControllerFunction()

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

Constructor, requires a scale factor.

Parameters
scalefactorThe multiplier applied to the input to produce the output.
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.

Member Function Documentation

◆ calculate()

Real Ogre::ScaleControllerFunction::calculate ( Real  source)
virtual

Overridden method.

Implements Ogre::ControllerFunction< Real >.

◆ getAdjustedInput()

Real Ogre::ControllerFunction< Real >::getAdjustedInput ( Real  input)
protectedinherited

Gets the input value as adjusted by any delta.

Definition at line 65 of file OgreController.h.

◆ operator delete() [1/3]

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/3]

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/3]

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [1/2]

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [2/2]

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/3]

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/3]

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/3]

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [1/2]

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/2]

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

Member Data Documentation

◆ mDeltaCount

Real Ogre::ControllerFunction< Real >::mDeltaCount
protectedinherited

Definition at line 61 of file OgreController.h.

◆ mDeltaInput

bool Ogre::ControllerFunction< Real >::mDeltaInput
protectedinherited

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

Definition at line 60 of file OgreController.h.

◆ mScale

Real Ogre::ScaleControllerFunction::mScale
protected

Definition at line 221 of file OgrePredefinedControllers.h.


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