include/modelskin.h

   1 /*
   2    Copyright (C) 2001-2006, William Joseph.
   3    All Rights Reserved.
   4
   5    This file is part of GtkRadiant.
   6
   7    GtkRadiant is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    GtkRadiant is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with GtkRadiant; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20  */
  21
  22 #if !defined( INCLUDED_MODELSKIN_H )
  23 #define INCLUDED_MODELSKIN_H
  24
  25 #include "generic/constant.h"
  26 #include "generic/callbackfwd.h"
  27
  28 class SkinRemap
  29 {
  30 public:
  31 const char* m_from;
  32 const char* m_to;
  33 SkinRemap( const char* from, const char* to ) : m_from( from ), m_to( to ){
  34 }
  35 };
  36
  37 typedef Callback1<SkinRemap> SkinRemapCallback;
  38 class ModuleObserver;
  39
  40 class ModelSkin
  41 {
  42 public:
  43 STRING_CONSTANT( Name, "ModelSkin" );
  44 /// \brief Attach an \p observer whose realise() and unrealise() methods will be called when the skin is loaded or unloaded.
  45 virtual void attach( ModuleObserver& observer ) = 0;
  46 /// \brief Detach an \p observer previously-attached by calling \c attach.
  47 virtual void detach( ModuleObserver& observer ) = 0;
  48 /// \brief Returns true if this skin is currently loaded.
  49 virtual bool realised() const = 0;
  50 /// \brief Returns the shader identifier that \p name remaps to, or "" if not found or not realised.
  51 virtual const char* getRemap( const char* name ) const = 0;
  52 /// \brief Calls \p callback for each remap pair. Has no effect if not realised.
  53 virtual void forEachRemap( const SkinRemapCallback& callback ) const = 0;
  54 };
  55
  56 class SkinnedModel
  57 {
  58 public:
  59 STRING_CONSTANT( Name, "SkinnedModel" );
  60 /// \brief Instructs the skinned model to update its skin.
  61 virtual void skinChanged() = 0;
  62 };
  63
  64 class ModelSkinCache
  65 {
  66 public:
  67 INTEGER_CONSTANT( Version, 1 );
  68 STRING_CONSTANT( Name, "modelskin" );
  69 /// \brief Increments the reference count of and returns a reference to the skin uniquely identified by 'name'.
  70 virtual ModelSkin& capture( const char* name ) = 0;
  71 /// \brief Decrements the reference-count of the skin uniquely identified by 'name'.
  72 virtual void release( const char* name ) = 0;
  73 };
  74
  75
  76 #include "modulesystem.h"
  77
  78 template<typename Type>
  79 class GlobalModule;
  80 typedef GlobalModule<ModelSkinCache> GlobalModelSkinCacheModule;
  81
  82 template<typename Type>
  83 class GlobalModuleRef;
  84 typedef GlobalModuleRef<ModelSkinCache> GlobalModelSkinCacheModuleRef;
  85
  86 inline ModelSkinCache& GlobalModelSkinCache(){
  87         return GlobalModelSkinCacheModule::getTable();
  88 }
  89
  90 #endif