src/SketchPlugin/SketchPlugin_ConstraintDistanceVertical.h

   1 // Copyright (C) 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 // File:    SketchPlugin_ConstraintDistanceVertical.h
  22 // Created: 10 May 2017
  23 // Author:  Artem ZHIDKOV
  24
  25 #ifndef SketchPlugin_ConstraintDistanceVertical_H_
  26 #define SketchPlugin_ConstraintDistanceVertical_H_
  27
  28 #include <SketchPlugin.h>
  29 #include <SketchPlugin_ConstraintDistance.h>
  30
  31 /** \class SketchPlugin_ConstraintDistanceVertical
  32  *  \ingroup Plugins
  33  *  \brief Feature for creation of a new constraint which defines a vertical distance between two points.
  34  *
  35  *  This constraint has three attributes:
  36  *  SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
  37  */
  38 class SketchPlugin_ConstraintDistanceVertical : public SketchPlugin_ConstraintDistance
  39 {
  40 public:
  41   /// Distance constraint kind
  42   inline static const std::string& ID()
  43   {
  44     static const std::string MY_CONSTRAINT_DISTANCE_ID("SketchConstraintDistanceVertical");
  45     return MY_CONSTRAINT_DISTANCE_ID;
  46   }
  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_ConstraintDistanceVertical::ID();
  52     return MY_KIND;
  53   }
  54
  55   /// attribute name of dimension location type
  56   inline static const std::string& LOCATION_TYPE_ID()
  57   {
  58     static const std::string MY_LOCATION_TYPE_ID("LocationType");
  59     return MY_LOCATION_TYPE_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   /// Returns the AIS preview
  69   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  70
  71   /// Called on change of any argument-attribute of this object
  72   /// \param theID identifier of changed attribute
  73   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  74
  75   /// \brief Use plugin manager for features creation
  76   SketchPlugin_ConstraintDistanceVertical();
  77
  78 protected:
  79   /// Returns the current distance between the feature attributes
  80   virtual double calculateCurrentDistance();
  81 };
  82
  83 #endif