#include <linesegment2d.h>

Inheritance diagram for tuw::LineSegment2D:

[legend]

Public Member Functions
double	angle () const

double	closestPointLineSegmentRatio (const Point2D &p) const

Point2D	closestPointTo (const Point2D &p) const

double	distanceSqrTo (const Point2D &p, double &dx, double &dy) const

double	distanceTo (const Point2D &p) const

double	distanceTo (const Point2D &p, double &dx, double &dy) const

const double	length () const

const Line2D &	line () const

	LineSegment2D ()
	the lines endpoints More...

	LineSegment2D (const double &x0, const double &y0, const double &x1, const double &y1)

	LineSegment2D (const LineSegment2D &l)

	LineSegment2D (const Point2D &p0, const Point2D &p1)

bool	operator== (const LineSegment2D &o) const
	comparison operator More...

const Point2D &	p0 () const

const Point2D &	p1 () const

Point2D	pc () const

LineSegment2D &	set (const double &x0, const double &y0, const double &x1, const double &y1)

LineSegment2D &	set (const Point2D &p0, const Point2D &p1)

const double &	x0 () const

const double &	x1 () const

const double &	y0 () const

const double &	y1 () const

Public Member Functions inherited from tuw::Line2D
double &	a ()

const double &	a () const

double &	b ()

const double &	b () const

double &	c ()

const double &	c () const

cv::Vec< double, 3 > &	cv ()

const cv::Vec< double, 3 > &	cv () const

double	distanceTo (const double &x, const double &y) const

double	distanceTo (const Point2D &p) const

Point2D	intersection (const Line2D &l) const

	Line2D ()
	constructor More...

	Line2D (const double &x0, const double &y0, const double &x1, const double &y1, bool normalize=true)

	Line2D (const Line2D &l)

	Line2D (const Point2D &pt1, const Point2D &pt2, bool normalize=true)

	Line2D (cv::Vec< double, 3 > &l, bool normalize=true)

cv::Vec< double, 2 >	normal () const

void	normalize ()

Point2D	pointOnLine (const double &x, const double &y) const

Point2D	pointOnLine (const Point2D &p) const

Line2D &	set (const double &x0, const double &y0, const double &x1, const double &y1, bool normalize=true)

Line2D &	set (const Point2D &p0, const Point2D &p1, bool normalize=true)

Polar2D	toPolar () const

Protected Attributes
Point2D	p0_

Point2D	p1_

Friends
std::ostream &	operator<< (std::ostream &os, const LineSegment2D &o)

Detailed Description

class to represent a 2D line with its endpoints and as equation a*x + b*y + c = 0

Definition at line 15 of file linesegment2d.h.

Constructor & Destructor Documentation

◆ LineSegment2D() [1/4]

LineSegment2D::LineSegment2D ( )

the lines endpoints

constructor

Definition at line 4 of file linesegment2d.cpp.

◆ LineSegment2D() [2/4]

LineSegment2D::LineSegment2D ( const LineSegment2D & l )

copy constructor

Parameters

l	LineSegment2D

Definition at line 5 of file linesegment2d.cpp.

◆ LineSegment2D() [3/4]

LineSegment2D::LineSegment2D	(	const Point2D &	p0,
		const Point2D &	p1
	)

constructor to create a line from points

Parameters

p0
p1

Definition at line 10 of file linesegment2d.cpp.

◆ LineSegment2D() [4/4]

LineSegment2D::LineSegment2D	(	const double &	x0,
		const double &	y0,
		const double &	x1,
		const double &	y1
	)

constructor to create a line from points

Parameters

x0
y0
x1
y1

Definition at line 15 of file linesegment2d.cpp.

Member Function Documentation

◆ angle()

double LineSegment2D::angle ( ) const

orientation of the line in space @retun angle between -PI and PI

Definition at line 32 of file linesegment2d.cpp.

◆ closestPointLineSegmentRatio()

double LineSegment2D::closestPointLineSegmentRatio ( const Point2D & p ) const

Definition at line 96 of file linesegment2d.cpp.

◆ closestPointTo()

Point2D LineSegment2D::closestPointTo ( const Point2D & p ) const

computes closest point along segment

Parameters

p point

Returns: closest point along segment to the given point

Definition at line 105 of file linesegment2d.cpp.

◆ distanceSqrTo()

double LineSegment2D::distanceSqrTo	(	const Point2D &	p,
		double &	dx,
		double &	dy
	)		const

computes distance to line segment

See also: http://stackoverflow.com/questions/849211/shortest-distance-between-a-point-and-a-line-segment

Parameters

p	point
dx	vector to point x
dx	vector to point y

Returns: distance to line between the segment endpoints or the distance to the nearest endpoints

computes squared distance to line segment

See also: http://stackoverflow.com/questions/849211/shortest-distance-between-a-point-and-a-line-segment

Parameters

p	point
dx	vector to point x
dx	vector to point y

Returns: distance to line between the segment endpoints or the distance to the nearest endpoints

Definition at line 82 of file linesegment2d.cpp.

◆ distanceTo() [1/2]

double LineSegment2D::distanceTo ( const Point2D & p ) const

computes distance to line segment

See also: http://stackoverflow.com/questions/849211/shortest-distance-between-a-point-and-a-line-segment

Returns: distance to line between the segment endpoints or the distance to the nearest endpoints

computes distance to line segment

See also: http://stackoverflow.com/questions/849211/shortest-distance-between-a-point-and-a-line-segment

Parameters

p point

Returns: distance to line between the segment endpoints or the distance to the nearest endpoints

Definition at line 116 of file linesegment2d.cpp.

◆ distanceTo() [2/2]

double LineSegment2D::distanceTo	(	const Point2D &	p,
		double &	dx,
		double &	dy
	)		const

computes distance to line segment

See also: http://stackoverflow.com/questions/849211/shortest-distance-between-a-point-and-a-line-segment

Parameters

p	point
dx	vector to point x
dx	vector to point y

Returns: distance to line between the segment endpoints or the distance to the nearest endpoints

Definition at line 73 of file linesegment2d.cpp.

◆ length()

const double LineSegment2D::length ( ) const

Returns: length of the line

Definition at line 51 of file linesegment2d.cpp.

◆ line()

const Line2D & LineSegment2D::line ( ) const

Returns: the line function of the base class

Definition at line 48 of file linesegment2d.cpp.

◆ operator==()

bool LineSegment2D::operator== ( const LineSegment2D & o ) const

comparison operator

Returns: true on equal; true on equal

Definition at line 55 of file linesegment2d.cpp.

◆ p0()

const Point2D & LineSegment2D::p0 ( ) const

Returns: startpoint

Definition at line 42 of file linesegment2d.cpp.

◆ p1()

const Point2D & LineSegment2D::p1 ( ) const

Returns: endpoint

Definition at line 45 of file linesegment2d.cpp.

◆ pc()

Point2D LineSegment2D::pc ( ) const

Returns: center point between p0 and p1

Definition at line 37 of file linesegment2d.cpp.

◆ set() [1/2]

LineSegment2D & LineSegment2D::set	(	const double &	x0,
		const double &	y0,
		const double &	x1,
		const double &	y1
	)

sets a line from points

Parameters

x0
y0
x1
y1

Definition at line 58 of file linesegment2d.cpp.

◆ set() [2/2]

LineSegment2D & LineSegment2D::set	(	const Point2D &	p0,
		const Point2D &	p1
	)

sets a line from points

Parameters

p0
p1

Definition at line 63 of file linesegment2d.cpp.

◆ x0()

const double & LineSegment2D::x0 ( ) const

Returns: startpoint x

Definition at line 20 of file linesegment2d.cpp.

◆ x1()

const double & LineSegment2D::x1 ( ) const

Returns: endpoint x

Definition at line 26 of file linesegment2d.cpp.

◆ y0()

const double & LineSegment2D::y0 ( ) const

Returns: startpoint y

Definition at line 23 of file linesegment2d.cpp.

◆ y1()

const double & LineSegment2D::y1 ( ) const

Returns: endpoint y

Definition at line 29 of file linesegment2d.cpp.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const LineSegment2D &	o
	)

friend

Definition at line 128 of file linesegment2d.h.

Member Data Documentation

◆ p0_

Point2D tuw::LineSegment2D::p0_

protected

Definition at line 17 of file linesegment2d.h.

◆ p1_

Point2D tuw::LineSegment2D::p1_

protected

Definition at line 17 of file linesegment2d.h.

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

Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ LineSegment2D() [1/4]

◆ LineSegment2D() [2/4]

◆ LineSegment2D() [3/4]

◆ LineSegment2D() [4/4]

Member Function Documentation

◆ angle()

◆ closestPointLineSegmentRatio()

◆ closestPointTo()

◆ distanceSqrTo()

◆ distanceTo() [1/2]

◆ distanceTo() [2/2]

◆ length()

◆ line()

◆ operator==()

◆ p0()

◆ p1()

◆ pc()

◆ set() [1/2]

◆ set() [2/2]

◆ x0()

◆ x1()

◆ y0()

◆ y1()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ p0_

◆ p1_