Salome HOME
updated copyright message
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintPerpendicular.h
index 6c5074a90cd62c1ec2b4205011d03af5cf1aba62..46b6c3d6018762622249a7e7a3799443d98f770b 100644 (file)
@@ -1,31 +1,51 @@
-// File:    SketchPlugin_ConstraintPerpendicular.h
-// Created: 26 May 2014
-// Author:  Artem ZHIDKOV
-
-#ifndef SketchPlugin_ConstraintPerpendicular_HeaderFile
-#define SketchPlugin_ConstraintPerpendicular_HeaderFile
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+#ifndef SketchPlugin_ConstraintPerpendicular_H_
+#define SketchPlugin_ConstraintPerpendicular_H_
 
 #include "SketchPlugin.h"
-#include "SketchPlugin_Constraint.h"
-
+#include <SketchPlugin_Sketch.h>
+#include "SketchPlugin_ConstraintBase.h"
 
 /** \class SketchPlugin_ConstraintPerpendicular
- *  \ingroup DataModel
+ *  \ingroup Plugins
  *  \brief Feature for creation of a new constraint for perpendicularity of two lines
  *
- *  These constraint has two attributes:
- *  CONSTRAINT_ATTR_ENTITY_A and CONSTRAINT_ATTR_ENTITY_B
+ *  This constraint has two attributes:
+ *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
  */
-class SketchPlugin_ConstraintPerpendicular: public SketchPlugin_Constraint
+class SketchPlugin_ConstraintPerpendicular : public SketchPlugin_ConstraintBase
 {
-public:
+ public:
+  /// Perpendicular constraint kind
+  inline static const std::string& ID()
+  {
+    static const std::string MY_CONSTRAINT_PERPENDICULAR_ID("SketchConstraintPerpendicular");
+    return MY_CONSTRAINT_PERPENDICULAR_ID;
+  }
   /// \brief Returns the kind of a feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getKind() 
-  {static std::string MY_KIND = "SketchConstraintPerpendicular"; return MY_KIND;}
-
-  /// \brief Returns to which group in the document must be added feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getGroup() 
-  {static std::string MY_GROUP = "Sketch"; return MY_GROUP;}
+  SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
+  {
+    static std::string MY_KIND = SketchPlugin_ConstraintPerpendicular::ID();
+    return MY_KIND;
+  }
 
   /// \brief Creates a new part document if needed
   SKETCHPLUGIN_EXPORT virtual void execute();
@@ -33,8 +53,8 @@ public:
   /// \brief Request for initialization of data model of the feature: adding all attributes
   SKETCHPLUGIN_EXPORT virtual void initAttributes();
 
-  /// \brief Returns the sketch preview
-  SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
+  /// Returns the AIS preview
+  SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
 
   /// \brief Use plugin manager for features creation
   SketchPlugin_ConstraintPerpendicular();