OgreControllerManager.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __ControllerManager_H__
29 #define __ControllerManager_H__
30 
31 #include "OgrePrerequisites.h"
32 
33 #include "OgreCommon.h"
34 #include "OgreSingleton.h"
35 #include "OgreController.h"
37 #include "OgreTextureUnitState.h"
38 #include "OgreSharedPtr.h"
39 #include "OgreHeaderPrefix.h"
40 
41 namespace Ogre {
51 
58  class _OgreExport ControllerManager : public Singleton<ControllerManager>, public ControllerAlloc
59  {
60  protected:
63 
66 
69 
71  unsigned long mLastFrameNumber;
72 
73  public:
76 
80  const ControllerValueRealPtr& dest, const ControllerFunctionRealPtr& func);
81 
85  const ControllerValueRealPtr& dest);
86 
89  void clearControllers(void);
90 
94 
95 
106 
109 
120 
134 
146 
158 
170 
189  WaveformType waveType, Real base = 0, Real frequency = 1, Real phase = 0, Real amplitude = 1);
190 
204  Real timeFactor = 1.0f);
205 
209 
214  Real getTimeFactor(void) const;
215 
225  void setTimeFactor(Real tf);
226 
231  Real getFrameDelay(void) const;
232 
245  void setFrameDelay(Real fd);
246 
251  Real getElapsedTime(void) const;
252 
261  void setElapsedTime(Real elapsedTime);
262 
295  };
296 
300 } // namespace Ogre
301 
302 #include "OgreHeaderSuffix.h"
303 
304 #endif // __ControllerManager_H__
OgreSharedPtr.h
OgreHeaderSuffix.h
Ogre::ControllerManager::mFrameTimeController
ControllerValueRealPtr mFrameTimeController
Global predefined controller.
Definition: OgreControllerManager.h:65
Ogre::TextureUnitState
Class representing the state of a single texture unit during a Pass of a Technique,...
Definition: OgreTextureUnitState.h:63
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre
Definition: OgreAndroidLogListener.h:35
OgreTextureUnitState.h
Ogre::ControllerManager::getSingleton
static ControllerManager & getSingleton(void)
Override standard Singleton retrieval.
Ogre::ControllerManager::createTextureAnimator
Controller< Real > * createTextureAnimator(TextureUnitState *layer, Real sequenceTime)
Creates a texture layer animator controller.
OgreSingleton.h
Ogre::set
Definition: OgrePrerequisites.h:520
Ogre::ControllerManager::setFrameDelay
void setFrameDelay(Real fd)
Sets a constant frame rate.
Ogre::ControllerManager
Class for managing Controller instances.
Definition: OgreControllerManager.h:59
Ogre::ControllerManager::mPassthroughFunction
ControllerFunctionRealPtr mPassthroughFunction
Global predefined controller.
Definition: OgreControllerManager.h:68
Ogre::ControllerManager::~ControllerManager
~ControllerManager()
Ogre::ControllerManager::updateAllControllers
void updateAllControllers(void)
Updates all the registered controllers.
Ogre::WaveformType
WaveformType
Enumerates the wave types usable with the Ogre engine.
Definition: OgreCommon.h:162
Ogre::ControllerManager::createGpuProgramTimerParam
Controller< Real > * createGpuProgramTimerParam(GpuProgramParametersSharedPtr params, size_t paramIndex, Real timeFactor=1.0f)
Creates a controller for passing a frame time value through to a vertex / fragment program parameter.
Ogre::ControllerFunctionRealPtr
SharedPtr< ControllerFunction< Real > > ControllerFunctionRealPtr
Definition: OgreControllerManager.h:50
Ogre::ControllerManager::getPassthroughControllerFunction
const ControllerFunctionRealPtr & getPassthroughControllerFunction(void) const
Retrieve a simple passthrough controller function.
Ogre::ControllerManager::getElapsedTime
Real getElapsedTime(void) const
Return the elapsed time.
Ogre::ControllerManager::createTextureUVScroller
Controller< Real > * createTextureUVScroller(TextureUnitState *layer, Real speed)
Creates a basic time-based texture uv coordinate modifier designed for creating scrolling textures.
Ogre::ControllerManager::getTimeFactor
Real getTimeFactor(void) const
Return relative speed of time as perceived by time based controllers.
Ogre::Controller< Real >
Ogre::ControllerManager::mLastFrameNumber
unsigned long mLastFrameNumber
Last frame number updated.
Definition: OgreControllerManager.h:71
OgreHeaderPrefix.h
Ogre::ControllerManager::createTextureRotater
Controller< Real > * createTextureRotater(TextureUnitState *layer, Real speed)
Creates a basic time-based texture coordinate modifier designed for creating rotating textures.
Ogre::ControllerManager::ControllerManager
ControllerManager()
OgrePrerequisites.h
OgrePredefinedControllers.h
Ogre::ControllerManager::setElapsedTime
void setElapsedTime(Real elapsedTime)
Set the elapsed time.
Ogre::ControllerManager::createTextureWaveTransformer
Controller< Real > * createTextureWaveTransformer(TextureUnitState *layer, TextureUnitState::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,...
Ogre::Singleton
Template class for creating single-instance global classes.
Definition: OgreSingleton.h:65
Ogre::ControllerManager::createTextureUScroller
Controller< Real > * createTextureUScroller(TextureUnitState *layer, Real uSpeed)
Creates a basic time-based texture u coordinate modifier designed for creating scrolling textures.
OgreController.h
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
OgreCommon.h
Ogre::ControllerManager::createTextureVScroller
Controller< Real > * createTextureVScroller(TextureUnitState *layer, Real vSpeed)
Creates a basic time-based texture v coordinate modifier designed for creating scrolling textures.
Ogre::SharedPtr
Reference-counted shared pointer, used for objects where implicit destruction is required.
Definition: OgreSharedPtr.h:112
Ogre::ControllerManager::ControllerList
set< Controller< Real > * >::type ControllerList
Definition: OgreControllerManager.h:61
Ogre::TextureUnitState::TextureTransformType
TextureTransformType
Useful enumeration when dealing with procedural transforms.
Definition: OgreTextureUnitState.h:113
Ogre::ControllerManager::createFrameTimePassthroughController
Controller< Real > * createFrameTimePassthroughController(const ControllerValueRealPtr &dest)
Creates a new controller use frame time source and passthrough controller function.
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::ControllerManager::destroyController
void destroyController(Controller< Real > *controller)
Removes & destroys the controller passed in as a pointer.
Ogre::ControllerManager::clearControllers
void clearControllers(void)
Destroys all the controllers in existence.
Ogre::ControllerManager::getSingletonPtr
static ControllerManager * getSingletonPtr(void)
Override standard Singleton retrieval.
Ogre::ControllerManager::createController
Controller< Real > * createController(const ControllerValueRealPtr &src, const ControllerValueRealPtr &dest, const ControllerFunctionRealPtr &func)
Creates a new controller and registers it with the manager.
Ogre::ControllerManager::getFrameTimeSource
const ControllerValueRealPtr & getFrameTimeSource(void) const
Returns a ControllerValue which provides the time since the last frame as a control value source.
Ogre::ControllerManager::mControllers
ControllerList mControllers
Definition: OgreControllerManager.h:62
Ogre::ControllerValueRealPtr
SharedPtr< ControllerValue< Real > > ControllerValueRealPtr
Definition: OgreControllerManager.h:49
Ogre::ControllerManager::setTimeFactor
void setTimeFactor(Real tf)
Set the relative speed to update frame time based controllers.
Ogre::ControllerManager::getFrameDelay
Real getFrameDelay(void) const
Gets the constant that is added to time lapsed between each frame.

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.