ParametrizedLine< _Scalar, _AmbientDim > Class Template Reference [Geometry module]

A parametrized line. More...

List of all members.

Public Types
enum	{ AmbientDimAtCompileTime }
typedef NumTraits< Scalar >::Real	RealScalar
typedef _Scalar	Scalar
typedef Matrix< Scalar, AmbientDimAtCompileTime, 1 >	VectorType
Public Member Functions
template<typename NewScalarType >
ei_cast_return_type < ParametrizedLine, ParametrizedLine < NewScalarType, AmbientDimAtCompileTime > >::type	cast () const
int	dim () const
const VectorType &	direction () const
VectorType &	direction ()
RealScalar	distance (const VectorType &p) const
Scalar	intersection (const Hyperplane< _Scalar, _AmbientDim > &hyperplane)
bool	isApprox (const ParametrizedLine &other, typename NumTraits< Scalar >::Real prec=precision< Scalar >()) const
VectorType &	origin ()
const VectorType &	origin () const
	ParametrizedLine (const Hyperplane< _Scalar, _AmbientDim > &hyperplane)
	ParametrizedLine (int _dim)
	ParametrizedLine ()
template<typename OtherScalarType >
	ParametrizedLine (const ParametrizedLine< OtherScalarType, AmbientDimAtCompileTime > &other)
	ParametrizedLine (const VectorType &origin, const VectorType &direction)
VectorType	projection (const VectorType &p) const
RealScalar	squaredDistance (const VectorType &p) const
Static Public Member Functions
static ParametrizedLine	Through (const VectorType &p0, const VectorType &p1)
Protected Attributes
VectorType	m_direction
VectorType	m_origin

---

Detailed Description

template<typename _Scalar, int _AmbientDim>
class Eigen::ParametrizedLine< _Scalar, _AmbientDim >

A parametrized line.

This is defined in the Geometry module.

 #include <Eigen/Geometry> 

A parametrized line is defined by an origin point and a unit direction vector such that the line corresponds to the set , .

Parameters:

	_Scalar	the scalar type, i.e., the type of the coefficients
	_AmbientDim	the dimension of the ambient space, can be a compile time value or Dynamic.

---

Constructor & Destructor Documentation

ParametrizedLine

(

)

[inline, explicit]

Default constructor without initialization

ParametrizedLine

(

int

_dim

)

[inline, explicit]

Constructs a dynamic-size line with _dim the dimension of the ambient space

ParametrizedLine	(	const VectorType &	origin,
		const VectorType &	direction
	)			[inline]

Initializes a parametrized line of direction direction and origin origin.

Warning:

the vector direction is assumed to be normalized.

ParametrizedLine

(

const Hyperplane< _Scalar, _AmbientDim > &

hyperplane

)

[inline, explicit]

Constructs a parametrized line from a 2D hyperplane

Warning:

the ambient space must have dimension 2 such that the hyperplane actually describes a line

ParametrizedLine

(

const ParametrizedLine< OtherScalarType, AmbientDimAtCompileTime > &

other

)

[inline, explicit]

Copy constructor with scalar type conversion

---

Member Function Documentation

ei_cast_return_type<ParametrizedLine, ParametrizedLine<NewScalarType,AmbientDimAtCompileTime> >::type cast

(

)

const [inline]

Returns:

*this with scalar type casted to NewScalarType

Note that if NewScalarType is equal to the current scalar type of *this then this function smartly returns a const reference to *this.

int dim

(

)

const [inline]

Returns:

the dimension in which the line holds

RealScalar distance

(

const VectorType &

p

)

const [inline]

Returns:

the distance of a point p to its projection onto the line *this.

See also:

squaredDistance()

_Scalar intersection

(

const Hyperplane< _Scalar, _AmbientDim > &

hyperplane

)

[inline]

Returns:

the parameter value of the intersection between *this and the given hyperplane

bool isApprox	(	const ParametrizedLine< _Scalar, _AmbientDim > &	other,
		typename NumTraits< Scalar >::Real	prec = precision<Scalar>()
	)			const [inline]

Returns:

true if *this is approximately equal to other, within the precision determined by prec.

See also:

MatrixBase::isApprox()

VectorType projection

(

const VectorType &

p

)

const [inline]

Returns:

the projection of a point p onto the line *this.

RealScalar squaredDistance

(

const VectorType &

p

)

const [inline]

Returns:

the squared distance of a point p to its projection onto the line *this.

See also:

distance()

static ParametrizedLine Through	(	const VectorType &	p0,
		const VectorType &	p1
	)			[inline, static]

Constructs a parametrized line going from p0 to p1.

---

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