SHAPER  9.15.0
SketchAPI_MacroCircle.h
1 // Copyright (C) 2014-2025 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 #ifndef SketchAPI_MacroCircle_H_
21 #define SketchAPI_MacroCircle_H_
22 
23 #include "SketchAPI.h"
24 #include "SketchAPI_SketchEntity.h"
25 
26 #include <SketchPlugin_MacroCircle.h>
27 
29 
34 {
35 public:
37  SKETCHAPI_EXPORT
38  explicit SketchAPI_MacroCircle(const std::shared_ptr<ModelAPI_Feature>& theFeature);
39 
41  SKETCHAPI_EXPORT
42  SketchAPI_MacroCircle(const std::shared_ptr<ModelAPI_Feature>& theFeature,
43  double theCenterX,
44  double theCenterY,
45  double thePassedX,
46  double thePassedY,
47  bool theIsToAddPoint = false,
48  double theAngle = 0.0);
49 
51  SKETCHAPI_EXPORT
52  SketchAPI_MacroCircle(const std::shared_ptr<ModelAPI_Feature>& theFeature,
53  const std::shared_ptr<GeomAPI_Pnt2d>& theCenterPoint,
54  const std::shared_ptr<GeomAPI_Pnt2d>& thePassedPoint,
55  bool theIsToAddPoint = false,
56  double theAngle = 0.0);
57 
59  SKETCHAPI_EXPORT
60  SketchAPI_MacroCircle(const std::shared_ptr<ModelAPI_Feature>& theFeature,
61  double theX1, double theY1,
62  double theX2, double theY2,
63  double theX3, double theY3,
64  bool theIsToAddPoint = false,
65  double theAngle = 0.0);
66 
68  SKETCHAPI_EXPORT
69  SketchAPI_MacroCircle(const std::shared_ptr<ModelAPI_Feature>& theFeature,
70  const std::shared_ptr<GeomAPI_Pnt2d>& thePoint1,
71  const std::shared_ptr<GeomAPI_Pnt2d>& thePoint2,
72  const std::shared_ptr<GeomAPI_Pnt2d>& thePoint3,
73  bool theIsToAddPoint = false,
74  double theAngle = 0.0);
75 
77  SKETCHAPI_EXPORT
78  virtual ~SketchAPI_MacroCircle();
79 
80  INTERFACE_8(SketchPlugin_MacroCircle::ID(),
81  circleType, SketchPlugin_MacroCircle::CIRCLE_TYPE(),
97 
98 private:
100  void setByCenterAndPassedPoints(double theCenterX, double theCenterY,
101  double thePassedX, double thePassedY,
102  bool theIsToAddPoint = false,
103  double theAngle = 0.0);
104 
106  void setByCenterAndPassedPoints(const std::shared_ptr<GeomAPI_Pnt2d>& theCenterPoint,
107  const std::shared_ptr<GeomAPI_Pnt2d>& thePassedPoint,
108  bool theIsToAddPoint = false,
109  double theAngle = 0.0);
110 
112  void setByThreePoints(double theX1, double theY1,
113  double theX2, double theY2,
114  double theX3, double theY3,
115  bool theIsToAddPoint = false,
116  double theAngle = 0.0);
117 
119  void setByThreePoints(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint1,
120  const std::shared_ptr<GeomAPI_Pnt2d>& thePoint2,
121  const std::shared_ptr<GeomAPI_Pnt2d>& thePoint3,
122  bool theIsToAddPoint = false,
123  double theAngle = 0.0);
124 };
125 
127 typedef std::shared_ptr<SketchAPI_MacroCircle> MacroCirclePtr;
128 
129 #endif // SketchAPI_MacroCircle_H_
2D point defined by two coordinates
Definition: GeomAPI_Pnt2d.h:36
Attribute that contains 2D point coordinates.
Definition: GeomDataAPI_Point2D.h:37
Attribute that contains boolean value.
Definition: ModelAPI_AttributeBoolean.h:31
Attribute that contains real value with double precision.
Definition: ModelAPI_AttributeDouble.h:34
API for the attribute that contains std (null terminated) string.
Definition: ModelAPI_AttributeString.h:33
Class for filling ModelAPI_AttributeSelection.
Definition: ModelHighAPI_Selection.h:49
Interface for Circle feature.
Definition: SketchAPI_MacroCircle.h:34
virtual std::shared_ptr< ModelAPI_AttributeBoolean > addpoint() const
Is to add point.
Definition: SketchAPI_MacroCircle.h:96
virtual std::shared_ptr< GeomDataAPI_Point2D > thirdPoint() const
Third point.
Definition: SketchAPI_MacroCircle.h:96
virtual std::shared_ptr< GeomDataAPI_Point2D > passedPoint() const
Passed point.
Definition: SketchAPI_MacroCircle.h:96
virtual std::shared_ptr< GeomDataAPI_Point2D > firstPoint() const
First point.
Definition: SketchAPI_MacroCircle.h:96
virtual ~SketchAPI_MacroCircle()
Destructor.
Definition: SketchAPI_MacroCircle.cpp:96
virtual std::shared_ptr< ModelAPI_AttributeDouble > angle() const
Angle.
Definition: SketchAPI_MacroCircle.h:96
virtual std::shared_ptr< GeomDataAPI_Point2D > centerPoint() const
Center point.
Definition: SketchAPI_MacroCircle.h:96
virtual std::shared_ptr< GeomDataAPI_Point2D > secondPoint() const
Second point.
Definition: SketchAPI_MacroCircle.h:96
SketchAPI_MacroCircle(const std::shared_ptr< ModelAPI_Feature > &theFeature)
Constructor without values.
Definition: SketchAPI_MacroCircle.cpp:33
virtual std::shared_ptr< ModelAPI_AttributeString > circleType() const
Circle type.
Definition: SketchAPI_MacroCircle.h:96
Base class for Sketch feature interfaces.
Definition: SketchAPI_SketchEntity.h:38
static const std::string & FIRST_POINT_ID()
First point id.
Definition: SketchPlugin_MacroCircle.h:105
static const std::string & CIRCLE_ROTATE_ANGLE_ID()
Rotate angle of the circle.
Definition: SketchPlugin_MacroCircle.h:161
static const std::string & PASSED_POINT_ID()
2D point - passed point of the circle
Definition: SketchPlugin_MacroCircle.h:91
static const std::string & THIRD_POINT_ID()
Third point id.
Definition: SketchPlugin_MacroCircle.h:133
static const std::string & SECOND_POINT_ID()
Second point id.
Definition: SketchPlugin_MacroCircle.h:119
static const std::string & CENTER_POINT_ID()
2D point - center of the circle.
Definition: SketchPlugin_MacroCircle.h:77
static const std::string & ADD_CONSTRUCTION_POINT_ID()
Is to create construction point or not.
Definition: SketchPlugin_MacroCircle.h:154
static const std::string & ID()
Circle feature kind.
Definition: SketchPlugin_MacroCircle.h:44