#include <DbPoint.h>
Public Member Functions inherited from Detailed Description
<group OdDb_Classes>
This class implements the point object (Point entity) in the database. This class inherits the base functionality of entities.
- See also
- TD_Db
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point.html, Working with Points>
<link db_point_appearance.html, Appearance and Size of Points>
Constructor & Destructor Documentation
◆ OdDbPoint() [1/2]
| OdDbPoint::OdDbPoint | ( | ) |
Builds an instance of the point entity.
- Parameters
-
gePoint [in] WCS position for the point entity.
- Remarks
- Use the static pseudo-constructor instead it. See: <link db_point_overview.html, Overview of Points>
◆ OdDbPoint() [2/2]
| OdDbPoint::OdDbPoint | ( | const OdGePoint3d & | gePoint | ) |
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.
◆ ecsRotation()
| double OdDbPoint::ecsRotation | ( | ) | const |
Returns the ECS Rotation which defines the angle in radians between the OCS X-axis for
the point based on the normal vector and the X-axis that will be used for displaying the
point entity (DXF 50). A positive angle value is measured clockwise. A negative angle value is measured counterclockwise.
- Remarks
- The ECS Rotation is used when PDMODE is non-zero.
- See also
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point_specific.html, Specific Point Properties>
OdDbPoint::setEcsRotation() method
◆ getPlane()
|
virtual |
Gets an arbitrary plane passed through the point 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_point_sample.html, Example of Working with the Point Object>
- <link db_point.html, Working with Points>
OdDbPoint::isPlanar(), OdDbEntity::getPlane() methods
Reimplemented from OdDbEntity.
◆ isPlanar()
|
inlinevirtual |
Determines whether the point entity is planar as a Boolean value and always returns True.
- See also
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point.html, Working with Points>
OdDbPoint::getPlane(), OdDbEntity::isPlanar() method
Reimplemented from OdDbEntity.
◆ normal()
| OdGeVector3d OdDbPoint::normal | ( | ) | const |
Returns the WCS unit vector which is the normal to the plane of the trace entity (DXF 210). The normal defines the orientation of the trace plane in world space.
- See also
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point_specific.html, Specific Point Properties>
OdDbPoint::setNormal() method
◆ ODDB_DECLARE_MEMBERS()
| OdDbPoint::ODDB_DECLARE_MEMBERS | ( | OdDbPoint | ) |
◆ position()
| OdGePoint3d OdDbPoint::position | ( | ) | const |
Returns the WCS position of the point entity (DXF 10) as three-dimensional point instance.
- See also
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point_specific.html, Specific Point Properties>
OdDbPoint::setPosition() method
◆ setEcsRotation()
| void OdDbPoint::setEcsRotation | ( | double | vAngle | ) |
Sets the ECS Rotation which defines the angle in the range 0 to 2PI radians between the
OCS X-axis for the point based on the normal vector and the X-axis that will be used for
displaying the point entity (DXF 50). A positive angle rotates clockwise. A negative angle
rotates counterclockwise. The initial value is zero by default.
- Parameters
-
vAngle [in] Rotation angle as a Double value.
- Remarks
- The ECS Rotation is used when PDMODE is non-zero. This method does not convert to an
equivalent angle and sets the specified angle value.
- See also
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point_specific.html, Specific Point Properties>
OdDbPoint::ecsRotation() method
◆ setNormal()
| void OdDbPoint::setNormal | ( | const OdGeVector3d & | geVector | ) |
Sets the WCS normal to the plane of the trace entity (DXF 210). The normal defines the orientation of the trace plane in world space. The initial value is (0,0,1) by default.
- Parameters
-
geVector [in] Three-dimensional vector instance to set the normal.
- See also
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point_specific.html, Specific Point Properties>
OdDbPoint::normal() method
◆ setPosition()
| void OdDbPoint::setPosition | ( | const OdGePoint3d & | gePoint | ) |
Sets the WCS position of the point entity (DXF 10). The initial value is (0,0,0) by default.
- Parameters
-
gePoint [in] Three-dimensional point instance to set the point position.
- See also
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point_specific.html, Specific Point Properties>
OdDbPoint::position() method
◆ setThickness()
| void OdDbPoint::setThickness | ( | double | vThickness | ) |
Sets the thickness of the point 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 trace
without thickness. The initial value is zero by default.
- Parameters
-
vThickness [in] Thickness value as a Double value.
- See also
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point_specific.html, Specific Point Properties>
OdDbPoint::thickness() method
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subSetAttributes()
|
virtual |
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
- Parameters
-
pTraits [in] Pointer to the OdGiDrawableTraits object to be set.
- Remarks
- When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add.
A derived class may not remove flags for any reason.
The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ thickness()
| double OdDbPoint::thickness | ( | ) | const |
Returns the thickness of the point 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 trace without thickness.
- See also
- <link db_point_sample.html, Example of Working with the Point Object>
- <link db_point_specific.html, Specific Point Properties>
OdDbPoint::setThickness() method
The documentation for this class was generated from the following file: