#include <DbXline.h>
Public Member Functions inherited from Detailed Description
<group OdDb_Classes>
This class implements the Xline object (Infinity Line entity) in the database. This class inherits the base functionality of entities. It is used as a construction line passed through a point.
- See also
- TD_Db
- <link db_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline.html, Working with Infinite Lines>
Constructor & Destructor Documentation
◆ OdDbXline()
| OdDbXline::OdDbXline | ( | ) |
Builds an instance of the Xline object.
- Remarks
- Use the static pseudo-constructor instead it. See: <link db_xline_overview.html, Overview of Infinite Lines>
Member Function Documentation
◆ basePoint()
| OdGePoint3d OdDbXline::basePoint | ( | ) | const |
Returns the WCS coordinates of the base point through which the inifinity line passes (DXF 10) as three-dimensional point instance.
- See also
- <link db_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_specific.html, Specific Infinite Line Properties>
OdDbXline::setBasePoint() method
◆ 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.
◆ 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.
◆ getArea()
|
virtual |
This method is not applicable for the infinity line entity.
Reimplemented from OdDbCurve.
◆ getDistAtParam()
|
virtual |
Computes the distance along the infinite line measured from the base point in drawing units
at the specified parameter.
- Parameters
-
param [in] Parameter value specifying the point on the infinite 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_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_compute.html, Computed Infinite Line Properties>
Implements OdDbCurve.
◆ getEndParam()
|
virtual |
This method is not applicable for the infinity line entity.
- Parameters
-
endParam [out] Reference to a variable of a Double type.
Implements OdDbCurve.
◆ getEndPoint()
|
virtual |
This method is not applicable for the infinity line entity.
- Parameters
-
endPoint [out] Reference to a variable which is three-dimensional point instance.
Implements OdDbCurve.
◆ getFirstDeriv()
|
virtual |
Computes the first derivative for the specified parameter of the infinity line entity and returns the three-dimensional vector instance. The first derivative is constant for any
point of the infinite line.
- Parameters
-
param [in] Parameter value specifying the point on the infinite 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_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_compute.html, Computed Infinite 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 infinite line measured from the base point.
- Parameters
-
dist [in] Distance value along the infinite 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_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_compute.html, Computed Infinite Line Properties>
Implements OdDbCurve.
◆ getParamAtPoint()
|
virtual |
Computes the parameter at the point placed on the infinite line.
- Parameters
-
pointOnCurve [in] Three-dimensional point instance which specifies the point on the infinite line. [out] Reference to a variable in which this method must save the parameter
value as a Double value.
- See also
- <link db_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_compute.html, Computed Infinite Line Properties>
Implements OdDbCurve.
◆ getPlane()
|
virtual |
Gets an arbitrary plane passed through the infinity 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_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline.html, Working with Infinite Lines>
OdDbXline::isPlanar(), OdDbEntity::getPlane() methods
Reimplemented from OdDbEntity.
◆ getPointAtParam()
|
virtual |
Computes the WCS coordinates of the point on the infinity line at the specified parameter value.
- Parameters
-
param [in] Parameter value specifying the point on the infinity 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_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_compute.html, Computed Infinite Line Properties>
Implements OdDbCurve.
◆ getSecondDeriv()
|
virtual |
Computes the second derivative for the specified parameter of the infinity line entity and returns the three-dimensional vector instance. The second derivative has (0,0,0) coordinates for any point of the infinite line.
- Parameters
-
param [in] Parameter value specifying the point on the infinite 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_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_compute.html, Computed Infinite Line Properties>
Reimplemented from OdDbCurve.
◆ getStartParam()
|
virtual |
This method is not applicable for the infinity line entity.
- Parameters
-
startParam [out] Reference to a variable of a Double type.
Implements OdDbCurve.
◆ getStartPoint()
|
virtual |
This method is not applicable for the infinity line entity.
- Parameters
-
startPoint [out] Reference to a variable which is three-dimensional point instance.
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 infinity line entity is planar as a Boolean value and returns True. This method is inherited from the OdDbEntity class.
- See also
- <link db_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline.html, Working with Infinite Lines>
OdDbXline::getPlane(), OdDbEntity::isPlanar() methods
Reimplemented from OdDbEntity.
◆ ODDB_DECLARE_MEMBERS()
| OdDbXline::ODDB_DECLARE_MEMBERS | ( | OdDbXline | ) |
◆ setBasePoint()
| void OdDbXline::setBasePoint | ( | const OdGePoint3d & | geBasePoint | ) |
Sets the base point of the infinity line (DXF 10). The initial value is (0,0,0) by default.
- Parameters
-
geBasePoint [in] Three-dimensional point instance to set the base point.
- See also
- <link db_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_specific.html, Specific Infinite Line Properties>
OdDbXline::basePoint() method
◆ 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.
◆ setUnitDir()
| void OdDbXline::setUnitDir | ( | const OdGeVector3d & | geDirVector | ) |
Sets the unit direction vector of the infinity line (DXF 11) in WCS. The initial value is (0,0,1) by default.
- Parameters
-
geDirVector [in] Three-dimensional vector instance to set the infinity line direction.
- Remarks
- The method automatically converts the specified coordinates to a unit vector.
- See also
- <link db_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_specific.html, Specific Infinite Line Properties>
OdDbXline::unitDir() method
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ TD_USING() [1/2]
| OdDbXline::TD_USING | ( | OdDbCurve::getFirstDeriv | ) |
◆ TD_USING() [2/2]
| OdDbXline::TD_USING | ( | OdDbCurve::getSecondDeriv | ) |
◆ unitDir()
| OdGeVector3d OdDbXline::unitDir | ( | ) | const |
Returns the WCS unit direction vector of the infinity line (DXF 11) as three-dimensional vector instance. This vector orients the infinity line in would space.
- See also
- <link db_xline_sample.html, Example of Working with the Xline Object>
- <link db_xline_specific.html, Specific Infinite Line Properties>
OdDbXline::setUnitDir() method
The documentation for this class was generated from the following file: