Share

AcDb2dPolyline Methods

Methods

Method Description
appendVertex
constantWidth This is constantWidth, a member of class AcDb2dPolyline.
convertToPolyType Uses the splineFit() and/or curveFit() methods to convert the polyline to the type specified by the newType argument value.Possible values for type are:
curveFit This function creates a smooth curve consisting of pairs of arcs joining each pair of vertices. The curve passes through all the vertices of the polyline and uses any tangent direction specified by the individual vertices. This operation performs the same modification as the PEDIT command "Fit" option.Returns Acad::eOk.
defaultEndWidth Returns the default polyline segment ending width value for the polyline. This value is used as the default end width for all vertices within the polyline. So, for DXFOUT, vertices that have this end width will not write the value out. For DXFIN, vertices that do not have a DXF group code 41 value will use the polyline's default end width.If non-zero, the default end width value is used for the polyline's DXF group code 41.
defaultStartWidth Returns the default polyline segment starting width value for the polyline. This value is used as the default start width for all vertices within the polyline. So, for DXFOUT, vertices that have this start width will not write the value out. For DXFIN, vertices that do not have a DXF group code 40 value will use the polyline's default start width.If non-zero, the default start width value is used for the polyline's DXF group code 40.
elevation Returns the elevation of the polyline. The elevation is the OCS Z axis value of the polyline (that is, the shortest distance from the WCS origin to the plane containing the polyline).The elevation value is used for the Z coordinate of DXF group code 10 (group code 30 in a DXF file).
insertVertexAt
isLinetypeGenerationOn Returns Adesk::kTrue if linetype generation is turned on for the polyline; otherwise, returns Adesk::kFalse. When linetype generation is on, the linetype pattern used by the polyline is generated continuously across all vertices rather than starting over at each vertex.The linetype generation is reflected in bit 8 of DXF group code 70 (that is, if linetype generation is on, then the bit is set).
length This is length, a member of class AcDb2dPolyline.
makeClosed This function sets the polyline to be closed (a line segment will be drawn between the last vertex and the first vertex to form a closed polygon).This sets the first bit of DXF group code 70.Returns Acad::eOk if successful, or Acad::eInvalidInput if the data passed in is not acceptable.
makeClosedIfStartAndEndVertexCoincide This is makeClosedIfStartAndEndVertexCoincide, a member of class AcDb2dPolyline.
makeOpen This function sets the polyline to be open. No line segment will be drawn between the last vertex and the first vertex, so the polyline will not form a closed polygon.This clears the first bit of DXF group code 70.Returns Acad::eOk if successful, or Acad::eInvalidInput if the data passed in is not acceptable.
normal This function returns the normal vector of the plane containing the polyline. The normal vector is in WCS coordinates.The normal value is used for DXF group code 210.
openSequenceEnd This function provides access to the AcDbSequenceEnd entity for the polyline for the purpose of getting or setting xdata. An attempt is made to open the polyline's Seqend in the mode specified by openMode.The openMode argument may be one of the following:
  • AcDb::kForRead
  • AcDb::kForWrite
  • AcDb::kForNotify
If the open attempt is successful, then pSeqend will be set to the address of the AcDbSequenceEnd object and Acad::eOk will be returned.If attempting to open AcDb::kForRead and the Seqend is already opened for read the maximum of 256 times, then the open attempt will fail and this function will return Acad::eAtMaxReaders... more
openVertex This function provides access to the polyline's vertices. The function is passed in an empty pointer pVertex . The object ID of the vertex to open is vertId. The mode to open in is openMode. openErasedOne is a Boolean indicating whether or not to open the object if it is erased:.The openMode argument may be one of the following:
  • AcDb::kForRead
  • AcDb::kForWrite
  • AcDb::kForNotify
If the open attempt is successful, then pVertex will be set to the address of the object and Acad::eOk will be returned.If openErasedEntity is Adesk::kFalse, then attempting to open an erased vertex will... more
polyType Returns the AcDb::Poly2dType, which indicates the curve/spline-fit type for this polyline.Possible values for AcDb::Poly2dType are:
setClosed This is setClosed, a member of class AcDb2dPolyline.
setConstantWidth This is setConstantWidth, a member of class AcDb2dPolyline.
setDefaultEndWidth Sets newVal to be the default polyline segment ending width value for the polyline. This value is used as the default end width for all vertices within the polyline. So, for DXFOUT, vertices that have this end width will not write the value out. For DXFIN, vertices that do not have a DXF group code 41 value will use the polyline's default end width.If non-zero, the default end width value is used for the polyline's DXF group code 41.Returns Acad::eOk if successful, or Acad::eInvalidInput if the data passed in is not acceptable.
setDefaultStartWidth Sets newVal to be the default polyline segment starting width value for the polyline. This value is used as the default start width for all vertices within the polyline. So, for DXFOUT, vertices that have this start width will not write the value out. For DXFIN, vertices that do not have a DXF group code 40 value will use the polyline's default start width.If non-zero, the default start width value is used for the polyline's DXF group code 40.Returns Acad::eOk if successful, or Acad::eInvalidInput if the data passed in is not acceptable.
setElevation Sets newVal to be the elevation of the polyline. The elevation is the OCS Z axis value of the polyline (that is, the shortest distance from the WCS origin to the plane containing the polyline).The elevation value is used for the Z coordinate of DXF group code 10 (group code 30 in a DXF file).Returns Acad::eOk if successful, or Acad::eInvalidInput if the data passed in is not acceptable.
setLinetypeGenerationOff This function sets linetype generation off. This causes the linetype pattern in use by the polyline to start over at each vertex rather than continuing across vertices.This will clear bit 8 of DXF group code 70.Returns Acad::eOk if successful, or Acad::eInvalidInput if the data passed in is not acceptable.
setLinetypeGenerationOn
setNormal This function sets normal to be the normal vector for the plane containing the polyline. normal must be non-zero in length.The normal value is used for DXF group code 210.Returns Acad::eOk if successful, or Acad::eInvalidInput if the data passed in is not acceptable.
setPolyType Sets type to be the AcDb::Poly2dType for the polyline. The AcDb::Poly2dType indicates the curve/spline-fit type for this polyline.Possible values for type are:
setThickness This function sets thickness to be the thickness for the polyline. The thickness is the polyline's dimension along its normal vector direction. The normal vector direction is sometimes called the extrusion direction.The thickness value is used for DXF group code 39.
splineFit
straighten This function removes all spline and curve-fit vertices from the polyline and sets all remaining vertices to be simple vertices. This operation performs the same modification as the PEDIT command "Decurve" option.Returns Acad::eOk.
subGetClassID Override this virtual function in a AcDbEntity-derived class to provide your custom implementation for AcDbEntity::subGetClassID Method.
thickness This function returns the thickness of the polyline. The thickness is the polyline's dimension along its normal vector direction (sometimes called the extrusion direction).The thickness value is used for DXF group code 39.
vertexIterator This function creates a new AcDbObjectIterator set to iterate over the vertices of the polyline, and then returns a pointer to the iterator object just created. The calling application is responsible for deallocating the iterator object using the C++ delete operator.
vertexPosition This function returns the WCS coordinate position value of vert. This function uses the X and Y coordinates from the vertex along with the Z coordinate from the polyline and applies the polyline's OCS-to-WCS transformation to produce the WCS position value. This function will work with vertex objects that are not owned by the polyline. The position returned will be as though the vertex was owned by the polyline.

Was this information helpful?