MeVisLab Toolbox Reference
ml::XMarker Class Reference

#include <mlXMarkerList.h>

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

Public Member Functions

XMarkeroperator= (const XMarker &marker)
 Assignment operator.
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
std::string persistentState () const override
void setPersistentState (const std::string &state) override
 Initialize the item object from the string state.
void addStateToTree (TreeNode *parent) const override
 Add state to tree.
 ML_SET_ADDSTATE_VERSION (0)
 Set addState version number.
void readStateFromTree (TreeNode *parent) override
 Read state from tree.
Public Member Functions inherited from ml::BaseItem
void setId (MLssize_t id)
 Sets the id of the item.
MLssize_t getId () const
 Sets the id of the item.
 ~BaseItem () override
 Destructor.
BaseItemoperator= (const BaseItem &item)
 Assignment operator.
const char * name () const
 Get name.
void setName (const char *newName)
 Set name, object stores a copy.
BaseItemdeepCopy () const override
 Create a deep copy of the BaseItem.
 BaseItem ()
 Default constructor.
 BaseItem (MLssize_t id, const char *nameStr=nullptr)
 ID and name.
 BaseItem (const BaseItem &item)
 Copy constructor.
 ML_SET_ADDSTATE_VERSION (0)
 Set addState version number.
void writeTo (AbstractPersistenceOutputStream *stream) const override
 write state to stream
void readFrom (AbstractPersistenceInputStream *stream, int version) override
 read state from stream
Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
virtual ~Base ()
 Destructor.
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
virtual bool isRefCountedBase () const
 Returns whether the instance is derived from RefCountedBase.
virtual std::string detailString () const
virtual bool implementsPersistence (PersistenceInterface) const

Public Attributes

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

Additional Inherited Members

Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
Protected Member Functions inherited from ml::BaseItem
char * newString (const std::string &str) const
void deleteString (char *str) const
 Dispose a string allocated with newString().

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 51 of file mlXMarkerList.h.

Constructor & Destructor Documentation

◆ XMarker() [1/9]

ml::XMarker::XMarker ( )
inline

Default constructor.

Definition at line 69 of file mlXMarkerList.h.

References pos, type, and vec.

Referenced by operator=(), operator==(), readStateFromTree(), and XMarker().

◆ XMarker() [2/9]

ml::XMarker::XMarker ( const Vector3 & pos_)
inline

3D-Position

Definition at line 72 of file mlXMarkerList.h.

References pos, type, and vec.

◆ XMarker() [3/9]

ml::XMarker::XMarker ( const Vector6 & pos_)
inline

6D-Position

Definition at line 75 of file mlXMarkerList.h.

References pos, type, and vec.

◆ XMarker() [4/9]

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

6D-Position and type

Definition at line 78 of file mlXMarkerList.h.

References pos, type, and vec.

◆ XMarker() [5/9]

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

6D-Position, type and name

Definition at line 81 of file mlXMarkerList.h.

References pos, ml::BaseItem::setName(), type, and vec.

◆ XMarker() [6/9]

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

6D-Position and vector

Definition at line 85 of file mlXMarkerList.h.

References pos, type, and vec.

◆ XMarker() [7/9]

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

6D-Position, vector and type

Definition at line 88 of file mlXMarkerList.h.

References pos, type, and vec.

◆ XMarker() [8/9]

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

6D-Position, vector, type and name

Definition at line 91 of file mlXMarkerList.h.

References pos, ml::BaseItem::setName(), type, and vec.

◆ XMarker() [9/9]

ml::XMarker::XMarker ( const XMarker & marker)
inline

Copy constructor.

Definition at line 95 of file mlXMarkerList.h.

References ml::BaseItem::BaseItem(), and XMarker().

Member Function Documentation

◆ addStateToTree()

void ml::XMarker::addStateToTree ( TreeNode * parent) const
overridevirtual

Add state to tree.

Reimplemented from ml::BaseItem.

◆ c() [1/2]

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

Definition at line 112 of file mlXMarkerList.h.

References ML_VC, and pos.

◆ c() [2/2]

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

Definition at line 119 of file mlXMarkerList.h.

References ML_VC, and pos.

◆ ML_SET_ADDSTATE_VERSION()

ml::XMarker::ML_SET_ADDSTATE_VERSION ( 0 )

Set addState version number.

◆ operator=()

XMarker & ml::XMarker::operator= ( const XMarker & marker)

Assignment operator.

References XMarker().

◆ operator==()

bool ml::XMarker::operator== ( const XMarker & marker) const
inline

Equal operator.

Definition at line 104 of file mlXMarkerList.h.

References pos, type, vec, and XMarker().

◆ persistentState()

std::string ml::XMarker::persistentState ( ) const
overridevirtual

Return a string representation of the item object.

Reimplemented from ml::BaseItem.

◆ readStateFromTree()

void ml::XMarker::readStateFromTree ( TreeNode * parent)
overridevirtual

Read state from tree.

Reimplemented from ml::BaseItem.

References XMarker().

◆ setPersistentState()

void ml::XMarker::setPersistentState ( const std::string & state)
overridevirtual

Initialize the item object from the string state.

Reimplemented from ml::BaseItem.

◆ t() [1/2]

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

Definition at line 113 of file mlXMarkerList.h.

References ML_VT, and pos.

◆ t() [2/2]

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

Definition at line 120 of file mlXMarkerList.h.

References ML_VT, and pos.

◆ u() [1/2]

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

Definition at line 114 of file mlXMarkerList.h.

References ML_VU, and pos.

◆ u() [2/2]

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

Definition at line 121 of file mlXMarkerList.h.

References ML_VU, and pos.

◆ vx()

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

Definition at line 123 of file mlXMarkerList.h.

References ML_VX, and vec.

◆ vy()

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

Definition at line 124 of file mlXMarkerList.h.

References ML_VY, and vec.

◆ vz()

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

Definition at line 125 of file mlXMarkerList.h.

References ML_VZ, and vec.

◆ x() [1/2]

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

Definition at line 109 of file mlXMarkerList.h.

References ML_VX, and pos.

◆ x() [2/2]

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

Definition at line 116 of file mlXMarkerList.h.

References ML_VX, and pos.

◆ y() [1/2]

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

Definition at line 110 of file mlXMarkerList.h.

References ML_VY, and pos.

◆ y() [2/2]

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

Definition at line 117 of file mlXMarkerList.h.

References ML_VY, and pos.

◆ z() [1/2]

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

Definition at line 111 of file mlXMarkerList.h.

References ML_VZ, and pos.

◆ z() [2/2]

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

Definition at line 118 of file mlXMarkerList.h.

References ML_VZ, and pos.

Member Data Documentation

◆ pos

◆ type

◆ vec


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