#include <DbCircle.h>
Public Member Functions inherited from Detailed Description
<group OdDb_Classes>
This class implements the circle object (Circle entity) in the database. This class inherits the base functionality of entities. A circle is a circular closed figure in world space.
- See also
- TD_Db
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle.html, Working with Circles>
OdDbArc, OdDbEllipse classes
Definition at line 54 of file DbCircle.h.
Constructor & Destructor Documentation
◆ OdDbCircle()
| OdDbCircle::OdDbCircle | ( | ) |
Builds an instance of the circle object.
- Remarks
- Use the static pseudo-constructor instead it. See: <link db_circle_overview.html, Overview of Circles>
Member Function Documentation
◆ center()
| OdGePoint3d OdDbCircle::center | ( | ) | const |
Returns the WCS coordinates of the circle center (DXF 10) as three-dimensional point instance.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_specific.html, Specific Circle Properties>
OdDbCircle::setCenter() 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.
◆ 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.
◆ getArea()
|
virtual |
Returns the area of the circle calculated using the classic formula (PIRR).
- Parameters
-
vArea [out] Reference to a variable in which this method must save the area as a Double value.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle Properties>
Reimplemented from OdDbCurve.
◆ getDistAtParam()
|
virtual |
Computes the distance along the circle measured from the OCS X-axis to the point on the circle specified the parameter.
- Parameters
-
param [in] Parameter value specifying the point on the circle as a Double value in radians. dist [out] Reference to a variable in which this method must save the distance value as a Double value in drawing units.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle Properties>
Implements OdDbCurve.
◆ getEcs()
|
virtual |
Returns the entity coordinate system matrix.
Reimplemented from OdDbEntity.
◆ getEndParam()
|
virtual |
Gets the end parameter value. The end parameter equals the 2PI. Parameter is an angle measured counterclockwise from the OCS X-axis in the range 0 to 2PI radians.
- Parameters
-
endParam [out] Reference to a variable in which this method must save the end
parameter value as a Double value in radians.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle Properties>
Implements OdDbCurve.
◆ getEndPoint()
|
virtual |
Computes the WCS coordinates of the end point on the circle for which the parameter equals the circumference. The end point coincides with the start point.
- 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_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle Properties>
Implements OdDbCurve.
◆ getFirstDeriv()
|
virtual |
Computes the first derivative for the specified parameter of the circle entity and returns the three-dimensional vector instance.
- Parameters
-
param [in] Parameter value specifying the point on the circle as a Double value in radians. firstDeriv [out] Reference to a variable in which this method must save the first
derivative as three-dimensional vector instance.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle 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 circle. Parameter is an angle measured counterclockwise from the OCS X-axis in the range 0 to 2PI radians.
- Parameters
-
dist [in] Distance value along the circle curve 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 in radians.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle Properties>
Implements OdDbCurve.
◆ getParamAtPoint()
|
virtual |
Computes the parameter at the point placed on the circle. Parameter is an angle measured counterclockwise from the OCS X-axis in the range 0 to 2PI radians.
- Parameters
-
pointOnCurve [in] Three-dimensional point instance which specifies the point on the circle. param [out] Reference to a variable in which this method must save the parameter
value as a Double value in radians.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle Properties>
Implements OdDbCurve.
◆ getPlane()
|
virtual |
Gets a plane in which the circle entity places. 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 kPlanar - planar entity).
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle.html, Working with Circles>
OdDbCircle::isPlanar(), OdDbEntity::getPlane() methods
Reimplemented from OdDbEntity.
◆ getPointAtParam()
|
virtual |
Computes the WCS coordinates of the point on the circle at the specified parameter value. Parameter is an angle measured counterclockwise from the OCS X-axis in the range 0 to 2PI radians.
- Parameters
-
param [in] Parameter value specifying the point on the circle as a Double value in radians. 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_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle Properties>
Implements OdDbCurve.
◆ getSecondDeriv()
|
virtual |
Computes the second derivative for the specified parameter of the circle entity and
returns the three-dimensional vector instance.
- Parameters
-
param [in] Parameter value specifying the point on the circle as a Double value in radians. secondDeriv [out] Reference to a variable in which this method must save the second
derivative as three-dimensional vector instance.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle Properties>
Reimplemented from OdDbCurve.
◆ getStartParam()
|
virtual |
Gets the start parameter value. The start parameter equals zero for circles. Parameter is an angle measured counterclockwise from the OCS X-axis in the range 0 to 2PI radians.
- Parameters
-
startParam [out] Reference to a variable in which this method must save the start
parameter value as a Double value in radians.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle Properties>
Implements OdDbCurve.
◆ getStartPoint()
|
virtual |
Computes the WCS coordinates of the start point on the circle for which the parameter equals zero. The start point coincides with the end point.
- 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_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_compute.html, Computed Circle 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 circle entity is planar as a Boolean value and returns True. This method is inherited from the OdDbEntity class.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle.html, Working with Circles>
OdDbCircle::getPlane(), OdDbEntity::isPlanar() methods
Reimplemented from OdDbEntity.
◆ normal()
| OdGeVector3d OdDbCircle::normal | ( | ) | const |
Returns the WCS unit vector which is the normal to the plane of the circle entity (DXF 210). The normal defines the orientation of the circle plane in world space.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_specific.html, Specific Circle Properties>
OdDbCircle::setNormal() method
◆ ODDB_DECLARE_MEMBERS()
| OdDbCircle::ODDB_DECLARE_MEMBERS | ( | OdDbCircle | ) |
◆ radius()
| double OdDbCircle::radius | ( | ) | const |
Returns the radius of the circle entity (DXF 40).
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_specific.html, Specific Circle Properties>
OdDbCircle::setRadius() method
◆ setCenter()
| void OdDbCircle::setCenter | ( | const OdGePoint3d & | center | ) |
Sets the center of the circle entity (DXF 10) in WCS. The initial value is (0,0,0) by default.
- Parameters
-
center [in] Three-dimensional point instance to set the center.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_specific.html, Specific Circle Properties>
OdDbCircle::center() 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.
◆ setNormal()
| void OdDbCircle::setNormal | ( | const OdGeVector3d & | geVector | ) |
Sets the WCS normal to the plane of the circle entity (DXF 210). The normal defines the orientation of the circle 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_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_specific.html, Specific Circle Properties>
OdDbCircle::normal() method
◆ setRadius()
| void OdDbCircle::setRadius | ( | double | radius | ) |
Sets the radius of the circle entity (DXF 40). The initial value is 0.0 by default.
- Parameters
-
radius [in] Radius as a Double value.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_specific.html, Specific Circle Properties>
OdDbCircle::radius() method
◆ setThickness()
| void OdDbCircle::setThickness | ( | double | vThickness | ) |
Sets the thickness of the circle 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 circle
without thickness. The initial value is zero by default.
- Parameters
-
vThickness [in] Thickness as a Double value.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_specific.html, Specific Circle Properties>
OdDbCircle::thickness() method
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetTransformedCopy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ TD_USING() [1/2]
| OdDbCircle::TD_USING | ( | OdDbCurve::getFirstDeriv | ) |
◆ TD_USING() [2/2]
| OdDbCircle::TD_USING | ( | OdDbCurve::getSecondDeriv | ) |
◆ thickness()
| double OdDbCircle::thickness | ( | ) | const |
Returns the thickness of the circle 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 circle without thickness.
- See also
- <link db_circle_sample.html, Example of Working with the Circle Object>
- <link db_circle_specific.html, Specific Circle Properties>
OdDbCircle::setThickness() method
The documentation for this class was generated from the following file: