#include <GeLineSeg3d.h>
Additional Inherited Members | |
 Protected Member Functions inherited from OdGeLinearEnt3d | |
| OdGeLinearEnt3d () | |
| OdGeLinearEnt3d (const OdGeLinearEnt3d &source) | |
| Protected Member Functions inherited from OdGeCurve3d | |
| OdGeCurve3d () | |
| OdGeCurve3d (const OdGeCurve3d &source) | |
| Protected Member Functions inherited from OdGeEntity3d | |
| OdGeEntity3d () | |
| OdGeEntity3d (const OdGeEntity3d &) | |
| void | connectTo (OdGeEntity3dImpl *) |
Detailed Description
This class represents line segments in 3D space. 3D 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 46 of file GeLineSeg3d.h.
Constructor & Destructor Documentation
◆ OdGeLineSeg3d() [1/4]
| OdGeLineSeg3d::OdGeLineSeg3d | ( | ) |
Default constructor for objects of the OdGeLineSeg3d class. Constructs a line segment between the points (0.0, 0.0, 0.0) and (1.0, 0.0, 0.0).
◆ OdGeLineSeg3d() [2/4]
| OdGeLineSeg3d::OdGeLineSeg3d | ( | const OdGeLineSeg3d & | source | ) |
Constructor for objects of the OdGeLineSeg3d class.
- Parameters
-
source [in] Object to be copied.
◆ OdGeLineSeg3d() [3/4]
| OdGeLineSeg3d::OdGeLineSeg3d | ( | const OdGePoint3d & | point, |
| const OdGeVector3d & | vect | ||
| ) |
Constructor for objects of the OdGeLineSeg3d class.
- Parameters
-
point [in] First point of the line segment. vect [in] A 3D vector that defines the line direction and second point.
- Remarks
- Constructs a line segment between the points: point and point + vect. The vect vector can have a zero length.
◆ OdGeLineSeg3d() [4/4]
| OdGeLineSeg3d::OdGeLineSeg3d | ( | const OdGePoint3d & | point1, |
| const OdGePoint3d & | point2 | ||
| ) |
Constructor for objects of the OdGeLineSeg3d class.
- Parameters
-
point1 [in] Start point of the line segment. point2 [in] Second point of the line segment.
- Remarks
- Points point1 and point2 can be coincident. Constructs a line segment between the specified points.
Member Function Documentation
◆ baryComb()
| OdGePoint3d OdGeLineSeg3d::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 OdGePoint3d 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()
| OdGePoint3d OdGeLineSeg3d::endPoint | ( | ) | const |
Returns the end point of this line segment.
- Returns
- An instance of the OdGePoint3d class.
◆ getBisector()
Gets the unbounded perpendicular bisecting plane of this line segment.
- Parameters
-
plane [out] Receives the bisecting plane.
◆ getDistanceToVector()
| double OdGeLineSeg3d::getDistanceToVector | ( | const OdGePoint3d & | point, |
| const OdGeTol & | tol = OdGeContext::gTol |
||
| ) | const |
Deprecated! Use distanceTo instead.
Returns the distance to a vector.
- Parameters
-
point [in] A 3D point from which the distance is calculated. tol [in] Tolerance.
◆ joinWith()
| OdGeLineSeg3d & OdGeLineSeg3d::joinWith | ( | const OdGeLineSeg3d & | curve, |
| const OdGeTol & | iTolerance = OdGeContext::gTol |
||
| ) |
Attaches to the end of itself another curve.
- Parameters
-
curve [in] Link to the join curve. iTolerance [in] Geometric tolerance.
- Remarks
- The end of the current curve should coincide with the beginning of the next curve.
◆ operator=()
| OdGeLineSeg3d & OdGeLineSeg3d::operator= | ( | const OdGeLineSeg3d & | line | ) |
Assignment operator for the OdGeLineSeg3d object.
- Parameters
-
line [in] Linear segment to assign.
- Returns
- A reference to this OdGeLinearEnt3d object.
◆ set() [1/4]
| OdGeLineSeg3d & OdGeLineSeg3d::set | ( | const OdGeCurve3d & | curve, |
| const OdGePoint3d & | point, | ||
| double & | param, | ||
| bool & | success | ||
| ) |
Sets the parameters for this line segment according to the arguments and returns a reference to this line segment.
- Parameters
-
curve [in] A curve to which a line segment will be tangent. point [in] A 3D point through which a line segment passes. param [in] A point on curve where line segment is tangent to curve. success [out] Indicates that tangent line was computed successfully. If false, the line segment does not change.
- Returns
- Reference to this OdGeLineSeg3d object.
- Remarks
- The point must lie on the plane of the curve and the curve must be planar.
◆ set() [2/4]
| OdGeLineSeg3d & OdGeLineSeg3d::set | ( | const OdGeCurve3d & | curve1, |
| const OdGeCurve3d & | curve2, | ||
| double & | param1, | ||
| double & | param2, | ||
| bool & | success | ||
| ) |
Sets the parameters for this line segment according to the arguments and returns a reference to this line segment.
- Parameters
-
curve1 [in] First 3D curve to which a line segment must be tangent. curve2 [in] Second 3D curve to which a line segment must be tangent. param1 [in] Point on curve1 where line segment is tangent to curve. param2 [in] Point on curve2 where line segment is tangent to curve. success [out] Indicates that tangent line was computed successfully. If false, the line segment does not change.
- Returns
- Reference to this OdGeLineSeg3d object.
◆ set() [3/4]
| OdGeLineSeg3d & OdGeLineSeg3d::set | ( | const OdGePoint3d & | point, |
| const OdGeVector3d & | vect | ||
| ) |
Sets the parameters for this line according to the arguments and returns a reference to this line.
- Parameters
-
point [in] Start point of the line segment. vect [in] A 3D vector that defines the line direction and second point.
- Returns
- Reference to this OdGeLineSeg3d object.
- Remarks
- Constructs a line segment between the points: point and point + vect. The vect vector can have a zero length.
◆ set() [4/4]
| OdGeLineSeg3d & OdGeLineSeg3d::set | ( | const OdGePoint3d & | point1, |
| const OdGePoint3d & | point2 | ||
| ) |
Sets the parameters for this line according to the arguments and returns a reference to this line.
- Parameters
-
point1 [in] First point of the line segment. point2 [in] Second point of the line segment.
- Returns
- Reference to this OdGeLineSeg3d object.
- Remarks
- Constructs a line segment between points point1 and point2. The points can be coincident.
◆ startPoint()
| OdGePoint3d OdGeLineSeg3d::startPoint | ( | ) | const |
Returns the start point of this line segment.
- Returns
- An instance of the OdGePoint3d class.
The documentation for this class was generated from the following file: