#include <GeCircArc2d.h>
Additional Inherited Members | |
 Static Public Member Functions inherited from OdGeCurve2d | |
| static OdGeCurve2d * | restoreUvCurve (const OdGeCurve3d *curve, const OdGeSurface *surface, const OdGeTol &tol=OdGeContext::gTol) |
| Protected Member Functions inherited from OdGeCurve2d | |
| OdGeCurve2d () | |
| OdGeCurve2d (const OdGeCurve2d &source) | |
| Protected Member Functions inherited from OdGeEntity2d | |
| OdGeEntity2d () | |
| OdGeEntity2d (const OdGeEntity2d &) | |
| void | connectTo (OdGeEntity2dImpl *) |
Detailed Description
This class represents arcs and full circles in 2D space.
Corresponding C++ library: TD_Ge
<group OdGe_Classes>
- See also
- <link ge_OdGeCircArc3d, Working with Circular Arcs>
Definition at line 46 of file GeCircArc2d.h.
Constructor & Destructor Documentation
◆ OdGeCircArc2d() [1/6]
| OdGeCircArc2d::OdGeCircArc2d | ( | ) |
The default constructor for objects of the OdGeCircArc2d class. Constructs a full circle with a center (0.0, 0.0), radius of 1.0, and reference axis (1.0, 0.0).
◆ OdGeCircArc2d() [2/6]
| OdGeCircArc2d::OdGeCircArc2d | ( | const OdGeCircArc2d & | source | ) |
Copy constructor for objects of the OdGeCircArc2d class.
- Parameters
-
source [in] 2D arc to be copied.
- Remarks
- The constructor creates an arc that is a copy of an input arc.
◆ OdGeCircArc2d() [3/6]
| OdGeCircArc2d::OdGeCircArc2d | ( | const OdGePoint2d & | center, |
| double | radius | ||
| ) |
Constructor for objects of the OdGeCircArc2d class.
- Parameters
-
center [in] Center of the circle. radius [in] Radius of the circle.
- Remarks
- The constructor creates a circle with the specified parameters.
◆ OdGeCircArc2d() [4/6]
| OdGeCircArc2d::OdGeCircArc2d | ( | const OdGePoint2d & | center, |
| double | radius, | ||
| double | startAng, | ||
| double | endAng, | ||
| const OdGeVector2d & | refVec = OdGeVector2d::kXAxis, |
||
| bool | isClockWise = false |
||
| ) |
Constructor for objects of the OdGeCircArc2d class.
- Parameters
-
center [in] Center of arc. radius [in] Radius of arc. startAng [in] Starting angle of arc. endAng [in] Ending angle of arc. refVec [in] The reference vector defining arc angle 0. isClockWise [in] Specifies whether the circle arc is oriented clockwise.
- Remarks
- The constructor creates a circle arc with the specified parameters. To construct a circle, set endAng = startAng + Oda2PI.
- All angles are expressed in radians. startAng must be less than endAng.
◆ OdGeCircArc2d() [5/6]
| OdGeCircArc2d::OdGeCircArc2d | ( | const OdGePoint2d & | startPoint, |
| const OdGePoint2d & | secondPoint, | ||
| const OdGePoint2d & | endPoint | ||
| ) |
Constructor for objects of the OdGeCircArc2d class.
- Parameters
-
startPoint [in] Startpoint of an arc. secondPoint [in] Second point on a 3-point arc. endPoint [in] Endpoint of an arc.
- Remarks
- The constructor creates a circle arc with the specified parameters.
◆ OdGeCircArc2d() [6/6]
| OdGeCircArc2d::OdGeCircArc2d | ( | const OdGePoint2d & | startPoint, |
| const OdGePoint2d & | endPoint, | ||
| double | bulge, | ||
| bool | bulgeFlag = true |
||
| ) |
Constructor for objects of the OdGeCircArc2d class.
- Parameters
-
startPoint [in] Startpoint of an arc. endPoint [in] Endpoint of an arc. bulge [in] Bulge distance. bulgeFlag [in] Specifies how to interpret bulge distance for arc calculation.
- Remarks
- The constructor creates an arc with the specified parameters.
- If a line is drawn between startPoint and endPoint, the distance between this line and the midpoint of the constructed arc is equal to the bulge distance. If bulgeFlag is true, the bulge is interpreted as the maximum distance between the arc and the chord between the two input points. If bulgeFlag is false, the bulge is interpreted as the tangent of 1/4 the included angle (tan(ang/4)), where ang is the angle of the arc segment between the two input points. The direction of the constructed arc is always counterclockwise. This constructor always constructs a bounded arc and cannot be used to construct a full circle.
Member Function Documentation
◆ center()
| OdGePoint2d OdGeCircArc2d::center | ( | ) | const |
Returns the center of this arc.
◆ endAng()
| double OdGeCircArc2d::endAng | ( | ) | const |
Gets the ending angle measured from the reference vector in the arc direction.
- Returns
- Ending angle value.
- Remarks
- All angles are expressed in radians.
- The result of this method should not be used as a curve parameter. The angles and its corresponding parameter may differ.
◆ endAngFromXAxis()
| double OdGeCircArc2d::endAngFromXAxis | ( | ) | const |
Returns the ending angle measured from the X-axis in the arc direction.
- Remarks
- All angles are expressed in radians.
◆ endPoint()
| OdGePoint2d OdGeCircArc2d::endPoint | ( | ) | const |
Returns the end point of this arc.
◆ getGeomExtents()
| void OdGeCircArc2d::getGeomExtents | ( | OdGeExtents2d & | extents | ) | const |
Gets the geometric extents of this arc.
- Parameters
-
extents [out] Receives the geometric extents.
◆ intersectWith() [1/2]
| bool OdGeCircArc2d::intersectWith | ( | const OdGeCircArc2d & | circarc, |
| int & | numInt, | ||
| OdGePoint2d & | p1, | ||
| OdGePoint2d & | p2, | ||
| const OdGeTol & | tol = OdGeContext::gTol |
||
| ) | const |
Returns True if the specified arc entity intersects this arc entity, and returns the number of intersections and points of intersection.
- Parameters
-
circarc [in] Any 2D arc entity. numInt [out] Receives the number of intersections with this curve. p1 [out] Receives the first intersection point. p2 [out] Receives the second intersection point. tol [in] Geometric tolerance.
- Remarks
- p1 has meaning only if numInt > 0. p2 has meaning only if numInt > 1.
◆ intersectWith() [2/2]
| bool OdGeCircArc2d::intersectWith | ( | const OdGeLinearEnt2d & | line, |
| int & | numInt, | ||
| OdGePoint2d & | p1, | ||
| OdGePoint2d & | p2, | ||
| const OdGeTol & | tol = OdGeContext::gTol |
||
| ) | const |
Returns True if the specified linear entity intersects the arc entity, and returns the number of intersections and points of intersection.
- Parameters
-
line [in] Any 2D linear entity. numInt [out] Receives the number of intersections with this curve. p1 [out] Receives the first intersection point. p2 [out] Receives the second intersection point. tol [in] Geometric tolerance.
- Remarks
- p1 has meaning only if numInt > 0. p2 has meaning only if numInt > 1.
◆ isClockWise()
| bool OdGeCircArc2d::isClockWise | ( | ) | const |
Returns true if and only if this arc is drawn clockwise from the start point to the end point.
◆ isInside()
| bool OdGeCircArc2d::isInside | ( | const OdGePoint2d & | point, |
| const OdGeTol & | tol = OdGeContext::gTol |
||
| ) | const |
Returns true if and only if the input point lies within the full circle of this arc.
- Parameters
-
point [in] Any 2D point. tol [in] Geometric tolerance.
◆ operator=()
| OdGeCircArc2d & OdGeCircArc2d::operator= | ( | const OdGeCircArc2d & | arc | ) |
The assignment operator for the OdGeCircArc2d class.
- Parameters
-
arc [in] Arc to assign.
- Remarks
- Makes this arc identical to the input arc.
◆ radius()
| double OdGeCircArc2d::radius | ( | ) | const |
Returns the radius of this arc.
◆ refVec()
| OdGeVector2d OdGeCircArc2d::refVec | ( | ) | const |
Returns the reference vector as a unit vector.
◆ set() [1/7]
| OdGeCircArc2d & OdGeCircArc2d::set | ( | const OdGeCurve2d & | curve1, |
| const OdGeCurve2d & | curve2, | ||
| const OdGeCurve2d & | curve3, | ||
| double & | param1, | ||
| double & | param2, | ||
| double & | param3, | ||
| bool & | success | ||
| ) |
Sets the parameters for this arc according to the arguments, and returns a reference to this arc.
- Parameters
-
curve1 [in] First curve to define a tangent arc. curve2 [in] Second curve to define a tangent arc. curve3 [in] Third curve to define a tangent arc. param1 [out] Receives the parameter corresponding tangency point on curve1. param2 [out] Receives the parameter corresponding tangency point on curve2. param3 [out] Receives the parameter corresponding tangency point on curve3. success [out] Receives true if and only if the tan-tan-radius or tan-tan-tan curve could be constructed. If false, this arc is unmodified.
◆ set() [2/7]
| OdGeCircArc2d & OdGeCircArc2d::set | ( | const OdGeCurve2d & | curve1, |
| const OdGeCurve2d & | curve2, | ||
| double | radius, | ||
| double & | param1, | ||
| double & | param2, | ||
| bool & | success | ||
| ) |
Sets the parameters for this arc according to the arguments, and returns a reference to this arc.
- Parameters
-
radius [in] Radius of the arc. curve1 [in] First curve to define a tangent arc. curve2 [in] Second curve to define a tangent arc. param1 [out] Receives the parameter corresponding tangency point on curve1. param2 [out] Receives the parameter corresponding tangency point on curve2. success [out] Receives true if and only if the tan-tan-radius or tan-tan-tan curve could be constructed. If false, this arc is unmodified.
◆ set() [3/7]
| OdGeCircArc2d & OdGeCircArc2d::set | ( | const OdGePoint2d & | center, |
| double | radius | ||
| ) |
Sets the parameters for this arc according to the arguments, and returns a reference to this arc.
- Parameters
-
center [in] Center of arc. radius [in] Radius of arc.
◆ set() [4/7]
| OdGeCircArc2d & OdGeCircArc2d::set | ( | const OdGePoint2d & | center, |
| double | radius, | ||
| double | startAng, | ||
| double | endAng, | ||
| const OdGeVector2d & | refVec = OdGeVector2d::kXAxis, |
||
| bool | isClockWise = false |
||
| ) |
Sets the parameters for this arc according to the arguments, and returns a reference to this arc.
- Parameters
-
center [in] Center of the arc. radius [in] Radius of the arc. startAng [in] Starting angle of the arc. endAng [in] Ending angle of the arc. refVec [in] Reference vector defining arc angle 0. isClockWise [in] If true, the arc is drawn clockwise, otherwise counterclockwise.
- Remarks
- To construct a circle, set endAng = startAng + Oda2PI
- startAng must be less than endAng. All angles are expressed in radians.
◆ set() [5/7]
| OdGeCircArc2d & OdGeCircArc2d::set | ( | const OdGePoint2d & | startPoint, |
| const OdGePoint2d & | endPoint, | ||
| double | bulge, | ||
| bool | bulgeFlag = true |
||
| ) |
Sets the parameters for this arc according to the arguments, and returns a reference to this arc.
- Parameters
-
startPoint [in] Startpoint of arc. endPoint [in] Endpoint of arc. bulge [in] Specifies the bulge of the arc. bulgeFlag [in] Specifies how bulge is to be interpreted.
- Remarks
- If bulgeFlag == true, then bulge is the maximum distance from the arc to the chord between the start and endpoints.
If bulgeFlag == false, the bulge is the tangent of 1/4 the included angle of the arc.
◆ set() [6/7]
| OdGeCircArc2d & OdGeCircArc2d::set | ( | const OdGePoint2d & | startPoint, |
| const OdGePoint2d & | secondPoint, | ||
| const OdGePoint2d & | endPoint | ||
| ) |
Sets the parameters for this arc according to the arguments, and returns a reference to this arc.
- Parameters
-
startPoint [in] Startpoint of arc. secondPoint [in] Second point on a 3-point arc. endPoint [in] Endpoint of arc.
◆ set() [7/7]
| OdGeCircArc2d & OdGeCircArc2d::set | ( | const OdGePoint2d & | startPoint, |
| const OdGePoint2d & | secondPoint, | ||
| const OdGePoint2d & | endPoint, | ||
| OdGeError & | status | ||
| ) |
Sets the parameters for this arc according to the arguments, and returns a reference to this arc.
- Parameters
-
status [out] Receives the status for this method. startPoint [in] Startpoint of arc. secondPoint [in] Second point on a 3-point arc. endPoint [in] Endpoint of arc.
- Remarks
- Possible status values:
kEqualArg1Arg2 kEqualArg1Arg3 kEqualArg2Arg3 kLinearlyDependentArg1Arg2Arg3
◆ setAngles()
| OdGeCircArc2d & OdGeCircArc2d::setAngles | ( | double | startAng, |
| double | endAng | ||
| ) |
Sets the starting and ending angles of this arc, and returns a reference to this arc.
- Parameters
-
startAng [in] Starting angle of arc. endAng [in] Ending angle of arc.
- Remarks
- All angles are expressed in radians.
◆ setCenter()
| OdGeCircArc2d & OdGeCircArc2d::setCenter | ( | const OdGePoint2d & | center | ) |
Sets the center of this arc, and returns a reference to this arc.
- Parameters
-
center [in] Center of the arc.
◆ setRadius()
| OdGeCircArc2d & OdGeCircArc2d::setRadius | ( | double | radius | ) |
Sets the radius of this arc, and returns a reference to this arc.
- Parameters
-
radius [in] Radius of the arc.
◆ setRefVec()
| OdGeCircArc2d & OdGeCircArc2d::setRefVec | ( | const OdGeVector2d & | vect | ) |
Sets the reference vector of this arc, and returns a reference to this arc.
- Parameters
-
vect [in] The reference vector defining arc angle 0.
◆ setToComplement()
| OdGeCircArc2d & OdGeCircArc2d::setToComplement | ( | ) |
Reverses the direction of this arc while maintaining its endpoints, and returns a reference to this arc.
◆ startAng()
| double OdGeCircArc2d::startAng | ( | ) | const |
Gets the starting angle measured from the reference vector in the arc direction.
- Returns
- Starting angle value.
- Remarks
- All angles are expressed in radians.
- The result of this method should not be used as a curve parameter. The angles and its corresponding parameter may differ.
◆ startAngFromXAxis()
| double OdGeCircArc2d::startAngFromXAxis | ( | ) | const |
Returns the starting angle measured from the X-axis in the arc direction.
- Remarks
- All angles are expressed in radians.
◆ startPoint()
| OdGePoint2d OdGeCircArc2d::startPoint | ( | ) | const |
Returns the start point of this arc.
◆ tangent() [1/2]
| bool OdGeCircArc2d::tangent | ( | const OdGePoint2d & | point, |
| OdGeLine2d & | line, | ||
| const OdGeTol & | tol, | ||
| OdGeError & | status | ||
| ) | const |
Returns true if and only if the specified point is on the full circle of this arc, the tangent at that point, and the status of the query.
- Parameters
-
point [in] The point on the full circle. line [out] Receives the tangent at that point. tol [in] Geometric tolerance. status [out] Receives the status of the query.
- Remarks
- Possible status values:
kArg1TooBig kArg1InsideThis kArg1OnThis
◆ tangent() [2/2]
| bool OdGeCircArc2d::tangent | ( | const OdGePoint2d & | point, |
| OdGeLine2d & | line, | ||
| const OdGeTol & | tol = OdGeContext::gTol |
||
| ) | const |
Returns true if and only if the specified point is on the full circle of this arc, the tangent at that point.
- Parameters
-
point [in] The point on the full circle. line [out] Receives the tangent at that point. tol [in] Geometric tolerance.
The documentation for this class was generated from the following file: