2D line between two points with intersection methods. More...

#include <line2d.h>

Public Member Functions
	line2d ()
	Default constructor for line going from (0,0) to (1,1). More...

	line2d (T xa, T ya, T xb, T yb)
	Constructor for line between the two points. More...

	line2d (const vector2d< T > &start, const vector2d< T > &end)
	Constructor for line between the two points given as vectors. More...

	line2d (const line2d< T > &other)
	Copy constructor. More...

line2d< T >	operator+ (const vector2d< T > &point) const

line2d< T > &	operator+= (const vector2d< T > &point)

line2d< T >	operator- (const vector2d< T > &point) const

line2d< T > &	operator-= (const vector2d< T > &point)

bool	operator== (const line2d< T > &other) const

bool	operator!= (const line2d< T > &other) const

void	setLine (const T &xa, const T &ya, const T &xb, const T &yb)
	Set this line to new line going through the two points. More...

void	setLine (const vector2d< T > &nstart, const vector2d< T > &nend)
	Set this line to new line going through the two points. More...

void	setLine (const line2d< T > &line)
	Set this line to new line given as parameter. More...

T	getLength () const
	Get length of line. More...

T	getLengthSQ () const
	Get squared length of the line. More...

vector2d< T >	getMiddle () const
	Get middle of the line. More...

vector2d< T >	getVector () const
	Get the vector of the line. More...

bool	intersectAsSegments (const line2d< T > &other) const

bool	incidentSegments (const line2d< T > &other) const

bool	nearlyParallel (const line2d< T > &line, const T factor=relativeErrorFactor< T >()) const

vector2d< T >	fastLinesIntersection (const line2d< T > &l) const

bool	lineIntersectSegment (const line2d< T > &segment, vector2d< T > &out) const

bool	intersectWith (const line2d< T > &l, vector2d< T > &out, bool checkOnlySegments=true, bool ignoreCoincidentLines=false) const
	Tests if this line intersects with another line. More...

vector2d< T >	getUnitVector () const
	Get unit vector of the line. More...

double	getAngleWith (const line2d< T > &l) const
	Get angle between this line and given line. More...

T	getPointOrientation (const vector2d< T > &point) const
	Tells us if the given point lies to the left, right, or on the line. More...

bool	isPointOnLine (const vector2d< T > &point) const
	Check if the given point is a member of the line. More...

bool	isPointBetweenStartAndEnd (const vector2d< T > &point) const
	Check if the given point is between start and end of the line. More...

vector2d< T >	getClosestPoint (const vector2d< T > &point, bool checkOnlySegments=true) const
	Get the closest point on this line to a point. More...

vector2df	getClosestPoint (const vector2df &point, bool checkOnlySegments) const

Public Attributes
vector2d< T >	start
	Start point of the line. More...

vector2d< T >	end
	End point of the line. More...

Detailed Description

template<class T>
class saga::core::line2d< T >

2D line between two points with intersection methods.

Definition at line 17 of file line2d.h.

Constructor & Destructor Documentation

◆ line2d() [1/4]

template<class T >

saga::core::line2d< T >::line2d ( )

inline

Default constructor for line going from (0,0) to (1,1).

Definition at line 21 of file line2d.h.

◆ line2d() [2/4]

template<class T >

saga::core::line2d< T >::line2d	(	T	xa,
		T	ya,
		T	xb,
		T	yb
	)

inline

Constructor for line between the two points.

Definition at line 23 of file line2d.h.

◆ line2d() [3/4]

template<class T >

saga::core::line2d< T >::line2d	(	const vector2d< T > &	start,
		const vector2d< T > &	end
	)

inline

Constructor for line between the two points given as vectors.

Definition at line 25 of file line2d.h.

◆ line2d() [4/4]

template<class T >

saga::core::line2d< T >::line2d ( const line2d< T > & other )

inline

Copy constructor.

Definition at line 27 of file line2d.h.

Member Function Documentation

◆ fastLinesIntersection()

template<class T >

vector2d<T> saga::core::line2d< T >::fastLinesIntersection ( const line2d< T > & l ) const

inline

returns a intersection point of 2 lines (if lines are not parallel). Behaviour undefined if lines are parallel or coincident. It's on optimized intersectWith with checkOnlySegments=false and ignoreCoincidentLines=true

Definition at line 117 of file line2d.h.

◆ getAngleWith()

template<class T >

double saga::core::line2d< T >::getAngleWith ( const line2d< T > & l ) const

inline

Get angle between this line and given line.

Parameters

l	Other line for test.

Returns: Angle in degrees.

Definition at line 267 of file line2d.h.

◆ getClosestPoint() [1/2]

template<class T >

vector2d<T> saga::core::line2d< T >::getClosestPoint	(	const vector2d< T > &	point,
		bool	checkOnlySegments = `true`
	)		const

inline

Get the closest point on this line to a point.

Parameters

checkOnlySegments Default (true) is to return a point on the line-segment (between begin and end) of the line. When set to false the function will check for the first the closest point on the the line even when outside the segment.

Definition at line 301 of file line2d.h.

◆ getClosestPoint() [2/2]

vector2df saga::core::line2d< float >::getClosestPoint	(	const vector2df &	point,
		bool	checkOnlySegments
	)		const

inline

Definition at line 329 of file line2d.h.

◆ getLength()

template<class T >

T saga::core::line2d< T >::getLength ( ) const

inline

Get length of line.

Returns: Length of the line.

Definition at line 52 of file line2d.h.

◆ getLengthSQ()

template<class T >

T saga::core::line2d< T >::getLengthSQ ( ) const

inline

Get squared length of the line.

Returns: Squared length of line.

Definition at line 56 of file line2d.h.

◆ getMiddle()

template<class T >

vector2d<T> saga::core::line2d< T >::getMiddle ( ) const

inline

Get middle of the line.

Returns: center of the line.

Definition at line 60 of file line2d.h.

◆ getPointOrientation()

template<class T >

T saga::core::line2d< T >::getPointOrientation ( const vector2d< T > & point ) const

inline

Tells us if the given point lies to the left, right, or on the line.

Returns: 0 if the point is on the line <0 if to the left, or >0 if to the right.

Definition at line 277 of file line2d.h.

◆ getUnitVector()

template<class T >

vector2d<T> saga::core::line2d< T >::getUnitVector ( ) const

inline

Get unit vector of the line.

Returns: Unit vector of this line.

Definition at line 258 of file line2d.h.

◆ getVector()

template<class T >

vector2d<T> saga::core::line2d< T >::getVector ( ) const

inline

Get the vector of the line.

Returns: The vector of the line.

Definition at line 67 of file line2d.h.

◆ incidentSegments()

template<class T >

bool saga::core::line2d< T >::incidentSegments ( const line2d< T > & other ) const

inline

Check if 2 segments are incident (intersects in exactly 1 point).

Definition at line 97 of file line2d.h.

◆ intersectAsSegments()

template<class T >

bool saga::core::line2d< T >::intersectAsSegments ( const line2d< T > & other ) const

inline

Check if this segment intersects another segment, or if segments are coincindent (colinear).

Definition at line 71 of file line2d.h.

◆ intersectWith()

template<class T >

bool saga::core::line2d< T >::intersectWith	(	const line2d< T > &	l,
		vector2d< T > &	out,
		bool	checkOnlySegments = `true`,
		bool	ignoreCoincidentLines = `false`
	)		const

inline

Tests if this line intersects with another line.

Parameters

l	Other line to test intersection with.
checkOnlySegments	Default is to check intersection between the begin and endpoints. When set to false the function will check for the first intersection point when extending the lines.
out	If there is an intersection, the location of the intersection will be stored in this vector.
ignoreCoincidentLines	When true coincident lines (lines above each other) are never considered as intersecting. When false the center of the overlapping part is returned.

Returns: True if there is an intersection, false if not.

Definition at line 159 of file line2d.h.

◆ isPointBetweenStartAndEnd()

template<class T >

bool saga::core::line2d< T >::isPointBetweenStartAndEnd ( const vector2d< T > & point ) const

inline

Check if the given point is between start and end of the line.

Assumes that the point is already somewhere on the line.

Definition at line 293 of file line2d.h.

◆ isPointOnLine()

template<class T >

bool saga::core::line2d< T >::isPointOnLine ( const vector2d< T > & point ) const

inline

Check if the given point is a member of the line.

Returns: True if point is between start and end, else false.

Definition at line 285 of file line2d.h.

◆ lineIntersectSegment()

template<class T >

bool saga::core::line2d< T >::lineIntersectSegment	(	const line2d< T > &	segment,
		vector2d< T > &	out
	)		const

inline

Check if this line intersect a segment. The eventual intersection point is returned in "out".

Definition at line 140 of file line2d.h.

◆ nearlyParallel()

template<class T >

bool saga::core::line2d< T >::nearlyParallel	(	const line2d< T > &	line,
		const T	factor = `relativeErrorFactor<T>()`
	)		const

inline

Check if 2 lines/segments are parallel or nearly parallel.

Definition at line 105 of file line2d.h.

◆ operator!=()

template<class T >

bool saga::core::line2d< T >::operator!= ( const line2d< T > & other ) const

inline

Definition at line 39 of file line2d.h.

◆ operator+()

template<class T >

line2d<T> saga::core::line2d< T >::operator+ ( const vector2d< T > & point ) const

inline

Definition at line 31 of file line2d.h.

◆ operator+=()

template<class T >

line2d<T>& saga::core::line2d< T >::operator+= ( const vector2d< T > & point )

inline

Definition at line 32 of file line2d.h.

◆ operator-()

template<class T >

line2d<T> saga::core::line2d< T >::operator- ( const vector2d< T > & point ) const

inline

Definition at line 34 of file line2d.h.

◆ operator-=()

template<class T >

line2d<T>& saga::core::line2d< T >::operator-= ( const vector2d< T > & point )

inline

Definition at line 35 of file line2d.h.

◆ operator==()

template<class T >

bool saga::core::line2d< T >::operator== ( const line2d< T > & other ) const

inline

Definition at line 37 of file line2d.h.

◆ setLine() [1/3]

template<class T >

void saga::core::line2d< T >::setLine ( const line2d< T > & line )

inline

Set this line to new line given as parameter.

Definition at line 48 of file line2d.h.

◆ setLine() [2/3]

template<class T >

void saga::core::line2d< T >::setLine	(	const T &	xa,
		const T &	ya,
		const T &	xb,
		const T &	yb
	)

inline

Set this line to new line going through the two points.

Definition at line 44 of file line2d.h.

◆ setLine() [3/3]

template<class T >

void saga::core::line2d< T >::setLine	(	const vector2d< T > &	nstart,
		const vector2d< T > &	nend
	)

inline

Set this line to new line going through the two points.

Definition at line 46 of file line2d.h.

Member Data Documentation

◆ end

template<class T >

vector2d<T> saga::core::line2d< T >::end

End point of the line.

Definition at line 324 of file line2d.h.

◆ start

template<class T >

vector2d<T> saga::core::line2d< T >::start

Start point of the line.

Definition at line 322 of file line2d.h.

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

library/include/line2d.h

Public Member Functions

Public Attributes

Detailed Description

template<class T> class saga::core::line2d< T >

Constructor & Destructor Documentation

◆ line2d() [1/4]

◆ line2d() [2/4]

◆ line2d() [3/4]

◆ line2d() [4/4]

Member Function Documentation

◆ fastLinesIntersection()

◆ getAngleWith()

◆ getClosestPoint() [1/2]

◆ getClosestPoint() [2/2]

◆ getLength()

◆ getLengthSQ()

◆ getMiddle()

◆ getPointOrientation()

◆ getUnitVector()

◆ getVector()

◆ incidentSegments()

◆ intersectAsSegments()

◆ intersectWith()

◆ isPointBetweenStartAndEnd()

◆ isPointOnLine()

◆ lineIntersectSegment()

◆ nearlyParallel()

◆ operator!=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator==()

◆ setLine() [1/3]

◆ setLine() [2/3]

◆ setLine() [3/3]

Member Data Documentation

◆ end

◆ start

template<class T>
class saga::core::line2d< T >