MeVisLabToolboxReference
ml::PointList Class Reference

Base object class PointList managing a list of points. More...

#include <mlPointList.h>

Inheritance diagram for ml::PointList:
ml::Base

List of all members.

Public Member Functions

 PointList ()
 Constructor creating an empty list.
virtual ~PointList ()
 Destructor.
MLssize_t getNum () const
 returns the number of contained points
void getValue (MLssize_t index, Vector3 &vec) const
 get point at given index
void getValue (MLssize_t index, float &x, float &y, float &z) const
 get point at given index
void addValue (const Vector3 &vec)
 add point at end of list
void setValue (MLssize_t index, 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 PointList managing a list of points.

Definition at line 31 of file mlPointList.h.


Constructor & Destructor Documentation

ml::PointList::PointList ( ) [inline]

Constructor creating an empty list.

Definition at line 35 of file mlPointList.h.

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

Destructor.

Definition at line 38 of file mlPointList.h.


Member Function Documentation

void ml::PointList::addValue ( const Vector3 vec)

add point at end of list

void ml::PointList::clear ( )

clear all entries

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

Disposes a string previously allocated by getPersistentState().

Reimplemented from ml::Base.

MLssize_t ml::PointList::getNum ( ) const
virtual char* ml::PointList::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::PointList::getValue ( MLssize_t  index,
Vector3 vec 
) const
void ml::PointList::getValue ( MLssize_t  index,
float &  x,
float &  y,
float &  z 
) const

get point at given index

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

debug print

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

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

virtual void ml::PointList::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::PointList::setValue ( MLssize_t  index,
const Vector3 vec 
)

set value at index


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