CustusX  2021.04.22-dev+develop.337f9
An IGT application
cx::ToolNull Class Reference

#include <cxToolNull.h>

Inheritance diagram for cx::ToolNull:
cx::Tool

Public Member Functions

virtual ~ToolNull ()
 
virtual std::set< TypegetTypes () const
 
virtual vtkPolyDataPtr getGraphicsPolyData () const
 get geometric 3D description More...
 
virtual TimedTransformMapPtr getPositionHistory ()
 get historical positions More...
 
virtual ToolPositionMetadata getMetadata () const
 
virtual const std::map< double, ToolPositionMetadata > & getMetadataHistory ()
 
virtual bool getVisible () const
 
virtual bool isInitialized () 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 Transform3D getCalibration_sMt () const
 get the calibration transform from tool space to sensor space (where the spheres or similar live) More...
 
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 double getTimestamp () const
 latest valid timestamp for the position matrix. 0 means indeterminate (for f.ex. manual tools) More...
 
virtual void printSelf (std::ostream &os, Indent indent)
 dump internal debug data 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 std::map< int, Vector3DgetReferencePoints () const
 Get the optional reference points from this tool. More...
 
virtual bool hasReferencePointWithId (int id)
 
virtual TimedTransformMap getSessionHistory (double startTime, double stopTime)
 
virtual Transform3D get_prMt () const
 
virtual void resetTrackingPositionFilter (TrackingPositionFilterPtr filter)
 
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...
 
virtual bool isNull ()
 
- Public Member Functions inherited from cx::Tool
 Tool (const QString &uid="", const QString &name="")
 
virtual ~Tool ()
 
virtual bool hasType (Type type) const
 

Static Public Member Functions

static ToolPtr getNullObject ()
 
- Static Public Member Functions inherited from cx::Tool
static vtkPolyDataPtr createDefaultPolyDataCone ()
 
static ToolPtr getNullObject ()
 

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)
 
- Protected Attributes inherited from cx::Tool
QString mUid
 
QString mName
 

Detailed Description

Null implementation of Tool

Definition at line 23 of file cxToolNull.h.

Constructor & Destructor Documentation

virtual cx::ToolNull::~ToolNull ( )
inlinevirtual

Definition at line 26 of file cxToolNull.h.

Member Function Documentation

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

Implements cx::Tool.

Definition at line 107 of file cxToolNull.cpp.

Transform3D cx::ToolNull::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 56 of file cxToolNull.cpp.

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

get geometric 3D description

Implements cx::Tool.

Definition at line 11 of file cxToolNull.cpp.

ToolPositionMetadata cx::ToolNull::getMetadata ( ) const
virtual

Implements cx::Tool.

Definition at line 21 of file cxToolNull.cpp.

const std::map< double, ToolPositionMetadata > & cx::ToolNull::getMetadataHistory ( )
virtual

Implements cx::Tool.

Definition at line 26 of file cxToolNull.cpp.

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

Implements cx::Tool.

Definition at line 47 of file cxToolNull.cpp.

static ToolPtr cx::ToolNull::getNullObject ( )
static
TimedTransformMapPtr cx::ToolNull::getPositionHistory ( )
virtual

get historical positions

Implements cx::Tool.

Definition at line 16 of file cxToolNull.cpp.

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

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

Reimplemented from cx::Tool.

Definition at line 66 of file cxToolNull.cpp.

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

Get the optional reference points from this tool.

Reimplemented from cx::Tool.

Definition at line 91 of file cxToolNull.cpp.

TimedTransformMap cx::ToolNull::getSessionHistory ( double  startTime,
double  stopTime 
)
virtual

Implements cx::Tool.

Definition at line 102 of file cxToolNull.cpp.

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

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

Implements cx::Tool.

Definition at line 71 of file cxToolNull.cpp.

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

get a virtual offset extending from the tool tip.

Reimplemented from cx::Tool.

Definition at line 81 of file cxToolNull.cpp.

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

Implements cx::Tool.

Definition at line 6 of file cxToolNull.cpp.

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

Implements cx::Tool.

Definition at line 41 of file cxToolNull.cpp.

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

Implements cx::Tool.

Definition at line 31 of file cxToolNull.cpp.

bool cx::ToolNull::hasReferencePointWithId ( int  id)
virtual

Reimplemented from cx::Tool.

Definition at line 96 of file cxToolNull.cpp.

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

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

Implements cx::Tool.

Definition at line 52 of file cxToolNull.cpp.

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

Reimplemented from cx::Tool.

Definition at line 36 of file cxToolNull.cpp.

bool cx::ToolNull::isNull ( )
virtual

Implements cx::Tool.

Definition at line 128 of file cxToolNull.cpp.

void cx::ToolNull::printSelf ( std::ostream &  os,
Indent  indent 
)
virtual

dump internal debug data

Reimplemented from cx::Tool.

Definition at line 76 of file cxToolNull.cpp.

void cx::ToolNull::resetTrackingPositionFilter ( TrackingPositionFilterPtr  filter)
virtual

Implements cx::Tool.

Definition at line 112 of file cxToolNull.cpp.

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

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

Implements cx::Tool.

Definition at line 117 of file cxToolNull.cpp.

void cx::ToolNull::setCalibration_sMt ( Transform3D  calibration)
virtual

requests to use the calibration and replaces the tools calibration file

Reimplemented from cx::Tool.

Definition at line 61 of file cxToolNull.cpp.

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

set a virtual offset extending from the tool tip.

Reimplemented from cx::Tool.

Definition at line 86 of file cxToolNull.cpp.

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

if available for this type, set visibility

Implements cx::Tool.

Definition at line 123 of file cxToolNull.cpp.


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