mitkTrackingTool.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/


#ifndef MITKTRACKINGTOOL_H_HEADER_INCLUDED_
#define MITKTRACKINGTOOL_H_HEADER_INCLUDED_

#include <itkObject.h>
#include <MitkIGTExports.h>
#include <mitkCommon.h>
#include <mitkNumericTypes.h>
#include <itkFastMutexLock.h>

namespace mitk
{
  class MITKIGT_EXPORT TrackingTool : public itk::Object
  {
  public:
    mitkClassMacroItkParent(TrackingTool, itk::Object);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);

    void PrintSelf(std::ostream& os, itk::Indent indent) const override;

    virtual const char* GetToolName() const; 
    virtual void SetToolName(const std::string _arg); 
    virtual void SetToolName(const char* _arg); 

    Point3D GetToolTipPosition() const; 
    Quaternion GetToolAxisOrientation() const; 
    virtual void SetToolTipPosition(Point3D toolTipPosition, Quaternion orientation, ScalarType eps=0.0); 
    virtual bool IsToolTipSet() const; 

    virtual void GetPosition(Point3D& position) const; 
    virtual void SetPosition(Point3D position); 

    virtual void GetOrientation(Quaternion& orientation) const; 
    virtual void SetOrientation(Quaternion orientation); 

    virtual bool Enable(); 
    virtual bool Disable(); 
    virtual bool IsEnabled() const; 

    virtual void SetDataValid(bool isDataValid); 
    virtual bool IsDataValid() const; 

    virtual float GetTrackingError() const; 
    virtual void SetTrackingError(float error); 

    virtual const char* GetErrorMessage() const; 
    virtual void SetErrorMessage(const char* _arg); 

    itkSetMacro(IGTTimeStamp, double) 
    itkGetConstMacro(IGTTimeStamp, double) 

  protected:
    TrackingTool();
    ~TrackingTool() override;

    std::string m_ToolName;                          
    std::string m_ErrorMessage;                      
    double m_IGTTimeStamp;                           
    itk::FastMutexLock::Pointer m_MyMutex;           

    Point3D m_Position;         
    Quaternion m_Orientation;   
    float m_TrackingError;      
    bool m_Enabled;             
    bool m_DataValid;           
    Point3D m_ToolTipPosition;  
    Quaternion m_ToolAxisOrientation; 
    bool m_ToolTipSet;
  };
} // namespace mitk
#endif /* MITKTRACKINGTOOL_H_HEADER_INCLUDED_ */