#include <DbLine.h>
Public Member Functions inherited from Detailed Description
<group OdDb_Classes>
This class implements the line object (Line entity) in the database. This class inherits the base functionality of entities. A line is a straight segment in world space.
- See also
- TD_Db
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line.html, Working with Lines>
Constructor & Destructor Documentation
◆ OdDbLine()
| OdDbLine::OdDbLine | ( | ) |
Builds an instance of the line object.
- Remarks
- Use the static pseudo-constructor instead it. See: <link db_line_overview.html, Overview of Lines>
Member Function Documentation
◆ 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.
◆ 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.
◆ endPoint()
| OdGePoint3d OdDbLine::endPoint | ( | ) | const |
Returns the WCS coordinates of the end point of the line (DXF 11) as three-dimensional point instance.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_specific.html, Specific Line Properties>
◆ getArea()
|
virtual |
Returns a zero for the line entity.
Reimplemented from OdDbCurve.
◆ getDistAtParam()
|
virtual |
Computes the distance along the line measured from the start point in drawing units
at the specified parameter.
- Parameters
-
param [in] Parameter value specifying the point on the line as a Double value. dist [out] Reference to a variable in which this method must save the distance value as a Double value.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
Implements OdDbCurve.
◆ getEcs()
|
virtual |
Returns the entity coordinate system matrix.
- Remarks
- Default implementation returns Identity matrix.
Reimplemented from OdDbEntity.
◆ getEndParam()
|
virtual |
Gets the end parameter value. The end parameter equals the line length. Parameter is a distance measured from the start point in drawing units.
- Parameters
-
endParam [out] Reference to a variable in which this method must save the end
parameter value as a Double value.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
Implements OdDbCurve.
◆ getEndPoint()
|
virtual |
Computes the WCS coordinates of the end point on the line for which the parameter equals the line length.
- Parameters
-
endPoint [out] Reference to a variable in which this method must save the end
point as three-dimensional point instance.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
Implements OdDbCurve.
◆ getFirstDeriv()
|
virtual |
Computes the first derivative for the specified parameter of the line entity and returns the three-dimensional vector instance. The first derivative is constant for any point of the line.
- Parameters
-
param [in] Parameter value specifying the point on the line as a Double value. firstDeriv [out] Reference to a variable in which this method must save the first
derivative as three-dimensional vector instance.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
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 |
Computes the parameter at the distance along the line. Parameter is a distance measured from the start point in drawing units.
- Parameters
-
dist [in] Distance value along the line as a Double value in drawing units. param [out] Reference to a variable in which this method must save the parameter value
as a Double value.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
Implements OdDbCurve.
◆ getParamAtPoint()
|
virtual |
Computes the parameter at the point placed on the line. Parameter is a distance measured from the start point in drawing units.
- Parameters
-
pointOnCurve [in] Three-dimensional point instance which specifies the point on the line. param [out] Reference to a variable in which this method must save the parameter
value as a Double value.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
Implements OdDbCurve.
◆ getPlane()
|
virtual |
Gets an arbitrary plane passed through the line entity. This method is inherited from the
OdDbEntity class.
- Parameters
-
gePlane [out] Reference to a variable in which this method must save the plane parameters as a plane instance. gePlanarity [out] Reference to a variable in which this method must save the plane type (returns kLinear - arbitrary plane).
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line.html, Working with Lines>
OdDbLine::isPlanar(), OdDbEntity::getPlane() methods
Reimplemented from OdDbEntity.
◆ getPointAtParam()
|
virtual |
Computes the WCS coordinates of the point on the line at the specified parameter value. Parameter is a distance measured from the start point in drawing units.
- Parameters
-
param [in] Parameter value specifying the point on the line as a Double value. pointOnCurve [out] Reference to a variable in which this method must save the three-dimensional point instance corresponding to the parameter.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
Implements OdDbCurve.
◆ getSecondDeriv()
|
virtual |
Computes the second derivative for the specified parameter of the line entity and returns the three-dimensional vector instance. The second derivative is constant for any point of the line.
- Parameters
-
param [in] Parameter value specifying the point on the line as a Double value. secondDeriv [out] Reference to a variable in which this method must save the second
derivative as three-dimensional vector instance.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
Reimplemented from OdDbCurve.
◆ getStartParam()
|
virtual |
Gets the start parameter value. The start parameter equals a zero for lines. Parameter is a distance measured from the start point in drawing units.
- Parameters
-
startParam [out] Reference to a variable in which this method must save the start
parameter value as a Double value.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
Implements OdDbCurve.
◆ getStartPoint()
|
virtual |
Computes the WCS coordinates of the start point on the line for which the parameter equals zero.
- Parameters
-
startPoint [out] Reference to a variable in which this method must save the start point as three-dimensional point instance.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_compute.html, Computed Line Properties>
Implements OdDbCurve.
◆ isClosed()
|
virtual |
Returns true if and only if this Curve object is closed.
Reimplemented from OdDbCurve.
◆ isPeriodic()
|
virtual |
Returns true if and only if this Curve object is periodic.
Reimplemented from OdDbCurve.
◆ isPlanar()
|
virtual |
Determines whether the line entity is planar as a Boolean value and returns True. This method is inherited from the OdDbEntity class.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line.html, Working with Lines>
OdDbLine::getPlane(), OdDbEntity::isPlanar() methods
Reimplemented from OdDbEntity.
◆ normal()
| OdGeVector3d OdDbLine::normal | ( | ) | const |
Returns the WCS unit vector which is the normal to the plane of the line entity (DXF 210). The normal defines the orientation of the line plane in world space.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_specific.html, Specific Line Properties>
OdDbLine::setNormal() method
◆ ODDB_DECLARE_MEMBERS()
| OdDbLine::ODDB_DECLARE_MEMBERS | ( | OdDbLine | ) |
◆ reverseCurve()
◆ setEndPoint()
| void OdDbLine::setEndPoint | ( | const OdGePoint3d & | geEndPoint | ) |
Sets the end point of the line (DXF 11) in WCS. The initial value is (0,0,0) by default.
- Parameters
-
geEndPoint [in] Three-dimensional point instance to set the end point.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_specific.html, Specific Line Properties>
◆ 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 OdDbLine::setNormal | ( | const OdGeVector3d & | geVector | ) |
Sets the WCS normal to the plane of the line entity (DXF 210). The normal defines the orientation of the line plane in world space. The initial value is (0,0,1) by default.
- Parameters
-
geVector [in] Three-dimensional vector instance to set the normal.
- Remarks
- This method automatically converts the specified vector to the unit vector.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_specific.html, Specific Line Properties>
OdDbLine::normal() method
◆ setStartPoint()
| void OdDbLine::setStartPoint | ( | const OdGePoint3d & | geStartPoint | ) |
Sets the start point of the line (DXF 10) in WCS. The initial value is (0,0,0) by default.
- Parameters
-
geStartPoint [in] Three-dimensional point instance to set the start point.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_specific.html, Specific Line Properties>
◆ setThickness()
| void OdDbLine::setThickness | ( | double | vThickness | ) |
Sets the thickness of the line entity (DXF 39) in drawing units. Thickness is the extrusion length along the normal. A positive value extrudes along the normal. A negative value extrudes opposite from the normal. A zero value defines a line
without thickness. The initial value is zero by default.
- Parameters
-
vThickness [in] Thickness as a Double value.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_specific.html, Specific Line Properties>
OdDbLine::thickness() method
◆ startPoint()
| OdGePoint3d OdDbLine::startPoint | ( | ) | const |
Returns the WCS coordinates of the start point of the line (DXF 10) as three-dimensional point instance.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_specific.html, Specific Line Properties>
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ TD_USING() [1/2]
| OdDbLine::TD_USING | ( | OdDbCurve::getFirstDeriv | ) |
◆ TD_USING() [2/2]
| OdDbLine::TD_USING | ( | OdDbCurve::getSecondDeriv | ) |
◆ thickness()
| double OdDbLine::thickness | ( | ) | const |
Returns the thickness of the line entity (DXF 39) in drawing units. Thickness is the extrusion length along the normal. A positive value defines the thickness to be drawn along the normal direction. A negative value defines the thickness to be drawn in the opposite direction from
the normal. A zero value defines a line without thickness.
- See also
- <link db_line_sample.html, Example of Working with the Line Object>
- <link db_line_specific.html, Specific Line Properties>
OdDbLine::setThickness() method
The documentation for this class was generated from the following file: