C2DCircle Class Reference

class which represents a circle. More...

#include <2DCircle.h>

Inheritance diagram for C2DCircle:

List of all members.

Public Member Functions
	C2DCircle (void)
	Constructor.
	C2DCircle (const C2DPoint &Point, double dRadius)
	Constructor.
	C2DCircle (const C2DCircle &Other)
	Copy constructor.
	~C2DCircle (void)
	Destructor.
void	Set (const C2DPoint &Centre, double dRadius)
	Set.
void	SetCentre (const C2DPoint &Centre)
	Set centre.
void	SetRadius (double dRadius)
	Set radius.
void	SetMinimum (const C2DPoint &Point1, const C2DPoint &Point2)
	Set to be the minimum bounding circle for the 2 points.
void	SetMinimum (const C2DPoint &Point1, const C2DPoint &Point2, const C2DPoint &Point3)
	Set to be the minimum bounding circle for the 3 points.
void	SetInscribed (const C2DPoint &Point1, const C2DPoint &Point2, const C2DPoint &Point3)
	Sets the circle to be the maximum contained circle within the 3 points provided.
void	SetInscribed (const C2DTriangle &Triangle)
	Sets the circle to be the maximum contained circle within the 3 points provided.
bool	SetCircumscribed (const C2DPoint &Point1, const C2DPoint &Point2, const C2DPoint &Point3)
	Set to be circle that places all 3 points on the edge.
bool	SetCircumscribed (const C2DTriangle &Triangle)
	Set to be circle that places all 3 points of the triangle on the edge.
const C2DPoint &	GetCentre (void) const
	Returns the centre.
double	GetRadius (void) const
	Returns the radius.
double	GetArea (void) const
	Returns the area.
double	GetPerimeter (void) const
	Returns the perimeter.
const C2DCircle &	operator= (const C2DCircle &Other)
	Assignment.
void	GetBoundingRect (C2DRect &Rect) const
	Bounding rect.
bool	Crosses (const C2DCircle &Other, C2DPointSet *IntersectionPts=0) const
	Circle-circle intersection.
bool	Crosses (const C2DLine &Line, C2DPointSet *IntersectionPts=0) const
	Circle-line intersection.
bool	CrossesRay (const C2DLine &Ray, C2DPointSet *IntersectionPts=0) const
	Circle-ray intersection.
bool	Contains (const C2DPoint &pt) const
	Containment.
bool	IsWithinDistance (const C2DPoint &pt, double dRange) const
	Proximity.
void	Move (const C2DVector &Vector)
	Move by the verctor.
void	RotateToRight (double dAng, const C2DPoint &Origin)
	Rotation.
void	Grow (double dFactor, const C2DPoint &Origin)
	Grow around the origin.
void	Reflect (const C2DPoint &Point)
	Reflection.
void	Reflect (const C2DLine &Line)
	Reflects throught the line provided.
double	Distance (const C2DPoint &TestPoint) const
	Distance to a point.
double	Distance (const C2DPoint &TestPoint, C2DPoint *ptOnThis=0) const
	Distance to a point, returns the closest point on the circle.
double	Distance (const C2DLine &Line, C2DPoint *ptOnThis=0, C2DPoint *ptOnOther=0) const
	Distance to the line, can retrieve closest points.
double	Distance (const C2DCircle &Other, C2DPoint *ptOnThis=0, C2DPoint *ptOnOther=0) const
	Distance to the other circles, can retrieve closest points.
void	Project (const C2DLine &Line, CInterval &Interval) const
	Projection onto the line.
void	Project (const C2DVector &Vector, CInterval &Interval) const
	Projection onto the vector.
void	SnapToGrid (void)
	Snaps to the conceptual grid.

---

Detailed Description

class which represents a circle.

Class which represents a circle.

---------------------------------------------------------------------------

---

Constructor & Destructor Documentation

C2DCircle::C2DCircle (  void   )

Constructor. -------------------------------------------------------------------------- C2DCircle::C2DCircle ---------------------------------------------------------------------------

C2DCircle::C2DCircle (  const C2DPoint &  Centre, double  dRadius )

Constructor. -------------------------------------------------------------------------- C2DCircle::C2DCircle ---------------------------------------------------------------------------

C2DCircle::C2DCircle (  const C2DCircle &  Other  )

Copy constructor. -------------------------------------------------------------------------- C2DCircle::C2DCircle ---------------------------------------------------------------------------

C2DCircle::~C2DCircle (  void   )

Destructor. -------------------------------------------------------------------------- C2DCircle::C2DCircle ---------------------------------------------------------------------------

---

Member Function Documentation

bool C2DCircle::Contains (  const C2DPoint &  pt  )  const

Containment. -------------------------------------------------------------------------- C2DCircle::Contains. ---------------------------------------------------------------------------

bool C2DCircle::Crosses (  const C2DLine &  Line, C2DPointSet *  IntersectionPts = 0 )  const

Circle-line intersection. -------------------------------------------------------------------------- C2DCircle::Crosses. ---------------------------------------------------------------------------

bool C2DCircle::Crosses (  const C2DCircle &  Other, C2DPointSet *  IntersectionPts = 0 )  const

Circle-circle intersection. -------------------------------------------------------------------------- C2DCircle::Crosses ---------------------------------------------------------------------------

bool C2DCircle::CrossesRay (  const C2DLine &  Ray, C2DPointSet *  IntersectionPts = 0 )  const

Circle-ray intersection. -------------------------------------------------------------------------- C2DCircle::CrossesRay. ---------------------------------------------------------------------------

double C2DCircle::Distance (  const C2DCircle &  Other, C2DPoint *  ptOnThis = 0, C2DPoint *  ptOnOther = 0 )  const

Distance to the other circles, can retrieve closest points. -------------------------------------------------------------------------- C2DCircle::Distance. ---------------------------------------------------------------------------

double C2DCircle::Distance (  const C2DLine &  Line, C2DPoint *  ptOnThis = 0, C2DPoint *  ptOnOther = 0 )  const

Distance to the line, can retrieve closest points. -------------------------------------------------------------------------- C2DCircle::Distance. ---------------------------------------------------------------------------

double C2DCircle::Distance (  const C2DPoint &  TestPoint, C2DPoint *  ptOnThis = 0 )  const

Distance to a point, returns the closest point on the circle. -------------------------------------------------------------------------- C2DCircle::Distance. ---------------------------------------------------------------------------

double C2DCircle::Distance (  const C2DPoint &  TestPoint  )  const [virtual]

Distance to a point. -------------------------------------------------------------------------- C2DCircle::Distance. --------------------------------------------------------------------------- Implements C2DBase.

double C2DCircle::GetArea (  void   )  const

Returns the area. -------------------------------------------------------------------------- C2DCircle::GetArea ---------------------------------------------------------------------------

void C2DCircle::GetBoundingRect (  C2DRect &  Rect  )  const [virtual]

Bounding rect. -------------------------------------------------------------------------- C2DCircle::C2DCircle. --------------------------------------------------------------------------- Implements C2DBase.

double C2DCircle::GetPerimeter (  void   )  const

Returns the perimeter. -------------------------------------------------------------------------- C2DCircle::GetPerimeter ---------------------------------------------------------------------------

double C2DCircle::GetRadius (  void   )  const

Returns the radius. -------------------------------------------------------------------------- C2DCircle::GetRadius ---------------------------------------------------------------------------

void C2DCircle::Grow (  double  dFactor, const C2DPoint &  Origin )  [virtual]

Grow around the origin. -------------------------------------------------------------------------- C2DCircle::Grow. --------------------------------------------------------------------------- Implements C2DBase.

bool C2DCircle::IsWithinDistance (  const C2DPoint &  pt, double  dRange )  const

Proximity. -------------------------------------------------------------------------- C2DCircle::IsWithinDistance. ---------------------------------------------------------------------------

void C2DCircle::Move (  const C2DVector &  Vector  )  [virtual]

Move by the verctor. -------------------------------------------------------------------------- C2DCircle::Move --------------------------------------------------------------------------- Implements C2DBase.

const C2DCircle & C2DCircle::operator= (  const C2DCircle &  Other  )

Assignment. -------------------------------------------------------------------------- C2DCircle::C2DCircle. ---------------------------------------------------------------------------

void C2DCircle::Project (  const C2DVector &  Vector, CInterval &  Interval )  const [virtual]

Projection onto the vector. -------------------------------------------------------------------------- C2DCircle::Project. --------------------------------------------------------------------------- Implements C2DBase.

void C2DCircle::Project (  const C2DLine &  Line, CInterval &  Interval )  const [virtual]

Projection onto the line. -------------------------------------------------------------------------- C2DCircle::Project. --------------------------------------------------------------------------- Implements C2DBase.

void C2DCircle::Reflect (  const C2DLine &  Line  )  [virtual]

Reflects throught the line provided. -------------------------------------------------------------------------- C2DCircle::Reflect. --------------------------------------------------------------------------- Implements C2DBase.

void C2DCircle::Reflect (  const C2DPoint &  Point  )  [virtual]

Reflection. -------------------------------------------------------------------------- C2DCircle::Reflect. --------------------------------------------------------------------------- Implements C2DBase.

void C2DCircle::RotateToRight (  double  dAng, const C2DPoint &  Origin )  [virtual]

Rotation. -------------------------------------------------------------------------- C2DCircle::RotateToRight. --------------------------------------------------------------------------- Implements C2DBase.

void C2DCircle::Set (  const C2DPoint &  Centre, double  dRadius )

Set. -------------------------------------------------------------------------- C2DCircle::Set ---------------------------------------------------------------------------

bool C2DCircle::SetCircumscribed (  const C2DTriangle &  Triangle  )

Set to be circle that places all 3 points of the triangle on the edge. -------------------------------------------------------------------------- C2DCircle::SetCircumscribed ---------------------------------------------------------------------------

bool C2DCircle::SetCircumscribed (  const C2DPoint &  Point1, const C2DPoint &  Point2, const C2DPoint &  Point3 )

Set to be circle that places all 3 points on the edge. -------------------------------------------------------------------------- C2DCircle::SetCircumscribed ---------------------------------------------------------------------------

void C2DCircle::SetInscribed (  const C2DTriangle &  Triangle  )

Sets the circle to be the maximum contained circle within the 3 points provided. -------------------------------------------------------------------------- C2DCircle::SetInscribed. ---------------------------------------------------------------------------

void C2DCircle::SetInscribed (  const C2DPoint &  Point1, const C2DPoint &  Point2, const C2DPoint &  Point3 )

Sets the circle to be the maximum contained circle within the 3 points provided. -------------------------------------------------------------------------- C2DCircle::SetInscribed. ---------------------------------------------------------------------------

void C2DCircle::SetMinimum (  const C2DPoint &  Point1, const C2DPoint &  Point2, const C2DPoint &  Point3 )

Set to be the minimum bounding circle for the 3 points. -------------------------------------------------------------------------- C2DCircle::SetMinimum ---------------------------------------------------------------------------

void C2DCircle::SetMinimum (  const C2DPoint &  Point1, const C2DPoint &  Point2 )

Set to be the minimum bounding circle for the 2 points. -------------------------------------------------------------------------- C2DCircle::SetMinimum ---------------------------------------------------------------------------

void C2DCircle::SnapToGrid (  void   )  [virtual]

Snaps to the conceptual grid. -------------------------------------------------------------------------- C2DPoint::SnapToGrid --------------------------------------------------------------------------- Implements C2DBase.

---

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

• C:/GeoLib 3.0/GeoLib 3.0/GeoLib Source/2DCircle.h
• C:/GeoLib 3.0/GeoLib 3.0/GeoLib Source/2DCircle.cpp

---