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

Ogre::ControllerManager Class Reference

Class for managing Controller instances. More...

#include <OgreControllerManager.h>

Inheritance diagram for Ogre::ControllerManager:

List of all members.

Public Methods
	ControllerManager ()
	~ControllerManager ()
Controller *	createController (ControllerValue src, ControllerValue dest, ControllerFunction *func)
	Creates a new controller and registers it with the manager. More...
void	clearControllers (void)
	Destroys all the controllers in existence. More...
void	updateAllControllers (void)
	Updates all the registered controllers. More...
ControllerValue *	getFrameTimeSource (void)
	Returns a ControllerValue which provides the time since the last frame as a control value source. More...
Controller *	createTextureAnimator (Material::TextureLayer *layer, Real sequenceTime)
	Creates a texture layer animator controller. More...
Controller *	createTextureScroller (Material::TextureLayer *layer, Real uSpeed, Real vSpeed)
	Creates a basic time-based texture coordinate modifier designed for creating scrolling textures. More...
Controller *	createTextureRotater (Material::TextureLayer *layer, Real speed)
	Creates a basic time-based texture coordinate modifier designed for creating rotating textures. More...
Controller *	createTextureWaveTransformer (Material::TextureLayer *layer, Material::TextureLayer::TextureTransformType ttype, WaveformType waveType, Real base=0, Real frequency=1, Real phase=0, Real amplitude=1)
	Creates a very flexible time-based texture transformation which can alter the scale, position or rotation of a texture based on a wave function. More...
void	destroyController (Controller *controller)
	Removes & destroys the controller passed in as a pointer. More...
Real	getTimeFactor (void)
	Return relative speed of time as perceived by time based controllers. More...
void	setTimeFactor (Real tf)
	Set the relative speed to update frame time based controllers. More...
Static Public Methods
ControllerManager &	getSingleton (void)
	Override standard Singleton retrieval. More...
ControllerManager *	getSingletonPtr (void)
Protected Types
typedef std::set< Controller * >	ControllerList
Protected Attributes
ControllerList	mControllers
FrameTimeControllerValue	mFrameTimeController
	Global predefined controller. More...
Static Protected Attributes
ControllerManager *	ms_Singleton = 0

Detailed Description

Class for managing Controller instances.

Remarks:: This class is responsible to keeping tabs on all the Controller instances registered and updating them when requested. It also provides a number of convenience methods for creating commonly used controllers (such as texture animators).

Member Typedef Documentation

typedef std::set<Controller*> Ogre::ControllerManager::ControllerList [protected]

Constructor & Destructor Documentation

Ogre::ControllerManager::ControllerManager ( )

Ogre::ControllerManager::~ControllerManager ( )

Member Function Documentation

void Ogre::ControllerManager::clearControllers ( void )

Destroys all the controllers in existence.

Controller * Ogre::ControllerManager::createController ( ControllerValue * src,

ControllerValue * dest,

ControllerFunction * func

)

Creates a new controller and registers it with the manager.

Controller * Ogre::ControllerManager::createTextureAnimator ( Material::TextureLayer * layer,

Real sequenceTime

)

Creates a texture layer animator controller.

Remarks:
This helper method creates the Controller, ControllerValue and ControllerFunction classes required to animate a texture.
Parameters:

layer TextureLayer object to animate

sequenceTime The amount of time in seconds it will take to loop through all the frames.

Controller * Ogre::ControllerManager::createTextureRotater ( Material::TextureLayer * layer,

Real speed

)

Creates a basic time-based texture coordinate modifier designed for creating rotating textures.

Returns:
This simple method allows you to easily create constant-speed rotating textures. If you want more control, look up the ControllerManager::createTextureWaveTransformer for more complex wave-based scrollers / stretchers / rotaters.
Parameters:

layer The texture layer to rotate.

vSpeed Speed of rotation, in complete anticlockwise revolutions per second

Controller * Ogre::ControllerManager::createTextureScroller ( Material::TextureLayer * layer,

Real uSpeed,

Real vSpeed

)

Creates a basic time-based texture coordinate modifier designed for creating scrolling textures.

Remarks:
This simple method allows you to easily create constant-speed scrolling textures. If you want more control, look up the ControllerManager::createTextureWaveTransformer for more complex wave-based scrollers / stretchers / rotaters.
Parameters:

layer The texture layer to animate.

uSpeed Speed of horizontal (u-coord) scroll, in complete wraps per second

vSpeed Speed of vertical (v-coord) scroll, in complete wraps per second

Controller * Ogre::ControllerManager::createTextureWaveTransformer ( Material::TextureLayer * layer,

Material::TextureLayer::TextureTransformType ttype,

WaveformType waveType,

Real base = 0,

Real frequency = 1,

Real phase = 0,

Real amplitude = 1

)

Creates a very flexible time-based texture transformation which can alter the scale, position or rotation of a texture based on a wave function.

Parameters:

layer The texture layer to affect

ttype The type of transform, either translate (scroll), scale (stretch) or rotate (spin)

waveType The shape of the wave, see WaveformType enum for details

base The base value of the output

frequency The speed of the wave in cycles per second

phase The offset of the start of the wave, e.g. 0.5 to start half-way through the wave

amplitude Scales the output so that instead of lying within 0..1 it lies within 0..1*amplitude for exaggerated effects

void Ogre::ControllerManager::destroyController ( Controller * controller )

Removes & destroys the controller passed in as a pointer.

ControllerValue * Ogre::ControllerManager::getFrameTimeSource ( void )

Returns a ControllerValue which provides the time since the last frame as a control value source.

Remarks:
A common source value to use to feed into a controller is the time since the last frame. This method returns a pointer to a common source value which provides this information.
Remember the value will only be up to date after the RenderSystem::beginFrame method is called.
See also:
RenderSystem::beginFrame

ControllerManager & Ogre::ControllerManager::getSingleton ( void ) [static]

Override standard Singleton retrieval.

Remarks:
Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.
This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< ControllerManager >.

ControllerManager* Ogre::Singleton< ControllerManager >::getSingletonPtr ( void ) [inline, static, inherited]

Real Ogre::ControllerManager::getTimeFactor ( void )

Return relative speed of time as perceived by time based controllers.

Remarks:
See setTimeFactor for full information on the meaning of this value.

void Ogre::ControllerManager::setTimeFactor ( Real tf )

Set the relative speed to update frame time based controllers.

Remarks:
Normally any controllers which use time as an input (FrameTimeController) are updated automatically in line with the real passage of time. This method allows you to change that, so that controllers are told that the time is passing slower or faster than it actually is. Use this to globally speed up / slow down the effect of time-based controllers.
Parameters:

tf The virtual speed of time (1.0 is real time).

void Ogre::ControllerManager::updateAllControllers ( void )

Updates all the registered controllers.

Member Data Documentation

ControllerList Ogre::ControllerManager::mControllers [protected]

FrameTimeControllerValue Ogre::ControllerManager::mFrameTimeController [protected]

Global predefined controller.

ControllerManager * Ogre::Singleton< ControllerManager >::ms_Singleton = 0 [static, protected, inherited]

Ogre::ControllerManager Class Reference

Public Methods

Static Public Methods

Protected Types

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation