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
  38 typedef Callback1<SkinRemap> SkinRemapCallback;
  39 class ModuleObserver;
  40
  41 class ModelSkin
  42 {
  43 public:
  44   STRING_CONSTANT(Name, "ModelSkin");
  45   /// \brief Attach an \p observer whose realise() and unrealise() methods will be called when the skin is loaded or unloaded.
  46   virtual void attach(ModuleObserver& observer) = 0;
  47   /// \brief Detach an \p observer previously-attached by calling \c attach.
  48   virtual void detach(ModuleObserver& observer) = 0;
  49   /// \brief Returns true if this skin is currently loaded.
  50   virtual bool realised() const = 0;
  51   /// \brief Returns the shader identifier that \p name remaps to, or "" if not found or not realised.
  52   virtual const char* getRemap(const char* name) const = 0;
  53   /// \brief Calls \p callback for each remap pair. Has no effect if not realised.
  54   virtual void forEachRemap(const SkinRemapCallback& callback) const = 0;
  55 };
  56
  57 class SkinnedModel
  58 {
  59 public:
  60   STRING_CONSTANT(Name, "SkinnedModel");
  61   /// \brief Instructs the skinned model to update its skin.
  62   virtual void skinChanged() = 0;
  63 };
  64
  65 class ModelSkinCache
  66 {
  67 public:
  68   INTEGER_CONSTANT(Version, 1);
  69   STRING_CONSTANT(Name, "modelskin");
  70   /// \brief Increments the reference count of and returns a reference to the skin uniquely identified by 'name'.
  71   virtual ModelSkin& capture(const char* name) = 0;
  72   /// \brief Decrements the reference-count of the skin uniquely identified by 'name'.
  73   virtual void release(const char* name) = 0;
  74 };
  75
  76
  77 #include "modulesystem.h"
  78
  79 template<typename Type>
  80 class GlobalModule;
  81 typedef GlobalModule<ModelSkinCache> GlobalModelSkinCacheModule;
  82
  83 template<typename Type>
  84 class GlobalModuleRef;
  85 typedef GlobalModuleRef<ModelSkinCache> GlobalModelSkinCacheModuleRef;
  86
  87 inline ModelSkinCache& GlobalModelSkinCache()
  88 {
  89   return GlobalModelSkinCacheModule::getTable();
  90 }
  91
  92 #endif