Make list not initialized if it is empty: on sketch add and then remove element sketc...

[modules/shaper.git] / src / InitializationPlugin / InitializationPlugin_Plugin.h

diff --git a/src/InitializationPlugin/InitializationPlugin_Plugin.h b/src/InitializationPlugin/InitializationPlugin_Plugin.h
index bbd9e4aa02ad6922f40febfb252f08904daf61d7..42d157703e7d9c46cd52a373e83229c11bbd4ac6 100644 (file)
--- a/src/InitializationPlugin/InitializationPlugin_Plugin.h
+++ b/src/InitializationPlugin/InitializationPlugin_Plugin.h
@@ -1,4 +1,3 @@
-
 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
 
 #ifndef INITIALIZATIONPLUGIN_PLUGIN_H_
@@ -11,17 +10,32 @@
 #include <Events_Loop.h>
 
 /**\class InitializationPlugin_Plugin
- * TODO: Add documentation
+ * \ingroup Plugins
+ * This class is represents a plugin.
+ * It's aim is to fulfill the newly created documents with the "origin"
+ * construction point (0,0,0) and base planes (x0y, z0y, x0z)
  */
 class INITIALIZATIONPLUGIN_EXPORT InitializationPlugin_Plugin : public Events_Listener
 {
  public:
+  /// Creates plug-in and registers it in the Event Loop
   InitializationPlugin_Plugin();
-  ~InitializationPlugin_Plugin() {}
+  /// Destructs the plugin
+  virtual ~InitializationPlugin_Plugin() {}
+  /// Process the ModelAPI_DocumentCreatedMessage to fulfill a document
+  /// from the message with origin and planes
   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 
-  void createPlane(DocumentPtr theDoc, double theA, double theB, double theC);
-  void createPoint(DocumentPtr theDoc);
+ protected:
+  /// Creates a plane by given parameters A, B, C
+  /// \param theDoc - document to contain a "plane" feature
+  /// \param theX - determines if X is 0 or not
+  /// \param theY - determines if Y is 0 or not
+  /// \param theZ - determines if Z is 0 or not
+  FeaturePtr createPlane(DocumentPtr theDoc, double theX, double theY, double theZ);
+  /// Creates the origin point in (0,0,0)
+  /// \param theDoc - document to contain a "point" feature
+  FeaturePtr createPoint(DocumentPtr theDoc);
 };
 
 #endif