dlr::geometry::Circle2D Class Reference

The Circle2D class represents a circle in 2D space. More...

#include <circle2D.h>

List of all members.

Public Member Functions
	Circle2D ()
	The default constructor initializes to the unit circle.
	Circle2D (const dlr::numeric::Vector2D &origin, double radius)
	This constructor initializes the circle using explicitly specified values.
	Circle2D (const Circle2D &source)
	The copy constructor deep copies its argument.
	~Circle2D ()
	Destructor.
Circle2D &	operator= (const Circle2D &source)
	The assignment operator deep copies its argument.
dlr::numeric::Vector2D const &	getOrigin () const
	This member function returns the geometric center of the circle.
double	getRadius () const
	This member function returns the radius of the circle.

---

Detailed Description

The Circle2D class represents a circle in 2D space.

Definition at line 28 of file circle2D.h.

---

Constructor & Destructor Documentation

dlr::geometry::Circle2D::Circle2D

(

)

[inline]

The default constructor initializes to the unit circle.

Definition at line 128 of file circle2D.h.

dlr::geometry::Circle2D::Circle2D	(	const dlr::numeric::Vector2D &	origin,
		double	radius
	)			[inline]

This constructor initializes the circle using explicitly specified values.

Parameters:

	origin	This argument specifies the position of the geometric center of the circle.
	radius	This argument specifies the radius of the circle. If the value of radius is less than 0.0, it will be multiplied by -1.

Definition at line 139 of file circle2D.h.

dlr::geometry::Circle2D::Circle2D

(

const Circle2D &

source

)

[inline]

The copy constructor deep copies its argument.

Parameters:

source

This argument is the class instance to be copied.

Definition at line 152 of file circle2D.h.

dlr::geometry::Circle2D::~Circle2D

(

)

[inline]

Destructor.

Definition at line 66 of file circle2D.h.

---

Member Function Documentation

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

(

)

const [inline]

This member function returns the geometric center of the circle.

Returns:

The return value is the point at the center of the circle.

Definition at line 87 of file circle2D.h.

double dlr::geometry::Circle2D::getRadius

(

)

const [inline]

This member function returns the radius of the circle.

Returns:

The return value is the radius of the circle.

Definition at line 96 of file circle2D.h.

Circle2D & dlr::geometry::Circle2D::operator=

(

const Circle2D &

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 163 of file circle2D.h.

References m_origin, and m_radius.

---

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

• circle2D.h