Documentation

animal::Frame< N, Real > Struct Template Reference
[Bases and frames]

#include <basicFrames.h>

List of all members.

Detailed Description

template<int N = 3, class Real = float>
struct animal::Frame< N, Real >

Origin and basis of a local frame (coordinate system) with respect to a reference frame (coordinate system).

No reference to the reference frame is stored. The basis, typically a matrix, is not necessarily orthogonal.

Definition at line 92 of file basicFrames.h.

Public Types

typedef Array< N, Real > Vec
 Typically a vector in dimension 3.

typedef Array< N, Vec > Basis
 Typically a matrix whose columns define the vectors of the local basis with respect to the reference basis.

typedef Basis_ Basis
 Typically a matrix whose columns define the vectors of the local basis with respect to the reference basis.

typedef Vec_ Vec
 Typically a vector in dimension 3.


Public Member Functions

 Frame ()
 Default constructor does not initialize the values.

 Frame (const Basis &b, const Vec &t)
 Construct from given base and translation.

 Frame ()
 Default constructor does not initialize the values.

 Frame (const Basis &b, const Vec &t)
 Construct from given base and translation.


Public Attributes

Basis basis
 The local basis with respect to the reference basis.

Vec displacement
 The position of the origin of the local frame with respect to the reference frame.

Member Typedef Documentation

template<int N = 3, class Real = float>
typedef Basis_ animal::Frame< N, Real >::Basis
 

Typically a matrix whose columns define the vectors of the local basis with respect to the reference basis.

Definition at line 151 of file basicFrames.inl.

template<int N = 3, class Real = float>
typedef Array< N,Vec > animal::Frame< N, Real >::Basis
 

Typically a matrix whose columns define the vectors of the local basis with respect to the reference basis.

Definition at line 95 of file basicFrames.h.

Referenced by animal::Frame< N, Real >::Frame().

template<int N = 3, class Real = float>
typedef Vec_ animal::Frame< N, Real >::Vec
 

Typically a vector in dimension 3.

Definition at line 152 of file basicFrames.inl.

template<int N = 3, class Real = float>
typedef Array<N,Real> animal::Frame< N, Real >::Vec
 

Typically a vector in dimension 3.

Definition at line 94 of file basicFrames.h.

Referenced by animal::Frame< N, Real >::Frame().

Constructor & Destructor Documentation

template<int N = 3, class Real = float>
animal::Frame< N, Real >::Frame (   ) 
 

Default constructor does not initialize the values.

template<int N = 3, class Real = float>
animal::Frame< N, Real >::Frame (  const Basis &  b,
const Vec &  t
) 
 

Construct from given base and translation.

template<int N = 3, class Real = float>
animal::Frame< N, Real >::Frame (   )  [inline]
 

Default constructor does not initialize the values.

Definition at line 155 of file basicFrames.inl.

template<int N = 3, class Real = float>
animal::Frame< N, Real >::Frame (  const Basis &  b,
const Vec &  t
)  [inline]
 

Construct from given base and translation.

Definition at line 158 of file basicFrames.inl.

References animal::Frame< N, Real >::basis, animal::Frame< N, Real >::Basis, animal::Frame< N, Real >::displacement, and animal::Frame< N, Real >::Vec.

Member Data Documentation

template<int N = 3, class Real = float>
Basis animal::Frame< N, Real >::basis
 

The local basis with respect to the reference basis.

Definition at line 163 of file basicFrames.inl.

Referenced by animal::Frame< N, Real >::Frame().

template<int N = 3, class Real = float>
Vec animal::Frame< N, Real >::displacement
 

The position of the origin of the local frame with respect to the reference frame.

Definition at line 164 of file basicFrames.inl.

Referenced by animal::Frame< N, Real >::Frame().

The documentation for this struct was generated from the following files:
Generated on Thu Dec 23 13:52:29 2004 by doxygen 1.3.6