src/SketchPlugin/SketchPlugin_ConstraintDistanceVertical.h

   1 // Copyright (C) 2017-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 // File:    SketchPlugin_ConstraintDistanceVertical.h
  21 // Created: 10 May 2017
  22 // Author:  Artem ZHIDKOV
  23
  24 #ifndef SketchPlugin_ConstraintDistanceVertical_H_
  25 #define SketchPlugin_ConstraintDistanceVertical_H_
  26
  27 #include <SketchPlugin.h>
  28 #include <SketchPlugin_ConstraintDistanceAlongDir.h>
  29
  30 /** \class SketchPlugin_ConstraintDistanceVertical
  31  *  \ingroup Plugins
  32  *  \brief Feature for creation of a new constraint which defines a vertical distance between two points.
  33  *
  34  *  This constraint has three attributes:
  35  *  SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
  36  */
  37 class SketchPlugin_ConstraintDistanceVertical : public SketchPlugin_ConstraintDistanceAlongDir
  38 {
  39 public:
  40   /// Distance constraint kind
  41   inline static const std::string& ID()
  42   {
  43     static const std::string MY_CONSTRAINT_DISTANCE_ID("SketchConstraintDistanceVertical");
  44     return MY_CONSTRAINT_DISTANCE_ID;
  45   }
  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_ConstraintDistanceVertical::ID();
  51     return MY_KIND;
  52   }
  53
  54   /// \brief Use plugin manager for features creation
  55   SketchPlugin_ConstraintDistanceVertical();
  56
  57 protected:
  58   /// Returns the current distance between the feature attributes
  59   virtual double calculateCurrentDistance();
  60
  61   /// Update flyout point
  62   virtual void updateFlyoutPoint();
  63 };
  64
  65 #endif