1 // File: ModelAPI_PluginManager.hxx
2 // Created: 20 Mar 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef ModelAPI_PluginManager_HeaderFile
6 #define ModelAPI_PluginManager_HeaderFile
12 class ModelAPI_Feature;
13 class ModelAPI_Plugin;
14 class ModelAPI_Document;
16 /**\class ModelAPI_PluginManager
18 * \brief Object that knows (from the initial XML file) which
19 * plugin contains which feature, loads and stores reference to loaded plugins by
20 * the feature functionality request.
23 class MODELAPI_EXPORT ModelAPI_PluginManager
26 /// Returns the real implementation (the alone instance per application) of the plugin manager
27 static std::shared_ptr<ModelAPI_PluginManager> get();
29 /// Registers the plugin that creates features.
30 /// It is obligatory for each plugin to call this function on loading to be found by
31 /// the plugin manager on call of the feature)
32 virtual void registerPlugin(ModelAPI_Plugin* thePlugin) = 0;
34 /// Returns the root document of the application (that may contains sub-documents)
35 virtual std::shared_ptr<ModelAPI_Document> rootDocument() = 0;
37 /// Returns the current document that used for current work in the application
38 virtual std::shared_ptr<ModelAPI_Document> currentDocument() = 0;
40 /// Defines the current document that used for current work in the application
41 virtual void setCurrentDocument(std::shared_ptr<ModelAPI_Document> theDoc) = 0;
43 /// loads the library with specific name, appends "lib*.dll" or "*.so" depending on the platform
44 static void ModelAPI_PluginManager::loadLibrary(const std::string theLibName);
46 /// Is needed for python wrapping by swig, call Get to get an instance
47 ModelAPI_PluginManager();
50 /// Creates the feature object using plugins functionality
51 virtual std::shared_ptr<ModelAPI_Feature> createFeature(std::string theFeatureID) = 0;
53 static void SetPluginManager(std::shared_ptr<ModelAPI_PluginManager> theManager);
55 friend class Model_Document;