X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FInitializationPlugin%2FInitializationPlugin_Plugin.h;h=52d5cc3e93664e2460c9c506175323fe31e60e65;hb=aef9c1a87bc7ca357d8dfe47c56ac5edc9935d35;hp=dfa0727b817b78588709fc6f9ca2bcea31d30163;hpb=0a76161addf39a6d03b90308eb99abc3a8d10e74;p=modules%2Fshaper.git diff --git a/src/InitializationPlugin/InitializationPlugin_Plugin.h b/src/InitializationPlugin/InitializationPlugin_Plugin.h index dfa0727b8..52d5cc3e9 100644 --- a/src/InitializationPlugin/InitializationPlugin_Plugin.h +++ b/src/InitializationPlugin/InitializationPlugin_Plugin.h @@ -1,24 +1,60 @@ - // Copyright (C) 2014-20xx CEA/DEN, EDF R&D #ifndef INITIALIZATIONPLUGIN_PLUGIN_H_ #define INITIALIZATIONPLUGIN_PLUGIN_H_ #include -#include #include +#include + +class InitializationPlugin_EvalListener; + /**\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 ModelAPI_Plugin +class InitializationPlugin_Plugin : public Events_Listener { public: - /// Creates the feature object of this plugin by the feature string ID - virtual FeaturePtr createFeature(std::string theFeatureID); + /// Creates plug-in and registers it in the Event Loop + INITIALIZATIONPLUGIN_EXPORT InitializationPlugin_Plugin(); + /// Destructs the plugin + INITIALIZATIONPLUGIN_EXPORT virtual ~InitializationPlugin_Plugin() {} + /// Process the ModelAPI_DocumentCreatedMessage to fulfill a document + /// from the message with origin and planes + INITIALIZATIONPLUGIN_EXPORT virtual void processEvent( + const std::shared_ptr& theMessage); - public: - InitializationPlugin_Plugin(); + 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 + /// \param theName - name of the point + /// \param theX - X coordinate + /// \param theY - Y coordinate + /// \param theZ - Z coordinate + FeaturePtr createPoint(DocumentPtr theDoc, const std::string& theName, + double theX, double theY, double theZ); + + /// Creates an axis which is started from origin point + /// \param theDoc - document to contain an "axis" feature + /// \param theOrigin - origin point feature + /// \param theX - X of direction point + /// \param theY - Y of direction point + /// \param theZ - Z of direction point + FeaturePtr createAxis(DocumentPtr theDoc, FeaturePtr theOrigin, + double theX, double theY, double theZ); + + private: + std::shared_ptr myEvalListener; }; #endif