#include <DbPolyline.h>
Public Types inherited from Detailed Description
This class represents Lightweight Polyline entities in an OdDbDatabase instance.
- See also
- TD_Db
OdDbPolyline entities differ from OdDb2dPolyline entities as follows: OdDbPolyline entities are stored as single objects, thereby improving performance and reducing overhead compared to OdDb2DPolyline objects. Curve fitting and Spline fitting of OdDbPolyline entities are not supported.
- Remarks
- The number of vertices in an OdDbPolyline must be at least two. Polylines with less than two vertices should not left in or added to the database.
Since the nth Segment of a Polyline is the segment following the nth Vertex, the segment index and vertex index may be used interchangeably.
<group OdDb_Classes>
Definition at line 62 of file DbPolyline.h.
Member Enumeration Documentation
◆ SegType
| Enumerator | |
|---|---|
| kLine | |
| kArc | |
| kCoincident | |
| kPoint | |
| kEmpty | |
Definition at line 153 of file DbPolyline.h.
Constructor & Destructor Documentation
◆ OdDbPolyline()
| OdDbPolyline::OdDbPolyline | ( | ) |
Member Function Documentation
◆ addVertexAt()
| void OdDbPolyline::addVertexAt | ( | unsigned int | vertexIndex, |
| const OdGePoint2d & | point2d, | ||
| double | bulge = 0., |
||
| double | startWidth = -1., |
||
| double | endWidth = -1., |
||
| OdInt32 | vertexIdentifier = 0 |
||
| ) |
Inserts a vertex into this Polyline entity at the specified index.
- Parameters
-
vertexIndex [in] Vertex index. point2d [in] OCS point of the vertex. bulge [in] Bulge value for the segment following the vertex. startWidth [in] Start width for the segment following the vertex. endWidth [in] End width for the segment following the vertex. vertexIdentifier [in]
- Remarks
- The vertex is inserted before the specified vertex. If vertexIndex == numVerts(), the vertex is appended to the Polyline.
Bulge is the tangent of 1/4 the included angle of the arc segment, measured counterclockwise.
◆ convertFrom()
| OdResult OdDbPolyline::convertFrom | ( | OdDbEntity * | pSource, |
| bool | transferId = true |
||
| ) |
Fills this OdDbPolyline entity with data from the specified OdDb2dPolyline entity.
- Parameters
-
pSource [in] Pointer to the source OdDb2dPolyline entity. transferId [in] True to do a handOverTo() between the source OdDb2dPolyline entity and this OdDbPolyline entity.
- Remarks
- If and only if transferId is true, This OdDbPolyline entity will be made database resident. It will assume the objectId, handle, extended entity data, extension dictionary, and reactors of the source OdDb2dPolyline entity The source OdDb2dPolyline entity will be deleted.
- The source OdDb2dPolyline entity Must be non- database resident. Must by of type k2dSimplePoly or k2dFitCurvePoly.
- Returns
- Returns one of the following:
Description eOk Success AlreadyInDb This entity is database resident eIllegalEntityType *pSource is not an OdDb2dPolyline eNotApplicable *pSource is not k2dSimplePoly or there is extended entity data attached to a vertex.
◆ convertTo()
| OdResult OdDbPolyline::convertTo | ( | OdDb2dPolyline * | pDest, |
| bool | transferId = true |
||
| ) |
Fills the specified OdDb2dPolyline with data from this OdDbPolyline entity.
- Parameters
-
pDest [in] Pointer to the destination OdDb2dPolyline entity. transferId [in] True to do a handOverTo() between this OdDbPolyline entity and the destination OdDb2dPolyline entity.
- Remarks
- If and only if transferId is true, The destination OdDb2dPolyline entity will be made database resident. It will assume the objectId, handle, extended entity data, extension dictionary, and reactors of this OdDbPolyline entity. This OdDbPolyline entity will made non- database resident, and may be deleted with the C++ delete operator.
- Returns
- Returns one of the following:
Description eOk Success eIllegalReplacement This entity is non- database resident. eObjectToBeDeleted This entity is now non- database resident, and should be deleted.
◆ 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.
◆ 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.
◆ 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.
◆ 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.
◆ elevation()
| double OdDbPolyline::elevation | ( | ) | const |
Returns the elevation of this entity in the OCS (DXF 30).
- Remarks
- The elevation is the distance from the WCS origin to the plane of this entity.
◆ 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.
◆ getArcSegAt() [1/2]
| void OdDbPolyline::getArcSegAt | ( | unsigned int | segmentIndex, |
| OdGeCircArc2d & | arc2d | ||
| ) | const |
Returns the specified OCS arc segment of this Polyline entity.
- Parameters
-
segmentIndex [in] Segment index. arc2d [out] Receives the OCS arc segment.
◆ getArcSegAt() [2/2]
| void OdDbPolyline::getArcSegAt | ( | unsigned int | segmentIndex, |
| OdGeCircArc3d & | arc3d | ||
| ) | const |
Returns the specified WCS arc segment of this Polyline entity.
- Parameters
-
segmentIndex [in] Segment index. arc3d [out] Receives the WCS arc segment.
◆ 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.
◆ getBulgeAt()
| double OdDbPolyline::getBulgeAt | ( | unsigned int | index | ) | const |
Returns the bulge of the specified segment of this Polyline entity.
- Parameters
-
index [in] Segment index.
- Remarks
- Bulge is the tangent of 1/4 the included angle of the arc segment, measured counterclockwise.
◆ getConstantWidth()
| double OdDbPolyline::getConstantWidth | ( | ) | const |
Returns the constant width for this Polyline entity (DXF 43).
◆ 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.
◆ getEcs()
|
virtual |
Returns the entity coordinate system matrix.
Reimplemented from OdDbEntity.
◆ 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.
◆ getLineSegAt() [1/2]
| void OdDbPolyline::getLineSegAt | ( | unsigned int | segmentIndex, |
| OdGeLineSeg2d & | line2d | ||
| ) | const |
Returns the specified OCS line segment of this Polyline entity.
- Parameters
-
segmentIndex [in] Segment index. line2d [out] Receives the OCS line segment.
◆ getLineSegAt() [2/2]
| void OdDbPolyline::getLineSegAt | ( | unsigned int | segmentIndex, |
| OdGeLineSeg3d & | line3d | ||
| ) | const |
Returns the specified WCS line segment of this Polyline entity.
- Parameters
-
segmentIndex [in] Segment index. line3d [out] Receives the WCS line segment.
◆ 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.
◆ getPointAt() [1/2]
| void OdDbPolyline::getPointAt | ( | unsigned int | vertexIndex, |
| OdGePoint2d & | point2d | ||
| ) | const |
Returns the OCS point of the specified vertex of this Polyline entity (DXF 10).
- Parameters
-
vertexIndex [in] Vertex index. point2d [out] Receives the OCS point.
◆ getPointAt() [2/2]
| void OdDbPolyline::getPointAt | ( | unsigned int | vertexIndex, |
| OdGePoint3d & | point3d | ||
| ) | const |
Returns the WCS point of the specified vertex of this Polyline entity (DXF 10).
- Parameters
-
vertexIndex [in] Vertex index. point3d [out] Receives the WCS point.
◆ 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.
◆ getVertexIdentifierAt()
| OdInt32 OdDbPolyline::getVertexIdentifierAt | ( | unsigned int | index | ) | const |
Returns the vertex identifier of the specified segment of this Polyline entity.
- Parameters
-
index [in] Segment index.
◆ getWidthsAt()
| void OdDbPolyline::getWidthsAt | ( | unsigned int | segmentIndex, |
| double & | startWidth, | ||
| double & | endWidth | ||
| ) | const |
Returns the start and end widths for the specified segment of this Polyline entity.
- Parameters
-
segmentIndex [in] Segment index. startWidth [out] Receives the start width for the vertex. endWidth [out] Receives the end width for the vertex.
◆ hasBulges()
| bool OdDbPolyline::hasBulges | ( | ) | const |
Returns true if and only if any of the segments in this Polyline entity have non-zero bulges.
◆ hasPlinegen()
| bool OdDbPolyline::hasPlinegen | ( | ) | const |
Returns true if and only if linetype generation is on for this Polyline entity (DXF 70, bit 0x80).
- Remarks
- Linetype generation on indicates that the linetype pattern of this Polyline entity is continuously generated around all vertices.
Linetype generation off indicates that the linetype pattern of this Polyline entity is restarted at each vertex.
◆ hasVertexIdentifiers()
| bool OdDbPolyline::hasVertexIdentifiers | ( | ) | const |
Returns true if and only if any of the segments in this Polyline entity have non-zero vertex identifiers.
◆ hasWidth()
| bool OdDbPolyline::hasWidth | ( | ) | const |
Returns true if and only if any of the segments in this Polyline entity have start and end widths.
◆ isClosed()
|
virtual |
OdDbCurveMethods
Reimplemented from OdDbCurve.
◆ isOnlyLines()
| bool OdDbPolyline::isOnlyLines | ( | ) | const |
Returns true if and only if this Polyline entity consists solely of line segments.
◆ 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.
◆ maximizeMemory()
| void OdDbPolyline::maximizeMemory | ( | ) |
Decompresses this Polyline entity to expedite modifications.
◆ minimizeMemory()
| void OdDbPolyline::minimizeMemory | ( | ) |
Compresses this Polyline entity.
- Remarks
- Takes processing time, and should not be used until all edits are complete.
◆ normal()
| OdGeVector3d OdDbPolyline::normal | ( | ) | const |
Returns the WCS normal to the plane of this entity (DXF 210).
◆ numVerts()
| unsigned int OdDbPolyline::numVerts | ( | ) | const |
Returns the number of vertices in this Polyline entity (DXF 90).
◆ ODDB_DECLARE_MEMBERS()
| OdDbPolyline::ODDB_DECLARE_MEMBERS | ( | OdDbPolyline | ) |
◆ onSegAt()
|
virtual |
Returns true if and only if the specified OCS point is on the specified segment of this Polyline entity, and returns the parameter of that point on the segment.
- Parameters
-
segmentIndex [in] Segment index. point2d [in] The OCS point to query. param [out] The parameter at that point.
- Remarks
- The returned parameter will be in the parametric form of the segment (linear or arc).
◆ removeVertexAt()
| void OdDbPolyline::removeVertexAt | ( | unsigned int | vertexIndex | ) |
Removes the specified vertex from this Polyline entity.
- Parameters
-
vertexIndex [in] Vertex index.
◆ reset()
| void OdDbPolyline::reset | ( | bool | reuse, |
| unsigned int | numVerts | ||
| ) |
Resets the vertex data for this Polyline entity.
- Parameters
-
reuse [in] True to retain vertices. numVerts [in] Number of vertices to retain.
- Remarks
- If reuse is true, the vertex list will be expanded or truncated such that exactly numVerts vertices exist.
If reuse is false, all vertices will be deleted.
◆ reverseCurve()
◆ segType()
| SegType OdDbPolyline::segType | ( | unsigned int | segmentIndex | ) | const |
Returns the type of the specified segment of this Polyline entity.
- Parameters
-
segmentIndex [in] Segment index.
- Returns
- Returns one of the following:
Description kLine Straight segment with length > 0.0 kArc Arc segment with length > 0.0 kCoincident Segment with length == 0.0 kPoint Polyline with 1 vertex. kEmpty Polyline with 0 vertices.
◆ setBulgeAt()
| void OdDbPolyline::setBulgeAt | ( | unsigned int | index, |
| double | bulge | ||
| ) |
Sets the bulge of the specified segment of this Polyline entity.
- Parameters
-
index [in] Segment index. bulge [in] Bulge.
- Remarks
- Bulge is the tangent of 1/4 the included angle of the arc segment, measured counterclockwise.
◆ setClosed()
| void OdDbPolyline::setClosed | ( | bool | closed | ) |
Controls the closed state for this Polyline entity (DXF 70, bit 0x01=1).
- Parameters
-
closed [in] Controls closed.
◆ setConstantWidth()
| void OdDbPolyline::setConstantWidth | ( | double | constantWidth | ) |
Sets this Polyline entity to a constant width (DXF 43).
- Parameters
-
constantWidth [in] Constant width.
◆ setElevation()
| void OdDbPolyline::setElevation | ( | double | elevation | ) |
Sets the elevation of this entity in the OCS (DXF 38).
- Parameters
-
elevation [in] Elevation.
- Remarks
- The elevation is the distance from the WCS origin to the plane of this entity.
◆ 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.
◆ setNormal()
| void OdDbPolyline::setNormal | ( | const OdGeVector3d & | normal | ) |
Sets the WCS normal to the plane of this entity (DXF 210).
- Parameters
-
normal [in] Normal.
◆ setPlinegen()
| void OdDbPolyline::setPlinegen | ( | bool | plinegen | ) |
Controls the linetype generation for this Polyline entity (DXF 70, bit 0x80).
- Remarks
- Linetype generation on indicates that the linetype pattern of this Polyline entity is continuously generated around all vertices.
Linetype generation off indicates that the linetype pattern of this Polyline entity is restarted at each vertex.
- Parameters
-
plinegen [in] Controls linetype generation.
◆ setPointAt()
| void OdDbPolyline::setPointAt | ( | unsigned int | vertexIndex, |
| const OdGePoint2d & | point2d | ||
| ) |
Sets the OCS point for the specified vertex of this Polyline entity.
- Parameters
-
vertexIndex [in] Vertex index. point2d [in] OCS point of vertex.
◆ setThickness()
| void OdDbPolyline::setThickness | ( | double | thickness | ) |
Sets the thickness of this entity (DXF 39).
- Parameters
-
thickness [in] Thickness.
- Remarks
- Thickness is the extrusion length along the normal.
◆ setVertexIdentifierAt()
Sets the vertex identifier of the specified segment of this Polyline entity.
- Parameters
-
index [in] Segment index. suggestedId [in] Vertex identifier.
◆ setWidthsAt()
| void OdDbPolyline::setWidthsAt | ( | unsigned int | index, |
| double | startWidth, | ||
| double | endWidth | ||
| ) |
Sets the start and end widths for the specified segment of this Polyline entity.
- Parameters
-
index [in] Segment index. startWidth [in] Start width for the vertex. endWidth [in] End width for the vertex.
◆ subExplode()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetGsMarkersAtSubentPath()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetSubentPathsAtGsMarker()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetTransformedCopy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subSubentPtr()
|
virtual |
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ TD_USING() [1/2]
| OdDbPolyline::TD_USING | ( | OdDbCurve::getFirstDeriv | ) |
◆ TD_USING() [2/2]
| OdDbPolyline::TD_USING | ( | OdDbCurve::getSecondDeriv | ) |
◆ thickness()
| double OdDbPolyline::thickness | ( | ) | const |
Returns the thickness of this entity (DXF 39).
- Remarks
- Thickness is the extrusion length along the normal.
The documentation for this class was generated from the following file: