MeVisLab Toolbox Reference
ml::KeyFrame Class Reference

Class KeyFrame consisting of a 3D position, tangent and up vector. More...

#include <mlKeyFrameList.h>

Public Member Functions

virtual KeyFrameoperator= (const KeyFrame &frame)
 Assignment operator.
 
bool operator< (const KeyFrame &) const
 Dummy "lesser than operator", required for VC7.
 
bool operator== (const KeyFrame &) const
 Dummy "equal operator", required for VC7.
 
Constructors
 KeyFrame ()
 Default constructor.
 
 KeyFrame (const Vector3 &point, const Vector3 &tangentVec, const Vector3 &upVec)
 Position, tangent and up.
 
 KeyFrame (const KeyFrame &frame)
 Copy constructor.
 
virtual ~KeyFrame ()
 Implement destructor to be sure that it is virtual to avoid warnings.
 

Public Attributes

Key frame properties
Vector3 p
 Position.
 
Vector3 tangent
 Orientation.
 
Vector3 up
 Local vertical.
 

Detailed Description

Class KeyFrame consisting of a 3D position, tangent and up vector.

A KeyFrame describes a position and orientation in space. It has the properties

  • p: 3D position
  • tangent: 3D orientation vector
  • up: 3D vector defining positive local Y-direction (orthogonal to tangent)

Definition at line 45 of file mlKeyFrameList.h.

Constructor & Destructor Documentation

◆ KeyFrame() [1/3]

ml::KeyFrame::KeyFrame ( )
inline

Default constructor.

Definition at line 63 of file mlKeyFrameList.h.

◆ KeyFrame() [2/3]

ml::KeyFrame::KeyFrame ( const Vector3 & point,
const Vector3 & tangentVec,
const Vector3 & upVec )
inline

Position, tangent and up.

Definition at line 66 of file mlKeyFrameList.h.

◆ KeyFrame() [3/3]

ml::KeyFrame::KeyFrame ( const KeyFrame & frame)
inline

Copy constructor.

Definition at line 70 of file mlKeyFrameList.h.

References mlrange_cast().

◆ ~KeyFrame()

virtual ml::KeyFrame::~KeyFrame ( )
inlinevirtual

Implement destructor to be sure that it is virtual to avoid warnings.

Definition at line 73 of file mlKeyFrameList.h.

Member Function Documentation

◆ operator<()

bool ml::KeyFrame::operator< ( const KeyFrame & ) const
inline

Dummy "lesser than operator", required for VC7.

Definition at line 81 of file mlKeyFrameList.h.

◆ operator=()

virtual KeyFrame & ml::KeyFrame::operator= ( const KeyFrame & frame)
virtual

Assignment operator.

◆ operator==()

bool ml::KeyFrame::operator== ( const KeyFrame & ) const
inline

Dummy "equal operator", required for VC7.

Definition at line 84 of file mlKeyFrameList.h.

Member Data Documentation

◆ p

Vector3 ml::KeyFrame::p

Position.

Definition at line 52 of file mlKeyFrameList.h.

◆ tangent

Vector3 ml::KeyFrame::tangent

Orientation.

Definition at line 53 of file mlKeyFrameList.h.

◆ up

Vector3 ml::KeyFrame::up

Local vertical.

Definition at line 54 of file mlKeyFrameList.h.


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