Fraxinus  17.12-rc1
An IGT application
cxToolNull.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 #ifndef CXTOOLNULL_H
33 #define CXTOOLNULL_H
34 
35 #include "cxTool.h"
36 
37 namespace cx
38 {
39 
44 class cxResource_EXPORT ToolNull: public Tool
45 {
46 public:
47  virtual ~ToolNull() {}
48 
49  virtual std::set<Type> getTypes() const;
50  virtual vtkPolyDataPtr getGraphicsPolyData() const;
51  virtual TimedTransformMapPtr getPositionHistory();
52  virtual ToolPositionMetadata getMetadata() const;
53  virtual const std::map<double, ToolPositionMetadata>& getMetadataHistory();
54 
55  virtual bool getVisible() const;
56  virtual bool isInitialized() const;
57 
58  virtual QString getUid() const;
59  virtual QString getName() const;
60 
61  virtual bool isCalibrated() const;
62  virtual Transform3D getCalibration_sMt() const;
63  virtual void setCalibration_sMt(Transform3D calibration);
64 
65  virtual ProbePtr getProbe() const;
66  virtual double getTimestamp() const;
67  virtual void printSelf(std::ostream &os, Indent indent);
68 
69  virtual double getTooltipOffset() const;
70  virtual void setTooltipOffset(double val);
71  virtual std::map<int, Vector3D> getReferencePoints() const;
72  virtual bool hasReferencePointWithId(int id);
73 
74  virtual TimedTransformMap getSessionHistory(double startTime, double stopTime);
75  virtual Transform3D get_prMt() const;
76 
77  virtual void resetTrackingPositionFilter(TrackingPositionFilterPtr filter);
78 
79  virtual void set_prMt(const Transform3D& prMt, double timestamp);
80  virtual void setVisible(bool vis);
81 
82  virtual bool isNull();
83  static ToolPtr getNullObject();
84 
85 private:
86  std::map<double, ToolPositionMetadata> mMetadata;
87 };
88 
89 } // namespace cx
90 
91 #endif // CXTOOLNULL_H
Interface to a tool, i.e. a pointer, US probe or similar.
Definition: cxTool.h:82
Transform3D Transform3D
Transform3D is a representation of an affine 3D transform.
virtual ~ToolNull()
Definition: cxToolNull.h:47
boost::shared_ptr< Probe > ProbePtr
Definition: cxProbe.h:93
boost::shared_ptr< TimedTransformMap > TimedTransformMapPtr
Definition: cxTool.h:57
Formatting class for debug printing of the ssc library.
Definition: cxIndent.h:49
vtkSmartPointer< vtkPolyData > vtkPolyDataPtr
boost::shared_ptr< class TrackingPositionFilter > TrackingPositionFilterPtr
Definition: cxTool.h:58
std::map< double, Transform3D > TimedTransformMap
Namespace for all CustusX production code.
boost::shared_ptr< class Tool > ToolPtr