NorMIT-nav  2023.01.05-dev+develop.0da12
An IGT application
cx::ToolProxy Class Reference

#include <cxToolProxy.h>

Inheritance diagram for cx::ToolProxy:
cx::Tool

Public Member Functions

virtual ~ToolProxy ()
 
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)
 
virtual ProbePtr getProbe () const
 
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)
 
virtual double getTooltipOffset () const
 
virtual void setTooltipOffset (double val)
 
virtual std::map< QString, Vector3DgetReferencePoints () const
 
virtual bool hasReferencePointWithId (QString 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 ToolPtr getBaseTool ()
 
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 create (ToolPtr base, ctkPluginContext *pluginContext)
 
- 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

Proxy for a real Tool. Turns to Null when Tool becomes unavailable

Definition at line 27 of file cxToolProxy.h.

Constructor & Destructor Documentation

◆ ~ToolProxy()

virtual cx::ToolProxy::~ToolProxy ( )
inlinevirtual

Definition at line 33 of file cxToolProxy.h.

Member Function Documentation

◆ create()

ToolPtr cx::ToolProxy::create ( ToolPtr  base,
ctkPluginContext *  pluginContext 
)
static

Definition at line 10 of file cxToolProxy.cpp.

◆ get_prMt()

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

Implements cx::Tool.

Definition at line 165 of file cxToolProxy.cpp.

◆ getBaseTool()

ToolPtr cx::ToolProxy::getBaseTool ( )
virtual

Implements cx::Tool.

Definition at line 185 of file cxToolProxy.cpp.

◆ getCalibration_sMt()

Transform3D cx::ToolProxy::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 115 of file cxToolProxy.cpp.

◆ getGraphicsPolyData()

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

get geometric 3D description

Implements cx::Tool.

Definition at line 70 of file cxToolProxy.cpp.

◆ getMetadata()

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

Implements cx::Tool.

Definition at line 80 of file cxToolProxy.cpp.

◆ getMetadataHistory()

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

Implements cx::Tool.

Definition at line 85 of file cxToolProxy.cpp.

◆ getName()

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

Implements cx::Tool.

Definition at line 106 of file cxToolProxy.cpp.

◆ getPositionHistory()

TimedTransformMapPtr cx::ToolProxy::getPositionHistory ( )
virtual

get historical positions

Implements cx::Tool.

Definition at line 75 of file cxToolProxy.cpp.

◆ getProbe()

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

Definition at line 125 of file cxToolProxy.cpp.

◆ getReferencePoints()

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

Definition at line 150 of file cxToolProxy.cpp.

◆ getSessionHistory()

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

Implements cx::Tool.

Definition at line 160 of file cxToolProxy.cpp.

◆ getTimestamp()

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

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

Implements cx::Tool.

Definition at line 130 of file cxToolProxy.cpp.

◆ getTooltipOffset()

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

Definition at line 140 of file cxToolProxy.cpp.

◆ getTypes()

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

Implements cx::Tool.

Definition at line 65 of file cxToolProxy.cpp.

◆ getUid()

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

Implements cx::Tool.

Definition at line 100 of file cxToolProxy.cpp.

◆ getVisible()

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

Implements cx::Tool.

Definition at line 90 of file cxToolProxy.cpp.

◆ hasReferencePointWithId()

bool cx::ToolProxy::hasReferencePointWithId ( QString  id)
virtual

Reimplemented from cx::Tool.

Definition at line 155 of file cxToolProxy.cpp.

◆ isCalibrated()

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

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

Implements cx::Tool.

Definition at line 111 of file cxToolProxy.cpp.

◆ isInitialized()

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

Reimplemented from cx::Tool.

Definition at line 95 of file cxToolProxy.cpp.

◆ isNull()

bool cx::ToolProxy::isNull ( )
virtual

Implements cx::Tool.

Definition at line 191 of file cxToolProxy.cpp.

◆ printSelf()

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

Definition at line 135 of file cxToolProxy.cpp.

◆ resetTrackingPositionFilter()

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

Implements cx::Tool.

Definition at line 170 of file cxToolProxy.cpp.

◆ set_prMt()

void cx::ToolProxy::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 175 of file cxToolProxy.cpp.

◆ setCalibration_sMt()

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

Definition at line 120 of file cxToolProxy.cpp.

◆ setTooltipOffset()

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

Definition at line 145 of file cxToolProxy.cpp.

◆ setVisible()

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

if available for this type, set visibility

Implements cx::Tool.

Definition at line 180 of file cxToolProxy.cpp.


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