mlXMarkerList.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_XMARKER_LIST_H
#define ML_XMARKER_LIST_H
 
 
 
// Defines the classes:
// - XMarker: A general marker with a 6D-position, a 3D-vector and an integer type.
// - XMarkerList: A list of XMarker items
// - XMarkerContainer: A container module for a XMarkerList object
 
// ML includes
#include "mlBaseInit.h"
#include "mlModuleIncludes.h"
#include "mlLinearAlgebra.h"
#include "mlTreeNode.h"
 
 
 
#include "mlListBase.h"
#include "mlListContainer.h"
 
 
 
ML_START_NAMESPACE
 
 
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
 
class MLBASEEXPORT XMarker : public BaseItem
{
public:
 
 
  Vector6 pos;   
  Vector3 vec;   
  int type;   
 
 
 
 
  XMarker ()
    : pos(0), vec(0), type(0) {}
  XMarker (const Vector3 &pos_)
    : pos(pos_,0,0,0), vec(0), type(0) {}
  XMarker (const Vector6 &pos_)
    : pos(pos_), vec(0), type(0) {}
  XMarker (const Vector6 &pos_, int type_)
    : pos(pos_), vec(0), type(type_) {}
  XMarker (const Vector6 &pos_, int type_, const char *name_)
    : pos(pos_), vec(0), type(type_) {setName(name_);}
 
  XMarker (const Vector6 &pos_, const Vector3 &vec_)
    : pos(pos_), vec(vec_), type(0) {}
  XMarker (const Vector6 &pos_, const Vector3 &vec_, int type_)
    : pos(pos_), vec(vec_), type(type_) {}
  XMarker (const Vector6 &pos_, const Vector3 &vec_, int type_, const char *name_)
    : pos(pos_), vec(vec_), type(type_) {setName(name_);}
 
  XMarker (const XMarker &marker) : BaseItem() { *this = marker; }
 
 
 
  XMarker &operator = (const XMarker &marker);
 
  bool operator ==(const XMarker &marker) const { return (pos ==  marker.pos) && (vec == marker.vec) && (type == marker.type); }
 
 
  double &x () { return pos[ML_VX]; }
  double &y () { return pos[ML_VY]; }
  double &z () { return pos[ML_VZ]; }
  double &c () { return pos[ML_VC]; }
  double &t () { return pos[ML_VT]; }
  double &u () { return pos[ML_VU]; }
 
  const double &x () const { return pos[ML_VX]; }
  const double &y () const { return pos[ML_VY]; }
  const double &z () const { return pos[ML_VZ]; }
  const double &c () const { return pos[ML_VC]; }
  const double &t () const { return pos[ML_VT]; }
  const double &u () const { return pos[ML_VU]; }
 
  double vx () const { return vec[ML_VX]; }
  double vy () const { return vec[ML_VY]; }
  double vz () const { return vec[ML_VZ]; }
 
 
 
  std::string persistentState() const override;
 
  void setPersistentState(const std::string& state) override;
 
#if !ML_DEPRECATED_SINCE(3,5,0)
protected:
#endif
 
  [[nodiscard]][[deprecated]] char *getPersistentState () const override;
 
  [[deprecated]] void setPersistentState(const char *state) override;
#if !ML_DEPRECATED_SINCE(3,5,0)
public:
#endif
 
 
  void addStateToTree(TreeNode *parent) const override;
 
  ML_SET_ADDSTATE_VERSION(0);
 
  void readStateFromTree(TreeNode *parent) override;
 
 
 
private:
 
  ML_CLASS_HEADER(XMarker);
 
};
 
 
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
 
class MLBASEEXPORT XMarkerList : public BaseListTemplate<XMarker>
{
public:
 
  XMarkerList () : BaseListTemplate<XMarker>(true) {}
 
private:
 
  ML_CLASS_HEADER(XMarkerList);
 
};
 
 
 
// ------------------------------------------------------------------
// ------------------------------------------------------------------
 
class MLBASEEXPORT XMarkerListContainer : public ListContainerTemplate<XMarkerList>
{
public:
 
  XMarkerListContainer ();
 
 
protected:
 
  bool isPropertyField (Field *field) override;
 
  void resetPropertyFields () override;
 
  void updatePropertyFields () override;
 
 
 
  bool modifyItem (MLssize_t index, Field *field, bool fromCurrentItem) override;
 
  void copyItemToTemplate (MLssize_t index) override;
 
  void copyTemplateToCurrent () override;
 
  void initItem (MLssize_t index) override;
 
 
 
private:
 
 
  Vector3Field *_fldPosXYZ;  
  FloatField *_fldPosC,      
             *_fldPosT,      
             *_fldPosU;      
  Vector3Field *_fldVec;     
  FloatField* _fldVecLength;    
  IntField *_fldType;        
 
  // template fields for initialization of a newly inserted item
 
  Vector3Field *_fldNewPosXYZ;  
  FloatField *_fldNewPosC,      
             *_fldNewPosT,      
             *_fldNewPosU;      
  Vector3Field *_fldNewVec;     
  IntField *_fldNewType;        
 
 
 
  ML_MODULE_CLASS_HEADER(XMarkerListContainer);
 
};
 
 
 
ML_END_NAMESPACE
 
#endif // __mlXMarkerList_H