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

A tool used during playback. More...

#include <cxPlaybackTool.h>

Inheritance diagram for cx::PlaybackTool:
cx::ToolImpl cx::Tool

Public Member Functions

 PlaybackTool (ToolPtr base, PlaybackTimePtr time)
 
virtual ~PlaybackTool ()
 
virtual std::set< TypegetTypes () const
 
virtual vtkPolyDataPtr getGraphicsPolyData () const
 get geometric 3D description More...
 
virtual void setTransformSaveFile (const QString &filename)
 
virtual Transform3D get_prMt () const
 
virtual bool getVisible () const
 
virtual QString getUid () const
 
virtual QString getName () 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 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 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...
 
virtual TimedTransformMapPtr getPositionHistory ()
 get historical positions More...
 
virtual bool isInitialized () const
 
virtual ProbePtr getProbe () const
 additional information if the tool represents an US Probe. Extends getProbeSector() More...
 
virtual bool hasReferencePointWithId (QString id)
 
virtual TimedTransformMap getSessionHistory (double startTime, double stopTime)
 
virtual void set_prMt (const Transform3D &prMt, double timestamp)
 if available for this type, set pos, ts<0 means use current time More...
 
virtual void setVisible (bool vis)
 if available for this type, set visibility More...
 
ToolPtr getBase ()
 
- Public Member Functions inherited from cx::ToolImpl
 ToolImpl (const QString &uid="", const QString &name="")
 
virtual ~ToolImpl ()
 
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)
 
- Public Member Functions inherited from cx::Tool
 Tool (const QString &uid="", const QString &name="")
 
virtual ~Tool ()
 
virtual bool hasType (Type type) 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

A tool used during playback.

Date
Mar 29, 2012
Author
Christian Askeland, SINTEF

Definition at line 33 of file cxPlaybackTool.h.

Constructor & Destructor Documentation

cx::PlaybackTool::PlaybackTool ( ToolPtr  base,
PlaybackTimePtr  time 
)
explicit

Definition at line 21 of file cxPlaybackTool.cpp.

cx::PlaybackTool::~PlaybackTool ( )
virtual

Definition at line 32 of file cxPlaybackTool.cpp.

Member Function Documentation

Transform3D cx::PlaybackTool::get_prMt ( ) const
virtual

Reimplemented from cx::ToolImpl.

Definition at line 80 of file cxPlaybackTool.cpp.

ToolPtr cx::PlaybackTool::getBase ( )
inline

Definition at line 66 of file cxPlaybackTool.h.

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

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

Implements cx::Tool.

Definition at line 122 of file cxPlaybackTool.cpp.

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

get geometric 3D description

Reimplemented from cx::ToolImpl.

Definition at line 75 of file cxPlaybackTool.cpp.

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

Implements cx::Tool.

Definition at line 95 of file cxPlaybackTool.cpp.

virtual TimedTransformMapPtr cx::PlaybackTool::getPositionHistory ( )
inlinevirtual

get historical positions

Reimplemented from cx::ToolImpl.

Definition at line 56 of file cxPlaybackTool.h.

virtual ProbePtr cx::PlaybackTool::getProbe ( ) const
inlinevirtual

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

Reimplemented from cx::Tool.

Definition at line 58 of file cxPlaybackTool.h.

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

Get the optional reference points from this tool.

Reimplemented from cx::ToolImpl.

Definition at line 127 of file cxPlaybackTool.cpp.

virtual TimedTransformMap cx::PlaybackTool::getSessionHistory ( double  startTime,
double  stopTime 
)
inlinevirtual

Reimplemented from cx::ToolImpl.

Definition at line 60 of file cxPlaybackTool.h.

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

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

Implements cx::Tool.

Definition at line 105 of file cxPlaybackTool.cpp.

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

get a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 111 of file cxPlaybackTool.cpp.

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

Reimplemented from cx::ToolImpl.

Definition at line 70 of file cxPlaybackTool.cpp.

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

Implements cx::Tool.

Definition at line 90 of file cxPlaybackTool.cpp.

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

Implements cx::Tool.

Definition at line 85 of file cxPlaybackTool.cpp.

virtual bool cx::PlaybackTool::hasReferencePointWithId ( QString  id)
inlinevirtual

Reimplemented from cx::ToolImpl.

Definition at line 59 of file cxPlaybackTool.h.

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

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

Implements cx::Tool.

Definition at line 100 of file cxPlaybackTool.cpp.

bool cx::PlaybackTool::isInitialized ( ) const
virtual

Reimplemented from cx::Tool.

Definition at line 132 of file cxPlaybackTool.cpp.

void cx::PlaybackTool::set_prMt ( const Transform3D prMt,
double  timestamp 
)
virtual

if available for this type, set pos, ts<0 means use current time

Reimplemented from cx::ToolImpl.

Definition at line 137 of file cxPlaybackTool.cpp.

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

set a virtual offset extending from the tool tip.

Reimplemented from cx::ToolImpl.

Definition at line 117 of file cxPlaybackTool.cpp.

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

Definition at line 41 of file cxPlaybackTool.h.

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

if available for this type, set visibility

Implements cx::Tool.

Definition at line 142 of file cxPlaybackTool.cpp.


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