nel/tools/3d/pipeline_max/scene_class_registry.h

   1 /**
   2  * \file scene_class_registry.h
   3  * \brief CSceneClassRegistry
   4  * \date 2012-08-20 09:57GMT
   5  * \author Jan Boon (Kaetemi)
   6  * CSceneClassRegistry
   7  */
   8
   9 /*
  10  * Copyright (C) 2012  by authors
  11  *
  12  * This file is part of RYZOM CORE PIPELINE.
  13  * RYZOM CORE PIPELINE is free software: you can redistribute it
  14  * and/or modify it under the terms of the GNU Affero General Public
  15  * License as published by the Free Software Foundation, either
  16  * version 3 of the License, or (at your option) any later version.
  17  *
  18  * RYZOM CORE PIPELINE is distributed in the hope that it will be
  19  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  20  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Affero General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU Affero General Public
  24  * License along with RYZOM CORE PIPELINE.  If not, see
  25  * <http://www.gnu.org/licenses/>.
  26  */
  27
  28 #ifndef PIPELINE_SCENE_CLASS_REGISTRY_H
  29 #define PIPELINE_SCENE_CLASS_REGISTRY_H
  30 #include <nel/misc/types_nl.h>
  31
  32 // STL includes
  33
  34 // NeL includes
  35
  36 // Project includes
  37 #include "scene_class.h"
  38 #include "super_class_desc.h"
  39
  40 namespace PIPELINE {
  41 namespace MAX {
  42
  43 /**
  44  * \brief CSceneClassRegistry
  45  * \date 2012-08-20 09:57GMT
  46  * \author Jan Boon (Kaetemi)
  47  * CSceneClassRegistry
  48  */
  49 class CSceneClassRegistry
  50 {
  51 public:
  52         CSceneClassRegistry();
  53         virtual ~CSceneClassRegistry();
  54
  55         /// Add a class to the registry
  56         void add(const ISceneClassDesc *desc);
  57         /// Remove a class from the registry
  58         void remove(TSClassId superClassId, const NLMISC::CClassId classId);
  59
  60         /// Add a superclass to the registry
  61         void add(const ISuperClassDesc *desc);
  62         /// Remove a superclass from the registry
  63         void remove(const TSClassId superClassId);
  64
  65         /// Create a class by class id
  66         CSceneClass *create(CScene *scene, TSClassId superClassId, const NLMISC::CClassId classId) const;
  67
  68         /// Create an unknown class by superclass id
  69         CSceneClass *createUnknown(CScene *scene, TSClassId superClassId, const NLMISC::CClassId classId, const ucstring &displayName, const ucstring &dllFilename, const ucstring &dllDescription) const;
  70
  71         /// Destroy a class by pointer
  72         void destroy(CSceneClass *sceneClass) const;
  73
  74         /// Return the description of a class by class id
  75         const ISceneClassDesc *describe(TSClassId superClassId, const NLMISC::CClassId classId) const;
  76
  77 private:
  78         struct TKey
  79         {
  80                 TKey(TSClassId superClassId, NLMISC::CClassId classId);
  81                 TSClassId SuperClassId;
  82                 NLMISC::CClassId ClassId;
  83                 bool operator<(const TKey &right) const;
  84                 bool operator>(const TKey &right) const;
  85                 bool operator==(const TKey &right) const;
  86         };
  87
  88         std::map<TKey, const ISceneClassDesc *> m_ClassDescriptions;
  89         std::map<TSClassId, const ISuperClassDesc *> m_SuperClassDescriptions;
  90
  91 }; /* class CSceneClassRegistry */
  92
  93 } /* namespace MAX */
  94 } /* namespace PIPELINE */
  95
  96 #endif /* #ifndef PIPELINE_SCENE_CLASS_REGISTRY_H */
  97
  98 /* end of file */