MeVisLabToolboxReference
Public Member Functions
ml::MarkerList Class Reference

Base object class MarkerList managing a list of markers represented by Vector4's. More...

#include <mlMarkerList.h>

Inheritance diagram for ml::MarkerList:
ml::Base

List of all members.

Public Member Functions

 MarkerList ()
virtual ~MarkerList ()
MLssize_t getNum () const
 returns the number of contained points
void getValue (MLssize_t index, int &type, Vector3 &vec) const
 get marker at given index
void getValue (MLssize_t index, int &type, float &x, float &y, float &z) const
 get point at given index
void addValue (int type, const Vector3 &vec)
 add marker at end of list
void setValue (MLssize_t index, int type, const Vector3 &vec)
 set value at index
void removeValue (MLssize_t index=-1)
 remove point from list, if index is -1, last element is removed
void clear ()
 clear all entries
void print (const char *txt)
 debug print
Implementation of the virtual Base class functions for persistence; see class Base for details.
virtual char * getPersistentState () const
 Returns a C string describing the object's internal state.
virtual void setPersistentState (const char *state)
 Restores the object's internal state from a string that had been previously generated using getPersistentState().
virtual void clearPersistentState (char *state) const
 Disposes a string previously allocated by getPersistentState().

Detailed Description

Base object class MarkerList managing a list of markers represented by Vector4's.

Definition at line 31 of file mlMarkerList.h.

Constructor & Destructor Documentation

ml::MarkerList::MarkerList ( ) [inline]

Definition at line 34 of file mlMarkerList.h.

virtual ml::MarkerList::~MarkerList ( ) [inline, virtual]

Definition at line 35 of file mlMarkerList.h.

Member Function Documentation

void ml::MarkerList::addValue ( int  type,
const Vector3 &  vec 
)

add marker at end of list

void ml::MarkerList::clear ( )

clear all entries

virtual void ml::MarkerList::clearPersistentState ( char *  ) const [virtual]

Disposes a string previously allocated by getPersistentState().

Reimplemented from ml::Base.

MLssize_t ml::MarkerList::getNum ( ) const

returns the number of contained points

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

Returns a C string describing the object's internal state.

The memory for the string will be allocated here and has to be deallocated using clearPersistentState().

Reimplemented from ml::Base.

void ml::MarkerList::getValue ( MLssize_t  index,
int &  type,
Vector3 &  vec 
) const

get marker at given index

void ml::MarkerList::getValue ( MLssize_t  index,
int &  type,
float &  x,
float &  y,
float &  z 
) const

get point at given index

void ml::MarkerList::print ( const char *  txt)

debug print

void ml::MarkerList::removeValue ( MLssize_t  index = -1)

remove point from list, if index is -1, last element is removed

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

Restores the object's internal state from a string that had been previously generated using getPersistentState().

Reimplemented from ml::Base.

void ml::MarkerList::setValue ( MLssize_t  index,
int  type,
const Vector3 &  vec 
)

set value at index

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