Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OgreCodec.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 © 2000-2002 The OGRE Team
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 -----------------------------------------------------------------------------
00024 */
00025 #ifndef _Codec_H__
00026 #define _Codec_H__
00027 
00028 #include "OgrePrerequisites.h"
00029 
00030 namespace Ogre {
00031 
00041     class _OgreExport Codec
00042     {
00043     protected:
00044         typedef std::map< String, Codec* > CodecList; 
00047         static CodecList ms_mapCodecs;
00048 
00049     public:
00050         class CodecData 
00051         {
00052         public:
00053             virtual ~CodecData() {};
00054 
00057             virtual String dataType() const { return "CodecData"; };
00058         };
00059 
00060     public:
00061         virtual ~Codec();
00062         
00065         static void registerCodec( Codec *pCodec )
00066         {
00067             ms_mapCodecs[pCodec->getType()] = pCodec;
00068         }
00069 
00072         static void unRegisterCodec( Codec *pCodec )
00073         {
00074             ms_mapCodecs.erase(pCodec->getType());
00075         }
00076 
00078         static Codec* getCodec(const String& extension);
00079 
00085         virtual void code( const DataChunk& input, DataChunk* output, ... ) const = 0;
00093         virtual void codeToFile( const DataChunk& input, const String& outFileName, CodecData* pData) const = 0;
00094 
00103         virtual CodecData * decode( const DataChunk& input, DataChunk* output, ... ) const = 0;
00104 
00107         virtual String getType() const = 0;
00108     };
00109 
00110 } // namespace
00111 
00112 #endif

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:48:17 2004