Implement the Collinear constraint

[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintCollinear.h

diff --git a/src/SketchPlugin/SketchPlugin_ConstraintCollinear.h b/src/SketchPlugin/SketchPlugin_ConstraintCollinear.h
new file mode 100644 (file)
index 0000000..db8db73
--- /dev/null
+++ b/src/SketchPlugin/SketchPlugin_ConstraintCollinear.h
@@ -0,0 +1,50 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
+// File:    SketchPlugin_ConstraintCollinear.h
+// Created: 27 Jan 2016
+// Author:  Artem ZHIDKOV
+
+#ifndef SketchPlugin_ConstraintCollinear_H_
+#define SketchPlugin_ConstraintCollinear_H_
+
+#include "SketchPlugin.h"
+#include <SketchPlugin_Sketch.h>
+#include "SketchPlugin_ConstraintBase.h"
+
+/** \class SketchPlugin_ConstraintCollinear
+ *  \ingroup Plugins
+ *  \brief Feature for creation of a new constraint collinearity of two lines
+ *
+ *  This constraint has two attributes:
+ *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
+ */
+class SketchPlugin_ConstraintCollinear : public SketchPlugin_ConstraintBase
+{
+ public:
+  /// Parallel constraint kind
+  inline static const std::string& ID()
+  {
+    static const std::string MY_CONSTRAINT_COLLINEAR_ID("SketchConstraintCollinear");
+    return MY_CONSTRAINT_COLLINEAR_ID;
+  }
+  /// \brief Returns the kind of a feature
+  SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
+  {
+    static std::string MY_KIND = SketchPlugin_ConstraintCollinear::ID();
+    return MY_KIND;
+  }
+
+  /// \brief Creates a new part document if needed
+  SKETCHPLUGIN_EXPORT virtual void execute();
+
+  /// \brief Request for initialization of data model of the feature: adding all attributes
+  SKETCHPLUGIN_EXPORT virtual void initAttributes();
+
+  /// Returns the AIS preview
+  SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
+
+  /// \brief Use plugin manager for features creation
+  SketchPlugin_ConstraintCollinear();
+};
+
+#endif