dlr::geometry::Ellipse2D Class Reference

The Ellipse2D class represents a planar ellipse in 2D space. More...

#include <ellipse2D.h>

List of all members.

Public Member Functions
	Ellipse2D ()
	The default constructor initializes to the unit circle.
	Ellipse2D (const dlr::numeric::Vector2D &origin, const dlr::numeric::Vector2D &semimajorAxis, double ratio)
	This constructor initializes the ellipse using explicitly specified values.
	Ellipse2D (const Ellipse2D &source)
	The copy constructor deep copies its argument.
	~Ellipse2D ()
	Destructor.
Ellipse2D &	operator= (const Ellipse2D &source)
	The assignment operator deep copies its argument.
const dlr::numeric::Vector2D &	getOrigin () const
	This member function returns the geometric center of the ellipse.
const dlr::numeric::Vector2D &	getSemimajorAxis () const
	This member function returns a vector pointing from the center of the ellipse to the point on the edge of the ellipse that is farthest from the center.
const dlr::numeric::Vector2D &	getSemiminorAxis () const
	This member function returns a vector pointing from the center of the ellipse to the point on the edge of the ellipse that is closest to the center.

---

Detailed Description

The Ellipse2D class represents a planar ellipse in 2D space.

Definition at line 28 of file ellipse2D.h.

---

Constructor & Destructor Documentation

dlr::geometry::Ellipse2D::Ellipse2D

(

)

[inline]

The default constructor initializes to the unit circle.

Definition at line 159 of file ellipse2D.h.

dlr::geometry::Ellipse2D::Ellipse2D	(	const dlr::numeric::Vector2D &	origin,
		const dlr::numeric::Vector2D &	semimajorAxis,
		double	ratio
	)			[inline]

This constructor initializes the ellipse using explicitly specified values.

Parameters:

	origin	This argument specifies the position of the geometric center of the ellipse.
	majorAxis	This argument represents a vector pointing from the center of the ellipse to one of the two points on the boundary of the ellipse that is farthest from the center.
	ratio	This argument specifies the length of the minor axis as a proportion of the lenth of the major axis. It must be less than or equal to 1.0.

Definition at line 171 of file ellipse2D.h.

dlr::geometry::Ellipse2D::Ellipse2D

(

const Ellipse2D &

source

)

[inline]

The copy constructor deep copies its argument.

Parameters:

source

This argument is the class instance to be copied.

Definition at line 186 of file ellipse2D.h.

dlr::geometry::Ellipse2D::~Ellipse2D

(

)

[inline]

Destructor.

Definition at line 71 of file ellipse2D.h.

---

Member Function Documentation

const dlr::numeric::Vector2D& dlr::geometry::Ellipse2D::getOrigin

(

)

const [inline]

This member function returns the geometric center of the ellipse.

Returns:

The return value is the point at the centroid of the ellipse.

Definition at line 92 of file ellipse2D.h.

const dlr::numeric::Vector2D& dlr::geometry::Ellipse2D::getSemimajorAxis

(

)

const [inline]

This member function returns a vector pointing from the center of the ellipse to the point on the edge of the ellipse that is farthest from the center.

Note that there are two such farthest points on opposite sides of the ellipse. The vector returned by this member function will remain consistent for the life of the ellipse, and will reflect the semimajor axis specified as a constructor argument (if the three-argument constructor was used).

Returns:

The return value is a vector pointing along the semimajor axis of the ellipse.

Definition at line 109 of file ellipse2D.h.

const dlr::numeric::Vector2D& dlr::geometry::Ellipse2D::getSemiminorAxis

(

)

const [inline]

This member function returns a vector pointing from the center of the ellipse to the point on the edge of the ellipse that is closest to the center.

Note that there are two such closest points on opposite sides of the ellipse. The vector returned by this member function will remain consistent for the life of the ellipse, and will be normally be rotated 90 degrees counterclockwise from the vector returned by getSemiMajorAxis().

Returns:

The return value is a vector pointing along the semiminor axis of the ellipse.

Definition at line 126 of file ellipse2D.h.

Ellipse2D & dlr::geometry::Ellipse2D::operator=

(

const Ellipse2D &

source

)

[inline]

The assignment operator deep copies its argument.

Parameters:

source

This argument is the class instance to be copied.

Returns:

The return value is a reference to *this.

Definition at line 198 of file ellipse2D.h.

References m_origin, m_semimajorAxis, and m_semiminorAxis.

---

The documentation for this class was generated from the following file:

• ellipse2D.h