OgreControllerManager.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2012 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __ControllerManager_H__
#define __ControllerManager_H__

#include "OgrePrerequisites.h"

#include "OgreCommon.h"
#include "OgreSingleton.h"
#include "OgreController.h"
#include "OgrePredefinedControllers.h"
#include "OgreTextureUnitState.h"
#include "OgreSharedPtr.h"

namespace Ogre {
    typedef SharedPtr< ControllerValue<Real> > ControllerValueRealPtr;
    typedef SharedPtr< ControllerFunction<Real> > ControllerFunctionRealPtr;

    class _OgreExport ControllerManager : public Singleton<ControllerManager>, public ControllerAlloc
    {
    protected:
        typedef set<Controller<Real>*>::type ControllerList;
        ControllerList mControllers;

        ControllerValueRealPtr mFrameTimeController;
        
        ControllerFunctionRealPtr mPassthroughFunction;

        // Last frame number updated
        unsigned long mLastFrameNumber;

    public:
        ControllerManager();
        ~ControllerManager();

        Controller<Real>* createController(const ControllerValueRealPtr& src,
            const ControllerValueRealPtr& dest, const ControllerFunctionRealPtr& func);

        Controller<Real>* createFrameTimePassthroughController(
            const ControllerValueRealPtr& dest);

        void clearControllers(void);

        void updateAllControllers(void);


        const ControllerValueRealPtr& getFrameTimeSource(void) const;

        const ControllerFunctionRealPtr& getPassthroughControllerFunction(void) const;

        Controller<Real>* createTextureAnimator(TextureUnitState* layer, Real sequenceTime);

        Controller<Real>* createTextureUVScroller(TextureUnitState* layer, Real speed);

        Controller<Real>* createTextureUScroller(TextureUnitState* layer, Real uSpeed);

        Controller<Real>* createTextureVScroller(TextureUnitState* layer, Real vSpeed);

        Controller<Real>* createTextureRotater(TextureUnitState* layer, Real speed);

        Controller<Real>* createTextureWaveTransformer(TextureUnitState* layer, TextureUnitState::TextureTransformType ttype,
            WaveformType waveType, Real base = 0, Real frequency = 1, Real phase = 0, Real amplitude = 1);

        Controller<Real>* createGpuProgramTimerParam(GpuProgramParametersSharedPtr params, size_t paramIndex,
            Real timeFactor = 1.0f);

        void destroyController(Controller<Real>* controller);

        Real getTimeFactor(void) const;

        void setTimeFactor(Real tf);

        Real getFrameDelay(void) const;

        void setFrameDelay(Real fd);

        Real getElapsedTime(void) const;

        void setElapsedTime(Real elapsedTime);

        static ControllerManager& getSingleton(void);
        static ControllerManager* getSingletonPtr(void);
    };

}
#endif