MeVisLabToolboxReference
ml::XMarker Class Reference

Base object class XMarker (derived form baseItem) with 6D pos, 3D vec and type int. More...

#include <mlXMarkerList.h>

Inheritance diagram for ml::XMarker:
ml::BaseItem ml::Base

List of all members.

Public Member Functions

virtual XMarkeroperator= (const XMarker &marker)
 Assignment operator.
bool operator< (const XMarker &) const
 Dummy "less than operator", required for VC7.
bool operator== (const XMarker &marker) const
 Equal operator.
Constructors
 XMarker ()
 Default constructor.
 XMarker (const Vector3 &pos_)
 3D-Position
 XMarker (const Vector6 &pos_)
 6D-Position
 XMarker (const Vector6 &pos_, int type_)
 6D-Position and type
 XMarker (const Vector6 &pos_, int type_, const char *name_)
 6D-Position, type and name
 XMarker (const Vector6 &pos_, const Vector3 &vec_)
 6D-Position and vector
 XMarker (const Vector6 &pos_, const Vector3 &vec_, int type_)
 6D-Position, vector and type
 XMarker (const Vector6 &pos_, const Vector3 &vec_, int type_, const char *name_)
 6D-Position, vector, type and name
 XMarker (const XMarker &marker)
 Copy constructor.
Direct coordinate access
double & x ()
double & y ()
double & z ()
double & c ()
double & t ()
double & u ()
const double & x () const
const double & y () const
const double & z () const
const double & c () const
const double & t () const
const double & u () const
double vx () const
double vy () const
double vz () const
Persistence
virtual char * getPersistentState () const
 Return a string representation of the item object.
virtual void setPersistentState (const char *state)
 Initialize the item object from the string state.
virtual void addStateToTree (TreeNode *parent) const
 Add state to tree.
 ML_SET_ADDSTATE_VERSION (0)
 Set addState version number.
virtual void readStateFromTree (TreeNode *parent)
 Read state from tree.

Public Attributes

Marker properties
Vector6 pos
 Marker position.
Vector3 vec
 Marker vector, relative to position.
int type
 Marker type.

Detailed Description

Base object class XMarker (derived form baseItem) with 6D pos, 3D vec and type int.

General marker class with the following properties:

  • A 6D position
  • A 3D vector (relative to the marker position)
  • An integer type

Definition at line 62 of file mlXMarkerList.h.


Constructor & Destructor Documentation

ml::XMarker::XMarker ( ) [inline]

Default constructor.

Definition at line 80 of file mlXMarkerList.h.

ml::XMarker::XMarker ( const Vector3 pos_) [inline]

3D-Position

Definition at line 83 of file mlXMarkerList.h.

ml::XMarker::XMarker ( const Vector6 pos_) [inline]

6D-Position

Definition at line 86 of file mlXMarkerList.h.

ml::XMarker::XMarker ( const Vector6 pos_,
int  type_ 
) [inline]

6D-Position and type

Definition at line 89 of file mlXMarkerList.h.

ml::XMarker::XMarker ( const Vector6 pos_,
int  type_,
const char *  name_ 
) [inline]

6D-Position, type and name

Definition at line 92 of file mlXMarkerList.h.

References ml::BaseItem::setName().

ml::XMarker::XMarker ( const Vector6 pos_,
const Vector3 vec_ 
) [inline]

6D-Position and vector

Definition at line 96 of file mlXMarkerList.h.

ml::XMarker::XMarker ( const Vector6 pos_,
const Vector3 vec_,
int  type_ 
) [inline]

6D-Position, vector and type

Definition at line 99 of file mlXMarkerList.h.

ml::XMarker::XMarker ( const Vector6 pos_,
const Vector3 vec_,
int  type_,
const char *  name_ 
) [inline]

6D-Position, vector, type and name

Definition at line 102 of file mlXMarkerList.h.

References ml::BaseItem::setName().

ml::XMarker::XMarker ( const XMarker marker) [inline]

Copy constructor.

Definition at line 106 of file mlXMarkerList.h.


Member Function Documentation

virtual void ml::XMarker::addStateToTree ( TreeNode parent) const [virtual]

Add state to tree.

Reimplemented from ml::BaseItem.

double& ml::XMarker::c ( ) [inline]

Definition at line 126 of file mlXMarkerList.h.

References ML_VC.

const double& ml::XMarker::c ( ) const [inline]

Definition at line 133 of file mlXMarkerList.h.

References ML_VC.

virtual char* ml::XMarker::getPersistentState ( ) const [virtual]

Return a string representation of the item object.

The string is allocated on the heap and is later disposed by clearPersistentState().

Reimplemented from ml::BaseItem.

ml::XMarker::ML_SET_ADDSTATE_VERSION ( )

Set addState version number.

Reimplemented from ml::BaseItem.

bool ml::XMarker::operator< ( const XMarker ) const [inline]

Dummy "less than operator", required for VC7.

Definition at line 115 of file mlXMarkerList.h.

virtual XMarker& ml::XMarker::operator= ( const XMarker marker) [virtual]

Assignment operator.

bool ml::XMarker::operator== ( const XMarker marker) const [inline]

Equal operator.

Definition at line 118 of file mlXMarkerList.h.

References pos, type, and vec.

virtual void ml::XMarker::readStateFromTree ( TreeNode parent) [virtual]

Read state from tree.

Reimplemented from ml::BaseItem.

virtual void ml::XMarker::setPersistentState ( const char *  state) [virtual]

Initialize the item object from the string state.

Reimplemented from ml::BaseItem.

double& ml::XMarker::t ( ) [inline]

Definition at line 127 of file mlXMarkerList.h.

References ML_VT.

const double& ml::XMarker::t ( ) const [inline]

Definition at line 134 of file mlXMarkerList.h.

References ML_VT.

double& ml::XMarker::u ( ) [inline]

Definition at line 128 of file mlXMarkerList.h.

References ML_VU.

const double& ml::XMarker::u ( ) const [inline]

Definition at line 135 of file mlXMarkerList.h.

References ML_VU.

double ml::XMarker::vx ( ) const [inline]

Definition at line 137 of file mlXMarkerList.h.

References ML_VX.

double ml::XMarker::vy ( ) const [inline]

Definition at line 138 of file mlXMarkerList.h.

References ML_VY.

double ml::XMarker::vz ( ) const [inline]

Definition at line 139 of file mlXMarkerList.h.

References ML_VZ.

double& ml::XMarker::x ( ) [inline]

Definition at line 123 of file mlXMarkerList.h.

References ML_VX.

const double& ml::XMarker::x ( ) const [inline]

Definition at line 130 of file mlXMarkerList.h.

References ML_VX.

double& ml::XMarker::y ( ) [inline]

Definition at line 124 of file mlXMarkerList.h.

References ML_VY.

const double& ml::XMarker::y ( ) const [inline]

Definition at line 131 of file mlXMarkerList.h.

References ML_VY.

double& ml::XMarker::z ( ) [inline]

Definition at line 125 of file mlXMarkerList.h.

References ML_VZ.

const double& ml::XMarker::z ( ) const [inline]

Definition at line 132 of file mlXMarkerList.h.

References ML_VZ.


Member Data Documentation

Marker position.

Definition at line 69 of file mlXMarkerList.h.

Referenced by operator==().

Marker type.

Definition at line 71 of file mlXMarkerList.h.

Referenced by operator==().

Marker vector, relative to position.

Definition at line 70 of file mlXMarkerList.h.

Referenced by operator==().


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