Defines 3D ellipse. More...

#include <cadex/Geom/Ellipse.hxx>

Inheritance diagram for cadex::Geom::Ellipse:

Public Member Functions
	Ellipse ()
	Constructor.

	Ellipse (const Axis3d &thePosition, double theMajorRadius, double theMinorRadius)
	Constructor.

double	MajorRadius () const
	Returns a major radius.

double	MinorRadius () const
	Returns a minor radius.

Public Member Functions inherited from cadex::Geom::Conic
	Conic ()
	Constructor.

Axis3d	Position () const
	Returns an axis.

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

Public Member Functions inherited from cadex::Geom::Curve
	Curve ()
	Constructor.

CurveType	Type () const

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

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

Direction	Normal (double theParameter) const
	Returns the normal direction theNormal of parameter theParam.

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

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.

bool	IsTrimmed () const
	Returns whether curve is trimmed or not.

void	SetTrim (double theFirst, double theLast)
	Trims curve with [theFirst, theLast] section.

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

Curve	Transformed (const Transformation &theTransformation) const
	Returns a copy this object after applying transformation.

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

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

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

bool	DN (double theParameter, size_t theDerivativeOrder, Geom::Point &theValue, std::vector< Geom::Vector > &theD) const

void	Mirror (const Point &thePoint)

void	Mirror (const Axis1d &theAxis)

void	Mirror (const Axis3d &theAxis)

Curve	Mirrored (const Point &theRef) const

Curve	Mirrored (const Axis1d &theAxis) const

Curve	Mirrored (const Axis3d &theAxis) const

void	Rotate (const Axis1d &theAxis, double theAngle)

Curve	Rotated (const Axis1d &theAxis, double theAngle) const

void	Translate (const Vector &theVector)

Curve	Translated (const Vector &theVector) const

void	Scale (const Point &thePoint, double theScale)

Curve	Scaled (const Point &thePoint, double theScale) const

Public Member Functions inherited from cadex::BaseObject
size_t	Id () const
	Return unique identifier of public object.

internal::BaseObjectImpl *	Impl () const

bool	IsNull () const

	operator bool () const

template<typename T >
bool	IsOfType () const

template<typename T >
T *	Impl () const
	Reserved for internal use.

Static Public Member Functions
static bool	CompareType (const BaseObject &theObject)

Static Public Member Functions inherited from cadex::Geom::Conic
static bool	CompareType (const BaseObject &theObject)

Static Public Member Functions inherited from cadex::Geom::Curve
static bool	CompareType (const BaseObject &theObject)

Static Public Member Functions inherited from cadex::Geom::Geometry
static bool	CompareType (const BaseObject &theObject)

Additional Inherited Members
Public Types inherited from cadex::BaseObject
typedef std::shared_ptr< internal::BaseObjectImpl >	ImplType

Protected Member Functions inherited from cadex::Geom::Conic
	Conic (const ImplType &theImpl)

Protected Member Functions inherited from cadex::Geom::Curve
	Curve (const ImplType &theImpl)

Protected Member Functions inherited from cadex::Geom::Geometry
	Geometry (const ImplType &theImpl)

Protected Member Functions inherited from cadex::BaseObject
	BaseObject (const ImplType &theImpl)

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: Ellipse2d.

Constructor & Destructor Documentation

◆ Ellipse()

cadex::Geom::Ellipse::Ellipse	(	const Axis3d &	thePosition,
		double	theMajorRadius,
		double	theMinorRadius )

Constructor.

Creates an ellipse from axis, major and minor radii.

Member Function Documentation

◆ MajorRadius()

double cadex::Geom::Ellipse::MajorRadius ( ) const

Returns a major radius.

Returns the value specified in the constructor.

◆ MinorRadius()

double cadex::Geom::Ellipse::MinorRadius ( ) const

Returns a minor radius.