Source/System/FileIO/Collada/OSGColladaElementFactory.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *                   Copyright (C) 2009 by the OpenSG Forum                  *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGCOLLADAELEMENTFACTORY_H_
  40 #define _OSGCOLLADAELEMENTFACTORY_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGConfig.h"
  46
  47 #if defined(OSG_WITH_COLLADA) || defined(OSG_DO_DOC)
  48
  49 #include "OSGFileIODef.h"
  50 #include "OSGSingletonHolder.h"
  51 #include "OSGColladaElement.h"
  52
  53 #include <map>
  54 #include <string>
  55
  56 #include <boost/function.hpp>
  57
  58 OSG_BEGIN_NAMESPACE
  59
  60 /*! \ingroup GrpFileIOCollada
  61     \nohierarchy
  62  */
  63
  64 class OSG_FILEIO_DLLMAPPING ColladaElementFactorySingleton
  65 {
  66     /*==========================  PUBLIC  =================================*/
  67   public:
  68     /*---------------------------------------------------------------------*/
  69     /*! \name Types                                                        */
  70     /*! \{                                                                 */
  71
  72     typedef boost::function<
  73         ColladaElementTransitPtr (daeElement *,
  74                                   ColladaGlobal *)> CreateFunctor;
  75
  76     typedef std::map<std::string, CreateFunctor>    HandlerMap;
  77     typedef HandlerMap::iterator                    HandlerMapIt;
  78     typedef HandlerMap::const_iterator              HandlerMapConstIt;
  79
  80     typedef std::map<std::string, HandlerMap   >    ProfileHandlerMap;
  81     typedef ProfileHandlerMap::iterator             ProfileHandlerMapIt;
  82     typedef ProfileHandlerMap::const_iterator       ProfileHandlerMapConstIt;
  83
  84     /*! \}                                                                 */
  85     /*---------------------------------------------------------------------*/
  86     /*! \name Registration                                                 */
  87     /*! \{                                                                 */
  88
  89     bool registerElement  (CreateFunctor      createFunc,
  90                            const std::string &elemName,
  91                            const std::string &profile = "",
  92                                  bool         override = false);
  93     bool unregisterElement(const std::string &elemName,
  94                            const std::string &profile = "");
  95
  96     const HandlerMap        &getDefaultHandlerMap (void) const;
  97     HandlerMap              &editDefaultHandlerMap(void);
  98
  99     const ProfileHandlerMap &getProfileHandlerMap (void) const;
 100     ProfileHandlerMap       &editProfileHandlerMap(void);
 101
 102     /*! \}                                                                 */
 103     /*---------------------------------------------------------------------*/
 104     /*! \name Default Profile                                              */
 105     /*! \{                                                                 */
 106
 107     const std::string &getDefaultProfile(void                      ) const;
 108     void               setDefaultProfile(const std::string &profile);
 109
 110     /*! \}                                                                 */
 111     /*---------------------------------------------------------------------*/
 112     /*! \name Create                                                       */
 113     /*! \{                                                                 */
 114
 115     CreateFunctor            getCreateFunc(const std::string &elemName,
 116                                            const std::string &profile  = "" );
 117
 118     ColladaElementTransitPtr create       (daeElement        *daeElem,
 119                                            ColladaGlobal     *global,
 120                                            const std::string &elemName = "",
 121                                            const std::string &profile  = "" );
 122
 123     /*! \}                                                                 */
 124     /*=========================  PROTECTED  ===============================*/
 125   protected:
 126     /*---------------------------------------------------------------------*/
 127     /*! \name Helper                                                       */
 128     /*! \{                                                                 */
 129
 130     bool          doRegisterElement  (CreateFunctor      createFunc,
 131                                       const std::string &elemName,
 132                                       HandlerMap        &handlerMap,
 133                                       bool               override   );
 134     bool          doUnregisterElement(const std::string &elemName,
 135                                       HandlerMap        &handlerMap );
 136
 137     CreateFunctor doGetCreateFunc    (const std::string &elemName,
 138                                       HandlerMap        &handlerMap );
 139
 140     /*! \}                                                                 */
 141     /*==========================  PRIVATE  ================================*/
 142   private:
 143
 144     /*---------------------------------------------------------------------*/
 145     /*! \name Constructors/Destructor                                      */
 146     /*! \{                                                                 */
 147
 148      ColladaElementFactorySingleton(void);
 149     ~ColladaElementFactorySingleton(void);
 150
 151     /*! \}                                                                 */
 152     /*---------------------------------------------------------------------*/
 153
 154     template <class SingletonT>
 155     friend class SingletonHolder;
 156
 157     std::string       _defaultProfile;
 158     HandlerMap        _defaultHandlerMap;
 159     ProfileHandlerMap _profileHandlerMap;
 160 };
 161
 162 #if defined(WIN32)
 163 OSG_FILEIO_EXPIMP_TMPL
 164 template class OSG_FILEIO_DLLMAPPING SingletonHolder<ColladaElementFactorySingleton>;
 165 #endif
 166
 167 /*! \ingroup GrpFileIOCollada
 168  */
 169
 170 typedef SingletonHolder<ColladaElementFactorySingleton> ColladaElementFactory;
 171
 172 OSG_END_NAMESPACE
 173
 174 #endif // OSG_WITH_COLLADA
 175
 176 #endif // _OSGCOLLADAELEMENTFACTORY_H_