DGtal::StraightLineFrom2Points< TPoint > Class Template Reference

#include <StraightLineFrom2Points.h>

Collaboration diagram for DGtal::StraightLineFrom2Points< TPoint >:

Public Types
typedef TPoint::Coordinate	Coordinate
typedef Coordinate	Distance
typedef TPoint	Point
typedef TPoint	Vector

Public Member Functions
	StraightLineFrom2Points ()
	StraightLineFrom2Points (const Point &aFirstPoint, const Point &aSecondPoint)
void	init (const Point &aFirstPoint, const Point &aSecondPoint)
	StraightLineFrom2Points (const StraightLineFrom2Points &other)
StraightLineFrom2Points &	operator= (const StraightLineFrom2Points &other)
	~StraightLineFrom2Points ()
void	selfDisplay (std::ostream &out) const
bool	isValid () const
Distance	signedDistance (const Point &aP) const
const Point &	p () const
const Point &	q () const
std::string	className () const

Private Attributes
Point	myP
Point	myQ

---

Detailed Description

template<typename TPoint>
class DGtal::StraightLineFrom2Points< TPoint >

Aim: Represents a straight line uniquely defined by two 2D points and that is able to return for any given 2D point its signed distance to itself.

Template Parameters:

TPoint

a type of points.

Definition at line 68 of file StraightLineFrom2Points.h.

---

Member Typedef Documentation

template<typename TPoint>

typedef TPoint::Coordinate DGtal::StraightLineFrom2Points< TPoint >::Coordinate

Definition at line 74 of file StraightLineFrom2Points.h.

template<typename TPoint>

typedef Coordinate DGtal::StraightLineFrom2Points< TPoint >::Distance

Definition at line 75 of file StraightLineFrom2Points.h.

template<typename TPoint>

typedef TPoint DGtal::StraightLineFrom2Points< TPoint >::Point

Definition at line 76 of file StraightLineFrom2Points.h.

template<typename TPoint>

typedef TPoint DGtal::StraightLineFrom2Points< TPoint >::Vector

Definition at line 77 of file StraightLineFrom2Points.h.

---

Constructor & Destructor Documentation

template<typename TPoint >

DGtal::StraightLineFrom2Points< TPoint >::StraightLineFrom2Points ( )

inline

Default constructor.

Definition at line 49 of file StraightLineFrom2Points.ih.

{
}

template<typename TPoint >

DGtal::StraightLineFrom2Points< TPoint >::StraightLineFrom2Points ( const Point &  aFirstPoint, const Point &  aSecondPoint  )

inline

Constructor.

Parameters:

firstPoint	a point
secondPoint	another point

Definition at line 67 of file StraightLineFrom2Points.ih.

                                  :
        myP(aFirstPoint),
        myQ(aSecondPoint)
{