mrpt::math::TLine2D Struct Reference

2D line without bounds, represented by its equation . More...

#include <mrpt/math/lightweight_geom_data.h>

List of all members.

Public Member Functions
double	evaluatePoint (const TPoint2D &point) const
	Evaluate point in the line's equation.
bool	contains (const TPoint2D &point) const
	Check whether a point is inside the line.
double	distance (const TPoint2D &point) const
	Distance from a given point.
void	getNormalVector (double(&vector)[2]) const
	Get line's normal vector.
void	unitarize ()
	Unitarize line's normal vector.
void	getUnitaryNormalVector (double(&vector)[2])
	Get line's normal vector after unitarizing line.
void	getDirectorVector (double(&vector)[2]) const
	Get line's director vector.
void	getUnitaryDirectorVector (double(&vector)[2])
	Unitarize line and then get director vector.
void	generate3DObject (TLine3D &l) const
	Project into 3D space, setting the z to 0.
void	getAsPose2D (mrpt::poses::CPose2D &outPose) const
	Get a pose2D whose X axis corresponds to the line.
void	getAsPose2DForcingOrigin (const TPoint2D &origin, mrpt::poses::CPose2D &outPose) const
	Get a pose2D whose X axis corresponds to the line, forcing the base point to one given.
	TLine2D (const TPoint2D &p1, const TPoint2D &p2) throw (std::logic_error)
	Constructor from two points, through which the line will pass.
	TLine2D (const TSegment2D &s)
	Constructor from a segment.
	TLine2D ()
	Fast default constructor.
	TLine2D (double A, double B, double C)
	Constructor from line's coefficients.
	TLine2D (const TLine3D &l)
	Construction from 3D object, discarding the Z.
Public Attributes
double	coefs [3]
	Line coefficients, stored as an array: .

---

Detailed Description

2D line without bounds, represented by its equation .

See also:

TLine3D,TSegment2D,TPolygon2D,TPoint2D

Definition at line 673 of file lightweight_geom_data.h.

---

Constructor & Destructor Documentation

mrpt::math::TLine2D::TLine2D	(	const TPoint2D &	p1,
		const TPoint2D &	p2
	)			throw (std::logic_error)

Constructor from two points, through which the line will pass.

Exceptions:

logic_error

if both points are the same

mrpt::math::TLine2D::TLine2D

(

const TSegment2D &

s

)

[explicit]

Constructor from a segment.

mrpt::math::TLine2D::TLine2D

(

)

[inline]

Fast default constructor.

Initializes to garbage.

Definition at line 744 of file lightweight_geom_data.h.

mrpt::math::TLine2D::TLine2D	(	double	A,
		double	B,
		double	C
	)			[inline]

Constructor from line's coefficients.

Definition at line 748 of file lightweight_geom_data.h.

mrpt::math::TLine2D::TLine2D

(

const TLine3D &

l

)

[explicit]

Construction from 3D object, discarding the Z.

Exceptions:

std::logic_error

if the line is normal to the XY plane.

---

Member Function Documentation

bool mrpt::math::TLine2D::contains

(

const TPoint2D &

point

)

const

Check whether a point is inside the line.

double mrpt::math::TLine2D::distance

(

const TPoint2D &

point

)

const

Distance from a given point.

double mrpt::math::TLine2D::evaluatePoint

(

const TPoint2D &

point

)

const

Evaluate point in the line's equation.

void mrpt::math::TLine2D::generate3DObject

(

TLine3D &

l

)

const

Project into 3D space, setting the z to 0.

void mrpt::math::TLine2D::getAsPose2D

(

mrpt::poses::CPose2D &

outPose

)

const

Get a pose2D whose X axis corresponds to the line.

See also:

mrpt::poses::CPose2D.

Referenced by mrpt::math::project2D().

void mrpt::math::TLine2D::getAsPose2DForcingOrigin	(	const TPoint2D &	origin,
		mrpt::poses::CPose2D &	outPose
	)			const

Get a pose2D whose X axis corresponds to the line, forcing the base point to one given.

Exceptions:

logic_error

if the point is not inside the line.

See also:

mrpt::poses::CPose2D.

Referenced by mrpt::math::project2D().

void mrpt::math::TLine2D::getDirectorVector

(

double(&)

vector[2]

)

const

Get line's director vector.

void mrpt::math::TLine2D::getNormalVector

(

double(&)

vector[2]

)

const

Get line's normal vector.

void mrpt::math::TLine2D::getUnitaryDirectorVector

(

double(&)

vector[2]

)

[inline]

Unitarize line and then get director vector.

Definition at line 713 of file lightweight_geom_data.h.

void mrpt::math::TLine2D::getUnitaryNormalVector

(

double(&)

vector[2]

)

[inline]

Get line's normal vector after unitarizing line.

Definition at line 702 of file lightweight_geom_data.h.

void mrpt::math::TLine2D::unitarize

(

)

Unitarize line's normal vector.

---

Member Data Documentation

double mrpt::math::TLine2D::coefs[3]

Line coefficients, stored as an array: .

Definition at line 678 of file lightweight_geom_data.h.

Referenced by mrpt::math::operator<<(), and mrpt::math::operator>>().