Displacement< _Scalar > Class Template Reference

Class describing a rigid Displacement or a 3D Frame position. More...

#include <Displacement.h>

Inheritance diagram for Displacement< _Scalar >:

List of all members.

Public Types
typedef internal::traits < Displacement >::Coefficients	Coefficients
typedef _Scalar	Scalar
Public Member Functions
	Displacement ()
	Displacement (const Displacement &other)
template<typename Derived >
	Displacement (const DisplacementBase< Derived > &other)
	Displacement (const Array< Scalar, 7, 1 > &g)
template<typename Derived >
	Displacement (const MatrixBase< Derived > &other)
EIGEN_STRONG_INLINE	Displacement (Scalar x, Scalar y, Scalar z, Scalar qw=(Scalar) 1.0, Scalar qx=(Scalar) 0.0, Scalar qy=(Scalar) 0.0, Scalar qz=(Scalar) 0.0)
EIGEN_STRONG_INLINE	Displacement (const typename Base::Vector3 &v, const typename Base::Rotation3D &r)
Coefficients &	get ()
const Coefficients &	get () const
Protected Types
typedef DisplacementBase < Displacement< Scalar > >	Base
Protected Attributes
Coefficients	m_coeffs

---

Detailed Description

template<typename _Scalar>
class Displacement< _Scalar >

Class describing a rigid Displacement or a 3D Frame position.

Template Parameters:

_Scalar

the type of the underlying array

This class add some specific constructors

See also:

The methods are defined in LieGroupBase and DisplacementBase

Definition at line 159 of file Displacement.h.

---

Member Typedef Documentation

template<typename _Scalar>

typedef DisplacementBase<Displacement<Scalar> > Displacement< _Scalar >::Base [protected]

The inherited class

Reimplemented from DisplacementBase< Displacement< _Scalar > >.

Definition at line 165 of file Displacement.h.

template<typename _Scalar>

typedef internal::traits<Displacement>::Coefficients Displacement< _Scalar >::Coefficients

the stored coefficients

Reimplemented from LieGroupBase< Array< internal::traits< Displacement< _Scalar > >::Scalar, 7, 1 >, Displacement< _Scalar > >.

Definition at line 168 of file Displacement.h.

template<typename _Scalar>

typedef _Scalar Displacement< _Scalar >::Scalar

The coefficients type

Reimplemented from DisplacementBase< Displacement< _Scalar > >.

Definition at line 162 of file Displacement.h.

---

Constructor & Destructor Documentation

template<typename _Scalar>

Displacement< _Scalar >::Displacement

(

)

[inline]

Default constructor

Definition at line 173 of file Displacement.h.

template<typename _Scalar>

Displacement< _Scalar >::Displacement

(

const Displacement< _Scalar > &

other

)

[inline]

Copy constructor

Definition at line 175 of file Displacement.h.

template<typename _Scalar>

template<typename Derived >

Displacement< _Scalar >::Displacement

(

const DisplacementBase< Derived > &

other

)

[inline]

Pseudo-copy constructor

Definition at line 179 of file Displacement.h.

template<typename _Scalar>

Displacement< _Scalar >::Displacement

(

const Array< Scalar, 7, 1 > &

g

)

[inline]

Copy constructor using the wrapped class

Definition at line 181 of file Displacement.h.

template<typename _Scalar>

template<typename Derived >

Displacement< _Scalar >::Displacement

(

const MatrixBase< Derived > &

other

)

[inline, explicit]

Definition at line 183 of file Displacement.h.

template<typename _Scalar>

EIGEN_STRONG_INLINE Displacement< _Scalar >::Displacement	(	Scalar	x,
		Scalar	y,
		Scalar	z,
		Scalar	qw = (Scalar)1.0,
		Scalar	qx = (Scalar)0.0,
		Scalar	qy = (Scalar)0.0,
		Scalar	qz = (Scalar)0.0
	)		[inline]

Constructs and initializes the displacement with first then

Warning:

Note the order of the arguments: R^3 first then qw (scalar part) while internally the coefficients are stored in the following order: [qx, qy, qz, qw x y z]

Definition at line 190 of file Displacement.h.

template<typename _Scalar>

EIGEN_STRONG_INLINE Displacement< _Scalar >::Displacement	(	const typename Base::Vector3 &	v,
		const typename Base::Rotation3D &	r
	)		[inline]

Constructs a element of SE(3) from an element of SO(3) r and R^3 v

Definition at line 203 of file Displacement.h.

---

Member Function Documentation

template<typename _Scalar>

Coefficients& Displacement< _Scalar >::get

(

)

[inline]

Returns:

The stored coefficients

Reimplemented from LieGroupBase< Array< internal::traits< Displacement< _Scalar > >::Scalar, 7, 1 >, Displacement< _Scalar > >.

Definition at line 209 of file Displacement.h.

template<typename _Scalar>

const Coefficients& Displacement< _Scalar >::get

(

)

const [inline]

Returns:

The read-only access to the stored coefficients

Reimplemented from LieGroupBase< Array< internal::traits< Displacement< _Scalar > >::Scalar, 7, 1 >, Displacement< _Scalar > >.

Definition at line 211 of file Displacement.h.

---

Member Data Documentation

template<typename _Scalar>

Coefficients Displacement< _Scalar >::m_coeffs [protected]

The wrapped coefficients

Definition at line 215 of file Displacement.h.

---

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

• Displacement.h