Defines 3D ellipse. More...

#include <cadex/ModelData_Ellipse.hxx>

Inheritance diagram for cadex::ModelData_Ellipse:

Public Types
typedef cadex::internal::ModelData_EllipseImpl	ImplType

Public Member Functions
	ModelData_Ellipse ()
	Constructor.

	ModelData_Ellipse (const ModelData_Axis2Placement &thePosition, double theMajorRadius, double theMinorRadius)
	Constructor.

	ModelData_Ellipse (const Handle_C &)
	Constructor.

double	MajorRadius () const
	Returns a major radius.

double	MinorRadius () const
	Returns a minor radius.

Public Member Functions inherited from cadex::ModelData_Conic
	ModelData_Conic ()
	Constructor.

const ModelData_Axis2Placement &	Position () const
	Returns an axis placement.

double	Parameter (const ModelData_Point &thePoint) const
	Returns parameter for a 3D point.

Public Member Functions inherited from cadex::ModelData_Curve
	ModelData_Curve ()
	Constructor.

	ModelData_Curve (const ModelData_Curve &theOther)
	Constructor.

	ModelData_Curve (ModelData_Curve &&theOther)
	Constructor.

	~ModelData_Curve ()
	Destructor.

ModelData_Curve &	operator= (const ModelData_Curve &theOther)
	Assignment operator.

ModelData_Curve &	operator= (ModelData_Curve &&theOther)
	Move assignment operator.

ModelData_CurveType	Type () const
	Returns a curve type.

bool	IsNull () const
	Returns true if the object has not been initialized yet.

void	Nullify ()
	Resets the object.

	operator bool () const
	Returns if the object has been initialized.

bool	IsPeriodic () const
	Returns true if the curve is periodic.

double	UMin () const
	Returns a minimum parameter of a definition domain.

double	UMax () const
	Returns a maximum parameter of a definition domain.

void	Domain (double &theUMin, double &theUMax) const
	Returns a definition domain.

ModelData_Point	Value (double theParameter) const
	Evaluates a point on the curve.

ModelData_Curve	Reversed () const
	Returns a curve with reversed orientation.

void	Transform (const ModelData_Transformation &theTransformation)
	Applies transformation matrix to this object.

ModelData_Curve	Transformed (const ModelData_Transformation &theTransformation) const
	Returns a copy this object after applying transformation.

ModelData_Continuity	Continuity () const
	Returns a continuity type of the curve.

void	D0 (double theParameter, ModelData_Point &theValue) const
	Returns the point theValue of parameter theParam.

void	D1 (double theParameter, ModelData_Point &theValue, ModelData_Vector &theD1) const
	Returns the point theValue of parameter theParam and the first derivative theD1.

void	D2 (double theParameter, ModelData_Point &theValue, ModelData_Vector &theD1, ModelData_Vector &theD2) const
	Returns the point theValue of parameter theParam, the first theD1 and second theD2 derivatives.

bool	DN (double theParameter, size_t theDerivativeOrder, ModelData_Point &theValue, ModelData_Vector theD[]) const

double	Curvature (double theParameter) const
	Returns the curvature value of parameter theParam.

void	Normal (double theParameter, ModelData_Direction &theNormal) const
	Returns the normal direction theNormal of parameter theParam.

void	Mirror (const ModelData_Point &thePoint)
	Mirrors the curve relative to the point.

void	Mirror (const ModelData_Axis1Placement &theAxis)
	Mirrors the curve relative to the axis placement.

void	Mirror (const ModelData_Axis2Placement &theAxis)
	Mirrors the curve relative to the axis placement.

ModelData_Curve	Mirrored (const ModelData_Point &theRef) const
	Returns a copy this curve mirrored along the object.

ModelData_Curve	Mirrored (const ModelData_Axis1Placement &theAxis) const
	Returns a copy this curve mirrored along the object.

ModelData_Curve	Mirrored (const ModelData_Axis2Placement &theAxis) const
	Returns a copy this curve mirrored along the object.

void	Rotate (const ModelData_Axis1Placement &theAxis, double theAngle)
	Rotates the curve around the axis.

ModelData_Curve	Rotated (const ModelData_Axis1Placement &theAxis, double theAngle) const
	Returns a copy this curve rotated along the axis.

void	Translate (const ModelData_Vector &theVector)
	Translates the curve along the vector.

ModelData_Curve	Translated (const ModelData_Vector &theVector) const
	Returns a copy this curve translated along the vector.

void	Scale (const ModelData_Point &thePoint, double theScale)
	Scales the curve with respect to the point.

ModelData_Curve	Scaled (const ModelData_Point &thePoint, double theScale) const
	Returns a copy this curve scaled with respect to the point.

Public Attributes
	operator Handle_C const

Public Attributes inherited from cadex::ModelData_Conic
	operator Handle_C const

Public Attributes inherited from cadex::ModelData_Curve
	operator Handle_C const

Detailed Description

Defines 3D ellipse.

An ellipse is defined by axis placement, major and minor radii. The following image depicts an ellipse example:

Ellipse

An ellipse is a periodic curve parametrized as follows: \(\mathbf{C}(t) = \mathbf{P} + R_{major}\cos(t)\mathbf{X} + R_{minor}\sin(t)\mathbf{Y}\), where

\(\mathbf{P}\) is an origin point,
\(\mathbf{X}\) and \(\mathbf{Y}\) are directions,
\(R_{major}\) and \(R_{minor}\) are major and minor radii,
\(t\) belongs to \([0, 2\pi]\).

Note that major radius is always along the X-axis and minor radius - along the Y-axis, and that the \(\mathbf{C}(0)\) point lies on the major radius.

See also: ModelData_Ellipse2d.

Examples: exploring/brepgeometry/Program.cs, exploring/brepgeometry/main.cxx, modeling/brep/Program.cs, and modeling/brep/main.cxx.

Constructor & Destructor Documentation

◆ ModelData_Ellipse() [1/2]

cadex::ModelData_Ellipse::ModelData_Ellipse ( )

inline

Constructor.

Empty constructor.

◆ ModelData_Ellipse() [2/2]

cadex::ModelData_Ellipse::ModelData_Ellipse	(	const ModelData_Axis2Placement &	thePosition,
		double	theMajorRadius,
		double	theMinorRadius
	)

Constructor.

Creates an ellipse from axis placement, major and minor radii.

Member Function Documentation

◆ MajorRadius()

double cadex::ModelData_Ellipse::MajorRadius ( ) const

Returns a major radius.

Returns the value specified in the constructor.

Examples: exploring/brepgeometry/Program.cs, and exploring/brepgeometry/main.cxx.

◆ MinorRadius()

double cadex::ModelData_Ellipse::MinorRadius ( ) const

Returns a minor radius.