CFx SDK Documentation
2023 SP0
|
#include <DbArc.h>
<group OdDb_Classes>
This class implements the circular arc object (Arc entity) in the database. This class inherits the base functionality of entities. An arc is a circular segment in world space.
OdDbCircle, OdDbEllipse classes
OdDbArc::OdDbArc | ( | ) |
Builds an instance of the circular arc object.
OdGePoint3d OdDbArc::center | ( | ) | const |
Returns the WCS coordinates of the arc center (DXF 10) as three-dimensional point instance.
OdDbArc::setCenter() method
|
virtual |
Reads the .dwg file data of this object.
pFiler | [in] Filer object from which data are read. |
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.
|
virtual |
Writes the .dwg file data of this object.
pFiler | [in] Pointer to the filer to which data are written. |
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.
|
virtual |
Reads the DXF data of this object.
pFiler | [in] Pointer to the filer from which data are read. |
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.
|
virtual |
Reads the DXF R12 format data of this object.
pFiler | [in] Pointer to the filer from which data are to be read. |
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.
|
virtual |
Writes the DXF data of this object.
pFiler | [in] Pointer to the filer to which data are to be written. |
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.
|
virtual |
Writes the DXF data of this object.
pFiler | [in] Pointer to the filer to which data are to be written. |
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.
double OdDbArc::endAngle | ( | ) | const |
Returns the end angle of the circular arc in radians (DXF 51).
|
virtual |
Returns the area calculated for the closed figure formed by the circular arc and a line passed from the end point to the start point.
vArea | [out] Reference to a variable in which this method must save the area as a Double value. |
Reimplemented from OdDbCurve.
|
virtual |
Computes the distance along the circular arc measured from the start point to the point on circular curve specified by the parameter.
param | [in] Parameter value specifying the point on the circular curve 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. |
Implements OdDbCurve.
|
virtual |
Returns the entity coordinate system matrix.
Reimplemented from OdDbEntity.
|
virtual |
Gets the end parameter value. The end parameter equals the end angle. Parameter is an angle measured counterclockwise from the OCS X-axis in the range 0 to 2PI radians.
endParam | [out] Reference to a variable in which this method must save the end parameter value as a Double value in radians. |
Implements OdDbCurve.
|
virtual |
Computes the WCS coordinates of the end point on the circular arc for which the
parameter equals the end angle.
endPoint | [out] Reference to a variable in which this method must save the end point as three-dimensional point instance. |
Implements OdDbCurve.
|
virtual |
Computes the first derivative for the specified parameter of the circular arc entity and returns the three-dimensional vector instance.
param | [in] Parameter value specifying the point on the circular curve 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. |
Implements OdDbCurve.
|
virtual |
Returns an OdGeCurve3d that is geometrically identical to this OdDbCurve.
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. |
Reimplemented from OdDbCurve.
|
virtual |
Computes the parameter at the distance along the circular arc. Parameter is an angle measured from the OCS X-axis in the range 0 to 2PI radians.
dist | [in] Distance value along the circular 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. |
Implements OdDbCurve.
|
virtual |
Computes the parameter at the point placed on the circular arc. Parameter is an angle measured counterclockwise from the OCS X-axis in the range 0 to 2PI radians.
pointOnCurve | [in] Three-dimensional point instance which specifies the point on the circular curve. |
param | [out] Reference to a variable in which this method must save the parameter value as a Double value in radians. |
Implements OdDbCurve.
|
virtual |
Gets a plane in which the circular arc entity places. This method is inherited from the
OdDbEntity class.
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). |
OdDbCircle::isPlanar(), OdDbEntity::getPlane() methods
Reimplemented from OdDbEntity.
|
virtual |
Computes the WCS coordinates of the point on the circular arc at the specified parameter value. Parameter is an angle measured counterclockwise from the OCS X-axis in the range 0 to 2PI radians.
param | [in] Parameter value specifying the point on the circular curve 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. |
Implements OdDbCurve.
|
virtual |
Computes the second derivative for the specified parameter of the circular arc entity
and returns the three-dimensional vector instance.
param | [in] Parameter value specifying the point on the circular curve 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. |
Reimplemented from OdDbCurve.
|
virtual |
Gets the start parameter value. The start parameter equals equals the start angle. Parameter is an angle measured counterclockwise from the OCS X-axis in the range 0 to 2PI radians.
startParam | [out] Reference to a variable in which this method must save the start parameter value as a Double value in radians. |
Implements OdDbCurve.
|
virtual |
Computes the WCS coordinates of the start point on the circular arc for which
the parameter equals the start angle.
startPoint | [out] Reference to a variable in which this method must save the start point as three-dimensional point instance. |
Implements OdDbCurve.
|
virtual |
Returns true if and only if this Curve object is closed.
Reimplemented from OdDbCurve.
|
virtual |
Returns true if and only if this Curve object is periodic.
Reimplemented from OdDbCurve.
|
virtual |
Determines whether the circular arc entity is planar as a Boolean value and returns True. This method is inherited from the OdDbEntity class.
OdDbArc::getPlane(), OdDbEntity::isPlanar() methods
Reimplemented from OdDbEntity.
OdGeVector3d OdDbArc::normal | ( | ) | const |
Returns the WCS unit vector which is the normal to the plane of the circular arc
entity (DXF 210). The normal defines the orientation of the arc plane in world space.
OdDbArc::setNormal() method
OdDbArc::ODDB_DECLARE_MEMBERS | ( | OdDbArc | ) |
double OdDbArc::radius | ( | ) | const |
Returns the radius of the circular arc (DXF 40).
OdDbArc::setRadius() method
void OdDbArc::setCenter | ( | const OdGePoint3d & | center | ) |
Sets the center point of the circular arc (DXF 10) in WCS. The initial value is
(0,0,0) by default.
center | [in] Three-dimensional point instance to set the center. |
OdDbArc::center() method
void OdDbArc::setEndAngle | ( | double | endAngle | ) |
Sets the end angle of the circular arc in the range �2PI radians (DXF 51). A positive value specifies the angle measured from the OCS X-axis counterclockwise. A negative value specifies the angle measured from the OCS X-axis clockwise. The initial value is zero by default.
endAngle | [in] End angle as a Double value. |
|
virtual |
Takes an OdGeCurve3d and sets this OdDbCurve to be geometrically identical to the OdGeCurve3d.
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. |
Reimplemented from OdDbCurve.
void OdDbArc::setNormal | ( | const OdGeVector3d & | geVector | ) |
Sets the WCS normal to the plane of the circular arc entity (DXF 210). The normal defines the orientation of the arc plane in world space. The initial value is (0,0,1) by default.
geVector | [in] Three-dimensional vector instance to set the normal. |
OdDbArc::normal() method
void OdDbArc::setRadius | ( | double | radius | ) |
Sets the radius of the circular arc (DXF 40). The initial value is 0.0 by default.
radius | [in] Radius as a Double value. |
OdDbArc::radius() method
void OdDbArc::setStartAngle | ( | double | startAngle | ) |
Sets the start angle of the circular arc in the range �2PI radians (DXF 50). A positive value specifies the angle measured from the OCS X-axis counterclockwise. A negative value specifies the angle measured from the OCS X-axis clockwise. The initial value is zero by default.
startAngle | [in] Start angle as a Double value. |
void OdDbArc::setThickness | ( | double | vThickness | ) |
Sets the thickness of the circular arc 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 an arc without thickness. The initial value is zero by default.
vThickness | [in] Thickness as a Double value. |
OdDbArc::thickness() method
double OdDbArc::startAngle | ( | ) | const |
Returns the start angle of the circular arc in radians (DXF 50).
Reimplemented from OdDbEntity.
|
virtual |
Reimplemented from OdDbEntity.
|
virtual |
Reimplemented from OdDbEntity.
|
virtual |
Reimplemented from OdDbEntity.
|
virtual |
Reimplemented from OdDbEntity.
|
virtual |
Reimplemented from OdDbEntity.
OdDbArc::TD_USING | ( | OdDbCurve::getFirstDeriv | ) |
OdDbArc::TD_USING | ( | OdDbCurve::getSecondDeriv | ) |
double OdDbArc::thickness | ( | ) | const |
Returns the thickness of the circular arc 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 an arc without thickness.
OdDbArc::setThickness() method