OgreExternalTextureSource.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-2013 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 _OgreExternalTextureSource_H
#define _OgreExternalTextureSource_H
 
/***************************************************************************
OgreExternalTextureSource.h  -  
    Base class that texture plugins need to derive from. This provides the hooks
    necessary for a plugin developer to easily extend the functionality of dynamic textures.
    It makes creation/destruction of dynamic textures more streamlined. While the plugin
    will need to talk with Ogre for the actual modification of textures, this class allows
    easy integration with Ogre apps. Material script files can be used to aid in the 
    creation of dynamic textures. Functionality can be added that is not defined here
    through the use of the base dictionary. For an example of how to use this class and the
    string interface see ffmpegVideoPlugIn.

-------------------
date                 : Jan 1 2004
email                : pjcast@yahoo.com
***************************************************************************/

#include "OgreStringInterface.h"
#include "OgreResourceGroupManager.h"
#include "OgreHeaderPrefix.h"

namespace Ogre
{
    enum eTexturePlayMode
    {
        TextureEffectPause = 0,         
        TextureEffectPlay_ASAP = 1,     
        TextureEffectPlay_Looping = 2   
    };

    class _OgreExport ExternalTextureSource : public StringInterface
    {
    public:
        ExternalTextureSource();
        virtual ~ExternalTextureSource() {}

        //------------------------------------------------------------------------------//
        /* Command objects for specifying some base features                            */
        /* Any Plugins wishing to add more specific params to "ExternalTextureSourcePlugins"*/
        /* dictionary, feel free to do so, that's why this is here                      */
        class _OgrePrivate CmdInputFileName : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgrePrivate CmdFPS : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgrePrivate CmdPlayMode : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgrePrivate CmdTecPassState : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        //--------------------------------------------------------//
        //Base Functions that work with Command String Interface... Or can be called
        //manually to create video through code 

        void setInputName( String sIN ) { mInputFileName = sIN; }
        const String& getInputName( ) const { return mInputFileName; }
        void setFPS( int iFPS ) { mFramesPerSecond = iFPS; }
        int getFPS( ) const { return mFramesPerSecond; }
        void setPlayMode( eTexturePlayMode eMode )  { mMode = eMode; }
        eTexturePlayMode getPlayMode() const { return mMode; }

        void setTextureTecPassStateLevel( int t, int p, int s ) 
                { mTechniqueLevel = t;mPassLevel = p;mStateLevel = s; }
        void getTextureTecPassStateLevel( int& t, int& p, int& s ) const
                {t = mTechniqueLevel;   p = mPassLevel; s = mStateLevel;}
        
        void addBaseParams();

        const String& getPluginStringName( void ) const { return mPluginName; }
        const String& getDictionaryStringName( void ) const { return mDictionaryName; }

        //Pure virtual functions that plugins must Override
        virtual bool initialise() = 0;
        virtual void shutDown() = 0;

        virtual void createDefinedTexture( const String& sMaterialName,
            const String& groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) = 0;
        virtual void destroyAdvancedTexture( const String& sTextureName,
            const String& groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME) = 0;

    protected:
        static CmdInputFileName msCmdInputFile;     
        static CmdFPS msCmdFramesPerSecond;         
        static CmdPlayMode msCmdPlayMode;           
        static CmdTecPassState msCmdTecPassState;   


        String mPluginName;
    
        //------ Vars used for setting/getting dictionary stuff -----------//
        eTexturePlayMode mMode;
        
        String mInputFileName;
        
        bool mUpdateEveryFrame;
        
        int mFramesPerSecond,
            mTechniqueLevel,
            mPassLevel, 
            mStateLevel;
        //------------------------------------------------------------------//

    protected:
        String mDictionaryName;
    };
}

#include "OgreHeaderSuffix.h"

#endif