src/SketchPlugin/SketchPlugin_ConstraintMirror.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_ConstraintMirror_H_
  21 #define SketchPlugin_ConstraintMirror_H_
  22
  23 #include "SketchPlugin.h"
  24 #include <SketchPlugin_Sketch.h>
  25 #include "SketchPlugin_ConstraintBase.h"
  26
  27 /** \class SketchPlugin_ConstraintMirror
  28  *  \ingroup Plugins
  29  *  \brief Feature for creation of a new constraint mirroring a list of objects regarding to a given line
  30  *
  31  *  This constraint has two attributes:
  32  *  SketchPlugin_Constraint::ENTITY_A() for mirror line and
  33  *  SketchPlugin_Constraint::ENTITY_B() for the list of objects
  34  *
  35  *  Also the constraint has attribute SketchPlugin_Constraint::ENTITY_C()
  36  *  which contains list of mirrored objects
  37  */
  38 class SketchPlugin_ConstraintMirror : public SketchPlugin_ConstraintBase
  39 {
  40  public:
  41   /// Mirror constraint kind
  42   inline static const std::string& ID()
  43   {
  44     static const std::string MY_CONSTRAINT_MIRROR_ID("SketchConstraintMirror");
  45     return MY_CONSTRAINT_MIRROR_ID;
  46   }
  47   /// \brief Returns the kind of a feature
  48   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  49   {
  50     static std::string MY_KIND = SketchPlugin_ConstraintMirror::ID();
  51     return MY_KIND;
  52   }
  53
  54   /// List of objects to be mirrored
  55   inline static const std::string& MIRROR_LIST_ID()
  56   {
  57     static const std::string MY_MIRROR_LIST_ID("ConstraintMirrorList");
  58     return MY_MIRROR_LIST_ID;
  59   }
  60
  61   /// \brief Creates a new part document if needed
  62   SKETCHPLUGIN_EXPORT virtual void execute();
  63
  64   /// \brief Request for initialization of data model of the feature: adding all attributes
  65   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  66
  67   /// Called on change of any argument-attribute of this object
  68   /// \param theID identifier of changed attribute
  69   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  70
  71   /// Returns the AIS preview
  72   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  73
  74   /// removes all fields from this feature: results, data, etc
  75   SKETCHPLUGIN_EXPORT virtual void erase();
  76
  77   /// \brief Use plugin manager for features creation
  78   SketchPlugin_ConstraintMirror();
  79 };
  80
  81 #endif