#include <GeLineSeg2d.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 OdGeLinearEnt2d | |
| OdGeLinearEnt2d () | |
| OdGeLinearEnt2d (const OdGeLinearEnt2d &source) | |
| 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 line segments in 2D space. 2D line segment can be defined with a start and end points or with a point and a non-zero vector that specifies segment length and direction. By default its start parameter equals to 0.0 and end parameter equals to 1.0.
Corresponding C++ library: TD_Ge
<group OdGe_Classes>
- See also
- <link ge_OdGeLineSeg, Working with Line Segments>
Definition at line 44 of file GeLineSeg2d.h.
Constructor & Destructor Documentation
◆ OdGeLineSeg2d() [1/4]
| OdGeLineSeg2d::OdGeLineSeg2d | ( | ) |
Default constructor for objects of the OdGeLineSeg2d class. Constructs a line segment between the points (0.0, 0.0) and (1.0, 0.0).
◆ OdGeLineSeg2d() [2/4]
| OdGeLineSeg2d::OdGeLineSeg2d | ( | const OdGeLineSeg2d & | source | ) |
Copy constructor for objects of the OdGeLineSeg2d class.
- Parameters
-
source [in] A 2D line segment to be copied.
◆ OdGeLineSeg2d() [3/4]
| OdGeLineSeg2d::OdGeLineSeg2d | ( | const OdGePoint2d & | point1, |
| const OdGePoint2d & | point2 | ||
| ) |
Constructor for objects of the OdGeLineSeg2d class.
- Parameters
-
point1 [in] First 2D point that represents the start of the segment. point2 [in] Second 2D point that represents the end of the segment.
◆ OdGeLineSeg2d() [4/4]
| OdGeLineSeg2d::OdGeLineSeg2d | ( | const OdGePoint2d & | point, |
| const OdGeVector2d & | vect | ||
| ) |
Constructor for objects of the OdGeLineSeg2d class.
- Parameters
-
point [in] A 2D point that represents the start of the segment. vect [in] Defines the direction of the line and the second point of the line.
Member Function Documentation
◆ baryComb()
| OdGePoint2d OdGeLineSeg2d::baryComb | ( | double | blendCoeff | ) | const |
Returns the weighted average of the start point and end point of this line segment.
- Parameters
-
blendCoeff [in] Blend coefficient.
- Returns
- An instance of the OdGePoint2d class.
- Remarks
Returns 0 Start point 1 End point 0 to 1 Point on this line segment < 0 or > 1 Point not on this line segment, but collinear with it
◆ endPoint()
| OdGePoint2d OdGeLineSeg2d::endPoint | ( | ) | const |
Returns the end point of this line segment.
- Returns
- An instance of the OdGePoint2d class.
◆ getBisector()
| void OdGeLineSeg2d::getBisector | ( | OdGeLine2d & | line | ) | const |
Gets the infinite perpendicular bisector of this line segment.
- Parameters
-
line [out] Receives the perpendicular bisector.
◆ operator=()
| OdGeLineSeg2d & OdGeLineSeg2d::operator= | ( | const OdGeLineSeg2d & | line | ) |
Assignment operator for the OdGeLinearEnt2d object.
- Parameters
-
line [in] Linear segment to assign.
- Returns
- A reference to this OdGeLinearEnt2d object.
◆ set() [1/4]
| OdGeLineSeg2d & OdGeLineSeg2d::set | ( | const OdGeCurve2d & | curve, |
| const OdGePoint2d & | point, | ||
| double & | param, | ||
| bool & | success | ||
| ) |
Sets the parameters for this line according to the arguments and returns a reference to this line.
- Parameters
-
point [in] 2D point at which the constructed line segment is tangent to the specified curve. curve [in] 2D curve to which the constructed line segment must be tangent. param [in] Parameter of the point on curve where this line segment is tangent to the curve. success [out] Receives true if and only if the tangent was constructed. If false, this line segment is unchanged.
- Returns
- Reference to this OdGeLineSeg2d object.
- Remarks
- Constructs a line segment starting at point, and tangent to curve. The param value is the approximate tangent point on curve.
◆ set() [2/4]
| OdGeLineSeg2d & OdGeLineSeg2d::set | ( | const OdGeCurve2d & | curve1, |
| const OdGeCurve2d & | curve2, | ||
| double & | param1, | ||
| double & | param2, | ||
| bool & | success | ||
| ) |
Sets the parameters for this line according to the arguments and returns a reference to this line.
- Parameters
-
curve1 [in] First 2D curve to which a constructed line segment must be tangent. curve2 [in] Second 2D curve to which a constructed line segment must be tangent. param1 [in] Point on curve1 where this line segment is tangent to curve1. param2 [in] Point on curve2 where this line segment is tangent to curve2. success [out] Receives true if and only if the tangent was constructed. If false, this line segment is unchanged.
- Returns
- Reference to this OdGeLineSeg2d object.
- Remarks
- Constructs a tangent line segment between curve1 and curve2. Points param1 and param2 are the approximate tangent points on curve1 and curve2 respectively.
◆ set() [3/4]
| OdGeLineSeg2d & OdGeLineSeg2d::set | ( | const OdGePoint2d & | point, |
| const OdGeVector2d & | vect | ||
| ) |
Sets the parameters for this line according to the arguments and returns a reference to this line.
- Parameters
-
point [in] A 2D point that represents the start of the segment. vect [in] Defines the direction of the line and the second point of the line.
- Returns
- Reference to this OdGeLineSeg2d object.
- Remarks
- Constructs a line segment between points point and point + vect. The vect parameter cannot have a zero length.
◆ set() [4/4]
| OdGeLineSeg2d & OdGeLineSeg2d::set | ( | const OdGePoint2d & | point1, |
| const OdGePoint2d & | point2 | ||
| ) |
Sets the parameters for this line according to the arguments and returns a reference to this line.
- Parameters
-
point1 [in] First 2D point that represents the start of the segment. point2 [in] Second 2D point that represents the end of the segment.
- Returns
- Reference to this OdGeLineSeg2d object.
- Remarks
- Constructs a line segment between points point1 and point2. The points cannot coincide.
◆ startPoint()
| OdGePoint2d OdGeLineSeg2d::startPoint | ( | ) | const |
Returns the start point of this line segment.
- Returns
- An instance of the OdGePoint2d class.
The documentation for this class was generated from the following file: