CustusX  2021.04.21-dev+develop.337f9
An IGT application
cx::SliceComputer Class Reference

Calculates a slice plane given a definition. More...

#include <cxSliceComputer.h>

Public Member Functions

 SliceComputer ()
 
 ~SliceComputer ()
 
void setToolPosition (const Transform3D &rMt)
 
void setOrientationType (ORIENTATION_TYPE val)
 
void setPlaneType (PLANE_TYPE val)
 
void setFixedCenter (const Vector3D &center)
 
void setFollowType (FOLLOW_TYPE val)
 
void setGravity (bool use, const Vector3D &dir)
 
void setToolOffset (double val)
 
void setToolViewOffset (bool use, double viewportHeight, double viewOffset)
 
void setToolViewportHeight (double viewportHeight)
 
void setClinicalApplication (CLINICAL_VIEW application)
 
SlicePlane getPlane () const
 
void initializeFromPlane (PLANE_TYPE plane, bool useGravity, const Vector3D &gravityDir, bool useViewOffset, double viewportHeight, double toolViewOffset, CLINICAL_VIEW application)
 
ORIENTATION_TYPE getOrientationType () const
 
PLANE_TYPE getPlaneType () const
 
FOLLOW_TYPE getFollowType () const
 
Transform3D getToolPosition () const
 

Detailed Description

Calculates a slice plane given a definition.

SliceComputer is set up with what image to slice and the tool to use, along with what method that defines the slicing. The input produces a slice plane defined by the i,j basis vectors spanning the plane, and a center c defining the center.

Most methods set the computer state, while getPlane() does all the computing.

Definition at line 53 of file cxSliceComputer.h.

Constructor & Destructor Documentation

cx::SliceComputer::SliceComputer ( )

Initialize the computer with reasonable defaults.

Definition at line 39 of file cxSliceComputer.cpp.

cx::SliceComputer::~SliceComputer ( )

Definition at line 55 of file cxSliceComputer.cpp.

Member Function Documentation

FOLLOW_TYPE cx::SliceComputer::getFollowType ( ) const

Definition at line 102 of file cxSliceComputer.cpp.

ORIENTATION_TYPE cx::SliceComputer::getOrientationType ( ) const

Definition at line 92 of file cxSliceComputer.cpp.

SlicePlane cx::SliceComputer::getPlane ( ) const

Calculate a slice plane given the defined parameters.

Definition at line 188 of file cxSliceComputer.cpp.

PLANE_TYPE cx::SliceComputer::getPlaneType ( ) const

Definition at line 97 of file cxSliceComputer.cpp.

Transform3D cx::SliceComputer::getToolPosition ( ) const

Definition at line 107 of file cxSliceComputer.cpp.

void cx::SliceComputer::initializeFromPlane ( PLANE_TYPE  plane,
bool  useGravity,
const Vector3D gravityDir,
bool  useViewOffset,
double  viewportHeight,
double  toolViewOffset,
CLINICAL_VIEW  application 
)

Group the typical plane definition uses together.

Definition at line 61 of file cxSliceComputer.cpp.

void cx::SliceComputer::setClinicalApplication ( CLINICAL_VIEW  application)

Definition at line 87 of file cxSliceComputer.cpp.

void cx::SliceComputer::setFixedCenter ( const Vector3D center)

Set center to use as basis for center calculations if FOLLOW_CENTER is set.

Definition at line 138 of file cxSliceComputer.cpp.

void cx::SliceComputer::setFollowType ( FOLLOW_TYPE  val)

Set the follow type. FOLLOW_TOOL means place the center relative to the tool tip. FIXED_CENTER means place the center relative to the FixedCenter.

Definition at line 147 of file cxSliceComputer.cpp.

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

Set the gravity direction. If used, the base planes will be oriented according to the gravity direction.

Definition at line 155 of file cxSliceComputer.cpp.

void cx::SliceComputer::setOrientationType ( ORIENTATION_TYPE  val)

Set planes to orient relative to the global space (ORTHOGONAL), or relative to the tool (OBLIQUE).

Definition at line 123 of file cxSliceComputer.cpp.

void cx::SliceComputer::setPlaneType ( PLANE_TYPE  val)

What plane to compute given the other settings.

Definition at line 130 of file cxSliceComputer.cpp.

void cx::SliceComputer::setToolOffset ( double  val)

Set a virtual extension of the tool.

Definition at line 163 of file cxSliceComputer.cpp.

void cx::SliceComputer::setToolPosition ( const Transform3D rMt)

Set the position of the navigation tool, using the standard definition of a tool transform (given in Tool).

Definition at line 115 of file cxSliceComputer.cpp.

void cx::SliceComputer::setToolViewOffset ( bool  use,
double  viewportHeight,
double  viewOffset 
)

Set the real tool center (without tooloffset) to a given distance from the top of a viewport. This is handled by setting the plane center accordingly. Overrides FollowType.

Definition at line 172 of file cxSliceComputer.cpp.

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

see setToolViewOffset()

Definition at line 181 of file cxSliceComputer.cpp.


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