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-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/
#ifndef _OgreExternalTextureSource_H
#define _OgreExternalTextureSource_H
 
/***************************************************************************
OgreExternalTextureSource.h  -  
    Base class that texture plugins need to derive from. This provides the hooks
    neccessary 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 exmaple 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"

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; }
        const 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;
    };
}

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:40 2006