ecl::LinearSegment Class Reference

#include <linear_segment.hpp>

Public Member Functions
	LinearSegment (const double &x_1, const double &y_1, const double &x_2, const double &y_2)
double	squaredDistanceFromPoint (const double &x, const double &y) const
	Distance of a point from the segment. More...

Public Attributes
ecl::Parameter< double >	A
ecl::Parameter< double >	B
ecl::Parameter< double >	C

Private Attributes
double	x_1
double	x_2
double	y_1
double	y_2

Detailed Description

Definition at line 27 of file linear_segment.hpp.

Constructor & Destructor Documentation

LinearSegment()

ecl::LinearSegment::LinearSegment	(	const double &	x_1,
		const double &	y_1,
		const double &	x_2,
		const double &	y_2
	)

Definition at line 20 of file lib/linear_segment.cpp.

Member Function Documentation

squaredDistanceFromPoint()

double ecl::LinearSegment::squaredDistanceFromPoint	(	const double &	x,
		const double &	y
	)		const

Distance of a point from the segment.

Returns the distance from one of the end points if it is closer than the segment itself.

TODO shift this to a standard geometry function computing the squared distance between two geometric objects.

Parameters

x	: x coordinate of the point
y	: y-coordinate of the point

Returns

double

Definition at line 36 of file lib/linear_segment.cpp.

Member Data Documentation

A

ecl::Parameter<double> ecl::LinearSegment::A

Definition at line 49 of file linear_segment.hpp.

B

ecl::Parameter<double> ecl::LinearSegment::B

Definition at line 49 of file linear_segment.hpp.

C

ecl::Parameter<double> ecl::LinearSegment::C

Definition at line 49 of file linear_segment.hpp.

x_1

double ecl::LinearSegment::x_1

private

Definition at line 52 of file linear_segment.hpp.

x_2

double ecl::LinearSegment::x_2

private

Definition at line 53 of file linear_segment.hpp.

y_1

double ecl::LinearSegment::y_1

private

Definition at line 52 of file linear_segment.hpp.

y_2

double ecl::LinearSegment::y_2

private

Definition at line 53 of file linear_segment.hpp.

---

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

• linear_segment.hpp
• lib/linear_segment.cpp