#include <Db3dPolyline.h>
Public Member Functions inherited from Detailed Description
This class represents 3D Polyline entities in an OdDbDatabase instance. <group OdDb_Classes>
Definition at line 66 of file Db3dPolyline.h.
Constructor & Destructor Documentation
◆ OdDb3dPolyline()
| OdDb3dPolyline::OdDb3dPolyline | ( | ) |
Member Function Documentation
◆ appendVertex()
| OdDbObjectId OdDb3dPolyline::appendVertex | ( | OdDb3dPolylineVertex * | pVertex | ) |
Appends the specified Vertex entity to this Polyline entity, and makes this Polyline entity its owner.
- Returns
- Returns the Object ID of the appended vertex.
If this Polyline entity is database resident, the Vertex entity will be made database resident.
If this Polyline entity is not database resident, the Vertex entity will be made database resident when this Polyline entity is made database resident.
- Remarks
- If this Polyline is database resident, the Vertex entity must explicitly be closed when appendVertex() returns.
- Parameters
-
pVertex [in] Pointer to the Vertex entity to be appended.
◆ convertToPolyType()
| OdResult OdDb3dPolyline::convertToPolyType | ( | OdDb::Poly3dType | newVal | ) |
Convert 3D-Polyline to the specified type.
- Parameters
-
newVal [in] Polyline type.
- Remarks
- newVal must be one of the following:
Value Description OdDb::k3dSimplePoly 0 Simple polyline. OdDb::k3dQuadSplinePoly 1 Quadratic B-spline fit (DXF 80, bit 0x08; DXF 75 == 5). OdDb::k3dCubicSplinePoly 2 Cubic B-spline-fit (DXF 80, bit 0x08; DXF 75 == 6).
◆ 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.
◆ DWGMAP_DECLARE_MEMBERS()
| OdDb3dPolyline::DWGMAP_DECLARE_MEMBERS | ( | OdDb3dPolyline | ) |
◆ 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.
◆ dxfIn()
|
virtual |
Reads the DXF format data of this object from the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer from which the data are to be read.
- Returns
- Returns the filer status.
This function calls this object's dxfInFields(pFiler), then loads any Xdata associated with this object.
Reimplemented from OdDbEntity.
◆ 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.
◆ dxfInFields_R12()
|
virtual |
Reads the DXF R12 format data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are to be 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 dxfInFields_R12(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfOutFields_R12(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.
◆ dxfOut()
|
virtual |
Writes the DXF format data of this object to the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer to which the data are to be written.
- Remarks
- This function calls this object's dxfOutFields(pFiler) function, writes any Xdata associated with this object.
Reimplemented from OdDbEntity.
◆ 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.
◆ dxfOutFields_R12()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Returns
- Returns the filer status.
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). 3) 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.
◆ explodeGeometry()
|
virtual |
Explodes this entity into a set of simpler entities.
- Parameters
-
entitySet [in/out] Receives an array of pointers to the new entities.
- Remarks
- The newly created entities will be not database resident. Entities resulting from the explosion are appended to the specified array. The default implementation of this function calls subWorldDraw() and makes entities from geometry generated by subWorldDraw(). This function can be overridden in custom classes.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbEntity.
◆ findVertexIndex()
|
virtual |
Reimplemented from OdDbCurve.
◆ 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.
◆ 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.
◆ 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 |
Returns the WCS point on this Curve object corresponding to the specified parameter.
- Parameters
-
param [in] Parameter specifying point. pointOnCurve [out] Receives the point on this Curve object.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Implements OdDbCurve.
◆ 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.
◆ 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.
◆ insertVertexAt() [1/2]
| OdDbObjectId OdDb3dPolyline::insertVertexAt | ( | const OdDb3dPolylineVertex * | pIndexVert, |
| OdDb3dPolylineVertex * | pVertex | ||
| ) |
Inserts the specified Vertex entity into this Polyline entity after the specified vertex, and makes this Polyline its owner.
- Returns
- Returns the Object ID of the newly inserted vertex.
The Vertex will be made database resident.
If this Polyline entity is not database resident, the vertex will be made database resident when the polyline is made database resident.
To insert the specified Vertex at the start of this Polyline, use a null indexVertexId.
- Remarks
- The Vertex entity must explicitly be closed when insertertex() returns.
- Parameters
-
pIndexVert [in] Pointer to vertex after which to insert the specified vertex. pVertex [in] Pointer to the Vertex entity to be inserted.
◆ insertVertexAt() [2/2]
| OdDbObjectId OdDb3dPolyline::insertVertexAt | ( | const OdDbObjectId & | indexVertId, |
| OdDb3dPolylineVertex * | pVertex | ||
| ) |
Inserts the specified Vertex entity into this Polyline entity after the specified vertex, and makes this Polyline its owner.
- Returns
- Returns the Object ID of the newly inserted vertex.
The Vertex will be made database resident.
If this Polyline entity is not database resident, the vertex will be made database resident when the polyline is made database resident.
To insert the specified Vertex at the start of this Polyline, use a null indexVertexId.
- Remarks
- The Vertex entity must explicitly be closed when insertertex() returns.
- Parameters
-
indexVertId [in] Object ID of vertex after which to insert the specified vertex. pVertex [in] Pointer to the Vertex entity to be inserted.
◆ isClosed()
|
virtual |
Returns true if 3D-Polyline is closed or false otherwise.
Reimplemented from OdDbCurve.
◆ isPeriodic()
|
virtual |
Returns true if and only if this Curve object is periodic.
Reimplemented from OdDbCurve.
◆ isPlanar()
|
virtual |
Returns true if and only if this entity is planar.
Reimplemented from OdDbEntity.
◆ makeClosed()
| void OdDb3dPolyline::makeClosed | ( | ) |
Sets this Polyline entity closed (DXF 70, bit 0x01=1).
◆ makeOpen()
| void OdDb3dPolyline::makeOpen | ( | ) |
Sets this Polyline entity open (DXF 70, bit 0x01=0).
◆ openSequenceEnd()
| OdDbSequenceEndPtr OdDb3dPolyline::openSequenceEnd | ( | OdDb::OpenMode | mode | ) |
Opens the OdDbSequenceEnd entity for this Polyline entity.
- Parameters
-
mode [in] Mode in which to open the OdDbSequenceEnd entity.
- Returns
- Returns a SmartPointer to the newly opened OdDbSequenceEnd, or a null SmartPointer.
- Remarks
- This method is provided solely for applications that store XData on OdDbSequenceEnd entities; this is not recommended.
◆ openVertex()
| OdDb3dPolylineVertexPtr OdDb3dPolyline::openVertex | ( | OdDbObjectId | vertId, |
| OdDb::OpenMode | mode, | ||
| bool | openErasedOne = false |
||
| ) |
Opens a vertex owned by this Polyline entity.
- Parameters
-
vertId [in] Object ID of vertex to be opened. mode [in] Mode in which to open the vertex. openErasedOne [in] If and only if true, erased objects will be opened.
- Returns
- Returns a SmartPointer to the opened object if successful, otherwise a null SmartPointer.
◆ polyType()
| OdDb::Poly3dType OdDb3dPolyline::polyType | ( | ) | const |
Returns the type of this Polyline entity.
- Remarks
- polyType() returns one of the following:
Value Description OdDb::k3dSimplePoly 0 Simple polyline. OdDb::k3dQuadSplinePoly 1 Quadratic B-spline fit (DXF 80, bit 0x08; DXF 75 == 5). OdDb::k3dCubicSplinePoly 2 Cubic B-spline-fit (DXF 80, bit 0x08; DXF 75 == 6).
◆ reverseCurve()
|
virtual |
Reverses the Polyline so that the first vertex become the last vertex of a Polyline and the last vertex become the first vertex.
- Returns
- eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbCurve.
◆ 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.
◆ setPolyType()
| void OdDb3dPolyline::setPolyType | ( | OdDb::Poly3dType | polyType | ) |
Sets the type of this Polyline entity.
- Parameters
-
polyType [in] Polyline type.
- Remarks
- polyType() returns one of the following:
Value Description OdDb::k3dSimplePoly 0 Simple polyline. OdDb::k3dQuadSplinePoly 1 Quadratic B-spline fit (DXF 80, bit 0x08; DXF 75 == 5). OdDb::k3dCubicSplinePoly 2 Cubic B-spline-fit (DXF 80, bit 0x08; DXF 75 == 6).
◆ splineFit() [1/2]
| OdResult OdDb3dPolyline::splineFit | ( | ) |
Transforms all simple vertices to control vertices and creates a new spline-fit vertices based on a control vertices, through which the polyline will be drawn.
- Returns
- eOk if successful, or an appropriate error code if not.
◆ splineFit() [2/2]
| OdResult OdDb3dPolyline::splineFit | ( | OdDb::Poly3dType | splineType, |
| OdInt16 | splineSegs | ||
| ) |
Transforms all simple vertices to control vertices and creates a new spline-fit vertices based on a control vertices, through which the polyline will be drawn.
- Parameters
-
splineType [in] Spline-Fit Polyline type. splineSegs [in] Number of Spline-Fit segments.
- Returns
- eOk if successful, or an appropriate error code if not.
◆ straighten()
| void OdDb3dPolyline::straighten | ( | ) |
Removes all spline fitting from this Polyline entity.
- Remarks
- Removes all but the simple vertices.
◆ subClose()
|
virtual |
Called as the first operation as this object is being closed, for database -resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subClose().
3) If other actions are required before close, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ subExplode()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetGsMarkersAtSubentPath()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetSubentPathsAtGsMarker()
|
virtual |
Reimplemented from OdDbEntity.
◆ subSubentPtr()
|
virtual |
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ TD_USING() [1/2]
| OdDb3dPolyline::TD_USING | ( | OdDbCurve::getFirstDeriv | ) |
◆ TD_USING() [2/2]
| OdDb3dPolyline::TD_USING | ( | OdDbCurve::getSecondDeriv | ) |
◆ vertexIterator()
| OdDbObjectIteratorPtr OdDb3dPolyline::vertexIterator | ( | ) | const |
Returns a SmartPointer to an iterator that can be used to traverse the vertices owned by this Polyline entity.
The documentation for this class was generated from the following file: