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

Provides a slice matrix based on definition and tool. More...

#include <cxSliceProxy.h>

Inheritance diagram for cx::SliceProxy:
cx::SliceProxyInterface

Signals

void toolTransformAndTimestamp (Transform3D prMt, double timestamp)
 forwarded from tool More...
 
void toolVisible (bool visible)
 forwarding of visible in tool More...
 
- Signals inherited from cx::SliceProxyInterface
void transformChanged (Transform3D sMr)
 emitted when transform is changed. More...
 

Public Member Functions

virtual ~SliceProxy ()
 
void setTool (ToolPtr tool)
 
void setOrientation (ORIENTATION_TYPE orientation)
 
void setPlane (PLANE_TYPE plane)
 
void setFollowType (FOLLOW_TYPE followType)
 
void initializeFromPlane (PLANE_TYPE plane, bool useGravity, bool useViewOffset, double viewportHeight, double toolViewOffset)
 
void setGravity (bool use, const Vector3D &dir)
 
void setToolViewOffset (bool use, double viewportHeight, double toolViewOffset)
 
void setToolViewportHeight (double viewportHeight)
 
void setDefaultCenter (const Vector3D &c)
 
void setAlwaysUseDefaultCenter (bool on)
 
SliceComputer getComputer () const
 
void setComputer (const SliceComputer &val)
 
ToolPtr getTool ()
 
virtual Transform3D get_sMr ()
 get slice transform, i.e. the matrix sMr transforming a point p in ref to slice space. More...
 
virtual void printSelf (std::ostream &os, Indent indent)
 
bool getUseTooltipOffset ()
 Return true if the active tools configured tool tip offset should be used for this slice proxy. More...
 
void setUseTooltipOffset (bool)
 Enable or disable usage of the tools tool tip offset for this slice proxy. More...
 
void setClinicalApplicationToFixedValue (CLINICAL_VIEW application)
 
- Public Member Functions inherited from cx::SliceProxyInterface
virtual ~SliceProxyInterface ()
 
void printSelf (std::ostream &os, Indent indent)
 

Static Public Member Functions

static SliceProxyPtr create (PatientModelServicePtr dataManager)
 

Detailed Description

Provides a slice matrix based on definition and tool.

Helper class that connects to a tool and generates slice matrices based on it and other slice parameters.

Used as the slicer in Sonowand. Used as the slicer in CustusX.

Definition at line 82 of file cxSliceProxy.h.

Constructor & Destructor Documentation

cx::SliceProxy::~SliceProxy ( )
virtual

Definition at line 45 of file cxSliceProxy.cpp.

Member Function Documentation

SliceProxyPtr cx::SliceProxy::create ( PatientModelServicePtr  dataManager)
static

Definition at line 24 of file cxSliceProxy.cpp.

Transform3D cx::SliceProxy::get_sMr ( )
virtual

get slice transform, i.e. the matrix sMr transforming a point p in ref to slice space.

Implements cx::SliceProxyInterface.

Definition at line 247 of file cxSliceProxy.cpp.

SliceComputer cx::SliceProxy::getComputer ( ) const

Definition at line 196 of file cxSliceProxy.cpp.

ToolPtr cx::SliceProxy::getTool ( )

Definition at line 242 of file cxSliceProxy.cpp.

bool cx::SliceProxy::getUseTooltipOffset ( )
inline

Return true if the active tools configured tool tip offset should be used for this slice proxy.

Definition at line 111 of file cxSliceProxy.h.

void cx::SliceProxy::initializeFromPlane ( PLANE_TYPE  plane,
bool  useGravity,
bool  useViewOffset,
double  viewportHeight,
double  toolViewOffset 
)

Group the typical plane definition uses together.

Definition at line 179 of file cxSliceProxy.cpp.

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

Definition at line 264 of file cxSliceProxy.cpp.

void cx::SliceProxy::setAlwaysUseDefaultCenter ( bool  on)

Definition at line 140 of file cxSliceProxy.cpp.

void cx::SliceProxy::setClinicalApplicationToFixedValue ( CLINICAL_VIEW  application)

Definition at line 168 of file cxSliceProxy.cpp.

void cx::SliceProxy::setComputer ( const SliceComputer val)

Definition at line 201 of file cxSliceProxy.cpp.

void cx::SliceProxy::setDefaultCenter ( const Vector3D c)

Definition at line 134 of file cxSliceProxy.cpp.

void cx::SliceProxy::setFollowType ( FOLLOW_TYPE  followType)

Definition at line 219 of file cxSliceProxy.cpp.

void cx::SliceProxy::setGravity ( bool  use,
const Vector3D dir 
)

Definition at line 225 of file cxSliceProxy.cpp.

void cx::SliceProxy::setOrientation ( ORIENTATION_TYPE  orientation)

Definition at line 207 of file cxSliceProxy.cpp.

void cx::SliceProxy::setPlane ( PLANE_TYPE  plane)

Definition at line 213 of file cxSliceProxy.cpp.

void cx::SliceProxy::setTool ( ToolPtr  tool)

not used here, but forwarded to users

Definition at line 55 of file cxSliceProxy.cpp.

void cx::SliceProxy::setToolViewOffset ( bool  use,
double  viewportHeight,
double  toolViewOffset 
)

Definition at line 230 of file cxSliceProxy.cpp.

void cx::SliceProxy::setToolViewportHeight ( double  viewportHeight)

Definition at line 236 of file cxSliceProxy.cpp.

void cx::SliceProxy::setUseTooltipOffset ( bool  use)

Enable or disable usage of the tools tool tip offset for this slice proxy.

x

Definition at line 107 of file cxSliceProxy.cpp.

void cx::SliceProxy::toolTransformAndTimestamp ( Transform3D  prMt,
double  timestamp 
)
signal

forwarded from tool

void cx::SliceProxy::toolVisible ( bool  visible)
signal

forwarding of visible in tool


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