src/SketchPlugin/SketchPlugin_ConstraintHorizontal.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:    SketchPlugin_ConstraintHorizontal.h
   4 // Created: 16 Mar 2015
   5 // Author:  Artem ZHIDKOV
   6
   7 #ifndef SketchPlugin_ConstraintHorizontal_H_
   8 #define SketchPlugin_ConstraintHorizontal_H_
   9
  10 #include "SketchPlugin.h"
  11 #include <SketchPlugin_Sketch.h>
  12 #include "SketchPlugin_ConstraintBase.h"
  13
  14 /** \class SketchPlugin_ConstraintHorizontal
  15  *  \ingroup Plugins
  16  *  \brief Feature for creation of a new constraint horizontality of a line
  17  *
  18  *  This constraint has one attribute SketchPlugin_Constraint::ENTITY_A(),
  19  *  which specifies a line to be horizontal
  20  */
  21 class SketchPlugin_ConstraintHorizontal : public SketchPlugin_ConstraintBase
  22 {
  23  public:
  24   /// Horizontal constraint kind
  25   inline static const std::string& ID()
  26   {
  27     static const std::string MY_CONSTRAINT_HORIZONTAL_ID("SketchConstraintHorizontal");
  28     return MY_CONSTRAINT_HORIZONTAL_ID;
  29   }
  30   /// \brief Returns the kind of a feature
  31   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  32   {
  33     static std::string MY_KIND = SketchPlugin_ConstraintHorizontal::ID();
  34     return MY_KIND;
  35   }
  36
  37   /// \brief Creates a new part document if needed
  38   SKETCHPLUGIN_EXPORT virtual void execute();
  39
  40   /// \brief Request for initialization of data model of the feature: adding all attributes
  41   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  42
  43   /// Returns the AIS preview
  44   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  45
  46   /// \brief Use plugin manager for features creation
  47   SketchPlugin_ConstraintHorizontal();
  48 };
  49
  50 #endif