igtl::CoordinateMessage Class Reference

#include <igtlCoordinateMessage.h>

Inheritance diagram for igtl::CoordinateMessage:
MessageBase

List of all members.

Public Types

enum  { POSITION_ONLY = 1, WITH_QUATERNION3, WITH_QUATERNION, ALL }
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef CoordinateMessage Self
typedef MessageBase Superclass

Public Member Functions

float GetInsertion ()
void GetOffset (float *x, float *y, float *z)
void GetOffset (float *offset)
void GetPosition (float *x, float *y, float *z)
void GetPosition (float *pos)
void GetQuaternion (float *ox, float *oy, float *oz, float *w)
void GetQuaternion (float *quat)
 igtlNewMacro (igtl::CoordinateMessage)
 igtlTypeMacro (igtl::CoordinateMessage, igtl::MessageBase)
void Init ()
void SetInsertion (float i)
virtual int SetMessageHeader (const MessageHeader *mb)
void SetOffset (float x, float y, float z)
void SetOffset (const float *offset)
void SetPackType (int t)
int SetPackTypeByBodySize (int s)
void SetPosition (float x, float y, float z)
void SetPosition (const float *pos)
void SetQuaternion (float ox, float oy, float oz, float w)
void SetQuaternion (const float *quat)

Protected Member Functions

 CoordinateMessage ()
virtual int GetBodyPackSize ()
virtual int PackBody ()
virtual int UnpackBody ()
 ~CoordinateMessage ()

Protected Attributes

igtlFloat32 m_Insertion
igtlFloat32 m_Offset [3]
igtlInt32 m_PackType
igtlFloat32 m_Position [3]
igtlFloat32 m_Quaternion [4]

Member Typedef Documentation

typedef SmartPointer<const Self> igtl::CoordinateMessage::ConstPointer
typedef SmartPointer<Self> igtl::CoordinateMessage::Pointer

Member Enumeration Documentation

anonymous enum
Enumerator:
POSITION_ONLY 
WITH_QUATERNION3 
WITH_QUATERNION 
ALL 

Constructor & Destructor Documentation

igtl::CoordinateMessage::CoordinateMessage (  )  [protected]

References Init().

igtl::CoordinateMessage::~CoordinateMessage (  )  [protected]

Member Function Documentation

int igtl::CoordinateMessage::GetBodyPackSize (  )  [protected, virtual]
float igtl::CoordinateMessage::GetInsertion (  )  [inline]
void igtl::CoordinateMessage::GetOffset ( float *  x,
float *  y,
float *  z 
)

References m_Offset.

void igtl::CoordinateMessage::GetOffset ( float *  offset  ) 

References m_Offset.

void igtl::CoordinateMessage::GetPosition ( float *  x,
float *  y,
float *  z 
)

References m_Position.

void igtl::CoordinateMessage::GetPosition ( float *  pos  ) 

References m_Position.

void igtl::CoordinateMessage::GetQuaternion ( float *  ox,
float *  oy,
float *  oz,
float *  w 
)

References m_Quaternion.

void igtl::CoordinateMessage::GetQuaternion ( float *  quat  ) 

References m_Quaternion.

igtl::CoordinateMessage::igtlNewMacro ( igtl::CoordinateMessage   ) 
igtl::CoordinateMessage::igtlTypeMacro ( igtl::CoordinateMessage  ,
igtl::MessageBase   
)
void igtl::CoordinateMessage::Init (  ) 

References ALL, m_PackType, m_Position, and m_Quaternion.

Referenced by CoordinateMessage().

int igtl::CoordinateMessage::PackBody (  )  [protected, virtual]
void igtl::CoordinateMessage::SetInsertion ( float  i  )  [inline]
int igtl::CoordinateMessage::SetMessageHeader ( const MessageHeader *  mb  )  [virtual]
void igtl::CoordinateMessage::SetOffset ( float  x,
float  y,
float  z 
)

References m_Offset.

void igtl::CoordinateMessage::SetOffset ( const float *  offset  ) 

References m_Offset.

void igtl::CoordinateMessage::SetPackType ( int  t  ) 

References ALL, m_PackType, and POSITION_ONLY.

int igtl::CoordinateMessage::SetPackTypeByBodySize ( int  s  ) 

Specify pack type by body size (in most case obtained from general header)

References ALL, m_PackType, POSITION_ONLY, WITH_QUATERNION, and WITH_QUATERNION3.

Referenced by SetMessageHeader().

void igtl::CoordinateMessage::SetPosition ( float  x,
float  y,
float  z 
)

References m_Position.

void igtl::CoordinateMessage::SetPosition ( const float *  pos  ) 

References m_Position.

void igtl::CoordinateMessage::SetQuaternion ( float  ox,
float  oy,
float  oz,
float  w 
)

References m_Quaternion.

void igtl::CoordinateMessage::SetQuaternion ( const float *  quat  ) 

References m_Quaternion.

int igtl::CoordinateMessage::UnpackBody (  )  [protected, virtual]

Member Data Documentation

igtlFloat32 igtl::CoordinateMessage::m_Insertion [protected]

Referenced by PackBody(), and UnpackBody().

igtlFloat32 igtl::CoordinateMessage::m_Offset[3] [protected]
igtlInt32 igtl::CoordinateMessage::m_PackType [protected]
igtlFloat32 igtl::CoordinateMessage::m_Position[3] [protected]
igtlFloat32 igtl::CoordinateMessage::m_Quaternion[4] [protected]

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

Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1