Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitkTrackingTool.h
Go to the documentation of this file.
1 /*===================================================================
2 
3 The Medical Imaging Interaction Toolkit (MITK)
4 
5 Copyright (c) German Cancer Research Center,
6 Division of Medical and Biological Informatics.
7 All rights reserved.
8 
9 This software is distributed WITHOUT ANY WARRANTY; without
10 even the implied warranty of MERCHANTABILITY or FITNESS FOR
11 A PARTICULAR PURPOSE.
12 
13 See LICENSE.txt or http://www.mitk.org for details.
14 
15 ===================================================================*/
16 
17 
18 #ifndef MITKTRACKINGTOOL_H_HEADER_INCLUDED_
19 #define MITKTRACKINGTOOL_H_HEADER_INCLUDED_
20 
21 #include <itkObject.h>
22 #include <MitkIGTExports.h>
23 #include <mitkCommon.h>
24 #include <mitkNumericTypes.h>
25 #include <itkFastMutexLock.h>
26 
27 namespace mitk
28 {
36  class MITKIGT_EXPORT TrackingTool : public itk::Object
37  {
38  public:
39  mitkClassMacroItkParent(TrackingTool, itk::Object);
40 
41  virtual void PrintSelf(std::ostream& os, itk::Indent indent) const override;
42 
43  virtual void SetToolTip(Point3D toolTipPosition, Quaternion orientation, ScalarType eps=0.0) = 0;
44  virtual void GetPosition(Point3D& position) const = 0;
45  virtual void GetOrientation(Quaternion& orientation) const = 0;
46  virtual bool Enable() = 0;
47  virtual bool Disable() = 0;
48  virtual bool IsEnabled() const = 0;
49  virtual bool IsDataValid() const = 0;
50  virtual float GetTrackingError() const = 0;
51  virtual const char* GetToolName() const;
52  virtual const char* GetErrorMessage() const;
53  itkSetMacro(IGTTimeStamp, double);
54  itkGetConstMacro(IGTTimeStamp, double);
55 
56  protected:
57  TrackingTool();
58  virtual ~TrackingTool();
59  std::string m_ToolName;
60  std::string m_ErrorMessage;
61  double m_IGTTimeStamp;
62  itk::FastMutexLock::Pointer m_MyMutex;
63  };
64 } // namespace mitk
65 #endif /* MITKTRACKINGTOOL_H_HEADER_INCLUDED_ */
mitk::TrackingTool
Interface for all Tracking Tools.
Definition: mitkTrackingTool.h:36
mitk::Pointer
itk::SmartPointer< Self > Pointer
Definition: mitkRenderingManager.h:389
mitk::TrackingTool::m_IGTTimeStamp
double m_IGTTimeStamp
contains the time at which the tracking data was recorded
Definition: mitkTrackingTool.h:61
mitk::ScalarType
double ScalarType
Definition: mitkNumericConstants.h:24
mitk::TrackingTool::m_ErrorMessage
std::string m_ErrorMessage
if a tool is invalid, this member should contain a human readable explanation of why it is invalid ...
Definition: mitkTrackingTool.h:60
mitk::TrackingTool::m_MyMutex
itk::FastMutexLock::Pointer m_MyMutex
mutex to control concurrent access to the tool
Definition: mitkTrackingTool.h:62
mitk
DataCollection - Class to facilitate loading/accessing structured data.
Definition: GeometryOverview.dox:1
mitk::IGTTimeStamp
Time stamp in milliseconds.
Definition: mitkIGTTimeStamp.h:52
mitkClassMacroItkParent
#define mitkClassMacroItkParent(className, SuperClassName)
Definition: mitkCommon.h:53
mitk::Quaternion
vnl_quaternion< ScalarType > Quaternion
Definition: mitkQuaternion.h:25
mitk::TrackingTool::m_ToolName
std::string m_ToolName
every tool has a name that can be used to identify it.
Definition: mitkTrackingTool.h:59
mitk::eps
MITKCORE_EXPORT const ScalarType eps
Definition: mitkNumericConstants.cpp:21