CustusX  2023.01.05-dev+develop.0da12
An IGT application

Display a Tool in 3D. More...

#include <cxToolRep3D.h>

Inheritance diagram for cx::ToolRep3D:
cx::RepImpl cx::Rep

Public Member Functions

virtual ~ToolRep3D ()
 
virtual QString getType () const
 
virtual void setTool (ToolPtr tool)
 
virtual bool hasTool (ToolPtr tool) const
 
virtual ToolPtr getTool ()
 
ToolTracerPtr getTracer ()
 
void setSphereRadius (double radius)
 
void setStayHiddenAfterVisible (bool val)
 
void setStayVisibleAfterHide (bool val)
 if true, tool is still rendered as visible after visibility status is hidden. More...
 
void setOffsetPointVisibleAtZeroOffset (bool val)
 if true the sphere is visible even when the offset is zero More...
 
void setSphereRadiusInNormalizedViewport (bool on)
 
void setTooltipPointColor (const QColor &color)
 ToolRep3D::setTooltipPointColor. More...
 
void setToolOffsetPointColor (const QColor &color)
 
void setToolOffsetLineColor (const QColor &color)
 
- Public Member Functions inherited from cx::RepImpl
 RepImpl (const QString &uid="", const QString &name="")
 
virtual ~RepImpl ()
 
virtual void connectToView (ViewPtr theView)
 
virtual void disconnectFromView (ViewPtr theView)
 
virtual bool isConnectedToView (ViewPtr theView) const
 
void setName (QString name)
 
QString getName () const
 
QString getUid () const
 
virtual void printSelf (std::ostream &os, Indent indent)
 
- Public Member Functions inherited from cx::Rep
virtual ~Rep ()
 

Static Public Member Functions

static ToolRep3DPtr New (SpaceProviderPtr spaceProvider, const QString &uid="")
 
- Static Public Member Functions inherited from cx::RepImpl
template<class REP >
static boost::shared_ptr< REP > wrap_new (REP *object, QString uid)
 

Protected Member Functions

 ToolRep3D (SpaceProviderPtr spaceProvider)
 
virtual void addRepActorsToViewRenderer (ViewPtr view)
 
virtual void removeRepActorsFromViewRenderer (ViewPtr view)
 
bool showProbe ()
 
virtual void onModifiedStartRender ()
 
- Protected Member Functions inherited from cx::RepImpl
ViewPtr getView () const
 
vtkRendererPtr getRenderer ()
 
RepPtr getSelf ()
 
virtual void onEveryRender ()
 

Additional Inherited Members

- Protected Slots inherited from cx::RepImpl
void setModified ()
 

Detailed Description

Display a Tool in 3D.

ToolRep3D displays a Tool using the supplied graphical representation from the Tool interface, with points showing the tooltip and offset point. If the Tool is a Probe, the probe sector and the prope video can be shown as well.

Several optional visualizations are available.

sscArchitecture_tool.png
ToolRep2D, ToolRep3D and surrounding classes.

Used by CustusX and Sonowand.

Definition at line 51 of file cxToolRep3D.h.

Constructor & Destructor Documentation

cx::ToolRep3D::~ToolRep3D ( )
virtual

Definition at line 66 of file cxToolRep3D.cpp.

cx::ToolRep3D::ToolRep3D ( SpaceProviderPtr  spaceProvider)
protected

Definition at line 37 of file cxToolRep3D.cpp.

Member Function Documentation

void cx::ToolRep3D::addRepActorsToViewRenderer ( ViewPtr  view)
protectedvirtual

Implements cx::RepImpl.

Definition at line 208 of file cxToolRep3D.cpp.

ToolPtr cx::ToolRep3D::getTool ( )
virtual

Definition at line 84 of file cxToolRep3D.cpp.

ToolTracerPtr cx::ToolRep3D::getTracer ( )

Definition at line 69 of file cxToolRep3D.cpp.

QString cx::ToolRep3D::getType ( ) const
virtual
Returns
a string identifying the Rep type. Each suclass implement this with its own class name. Subclasses from other namespaces (such as cx and snw) should add that namespace as a prefix.

Implements cx::RepImpl.

Definition at line 79 of file cxToolRep3D.cpp.

bool cx::ToolRep3D::hasTool ( ToolPtr  tool) const
virtual

Definition at line 151 of file cxToolRep3D.cpp.

ToolRep3DPtr cx::ToolRep3D::New ( SpaceProviderPtr  spaceProvider,
const QString &  uid = "" 
)
static

Definition at line 74 of file cxToolRep3D.cpp.

void cx::ToolRep3D::onModifiedStartRender ( )
protectedvirtual

Reimplemented from cx::RepImpl.

Definition at line 272 of file cxToolRep3D.cpp.

void cx::ToolRep3D::removeRepActorsFromViewRenderer ( ViewPtr  view)
protectedvirtual

Implements cx::RepImpl.

Definition at line 235 of file cxToolRep3D.cpp.

void cx::ToolRep3D::setOffsetPointVisibleAtZeroOffset ( bool  val)

if true the sphere is visible even when the offset is zero

Definition at line 393 of file cxToolRep3D.cpp.

void cx::ToolRep3D::setSphereRadius ( double  radius)

Definition at line 156 of file cxToolRep3D.cpp.

void cx::ToolRep3D::setSphereRadiusInNormalizedViewport ( bool  on)

Definition at line 165 of file cxToolRep3D.cpp.

void cx::ToolRep3D::setStayHiddenAfterVisible ( bool  val)

Definition at line 377 of file cxToolRep3D.cpp.

void cx::ToolRep3D::setStayVisibleAfterHide ( bool  val)

if true, tool is still rendered as visible after visibility status is hidden.

If true, tool is still rendered as visible after visibility status is hidden. Nice for viewing the last known position of a tool.

Definition at line 388 of file cxToolRep3D.cpp.

void cx::ToolRep3D::setTool ( ToolPtr  tool)
virtual

Definition at line 119 of file cxToolRep3D.cpp.

void cx::ToolRep3D::setToolOffsetLineColor ( const QColor &  color)

Definition at line 202 of file cxToolRep3D.cpp.

void cx::ToolRep3D::setToolOffsetPointColor ( const QColor &  color)

Definition at line 196 of file cxToolRep3D.cpp.

void cx::ToolRep3D::setTooltipPointColor ( const QColor &  color)

ToolRep3D::setTooltipPointColor.

Parameters
colorSets the color of the crosshair and the sphere.

Definition at line 188 of file cxToolRep3D.cpp.

bool cx::ToolRep3D::showProbe ( )
protected

Definition at line 403 of file cxToolRep3D.cpp.


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