#include <DbSpline.h>
Public Types inherited from Detailed Description
This class represents Spline entities in an OdDbDatabase instance.
- See also
- TD_Db <group OdDb_Classes>
Definition at line 43 of file DbSpline.h.
Member Enumeration Documentation
◆ SplineType
Defines the spline method (either by fit points or by control points).
| Enumerator | |
|---|---|
| kFitPoints | |
| kControlPoints | |
Definition at line 505 of file DbSpline.h.
Constructor & Destructor Documentation
◆ OdDbSpline()
| OdDbSpline::OdDbSpline | ( | ) |
Member Function Documentation
◆ cvFrame()
| bool OdDbSpline::cvFrame | ( | ) | const |
Returns true if Control Vertices frame is visible.
◆ decomposeForSave()
|
virtual |
Determines the behavior for custom objects when saving to .dwg or .dxf file.
- Parameters
-
ver [in] Drawing version to save as. replaceId [out] Object ID of the object replacing this object. exchangeXData [out] Set to true if and only if this function did not add XData to the replacement object.
- Remarks
- This function either
Returns an OdDbObjectPtr for a non- database -resident (NDBRO) replacement object, setting replaceId to OdDbObjectId::kNull. Returns NULL, setting replaceId for a database -resident (DBRO) replacement object.
Custom objects can decompose themselves into other objects, adding additional XData as required. Teigha transfers XData from this object to the replacement object if and only if exchangeXData is true.
The default implementation returns NULL and sets replaceId to OdDbObjectId::kNull. This function can be overridden in custom classes.
The method is not intended to be called by client code. For processing owned objects use convertForSave() method.
Reimplemented from OdDbObject.
◆ degree()
| int OdDbSpline::degree | ( | ) | const |
Returns the degree of this Spline entity (DXF 71).
- Remarks
- degree is in the range [1..25].
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
Reimplemented in OdDbHelix.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
Reimplemented in OdDbHelix.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
Reimplemented in OdDbHelix.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
Reimplemented in OdDbHelix.
◆ elevateDegree()
| void OdDbSpline::elevateDegree | ( | int | newDegree | ) |
Increased the degree of this spline to the specified value.
◆ fitTolerance()
| double OdDbSpline::fitTolerance | ( | ) | const |
Returns the curve fitting tolerance for this Spline entity (DXF 44).
- Remarks
- This is the maximum drawing unit distance by which the Spline curve can deviate from a fit points.
◆ getArea()
|
virtual |
Returns the area of this Curve object.
- Parameters
-
area [out] Receives the area.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbCurve.
◆ getControlPointAt()
| void OdDbSpline::getControlPointAt | ( | int | controlPointIndex, |
| OdGePoint3d & | point | ||
| ) | const |
Returns the specified control point of this Spline entity (DXF 10).
- Parameters
-
controlPointIndex [in] Control point index. point [out] Receives the control point.
◆ getDistAtParam()
|
virtual |
Returns the distance along this Curve object from its start point to the point specified by param.
- Parameters
-
param [in] Parameter specifying point. dist [out] Receives the distance.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Implements OdDbCurve.
◆ getEndParam()
|
virtual |
Returns the parameter corresponding to the end point of this Curve object.
- Parameters
-
endParam [out] Receives the end parameter.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Implements OdDbCurve.
◆ getEndPoint()
|
virtual |
Returns the WCS end point of this Curve object.
- Parameters
-
endPoint [out] Receives the end point.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Implements OdDbCurve.
◆ getFirstDeriv()
|
virtual |
Returns the first derivative of this Curve object at the specified WCS point.
- Parameters
-
param [in] Parameter specifying point. firstDeriv [out] Receives the first derivative.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Implements OdDbCurve.
◆ getFitData() [1/2]
| OdResult OdDbSpline::getFitData | ( | OdGePoint3dArray & | fitPoints, |
| int & | degree, | ||
| double & | fitTolerance, | ||
| bool & | tangentsExist, | ||
| OdGeVector3d & | startTangent, | ||
| OdGeVector3d & | endTangent | ||
| ) | const |
Returns the fit data for this Spline entity.
- Parameters
-
fitPoints [out] Receives the fit points. degree [out] Receives the degree. fitTolerance [out] Receives the fit tolerance. tangentsExist [out] Receives true if and only if start and end tangents are used. startTangent [out] Receives the start point tangent. endTangent [out] Receives the end point tangent.
◆ getFitData() [2/2]
| OdResult OdDbSpline::getFitData | ( | OdGePoint3dArray & | fitPoints, |
| int & | degree, | ||
| double & | fitTolerance, | ||
| bool & | tangentsExist, | ||
| OdGeVector3d & | startTangent, | ||
| OdGeVector3d & | endTangent, | ||
| OdGe::OdGeKnotParameterization & | knotParam | ||
| ) | const |
Returns the fit data for this Spline entity.
- Parameters
-
fitPoints [out] Receives the fit points. degree [out] Receives the degree. fitTolerance [out] Receives the fit tolerance. tangentsExist [out] Receives true if and only if start and end tangents are used. startTangent [out] Receives the start point tangent. endTangent [out] Receives the end point tangent. knotParam [out] Receives the knot parametrization.
◆ getFitPointAt()
| OdResult OdDbSpline::getFitPointAt | ( | int | fitPointIndex, |
| OdGePoint3d & | point | ||
| ) | const |
Returns the specified fit point of this Spline entity (DXF 11).
- Parameters
-
fitPointIndex [in] Fit point index. point [out] Receives the fit point.
◆ getFitTangents()
| OdResult OdDbSpline::getFitTangents | ( | OdGeVector3d & | startTangent, |
| OdGeVector3d & | endTangent | ||
| ) | const |
Returns the start point and end point WCS fit tangents for this Spline entity (DXF 12, 13).
- Parameters
-
startTangent [out] Receives the start point tangent. endTangent [out] Receives the end point tangent.
◆ getNurbsData() [1/2]
| void OdDbSpline::getNurbsData | ( | int & | degree, |
| bool & | rational, | ||
| bool & | closed, | ||
| bool & | periodic, | ||
| OdGePoint3dArray & | controlPoints, | ||
| OdGeDoubleArray & | knots, | ||
| OdGeDoubleArray & | weights, | ||
| double & | controlPtTol, | ||
| double & | knotTol | ||
| ) | const |
TBC. void updateFitData();
Returns the NURBS data for this Spline entity.
- Parameters
-
degree [out] Receives the degree. rational [out] Receives true if and only if this Spline entity is rational. closed [out] Receives true if and only if this Spline entity is closed. periodic [out] Receives true if and only if this Spline entity is periodic. controlPoints [out] Receives an array of WCS control points. knots [out] Receives the knot vector. weights [out] Receives an array of weights. controlPtTol [out] Receives the control point tolerance. knotTol [out] Receives the knot tolerance.
◆ getNurbsData() [2/2]
| void OdDbSpline::getNurbsData | ( | int & | degree, |
| bool & | rational, | ||
| bool & | closed, | ||
| bool & | periodic, | ||
| OdGePoint3dArray & | controlPoints, | ||
| OdGeKnotVector & | knots, | ||
| OdGeDoubleArray & | weights, | ||
| double & | controlPtTol | ||
| ) | const |
Returns the NURBS data for this Spline entity.
- Parameters
-
degree [out] Receives the degree. rational [out] Receives true if and only if this Spline entity is rational. closed [out] Receives true if and only if this Spline entity is closed. periodic [out] Receives true if and only if this Spline entity is periodic. controlPoints [out] Receives an array of WCS control points. knots [out] Receives the knot vector. weights [out] Receives an array of weights. controlPtTol [out] Receives the control point tolerance.
◆ getOdGeCurve()
|
virtual |
Returns an OdGeCurve3d that is geometrically identical to this OdDbCurve.
- Parameters
-
pGeCurve [out] Receives a pointer to an OdGeCurve3d object that is geometrically identical to this OdDbCurve. The caller of this function is responsible for deleting this OdGeCurve3d object. tol [in] Optional tolerance.
- Returns
- Returns eOk if successful.
Reimplemented from OdDbCurve.
◆ getParamAtDist()
|
virtual |
Returns the parameter corresponding to the point a specified distance along this Curve object from its start point.
- Parameters
-
param [out] Receives the parameter. dist [in] Distance along the curve.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Implements OdDbCurve.
◆ getParamAtPoint()
|
virtual |
Returns the parameter corresponding to the specified WCS point on this Curve object.
- Parameters
-
param [out] Receives the parameter corresponding to pointOnCurve. pointOnCurve [in] Point to be evaluated.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Implements OdDbCurve.
◆ getPlane()
|
virtual |
Returns the plane that contains this entity.
- Parameters
-
plane [out] Receives the plane that contains this entity. planarity [out] Receives the planarity of this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
planarity and plane return values as follows::
Value Description plane kNonPlanar 0 Non-planar Not set kPlanar 1 Planar Entity plane kLinear 2 Linear Arrbitrary plane containing this entity
Reimplemented from OdDbEntity.
◆ getPointAtParam()
|
virtual |
◆ getSecondDeriv()
|
virtual |
Returns the second derivative of this Curve object at the specified point.
- Parameters
-
param [in] Parameter specifying point. secondDeriv [out] Receives the first derivative.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbCurve.
◆ getSplitCurves()
|
virtual |
Returns pointers to the curves that result from splitting this curve at the points corresponding to params.
- Parameters
-
params [in] The parameter values corresponding to the split points. entitySet [out] Receives an array of pointers to the split curves.
- Remarks
- The first split curve will be from the start of this curve to params[0]. The second split curve will be from params[0] to params[1]. The last split curve will be from params[n-1] to the end of his curve.
Reimplemented from OdDbCurve.
◆ getStartParam()
|
virtual |
Returns the parameter corresponding to the start point of this Curve object.
- Parameters
-
startParam [out] Receives the start parameter.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Implements OdDbCurve.
◆ getStartPoint()
|
virtual |
Returns the WCS start point of this Curve object.
- Parameters
-
startPoint [out] Receives the start point.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Implements OdDbCurve.
◆ hasFitData()
| bool OdDbSpline::hasFitData | ( | ) | const |
Returns true if and only if this Spline entity is constructed using fit points.
◆ insertControlPointAt()
| OdResult OdDbSpline::insertControlPointAt | ( | double | knotParam, |
| const OdGePoint3d & | ctrlPt, | ||
| double | weight = 1.0 |
||
| ) |
Inserts a control point at the specified knot.
- Parameters
-
knotParam [in] The knot parameter to add the control point at. ctrlPt [in] Coordinates of the control point to be added. weight [in] The weight to be assigned to the control point.
- Remarks
- When called for a non-rational spline, weight is ignored.
\returns
eOk if successful, or an appropriate error code if not.
◆ insertFitPointAt()
| void OdDbSpline::insertFitPointAt | ( | int | fitPointIndex, |
| const OdGePoint3d & | point | ||
| ) |
Inserts a fit point into this Spline entity after the specified index.
- Parameters
-
fitPointIndex [in] Fit point index. point [out] Receives the fit point.
- Remarks
- If fitPointIndex < 0, point is inserted at before the first fit point.
If fitPointIndex >= numFitPoints(), point is appended to the spline.
◆ insertKnot()
| void OdDbSpline::insertKnot | ( | double | param | ) |
Inserts a knot value into this spline.
◆ isNull()
| bool OdDbSpline::isNull | ( | ) | const |
Returns true if the spline doesn't contain control points.
◆ isPlanar()
|
virtual |
Returns true if and only if this entity is planar.
Reimplemented from OdDbEntity.
◆ isRational()
| bool OdDbSpline::isRational | ( | ) | const |
Returns true if and only if this Spline entity is rational (DXF 70, bit 0x04).
◆ modifyPositionAndTangent()
| bool OdDbSpline::modifyPositionAndTangent | ( | double | param, |
| const OdGePoint3d & | point, | ||
| const OdGeVector3d * | deriv | ||
| ) |
Modifies the position and tangent of the point with a specified parameter.
- Parameters
-
param [in] Parameter value of the point. point [in] New position of the point. deriv [in] New value of the tangent vector at the point.
- Returns
- Returns true if and only if the point has successfully been adjusted.
◆ numControlPoints()
| int OdDbSpline::numControlPoints | ( | ) | const |
Returns the number of control points in this Spline entity (DXF 73).
◆ numFitPoints()
| int OdDbSpline::numFitPoints | ( | ) | const |
Returns the number of fit points in this Spline entity (DXF 74).
◆ ODDB_DECLARE_MEMBERS()
| OdDbSpline::ODDB_DECLARE_MEMBERS | ( | OdDbSpline | ) |
◆ purgeFitData()
| void OdDbSpline::purgeFitData | ( | ) |
Purges the fit data for this Spline entity.
◆ removeControlPointAt()
| OdResult OdDbSpline::removeControlPointAt | ( | int | index | ) |
Deletes a control point at the specified index.
- Parameters
-
index [in] The index of the control point to be deleted. \returns
eOk if successful, or an appropriate error code if not.
◆ removeFitPointAt()
| void OdDbSpline::removeFitPointAt | ( | int | fitPointIndex | ) |
Removes the specified fit point from this Spline entity.
- Parameters
-
fitPointIndex [in] Fit point index.
◆ reverseCurve()
|
virtual |
◆ setControlPointAt()
| void OdDbSpline::setControlPointAt | ( | int | controlPointIndex, |
| const OdGePoint3d & | point | ||
| ) |
Sets the specified control point of this Spline entity (DXF 10).
- Parameters
-
controlPointIndex [in] Control point index. point [in] Control point.
◆ setCvFrame()
| void OdDbSpline::setCvFrame | ( | bool | bVisible | ) |
Sets visibility of Control Vertices frame for this Spline entity.
- Parameters
-
bVisible [in] Control vertices frame visiblity.
◆ setFitData() [1/2]
| void OdDbSpline::setFitData | ( | const OdGePoint3dArray & | fitPoints, |
| int | degree, | ||
| double | fitTolerance, | ||
| const OdGeVector3d & | startTangent, | ||
| const OdGeVector3d & | endTangent | ||
| ) |
Sets the fit data for this Spline entity.
- Parameters
-
fitPoints [in] Fit points. degree [in] Degree. fitTolerance [in] Fit tolerance. startTangent [in] Start point tangent. endTangent [in] End point tangent.
◆ setFitData() [2/2]
| void OdDbSpline::setFitData | ( | const OdGePoint3dArray & | fitPoints, |
| int | degree, | ||
| double | fitTolerance, | ||
| const OdGeVector3d & | startTangent, | ||
| const OdGeVector3d & | endTangent, | ||
| OdGe::OdGeKnotParameterization | knotParam | ||
| ) |
Sets the fit data for this Spline entity.
- Parameters
-
fitPoints [in] Fit points. degree [in] Degree. fitTolerance [in] Fit tolerance. startTangent [in] Start point tangent. endTangent [in] End point tangent. knotParam [in] Knot parametrization.
◆ setFitPointAt()
| void OdDbSpline::setFitPointAt | ( | int | fitPointIndex, |
| const OdGePoint3d & | point | ||
| ) |
Sets the specfied fit point of this Spline entity (DXF 11).
- Parameters
-
fitPointIndex [in] Fit point index. point [in] Fit point.
◆ setFitTangents()
| void OdDbSpline::setFitTangents | ( | const OdGeVector3d & | startTangent, |
| const OdGeVector3d & | endTangent | ||
| ) |
Sets the start point and end point WCS fit tangents for this Spline entity (DXF 12, 13).
- Parameters
-
startTangent [out] Start point tangent. endTangent [out] End point tangent.
◆ setFitTol()
| void OdDbSpline::setFitTol | ( | double | fitTolerance | ) |
Sets the curve fitting tolerance for this Spline entity (DXF 44).
- Remarks
- This is the maximum drawing unit distance by which the Spline curve can deviate from a fit points.
- Parameters
-
fitTolerance [in] Geometric tolerance.
◆ setFromOdGeCurve()
|
virtual |
Takes an OdGeCurve3d and sets this OdDbCurve to be geometrically identical to the OdGeCurve3d.
- Parameters
-
geCurve [in] reference to an OdGeCurve3d. normal [in] Optional normal vector. If this parameter is supplied then it must be a valid vector that is perpendicular to the input geCurve, and this vector will become the normal vector of the output pDbCurve. If this parameter is not supplied, then this function will compute the normal vector itself. tol [in] Optional tolerance.
- Returns
- Returns eOk if successful.
Reimplemented from OdDbCurve.
◆ setNurbsData() [1/2]
| void OdDbSpline::setNurbsData | ( | int | degree, |
| bool | rational, | ||
| bool | closed, | ||
| bool | periodic, | ||
| const OdGePoint3dArray & | controlPoints, | ||
| const OdGeDoubleArray & | knots, | ||
| const OdGeDoubleArray & | weights, | ||
| double | controlPtTol, | ||
| double | knotTol | ||
| ) |
Sets the NURBS data for this Spline entity.
- Parameters
-
degree [in] Degree. rational [in] Controls if this Spline entity is rational. closed [in] Controls if this Spline entity closed. periodic [in] Controls if this Spline entity is periodic. controlPoints [in] Array of WCS control points. knots [in] Knot vector. weights [in] Array of weights. controlPtTol [in] Control point tolerance. knotTol [in] Knot tolerance.
- Remarks
- degree is in the range of [1..25] If rational is true, controlPoints.length() must equal weights.length() If periodic is false, then knots.length() must equal controlPoints.length() + degree + 1 If periodic is true, then knots.length() must equal controlPoints.length(), the first and last controlPoints must be equal, and the first and last weights (if provided) must be equal. If two control points are within controlPtTol, they are treated as the same control point. If two knots are within knotTol, they are treated as the same knot.
◆ setNurbsData() [2/2]
| void OdDbSpline::setNurbsData | ( | int | degree, |
| bool | rational, | ||
| bool | closed, | ||
| bool | periodic, | ||
| const OdGePoint3dArray & | controlPoints, | ||
| const OdGeKnotVector & | knots, | ||
| const OdGeDoubleArray & | weights, | ||
| double | controlPtTol | ||
| ) |
Sets the NURBS data for this Spline entity.
- Parameters
-
degree [in] Degree. rational [in] Controls if this Spline entity is rational. closed [in] Controls if this Spline entity closed. periodic [in] Controls if this Spline entity is periodic. controlPoints [in] Array of WCS control points. knots [in] Knot vector. weights [in] Array of weights. controlPtTol [in] Control point tolerance.
- Remarks
- degree is in the range of [1..25] If rational is true, controlPoints.length() must equal weights.length() If periodic is false, then knots.length() must equal controlPoints.length() + degree + 1 If periodic is true, then knots.length() must equal controlPoints.length(), the first and last controlPoints must be equal, and the first and last weights (if provided) must be equal. If two control points are within controlPtTol, they are treated as the same control point.
◆ setType()
| OdResult OdDbSpline::setType | ( | SplineType | type | ) |
Sets the spline method (either by fit points or by control points).
- Parameters
-
type [in] spline type to be set.
- Returns
- Returns the result of the operation: eOk if successful, or an appropriate error code if not.
- Remarks
- Changing type from kControlPoints to kFitPoints recalculates fit points from control points.
◆ setWeightAt()
| void OdDbSpline::setWeightAt | ( | int | weightIndex, |
| double | weight | ||
| ) |
Sets the specified weight (DXF 41).
- Parameters
-
weightIndex [in] Weight index. weight [in] Weight.
◆ subExplode()
|
virtual |
Explodes this entity into a set of simpler entities.
- Parameters
-
entitySet [in/out] Receives an array of pointers to the new entities.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- Entities resulting from the explosion are appended to the specified array.
The newly created entities are not database residents.
The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.
Reimplemented from OdDbEntity.
Reimplemented in OdDbHelix.
◆ subGetClassID()
Reimplemented from OdDbEntity.
Reimplemented in OdDbHelix.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
Reimplemented in OdDbHelix.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ TD_USING() [1/3]
| OdDbSpline::TD_USING | ( | OdDbCurve::getFirstDeriv | ) |
◆ TD_USING() [2/3]
| OdDbSpline::TD_USING | ( | OdDbCurve::getSecondDeriv | ) |
◆ TD_USING() [3/3]
| OdDbSpline::TD_USING | ( | OdDbCurve::getSplitCurves | ) |
◆ type()
| SplineType OdDbSpline::type | ( | ) | const |
Returns the spline method (either by fit points or by control points).
◆ weightAt()
| double OdDbSpline::weightAt | ( | int | weightIndex | ) | const |
Returns the specified weight (DXF 41).
- Parameters
-
weightIndex [in] Weight index.
The documentation for this class was generated from the following file: