OGRE: OgreControllerManager.h Source File - OGRE Documentation

# OgreControllerManager.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef __ControllerManager_H__
    00029 #define __ControllerManager_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032
    00033 #include "OgreCommon.h"
    00034 #include "OgreSingleton.h"
    00035 #include "OgreController.h"
    00036 #include "OgrePredefinedControllers.h"
    00037 #include "OgreTextureUnitState.h"
    00038 #include "OgreSharedPtr.h"
    00039
    00040 namespace Ogre {
    00048     typedef SharedPtr< ControllerValue<Real> > ControllerValueRealPtr;
    00049     typedef SharedPtr< ControllerFunction<Real> > ControllerFunctionRealPtr;
    00050
    00057     class _OgreExport ControllerManager : public Singleton<ControllerManager>, public ControllerAlloc
    00058     {
    00059     protected:
    00060         typedef set<Controller<Real>*>::type ControllerList;
    00061         ControllerList mControllers;
    00062
    00064         ControllerValueRealPtr mFrameTimeController;
    00065
    00067         ControllerFunctionRealPtr mPassthroughFunction;
    00068
    00069         // Last frame number updated
    00070         unsigned long mLastFrameNumber;
    00071
    00072     public:
    00073         ControllerManager();
    00074         ~ControllerManager();
    00075
    00078         Controller<Real>* createController(const ControllerValueRealPtr& src,
    00079             const ControllerValueRealPtr& dest, const ControllerFunctionRealPtr& func);
    00080
    00083         Controller<Real>* createFrameTimePassthroughController(
    00084             const ControllerValueRealPtr& dest);
    00085
    00088         void clearControllers(void);
    00089
    00092         void updateAllControllers(void);
    00093
    00094
    00104         const ControllerValueRealPtr& getFrameTimeSource(void) const;
    00105
    00107         const ControllerFunctionRealPtr& getPassthroughControllerFunction(void) const;
    00108
    00118         Controller<Real>* createTextureAnimator(TextureUnitState* layer, Real sequenceTime);
    00119
    00132         Controller<Real>* createTextureUVScroller(TextureUnitState* layer, Real speed);
    00133
    00144         Controller<Real>* createTextureUScroller(TextureUnitState* layer, Real uSpeed);
    00145
    00156         Controller<Real>* createTextureVScroller(TextureUnitState* layer, Real vSpeed);
    00157
    00168         Controller<Real>* createTextureRotater(TextureUnitState* layer, Real speed);
    00169
    00187         Controller<Real>* createTextureWaveTransformer(TextureUnitState* layer, TextureUnitState::TextureTransformType ttype,
    00188             WaveformType waveType, Real base = 0, Real frequency = 1, Real phase = 0, Real amplitude = 1);
    00189
    00199         Controller<Real>* createGpuProgramTimerParam(GpuProgramParametersSharedPtr params, size_t paramIndex,
    00200             Real timeFactor = 1.0f);
    00201
    00204         void destroyController(Controller<Real>* controller);
    00205
    00210         Real getTimeFactor(void) const;
    00211
    00220         void setTimeFactor(Real tf);
    00221
    00226         Real getFrameDelay(void) const;
    00227
    00239         void setFrameDelay(Real fd);
    00240
    00245         Real getElapsedTime(void) const;
    00246
    00254         void setElapsedTime(Real elapsedTime);
    00255
    00271         static ControllerManager& getSingleton(void);
    00287         static ControllerManager* getSingletonPtr(void);
    00288     };
    00289
    00293 }
    00294 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:51