#include <GeOffsetCurve3d.h>
Additional Inherited Members | |
 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 3D curves that are exact offsets of other curves.
- Remarks
- Every GeOffsetCurve3d contains a pointer to the curve from which it is offset. Modifying the base curve modifies the offset curve. Modifying the offset curve does not modify the base curve. Actual base curve can be obtained by calling curve() method, it can be changed relative to the curve passed in constructor due to cloning under the flag in constructor or applying transformBy() and reverseParam() methods. setInterval() for an offset curve result create a curve that is an offset of the specified interval in the base curve.
This curve may be self-intersecting, even if the base curve is not. To create offset curves that are not self-intersecting, use OdGeCurve3d::getTrimmedOffset().
The base curve must be planar, and a normal to the plane must be specified. Positive offset distances at any point on the base curve are defined as 90° counterclockwise from the tangent of the base curve at that point.
An offset curve with a 0.0 offset distance is exact replica of the base curve. An offset curve with a non-zero 0.0 offset distance has a continuity of one less than that of the base curve. To insure that the offset curve is a valid curve, the base curve must have a continuity of at least 1.
Corresponding C++ library: TD_Ge
<group OdGe_Classes>
Definition at line 59 of file GeOffsetCurve3d.h.
Constructor & Destructor Documentation
◆ OdGeOffsetCurve3d() [1/3]
| OdGeOffsetCurve3d::OdGeOffsetCurve3d | ( | ) |
Default constructor for the OdGeOffsetCurve3d class. Sets the base curve pointer to NULL, the offset distance to 0.0 and the normal to the plane is initialized by its default with coordinates (0, 0, 0).
◆ OdGeOffsetCurve3d() [2/3]
| OdGeOffsetCurve3d::OdGeOffsetCurve3d | ( | const OdGeCurve3d & | baseCurve, |
| const OdGeVector3d & | planeNormal, | ||
| double | offsetDistance, | ||
| bool | makeCopy = false |
||
| ) |
Sets the base curve pointer to baseCurve, the plain normal pointer to planeNormal, and the offset distance to offsetDistance.
- Parameters
-
baseCurve [in] Any 3D curve to be set as the base curve. planeNormal [in] A 3D vector to be set as the normal to the plane of the base curve. offsetDistance [in] Offset distance. makeCopy [in] If true, makes a copy of the base curve specified by the baseCurve parameter.
- Remarks
- If makeCopy is true, the constructor makes a copy of the 3D curve entity specified by the baseCurve parameter. The OdGeOffsetCurve3d object that is being created becomes the owner of the newly made copy of the given 3D curve. The direction of the offset is determined by the sign of the offsetDistance parameter and by the direction of planeNormal. The base curve must be planar and planeNormal must be perpendicular to the plane of the base curve.
There are two exceptions to this rule:
If the offset distance is 0, then planeNormal may be any vector, including the zero vector (it will not be used if the offset distance is 0). If the base curve is linear, then planeNormal must be perpendicular to the line of the curve.
◆ OdGeOffsetCurve3d() [3/3]
| OdGeOffsetCurve3d::OdGeOffsetCurve3d | ( | const OdGeOffsetCurve3d & | source | ) |
Creates a copy of the specified OdGeOffsetCurve3d object.
- Parameters
-
source [in] Object to be copied.
Member Function Documentation
◆ curve()
| const OdGeCurve3d * OdGeOffsetCurve3d::curve | ( | ) | const |
Returns a pointer to the base curve.
- Returns
- Pointer to the actual base curve.
- Remarks
- It can be different relative to the curve passed in constructor due to cloning under the flag in constructor or applying transformBy() and reverseParam() methods.
◆ normal()
| OdGeVector3d OdGeOffsetCurve3d::normal | ( | ) | const |
Returns the normal to the base curve as a unit vector.
- Returns
- Unit vector of the normal to the base curve.
◆ offsetDistance()
| double OdGeOffsetCurve3d::offsetDistance | ( | ) | const |
Returns the offset distance of this curve.
- Returns
- Offset distance to the base curve.
- Remarks
- Offset distance is a distance by which this curve is offset from the base curve. Positive offset distances at any point on the base curve are defined as 90° counterclockwise from the tangent of the base curve at that point.
◆ operator=()
| OdGeOffsetCurve3d & OdGeOffsetCurve3d::operator= | ( | const OdGeOffsetCurve3d & | offsetCurve | ) |
Assignment operator for the OdGeOffsetCurve3d object.
- Parameters
-
offsetCurve [in] Offset curve to assign.
- Returns
- Reference to this OdGeOffsetCurve3d object.
◆ paramDirection()
| bool OdGeOffsetCurve3d::paramDirection | ( | ) | const |
Checks whether this curve has the same parameter direction as the base curve.
- Returns
- True if this curve has the same parameter direction as the base curve, or false otherwise.
◆ setCurve()
| OdGeOffsetCurve3d & OdGeOffsetCurve3d::setCurve | ( | const OdGeCurve3d & | baseCurve, |
| bool | makeCopy = false |
||
| ) |
Sets the base curve for this OdGeOffsetCurve3d object.
- Parameters
-
baseCurve [in] Any 3D curve to be set as the base curve. makeCopy [in] If true, makes a copy of the base curve specified by the baseCurve parameter.
- Returns
- Reference to this OdGeOffsetCurve3d object.
- Remarks
- If makeCopy is true, the method makes a copy of the 3D curve entity specified by the baseCurve parameter. This OdGeOffsetCurve3d object becomes the owner of the newly made copy of the given 3D curve.
◆ setNormal()
| OdGeOffsetCurve3d & OdGeOffsetCurve3d::setNormal | ( | const OdGeVector3d & | planeNormal | ) |
Sets the normal to the plane of the base curve.
- Returns
- Reference to this OdGeOffsetCurve3d object.
- Parameters
-
planeNormal [in] A 3D normal vector to the plane on which base curve lies.
◆ setOffsetDistance()
| OdGeOffsetCurve3d & OdGeOffsetCurve3d::setOffsetDistance | ( | double | offsetDistance | ) |
Sets the offset distance for this curve.
- Returns
- Reference to this OdGeOffsetCurve3d object.
- Parameters
-
offsetDistance [in] Distance by which this curve is offset from the base curve.
- Remarks
- Positive offset distances at any point on the base curve are defined as 90° counterclockwise from the tangent of the base curve at that point. The direction of offset is determined by the sign of the distance parameter.
An offset curve with a 0.0 offset distance is exact replica of the base curve.
◆ transformation()
| OdGeMatrix3d OdGeOffsetCurve3d::transformation | ( | ) | const |
Returns the concatenation of the transformation matrices applied to this curve with transformBy().
- Returns
- Transformation matrix applied to this curve as the concatenation of all of the transformation matrices applied to this curve with transformBy().
- Remarks
- If no transformation matrices have been applied to this curve, returns the identity matrix.
The documentation for this class was generated from the following file: