Fraxinus  16.5.0-fx-rc6
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cxToolImpl.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 CXTOOLIMPL_H
33 #define CXTOOLIMPL_H
34 
35 #include "cxResourceExport.h"
36 
37 #include "cxTool.h"
38 
39 namespace cx
40 {
41 typedef boost::shared_ptr<class TrackingPositionFilter> TrackingPositionFilterPtr;
42 
50 class cxResource_EXPORT ToolImpl : public Tool
51 {
52  Q_OBJECT
53 public:
54  explicit ToolImpl(const QString& uid="", const QString& name ="");
55  virtual ~ToolImpl();
56 
57  virtual TimedTransformMapPtr getPositionHistory();
58  virtual TimedTransformMap getSessionHistory(double startTime, double stopTime);
59  virtual Transform3D get_prMt() const;
60 
61  virtual ToolPositionMetadata getMetadata() const;
62  virtual const std::map<double, ToolPositionMetadata>& getMetadataHistory();
63 
64  virtual double getTooltipOffset() const;
65  virtual void setTooltipOffset(double val);
66 
67  virtual void resetTrackingPositionFilter(TrackingPositionFilterPtr filter);
68  virtual bool isNull() { return false; }
69 
70  virtual void addXml(QDomNode& dataNode) {}
71  virtual void parseXml(QDomNode& dataNode) {}
72 
73 protected:
74  virtual void set_prMt(const Transform3D& prMt, double timestamp);
78  std::map<double, ToolPositionMetadata> mMetadata;
79 
80 private:
81  double mTooltipOffset;
82 };
83 typedef boost::shared_ptr<ToolImpl> cxToolPtr;
84 
85 } // namespace cx
86 
87 #endif // CXTOOLIMPL_H
TimedTransformMapPtr mPositionHistory
Definition: cxToolImpl.h:75
TrackingPositionFilterPtr mTrackingPositionFilter
Definition: cxToolImpl.h:77
Interface to a tool, i.e. a pointer, US probe or similar.
Definition: cxTool.h:82
virtual void parseXml(QDomNode &dataNode)
Definition: cxToolImpl.h:71
Transform3D Transform3D
Transform3D is a representation of an affine 3D transform.
boost::shared_ptr< ToolImpl > cxToolPtr
Definition: cxToolImpl.h:83
Common functionality for Tool subclasses.
Definition: cxToolImpl.h:50
virtual bool isNull()
Definition: cxToolImpl.h:68
boost::shared_ptr< TimedTransformMap > TimedTransformMapPtr
Definition: cxTool.h:57
std::map< double, ToolPositionMetadata > mMetadata
Definition: cxToolImpl.h:78
virtual void addXml(QDomNode &dataNode)
Definition: cxToolImpl.h:70
boost::shared_ptr< class TrackingPositionFilter > TrackingPositionFilterPtr
Definition: cxTool.h:58
std::map< double, Transform3D > TimedTransformMap
Transform3D m_prMt
the transform from the tool to the patient reference
Definition: cxToolImpl.h:76