src/SketchPlugin/SketchPlugin_ConstraintMirror.h

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