DtModelInstanceFactory.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2023 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 

 
#ifndef DtModelInstanceFactory_H_ 
#define DtModelInstanceFactory_H_ 
 
#include <vrvCore/vrvCore.h> 
#include <vrvUtil/DtVirtualBaseClass.h>

#include <list>
#include <string>
#include <map>
 
namespace makVrv 
{ 
   class DtDe;
   class DtModelDefinition;
   class DtModelInstance;
   class DtModelInstanceCreator;

   class DT_DLL_VRVCORE DtModelInstanceFactory : public DtVirtualBaseClass
   {

   public:
      typedef std::list<std::string> CreatorClassList;

      static DtModelInstanceFactory& instance(DtDe& de);

      virtual ~DtModelInstanceFactory();

      DtModelInstanceFactory() = delete;
      DtModelInstanceFactory(const DtModelInstanceFactory& rhs) = delete;
      DtModelInstanceFactory& operator=(const DtModelInstanceFactory& rhs) = delete;

   public:

      static const std::string& modelInstanceHintParameterName();

      virtual DtModelInstance* createModelInstance(const std::string& objectClassName,
         const DtModelDefinition& definition,
         bool ignoreDefinitionHint = false,
         const std::string& modelInstanceClassOverride = "", 
         bool realize = true);

      virtual bool isClassRegistered(const std::string& objectClass) const;

      virtual void registerSceneObjectClass(const std::string& objectClass,
         const CreatorClassList& classes);

      virtual void registerModelInstanceCreator(const std::string& modelInstanceClassName,
         DtModelInstanceCreator*);

      virtual DtModelInstanceCreator* modelInstanceCreator(const std::string& modelInstanceClassName) const;

      virtual const CreatorClassList& sceneObjectClassCreators(const std::string& objectClass);

      virtual void addObjectClassCreatorToFront(const std::string& objectClass,
         const std::string& newCreatorClass);

      virtual void addObjectClassCreatorToBack(const std::string& objectClass,
         const std::string& newCreatorClass);

   protected:

      DtModelInstanceFactory(DtDe& de);

   protected:
      virtual CreatorClassList modelDefinitionHints(const DtModelDefinition& modelInstance);

      virtual DtModelInstance* createAndRealize(const std::string& modelInstanceClassName, 
         const DtModelDefinition& modelDefinition, bool realize);
     
      typedef std::map<std::string,DtModelInstanceCreator*> CreatorMap;   
      typedef std::map<std::string,CreatorClassList> ObjectClassMap;

      DtDe& myDe;

      bool myEnableDebugModelInstanceFallback;
      std::string myDebugModelInstanceClass;

      CreatorMap myCreators;
      ObjectClassMap myObjectCreatorMap;
   };
} 
 
#endif