CustusX  2020.11.07-dev+develop.4ce4a
An IGT application
cx::DonutMetric Class Reference

Data class that represents a donut. More...

#include <cxShapedMetric.h>

Inheritance diagram for cx::DonutMetric:
cx::DataMetric cx::Data

Public Member Functions

virtual ~DonutMetric ()
 
virtual bool isValid () const
 
virtual QIcon getIcon ()
 
void setRadius (double val)
 
double getRadius () const
 
void setThickness (double val)
 
double getThickness () const
 
void setHeight (double val)
 
double getHeight () const
 
bool getFlat () const
 
void setFlat (bool val)
 
Vector3D getPosition ()
 
Vector3D getDirection ()
 
MetricReferenceArgumentListPtr getArguments ()
 
virtual void addXml (QDomNode &dataNode)
 adds xml information about the data and its variabels More...
 
virtual void parseXml (QDomNode &dataNode)
 Use a XML node to load data. More...
 
virtual DoubleBoundingBox3D boundingBox () const
 
virtual Vector3D getRefCoord () const
 
virtual QString getType () const
 
virtual QString getValueAsString () const
 
virtual bool showValueInGraphics () const
 
- Public Member Functions inherited from cx::DataMetric
 DataMetric (const QString &uid, const QString &name, PatientModelServicePtr dataManager, SpaceProviderPtr spaceProvider)
 
virtual ~DataMetric ()
 
virtual QString getSpace ()
 
virtual Transform3D getRefFrame () const
 
void setColor (const QColor &color)
 
QColor getColor ()
 
virtual bool load (QString path, FileManagerServicePtr filemanager)
 metrics don't store info in file, xml only. More...
 
virtual void save (const QString &basePath, FileManagerServicePtr filemanager)
 metrics don't store info in file, xml only. More...
 
- Public Member Functions inherited from cx::Data
 Data (const QString &uid, const QString &name="")
 
virtual ~Data ()
 
void setUid (const QString &uid)
 
void setName (const QString &name)
 
void setAcquisitionTime (QDateTime time)
 
void setSoftwareAcquisitionTime (QDateTime time)
 
void setOriginalAcquisitionTime (QDateTime time)
 
virtual RegistrationHistoryPtr get_rMd_History ()
 
LandmarksPtr getLandmarks ()
 
virtual QString getUid () const
 
virtual QString getName () const
 
virtual Transform3D get_rMd () const
 
virtual QDateTime getAcquisitionTime () const
 
virtual TimeInfo getAdvancedTimeInfo () const
 
virtual bool isEqual (DataPtr metric)
 
virtual QString getFilename () const
 
virtual void setFilename (QString val)
 
virtual QString getParentSpace ()
 
virtual std::vector< Vector3DgetPointCloud () const
 
virtual CoordinateSystem getCoordinateSystem ()
 
virtual void addPersistentClipPlane (vtkPlanePtr plane)
 
virtual std::vector< vtkPlanePtrgetAllClipPlanes ()
 
virtual void clearPersistentClipPlanes ()
 
virtual void setInteractiveClipPlane (vtkPlanePtr plane)
 set a plane that is not saved More...
 
void addInteractiveClipPlane (vtkPlanePtr plane)
 
void removeInteractiveClipPlane (vtkPlanePtr plane)
 

Static Public Member Functions

static DonutMetricPtr create (QString uid, QString name, PatientModelServicePtr dataManager, SpaceProviderPtr spaceProvider)
 
static QString getTypeName ()
 

Additional Inherited Members

- Signals inherited from cx::Data
void transformChanged ()
 emitted when transform is changed More...
 
void propertiesChanged ()
 emitted when one of the metadata properties (uid, name etc) changes More...
 
void clipPlanesChanged ()
 
- Protected Slots inherited from cx::Data
virtual void transformChangedSlot ()
 
- Protected Attributes inherited from cx::DataMetric
PatientModelServicePtr mDataManager
 
SpaceProviderPtr mSpaceProvider
 
QColor mColor
 
- Protected Attributes inherited from cx::Data
QString mUid
 
QString mName
 
QString mFilename
 
TimeInfo mTimeInfo
 
LandmarksPtr mLandmarks
 
REGISTRATION_STATUS mRegistrationStatus
 
RegistrationHistoryPtr m_rMd_History
 
std::vector< vtkPlanePtrmPersistentClipPlanes
 
std::vector< vtkPlanePtrmInteractiveClipPlanes
 
vtkPlanePtr mInteractiveClipPlane
 

Detailed Description

Data class that represents a donut.

The donut can be used as a targeting device, for example using needle injection. Use a point metric and a donut metric in a line, and target by visually placing the point inside the donut to aim along the line.

Date
2014-02-11
Author
Christian Askeland, SINTEF

Definition at line 40 of file cxShapedMetric.h.

Constructor & Destructor Documentation

cx::DonutMetric::~DonutMetric ( )
virtual

Definition at line 38 of file cxShapedMetric.cpp.

Member Function Documentation

void cx::DonutMetric::addXml ( QDomNode &  dataNode)
virtual

adds xml information about the data and its variabels

Reimplemented from cx::DataMetric.

Definition at line 42 of file cxShapedMetric.cpp.

DoubleBoundingBox3D cx::DonutMetric::boundingBox ( ) const
virtual

Implements cx::Data.

Definition at line 74 of file cxShapedMetric.cpp.

DonutMetricPtr cx::DonutMetric::create ( QString  uid,
QString  name,
PatientModelServicePtr  dataManager,
SpaceProviderPtr  spaceProvider 
)
static

Definition at line 33 of file cxShapedMetric.cpp.

MetricReferenceArgumentListPtr cx::DonutMetric::getArguments ( )
inline

Definition at line 62 of file cxShapedMetric.h.

Vector3D cx::DonutMetric::getDirection ( )

Definition at line 87 of file cxShapedMetric.cpp.

bool cx::DonutMetric::getFlat ( ) const

Definition at line 137 of file cxShapedMetric.cpp.

double cx::DonutMetric::getHeight ( ) const

Definition at line 126 of file cxShapedMetric.cpp.

virtual QIcon cx::DonutMetric::getIcon ( )
inlinevirtual

Reimplemented from cx::DataMetric.

Definition at line 48 of file cxShapedMetric.h.

Vector3D cx::DonutMetric::getPosition ( )

Definition at line 79 of file cxShapedMetric.cpp.

double cx::DonutMetric::getRadius ( ) const

Definition at line 104 of file cxShapedMetric.cpp.

Vector3D cx::DonutMetric::getRefCoord ( ) const
virtual

Implements cx::DataMetric.

Definition at line 69 of file cxShapedMetric.cpp.

double cx::DonutMetric::getThickness ( ) const

Definition at line 115 of file cxShapedMetric.cpp.

virtual QString cx::DonutMetric::getType ( ) const
inlinevirtual

Reimplemented from cx::Data.

Definition at line 67 of file cxShapedMetric.h.

static QString cx::DonutMetric::getTypeName ( )
inlinestatic

Definition at line 71 of file cxShapedMetric.h.

virtual QString cx::DonutMetric::getValueAsString ( ) const
inlinevirtual

Implements cx::DataMetric.

Definition at line 75 of file cxShapedMetric.h.

bool cx::DonutMetric::isValid ( ) const
virtual

Reimplemented from cx::DataMetric.

Definition at line 64 of file cxShapedMetric.cpp.

void cx::DonutMetric::parseXml ( QDomNode &  dataNode)
virtual

Use a XML node to load data.

Parameters
dataNodeA XML data representation of this object.

Reimplemented from cx::DataMetric.

Definition at line 53 of file cxShapedMetric.cpp.

void cx::DonutMetric::setFlat ( bool  val)

Definition at line 131 of file cxShapedMetric.cpp.

void cx::DonutMetric::setHeight ( double  val)

Definition at line 120 of file cxShapedMetric.cpp.

void cx::DonutMetric::setRadius ( double  val)

Definition at line 98 of file cxShapedMetric.cpp.

void cx::DonutMetric::setThickness ( double  val)

Definition at line 109 of file cxShapedMetric.cpp.

virtual bool cx::DonutMetric::showValueInGraphics ( ) const
inlinevirtual

Reimplemented from cx::DataMetric.

Definition at line 76 of file cxShapedMetric.h.


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