CustusX  2023.01.05-dev+develop.0da12
An IGT application
cx::ManualToolAdapter Class Reference

Adapter class for ManualTool.A ManualToolAdapter inherits from manual tool, but also contains a cx::Tool that is requests shape and probe info from. More...

#include <cxManualToolAdapter.h>

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

Public Member Functions

 ManualToolAdapter (QString uid)
 
 ManualToolAdapter (ToolPtr base)
 
virtual ~ManualToolAdapter ()
 
virtual std::set< TypegetTypes () const
 
virtual vtkPolyDataPtr getGraphicsPolyData () const
 get geometric 3D description More...
 
virtual bool isCalibrated () const
 a tool may not be calibrated, then no tracking is allowed More...
 
virtual ProbePtr getProbe () const
 additional information if the tool represents an US Probe. Extends getProbeSector() More...
 
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< QString, Vector3DgetReferencePoints () const
 Get the optional reference points from this tool. More...
 
void setBase (ToolPtr base)
 
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...
 
void startEmittingContinuousPositions (int msecBetweenPositions)
 
- Public Member Functions inherited from cx::ManualTool
 ManualTool (const QString &uid, const QString &name="")
 
virtual ~ManualTool ()
 
virtual void setTransformSaveFile (const QString &filename)
 
virtual bool getVisible () const
 
virtual QString getUid () const
 
virtual QString getName () const
 
virtual int getIndex () const
 
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 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 ToolPtr getBaseTool ()
 
virtual ToolPositionMetadata getMetadata () const
 
virtual const std::map< double, ToolPositionMetadata > & getMetadataHistory ()
 
virtual void resetTrackingPositionFilter (TrackingPositionFilterPtr filter)
 
virtual bool isNull ()
 
virtual void addXml (QDomNode &dataNode)
 
virtual void parseXml (QDomNode &dataNode)
 
virtual bool hasReferencePointWithId (QString 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 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

Adapter class for ManualTool.

A ManualToolAdapter inherits from manual tool, but also contains a cx::Tool that is requests shape and probe info from.

Used for debug - when testing tools without a tracking system.

Date
Feb 14, 2011
Author
christiana

Definition at line 34 of file cxManualToolAdapter.h.

Constructor & Destructor Documentation

cx::ManualToolAdapter::ManualToolAdapter ( QString  uid)
explicit

Definition at line 18 of file cxManualToolAdapter.cpp.

cx::ManualToolAdapter::ManualToolAdapter ( ToolPtr  base)
explicit

Definition at line 27 of file cxManualToolAdapter.cpp.

cx::ManualToolAdapter::~ManualToolAdapter ( )
virtual

Definition at line 32 of file cxManualToolAdapter.cpp.

Member Function Documentation

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

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

Reimplemented from cx::ManualTool.

Definition at line 80 of file cxManualToolAdapter.cpp.

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

get geometric 3D description

Reimplemented from cx::ManualTool.

Definition at line 65 of file cxManualToolAdapter.cpp.

ProbePtr cx::ManualToolAdapter::getProbe ( ) const
virtual

additional information if the tool represents an US Probe. Extends getProbeSector()

Reimplemented from cx::Tool.

Definition at line 75 of file cxManualToolAdapter.cpp.

std::map< QString, Vector3D > cx::ManualToolAdapter::getReferencePoints ( ) const
virtual

Get the optional reference points from this tool.

Reimplemented from cx::ManualTool.

Definition at line 85 of file cxManualToolAdapter.cpp.

double cx::ManualToolAdapter::getTooltipOffset ( ) const
virtual

get a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 90 of file cxManualToolAdapter.cpp.

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

Reimplemented from cx::ManualTool.

Definition at line 100 of file cxManualToolAdapter.cpp.

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

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

Reimplemented from cx::ManualTool.

Definition at line 70 of file cxManualToolAdapter.cpp.

void cx::ManualToolAdapter::setBase ( ToolPtr  base)

Definition at line 36 of file cxManualToolAdapter.cpp.

void cx::ManualToolAdapter::setTooltipOffset ( double  val)
virtual

set a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 95 of file cxManualToolAdapter.cpp.

void cx::ManualToolAdapter::startEmittingContinuousPositions ( int  msecBetweenPositions)

Definition at line 107 of file cxManualToolAdapter.cpp.


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