CustusX  2021.04.21-dev+develop.337f9
An IGT application
cx::ManualTool Class Reference

A manual tool that is unconnected to any hardware. More...

#include <cxManualTool.h>

Inheritance diagram for cx::ManualTool:
cx::ToolImpl cx::Tool cx::ManualToolAdapter

Public Member Functions

 ManualTool (const QString &uid, const QString &name="")
 
virtual ~ManualTool ()
 
virtual std::set< TypegetTypes () const
 
virtual vtkPolyDataPtr getGraphicsPolyData () const
 get geometric 3D description More...
 
virtual void setTransformSaveFile (const QString &filename)
 
virtual bool getVisible () const
 
virtual QString getUid () const
 
virtual QString getName () const
 
virtual int getIndex () const
 
virtual bool isCalibrated () const
 a tool may not be calibrated, then no tracking is allowed More...
 
virtual double getTimestamp () const
 latest valid timestamp for the position matrix. 0 means indeterminate (for f.ex. manual tools) More...
 
virtual void set_prMt (const Transform3D &prMt, double timestamp=-1)
 
virtual Transform3D getCalibration_sMt () const
 get the calibration transform from tool space to sensor space (where the spheres or similar live) More...
 
virtual std::map< int, Vector3DgetReferencePoints () const
 Get the optional reference points from this tool. More...
 
virtual void setVisible (bool vis)
 if available for this type, set visibility More...
 
- Public Member Functions inherited from cx::ToolImpl
 ToolImpl (const QString &uid="", const QString &name="")
 
virtual ~ToolImpl ()
 
virtual TimedTransformMapPtr getPositionHistory ()
 get historical positions More...
 
virtual TimedTransformMap getSessionHistory (double startTime, double stopTime)
 
virtual Transform3D get_prMt () const
 
virtual ToolPositionMetadata getMetadata () const
 
virtual const std::map< double, ToolPositionMetadata > & getMetadataHistory ()
 
virtual double getTooltipOffset () const
 get a virtual offset extending from the tool tip. More...
 
virtual void setTooltipOffset (double val)
 set a virtual offset extending from the tool tip. More...
 
virtual void resetTrackingPositionFilter (TrackingPositionFilterPtr filter)
 
virtual bool isNull ()
 
virtual void addXml (QDomNode &dataNode)
 
virtual void parseXml (QDomNode &dataNode)
 
virtual bool hasReferencePointWithId (int id)
 
- Public Member Functions inherited from cx::Tool
 Tool (const QString &uid="", const QString &name="")
 
virtual ~Tool ()
 
virtual bool hasType (Type type) const
 
virtual bool isInitialized () const
 
virtual void setCalibration_sMt (Transform3D calibration)
 requests to use the calibration and replaces the tools calibration file More...
 
virtual ProbePtr getProbe () const
 additional information if the tool represents an US Probe. Extends getProbeSector() More...
 
virtual void printSelf (std::ostream &os, Indent indent)
 dump internal debug data More...
 

Additional Inherited Members

- Public Types inherited from cx::Tool
enum  State { tsNONE =0, tsCONFIGURED, tsINITIALIZED, tsTRACKING }
 
enum  Type {
  TOOL_NONE, TOOL_REFERENCE, TOOL_MANUAL, TOOL_POINTER,
  TOOL_US_PROBE, TOOL_MICROSCOPE
}
 
- Signals inherited from cx::Tool
void toolTransformAndTimestamp (Transform3D matrix, double timestamp)
 
void toolVisible (bool visible)
 
void tooltipOffset (double offset)
 
void toolProbeSector ()
 
void tps (int)
 
- Static Public Member Functions inherited from cx::Tool
static vtkPolyDataPtr createDefaultPolyDataCone ()
 
static ToolPtr getNullObject ()
 
- Protected Member Functions inherited from cx::ToolImpl
void createToolGraphic ()
 
virtual ToolFileParser::ToolInternalStructurePtr getToolFileToolStructure () const
 
- Protected Attributes inherited from cx::ToolImpl
TimedTransformMapPtr mPositionHistory
 
Transform3D m_prMt
 the transform from the tool to the patient reference More...
 
TrackingPositionFilterPtr mTrackingPositionFilter
 
std::map< double, ToolPositionMetadatamMetadata
 
vtkPolyDataPtr mPolyData
 the polydata used to represent the tool graphically More...
 
- Protected Attributes inherited from cx::Tool
QString mUid
 
QString mName
 

Detailed Description

A manual tool that is unconnected to any hardware.

Implementation of a Tool that is controlled programatically. Can be used as a mouse-controlled offline tool.

Use this tool by setting the functions setTransform() and setVisible().

This class is Threadsafe.

Definition at line 36 of file cxManualTool.h.

Constructor & Destructor Documentation

cx::ManualTool::ManualTool ( const QString &  uid,
const QString &  name = "" 
)
explicit

Definition at line 24 of file cxManualTool.cpp.

cx::ManualTool::~ManualTool ( )
virtual

Definition at line 33 of file cxManualTool.cpp.

Member Function Documentation

Transform3D cx::ManualTool::getCalibration_sMt ( ) const
virtual

get the calibration transform from tool space to sensor space (where the spheres or similar live)

Implements cx::Tool.

Reimplemented in cx::ManualToolAdapter.

Definition at line 121 of file cxManualTool.cpp.

vtkPolyDataPtr cx::ManualTool::getGraphicsPolyData ( ) const
virtual

get geometric 3D description

Reimplemented from cx::ToolImpl.

Reimplemented in cx::ManualToolAdapter.

Definition at line 77 of file cxManualTool.cpp.

int cx::ManualTool::getIndex ( ) const
virtual

Definition at line 88 of file cxManualTool.cpp.

QString cx::ManualTool::getName ( ) const
virtual
Returns
a descriptive name for this instance

Implements cx::Tool.

Definition at line 98 of file cxManualTool.cpp.

virtual std::map<int, Vector3D> cx::ManualTool::getReferencePoints ( ) const
inlinevirtual

Get the optional reference points from this tool.

Reimplemented from cx::ToolImpl.

Reimplemented in cx::ManualToolAdapter.

Definition at line 55 of file cxManualTool.h.

double cx::ManualTool::getTimestamp ( ) const
virtual

latest valid timestamp for the position matrix. 0 means indeterminate (for f.ex. manual tools)

Implements cx::Tool.

Definition at line 116 of file cxManualTool.cpp.

std::set< Tool::Type > cx::ManualTool::getTypes ( ) const
virtual

Reimplemented from cx::ToolImpl.

Reimplemented in cx::ManualToolAdapter.

Definition at line 69 of file cxManualTool.cpp.

QString cx::ManualTool::getUid ( ) const
virtual
Returns
an unique id for this instance

Implements cx::Tool.

Definition at line 93 of file cxManualTool.cpp.

bool cx::ManualTool::getVisible ( ) const
virtual
Returns
the visibility status of the tool

Implements cx::Tool.

Definition at line 83 of file cxManualTool.cpp.

bool cx::ManualTool::isCalibrated ( ) const
virtual

a tool may not be calibrated, then no tracking is allowed

Implements cx::Tool.

Reimplemented in cx::ManualToolAdapter.

Definition at line 111 of file cxManualTool.cpp.

void cx::ManualTool::set_prMt ( const Transform3D prMt,
double  timestamp = -1 
)
virtual

Set tool position and timestamp

Reimplemented from cx::ToolImpl.

Definition at line 61 of file cxManualTool.cpp.

virtual void cx::ManualTool::setTransformSaveFile ( const QString &  filename)
inlinevirtual

Definition at line 45 of file cxManualTool.h.

void cx::ManualTool::setVisible ( bool  vis)
virtual

if available for this type, set visibility

Implements cx::Tool.

Definition at line 103 of file cxManualTool.cpp.


The documentation for this class was generated from the following files: