Ogre::ScaleControllerFunction Class Reference
[General]

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

#include <OgrePredefinedControllers.h>

Inheritance diagram for Ogre::ScaleControllerFunction:

[legend]

List of all members.

Public Member Functions
	ScaleControllerFunction (Real scalefactor, bool deltaInput)
	Constructor, requires a scale factor.
Real	calculate (Real source)
	Overridden method.
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
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 *)
Protected Member Functions
Real	getAdjustedInput (Realinput)
	Gets the input value as adjusted by any delta.
Protected Attributes
Real	mScale
bool	mDeltaInput
	If true, function will add input values together and wrap at 1.0 before evaluating.
Real	mDeltaCount

---

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

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

Constructor, requires a scale factor.

Parameters:

	scalefactor	The multiplier 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]

Overridden method.

Implements Ogre::ControllerFunction< Real >.

Real Ogre::ControllerFunction< Real >::getAdjustedInput

(

Real

input

)

[protected, inherited]

Gets the input value as adjusted by any delta.

Reimplemented in Ogre::WaveformControllerFunction.

Definition at line 64 of file OgreController.h.

References Ogre::ControllerFunction< T >::mDeltaCount, and Ogre::ControllerFunction< T >::mDeltaInput.

template<class Alloc >

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

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			[inherited]

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete

(

void *

ptr

)

[inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]

(

void *

ptr

)

[inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new

(

size_t

sz

)

[inherited]

Definition at line 72 of file OgreMemoryAllocatedObject.h.

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 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]

(

size_t

sz

)

[inherited]

Definition at line 90 of file OgreMemoryAllocatedObject.h.

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 85 of file OgreMemoryAllocatedObject.h.

---

Member Data Documentation

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

Definition at line 60 of file OgreController.h.

bool Ogre::ControllerFunction< Real >::mDeltaInput [protected, inherited]

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

Definition at line 59 of file OgreController.h.

Real Ogre::ScaleControllerFunction::mScale [protected]

Definition at line 221 of file OgrePredefinedControllers.h.

---

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

• OgrePredefinedControllers.h