OdDbEllipse Class

Class Hierarchy

Syntax

C++

class OdDbEllipse : public OdDbCurve;

File

DbEllipse.h

Description

This class implements the ellipse object (Ellipse entity) in the database. This class inherits the base functionality of entities. The ellipse entity can represent either an elliptical closed figure (ellipse) or unclosed elliptical segment (elliptical arc) in world space. When the start angle coincides with the end angle, the figure is closed and this class represents an ellipse. When the start angle differs from the end angle on 1e-6, the figure is unclosed and this class represents an elliptical arc.

Remarks

The ellipse must have (StartAngle = 0) and (EndAngle = Oda2PI). The elliptical arc has (EndAngle - StartAngle) > 1e-6. The radius ratio must be in the range [1e-6 to 1.0].

Example of Working with the Elliptical Arc

Working with Ellipses

	Name	Description
	OdDbEllipse	Builds an instance of the ellipse object.

OdDbEllipse Methods

	Name	Description
	angleAtParam	Returns the angle value corresponding to the specified parameter value.
	center	Returns the WCS coordinates of the center for the elliptical figure (ellipse or arc) (DXF 10) as three-dimensional point instance.
	dwgInFields	Reads the .dwg file data of this object.
	DWGMAP_DECLARE_MEMBERS
	dwgOutFields	Writes the .dwg file data of this object.
	dxfInFields	Reads the DXF data of this object.
	dxfOutFields	Writes the DXF data of this object.
	endAngle	Returns the end angle of the elliptical figure (ellipse or arc) in radians (DXF 51).
	get	{NoAutoLink} Gets the properties for the ellipse entity. This method passes the properties through own arguments.
	getArea	When an elliptical figure is unclosed, this method returns the area calculated for the closed figure formed by the elliptical arc and a line passed from the end point to the start point. When an elliptical figure is closed, this method returns the area of the ellipse.
	getDistAtParam	Computes the distance along the elliptical figure (ellipse or arc) measured from the start point to the point on the elliptical curve specified the parameter.
	getEndParam	Gets the end parameter value of the elliptical figure (ellipse or arc). The OdDbEllipse::setEndParam() method sets this value. Parameter is an angle measured counterclockwise from the major axis in the range 0 to 2PI radians as if the elliptical figure was a circular figure with a major radius.
	getEndPoint	Computes the WCS coordinates of the end point on the elliptical figure (ellipse or arc) for which the parameter equals the end value. When the elliptical figure is closed, the end point coincides with the start point. When the elliptical figure is unclosed, the end point corresponds to the end angle.
	getFirstDeriv	Computes the first derivative for the specified parameter of the elliptical figure (ellipse or arc) and returns the three-dimensional vector instance.
	getOdGeCurve	Returns an OdGeCurve3d that is geometrically identical to this OdDbCurve.
	getParamAtDist	Computes the parameter at the distance along the elliptical figure (ellipse or arc). Parameter is an angle measured counterclockwise from the major axis in the range 0 to 2PI radians as if the elliptical figure was a circular figure with a major radius.
	getParamAtPoint	Computes the parameter at the point placed on the elliptical figure (ellipse or arc). Parameter is an angle measured counterclockwise from the major axis in the range 0 to 2PI radians as if the elliptical figure was a circular figure with a major radius.
	getPlane	Gets a plane in which the ellipse entity places. This method is inherited from the OdDbEntity class.
	getPointAtParam	Computes the WCS coordinates of the point on the elliptical figure (ellipse or arc) at the specified parameter value. Parameter is an angle measured counterclockwise from the major axis in the range 0 to 2PI radians as if the elliptical figure was a circular figure with a major radius.
	getSecondDeriv	Computes the second derivative for the specified parameter of the elliptical figure (ellipse or arc) and returns the three-dimensional vector instance.
	getStartParam	Gets the start parameter value of the elliptical figure (ellipse or arc). The OdDbEllipse::setStartParam() method sets this value. Parameter is an angle measured counterclockwise from the major axis in the range 0 to 2PI radians as if the elliptical figure was a circular figure with a major radius.
	getStartPoint	Computes the WCS coordinates of the start point on the elliptical figure (ellipse or arc) for which the parameter equals the start value. When the elliptical figure is closed, the end point coincides with the start point. When the elliptical figure is unclosed, the start point corresponds to the start angle.
	isClosed	Returns true if and only if this Curve object is closed.
	isPeriodic	Returns true if and only if this Curve object is periodic.
	isPlanar	Determines whether the elliptical figure is planar as a Boolean value and returns True. This method is inherited from the OdDbEntity class.
	majorAxis	Returns the WCS major axis vector for the elliptical figure (ellipse or arc). The major axis defines the major radius and rotation of the elliptical figure in the plane.
	minorAxis	Returns the WCS minor axis vector for the elliptical figure (ellipse or arc). The minor axis defines the minor radius. The minor axis is perpendicular to the major axis. The minor radius less than or equal the major radius.
	normal	Returns the WCS unit vector which is the normal to the plane of the ellipse entity (DXF 210). The normal defines the orientation of the ellipse plane in world space.
	paramAtAngle	Returns the parameter value corresponding to the specified angle value.
	radiusRatio	Returns the ratio of the minor radius to the major radius for the elliptical figure (ellipse or arc). The radius ratio is in the range [1e-6 to 1.0].
	reverseCurve	Reverses this curve entity so the start becomes the end, and vice versa.
	set	{NoAutoLink} Sets the properties for the ellipse entity.
	setCenter	Sets the center of the elliptical figure (ellipse or arc) (DXF 10) in WCS. The initial value is (0,0,0) by default.
	setEndAngle	Sets the end angle for the elliptical figure (ellipse or arc) in the range ±2PI radians (DXF 51). A positive value specifies the angle measured from the major axis counterclockwise. A negative value specifies the angle measured from the major axis clockwise. The initial value is 2PI by default.
	setEndParam	Sets the end parameter for the elliptical figure (ellipse or arc) (DXF 42). Parameter is an angle measured from the major axis in the range 0 to 2PI radians as if the elliptical figure was a circular figure with a major radius. A positive value specifies the end parameter measured counterclockwise A negative value specifies the end parameter measured clockwise. The initial value is 2PI by default.
	setFromOdGeCurve	Takes an OdGeCurve3d and sets this OdDbCurve to be geometrically identical to the OdGeCurve3d.
	setRadiusRatio	Sets the ratio of the minor radius to the major radius for the elliptical figure (ellipse or arc) in the range [1e-6 to 1.0]. The initial value is 1.0 by default.
	setStartAngle	Sets the start angle for the elliptical figure (ellipse or arc) in the range ±2PI radians (DXF 50). A positive value specifies the angle measured from the major axis counterclockwise. A negative value specifies the angle measured from the major axis clockwise. The initial value is zero by default.
	setStartParam	Sets the start parameter for the elliptical figure (ellipse or arc) (DXF 41). Parameter is an angle measured from the major axis in the range 0 to 2PI radians as if the elliptical figure was a circular figure with a major radius. A positive value specifies the start parameter measured counterclockwise A negative value specifies the start parameter measured clockwise. The initial value is zero by default.
	startAngle	Returns the start angle of the elliptical figure (ellipse or arc) in radians (DXF 50).
	subGetClassID	overridables
	subTransformBy
	subWorldDraw
	TD_USING	This is the overview for the TD_USING method overload.

Send feedback about this topic