src/SketchPlugin/SketchPlugin_Plugin.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef SKETCHPLUGIN_PLUGIN_H_
  21 #define SKETCHPLUGIN_PLUGIN_H_
  22
  23 #include <SketchPlugin.h>
  24 #include <Events_Listener.h>
  25 #include <ModelAPI_Plugin.h>
  26 #include <ModelAPI_Feature.h>
  27 #include <ModelAPI_Events.h>
  28
  29 /**\class SketchPlugin_Plugin
  30  * \ingroup Plugins
  31  * \brief Interface common for any plugin: allows to use plugin by the plugins manager.
  32  */
  33 class SketchPlugin_Plugin : public ModelAPI_Plugin, public Events_Listener
  34 {
  35 public:
  36   /// Creates the feature object of this plugin by the feature string ID
  37   SKETCHPLUGIN_EXPORT virtual FeaturePtr createFeature(std::string theFeatureID);
  38
  39   /// Constructor that registers features and other plugin elements.
  40   SKETCHPLUGIN_EXPORT SketchPlugin_Plugin();
  41
  42   //! Redefinition of Events_Listener method
  43   SKETCHPLUGIN_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
  44
  45 protected:
  46   //! Returns the state of the feature in the WorkBench: enabled or disabled for the moment.
  47   std::shared_ptr<ModelAPI_FeatureStateMessage> getFeaturesState(
  48       const std::shared_ptr<ModelAPI_Feature>& theFeature) const;
  49 };
  50
  51 #endif