]> SALOME platform Git repositories - modules/shaper.git/blob - src/SketchAPI/SketchAPI_Rectangle.h
Salome HOME
Rework Sketch Rectangle feature.
[modules/shaper.git] / src / SketchAPI / SketchAPI_Rectangle.h
1 // Copyright (C) 2014-2020  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 email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef SRC_SKETCHAPI_SKETCHAPI_RECTANGLE_H_
21 #define SRC_SKETCHAPI_SKETCHAPI_RECTANGLE_H_
22
23 //--------------------------------------------------------------------------------------
24 #include "SketchAPI.h"
25
26 #include "SketchAPI_SketchEntity.h"
27
28 //--------------------------------------------------------------------------------------
29 class ModelHighAPI_Selection;
30 //--------------------------------------------------------------------------------------
31 /**\class SketchAPI_Rectangle
32  * \ingroup CPPHighAPI
33  * \brief Interface for Rectangle feature
34  */
35 class SketchAPI_Rectangle : public SketchAPI_SketchEntity
36 {
37 public:
38   /// Constructor without values
39   SKETCHAPI_EXPORT
40   explicit SketchAPI_Rectangle(const std::shared_ptr<ModelAPI_Feature> & theFeature);
41   /// Constructor with values
42   SKETCHAPI_EXPORT
43   SketchAPI_Rectangle(const std::shared_ptr<ModelAPI_Feature> & theFeature,
44                       double theX1, double theY1, double theX2, double theY2);
45   /// Constructor with values
46   SKETCHAPI_EXPORT
47   SketchAPI_Rectangle(const std::shared_ptr<ModelAPI_Feature> & theFeature,
48                       const std::shared_ptr<GeomAPI_Pnt2d> & theFirstPoint,
49                       const std::shared_ptr<GeomAPI_Pnt2d> & theEndPoint);
50   /// Destructor
51   SKETCHAPI_EXPORT
52   virtual ~SketchAPI_Rectangle();
53
54   INTERFACE_7("SketchRectangle",
55               type, "RectangleType", ModelAPI_AttributeString,
56               /** Creation type of rectangle */,
57               startPoint, "RectStartPoint", GeomDataAPI_Point2D,
58               /** Start point */,
59               endPoint, "RectEndPoint", GeomDataAPI_Point2D,
60               /** End point */,
61               centerPoint, "RectCenterPoint", GeomDataAPI_Point2D,
62               /** Center point */,
63               centerPointRef, "RectCenterPointRef", ModelAPI_AttributeRefAttr,
64               /** Reference to center point */,
65               cornerPoint, "RectCornerPoint", GeomDataAPI_Point2D,
66               /** Corner point */,
67               linesList, "RectangleList", ModelAPI_AttributeRefList,
68               /** Lines list */
69   )
70
71   /// Set by coordinates
72   SKETCHAPI_EXPORT
73   void setByCoordinates(double theX1, double theY1, double theX2, double theY2);
74
75   /// Set by points
76   SKETCHAPI_EXPORT
77   void setByPoints(const std::shared_ptr<GeomAPI_Pnt2d> & theFirstPoint,
78                    const std::shared_ptr<GeomAPI_Pnt2d> & theSecondPoint);
79
80   /// List of lines composing rectangle
81   SKETCHAPI_EXPORT std::list<std::shared_ptr<SketchAPI_SketchEntity> > lines() const;
82 };
83
84 //! Pointer on Rectangle object
85 typedef std::shared_ptr<SketchAPI_Rectangle> RectanglePtr;
86
87 //--------------------------------------------------------------------------------------
88 //--------------------------------------------------------------------------------------
89 #endif /* SRC_SKETCHAPI_SKETCHAPI_RECTANGLE_H_ */