A parametrized line. More...

#include <ParametrizedLine.h>

Public Types
enum	{ AmbientDimAtCompileTime = _AmbientDim , Options = _Options }

typedef _Scalar	Scalar

typedef NumTraits< Scalar >::Real	RealScalar

typedef Eigen::Index	Index

typedef Matrix< Scalar, AmbientDimAtCompileTime, 1, Options >	VectorType

Public Member Functions
EIGEN_DEVICE_FUNC	ParametrizedLine ()

template<int OtherOptions>
EIGEN_DEVICE_FUNC	ParametrizedLine (const ParametrizedLine< Scalar, AmbientDimAtCompileTime, OtherOptions > &other)

EIGEN_DEVICE_FUNC	ParametrizedLine (Index _dim)

EIGEN_DEVICE_FUNC	ParametrizedLine (const VectorType &origin, const VectorType &direction)

template<int OtherOptions>
EIGEN_DEVICE_FUNC	ParametrizedLine (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane)

EIGEN_DEVICE_FUNC	~ParametrizedLine ()

EIGEN_DEVICE_FUNC Index	dim () const

EIGEN_DEVICE_FUNC const VectorType &	origin () const

EIGEN_DEVICE_FUNC VectorType &	origin ()

EIGEN_DEVICE_FUNC const VectorType &	direction () const

EIGEN_DEVICE_FUNC VectorType &	direction ()

EIGEN_DEVICE_FUNC RealScalar	squaredDistance (const VectorType &p) const

EIGEN_DEVICE_FUNC RealScalar	distance (const VectorType &p) const

EIGEN_DEVICE_FUNC VectorType	projection (const VectorType &p) const

EIGEN_DEVICE_FUNC VectorType	pointAt (const Scalar &t) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC Scalar	intersectionParameter (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC Scalar	intersection (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC VectorType	intersectionPoint (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

template<typename XprType >
EIGEN_DEVICE_FUNC ParametrizedLine &	transform (const MatrixBase< XprType > &mat, TransformTraits traits=Affine)

template<int TrOptions>
EIGEN_DEVICE_FUNC ParametrizedLine &	transform (const Transform< Scalar, AmbientDimAtCompileTime, Affine, TrOptions > &t, TransformTraits traits=Affine)

template<typename NewScalarType >
EIGEN_DEVICE_FUNC internal::cast_return_type< ParametrizedLine, ParametrizedLine< NewScalarType, AmbientDimAtCompileTime, Options > >::type	cast () const

template<typename OtherScalarType , int OtherOptions>
EIGEN_DEVICE_FUNC	ParametrizedLine (const ParametrizedLine< OtherScalarType, AmbientDimAtCompileTime, OtherOptions > &other)

EIGEN_DEVICE_FUNC bool	isApprox (const ParametrizedLine &other, const typename NumTraits< Scalar >::Real &prec=NumTraits< Scalar >::dummy_precision()) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC _Scalar	intersectionParameter (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC _Scalar	intersection (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

Static Public Member Functions
static EIGEN_DEVICE_FUNC ParametrizedLine	Through (const VectorType &p0, const VectorType &p1)

Protected Attributes
VectorType	m_origin

VectorType	m_direction

Detailed Description

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

A parametrized line.

\geometry_module

A parametrized line is defined by an origin point $\mathbf{o}$ and a unit direction vector $\mathbf{d}$ such that the line corresponds to the set $l(t) = \mathbf{o} + t \mathbf{d}$ , $t \in \mathbf{R}$ .

Template 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.

Member Typedef Documentation

◆ Index

template<typename _Scalar , int _AmbientDim, int _Options>

typedef Eigen::Index Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::Index

Deprecated:: since Eigen 3.3

◆ RealScalar

template<typename _Scalar , int _AmbientDim, int _Options>

typedef NumTraits<Scalar>::Real Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::RealScalar

◆ Scalar

template<typename _Scalar , int _AmbientDim, int _Options>

typedef _Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::Scalar

◆ VectorType

template<typename _Scalar , int _AmbientDim, int _Options>

typedef Matrix<Scalar,AmbientDimAtCompileTime,1,Options> Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::VectorType

Member Enumeration Documentation

◆ anonymous enum

template<typename _Scalar , int _AmbientDim, int _Options>

anonymous enum

Enumerator
AmbientDimAtCompileTime
Options

Constructor & Destructor Documentation

◆ ParametrizedLine() [1/6]

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( )

inline

Default constructor without initialization

◆ ParametrizedLine() [2/6]

template<typename _Scalar , int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( const ParametrizedLine< Scalar, AmbientDimAtCompileTime, OtherOptions > & other )

inline

◆ ParametrizedLine() [3/6]

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( Index _dim )

inlineexplicit

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

◆ ParametrizedLine() [4/6]

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::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() [5/6]

template<typename _Scalar , int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane )

inlineexplicit

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()

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::~ParametrizedLine ( )

inline

◆ ParametrizedLine() [6/6]

template<typename _Scalar , int _AmbientDim, int _Options>

template<typename OtherScalarType , int OtherOptions>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( const ParametrizedLine< OtherScalarType, AmbientDimAtCompileTime, OtherOptions > & other )

inlineexplicit

Copy constructor with scalar type conversion

Member Function Documentation

◆ cast()

template<typename _Scalar , int _AmbientDim, int _Options>

template<typename NewScalarType >

EIGEN_DEVICE_FUNC internal::cast_return_type< ParametrizedLine, ParametrizedLine< NewScalarType, AmbientDimAtCompileTime, Options > >::type Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::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.

◆ dim()

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Index Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::dim ( ) const

inline

Returns: the dimension in which the line holds

◆ direction() [1/2]

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC VectorType & Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::direction ( )

inline

◆ direction() [2/2]

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC const VectorType & Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::direction ( ) const

inline

◆ distance()

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC RealScalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::distance ( const VectorType & p ) const

inline

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

See also: squaredDistance()

◆ intersection() [1/2]

template<typename _Scalar , int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersection ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

◆ intersection() [2/2]

template<typename _Scalar , int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC _Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersection ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

inline

Deprecated:: use intersectionParameter()

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

◆ intersectionParameter() [1/2]

template<typename _Scalar , int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersectionParameter ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

◆ intersectionParameter() [2/2]

template<typename _Scalar , int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC _Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersectionParameter ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

inline

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

◆ intersectionPoint()

template<typename _Scalar , int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC ParametrizedLine< _Scalar, _AmbientDim, _Options >::VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersectionPoint ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

inline

Returns: the point of the intersection between *this and the given hyperplane

◆ isApprox()

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC bool Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::isApprox	(	const ParametrizedLine< _Scalar, _AmbientDim, _Options > &	other,
		const typename NumTraits< Scalar >::Real &	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const

inline

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

See also: MatrixBase::isApprox()

◆ origin() [1/2]

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC VectorType & Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::origin ( )

inline

◆ origin() [2/2]

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC const VectorType & Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::origin ( ) const

inline

◆ pointAt()

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC ParametrizedLine< _Scalar, _AmbientDim, _Options >::VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::pointAt ( const Scalar & t ) const

inline

Returns: the point at t along this line

◆ projection()

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::projection ( const VectorType & p ) const

inline

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

◆ squaredDistance()

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC RealScalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::squaredDistance ( const VectorType & p ) const

inline

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

See also: distance()

◆ Through()

template<typename _Scalar , int _AmbientDim, int _Options>

static EIGEN_DEVICE_FUNC ParametrizedLine Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::Through	(	const VectorType &	p0,
		const VectorType &	p1
	)

inlinestatic

Constructs a parametrized line going from p0 to p1.

◆ transform() [1/2]

template<typename _Scalar , int _AmbientDim, int _Options>

template<typename XprType >

EIGEN_DEVICE_FUNC ParametrizedLine & Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::transform	(	const MatrixBase< XprType > &	mat,
		TransformTraits	traits = `Affine`
	)

inline

Applies the transformation matrix mat to *this and returns a reference to *this.

Parameters

mat	the Dim x Dim transformation matrix
traits	specifies whether the matrix mat represents an Isometry or a more generic Affine transformation. The default is Affine.

◆ transform() [2/2]

template<typename _Scalar , int _AmbientDim, int _Options>

template<int TrOptions>

EIGEN_DEVICE_FUNC ParametrizedLine & Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::transform	(	const Transform< Scalar, AmbientDimAtCompileTime, Affine, TrOptions > &	t,
		TransformTraits	traits = `Affine`
	)

inline

Applies the transformation t to *this and returns a reference to *this.

Parameters

t	the transformation of dimension Dim
traits	specifies whether the transformation t represents an Isometry or a more generic Affine transformation. The default is Affine. Other kind of transformations are not supported.

Member Data Documentation

◆ m_direction

template<typename _Scalar , int _AmbientDim, int _Options>

VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::m_direction

protected

◆ m_origin

template<typename _Scalar , int _AmbientDim, int _Options>

VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::m_origin

protected

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

core/util/algorithms/eigen-3.4.0/Eigen/src/Core/util/ForwardDeclarations.h
core/util/algorithms/eigen-3.4.0/Eigen/src/Geometry/ParametrizedLine.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Index

◆ RealScalar

◆ Scalar

◆ VectorType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ParametrizedLine() [1/6]

◆ ParametrizedLine() [2/6]

◆ ParametrizedLine() [3/6]

◆ ParametrizedLine() [4/6]

◆ ParametrizedLine() [5/6]

◆ ~ParametrizedLine()

◆ ParametrizedLine() [6/6]

Member Function Documentation

◆ cast()

◆ dim()

◆ direction() [1/2]

◆ direction() [2/2]

◆ distance()

◆ intersection() [1/2]

◆ intersection() [2/2]

◆ intersectionParameter() [1/2]

◆ intersectionParameter() [2/2]

◆ intersectionPoint()

◆ isApprox()

◆ origin() [1/2]

◆ origin() [2/2]

◆ pointAt()

◆ projection()

◆ squaredDistance()

◆ Through()

◆ transform() [1/2]

◆ transform() [2/2]

Member Data Documentation

◆ m_direction

◆ m_origin