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

Data class that represents a distance between two points, or a point and a plane. More...

#include <cxDistanceMetric.h>

Inheritance diagram for cx::DistanceMetric:
cx::DataMetric cx::Data

Public Member Functions

virtual ~DistanceMetric ()
 
virtual QIcon getIcon ()
 
double getDistance () const
 
Vector3D getDirection () const
 
std::vector< Vector3DgetEndpoints () const
 return the two endpoints in reference space. None if invalid. More...
 
virtual Vector3D getRefCoord () const
 
MetricReferenceArgumentListPtr getArguments ()
 
virtual bool isValid () const
 
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 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 DistanceMetricPtr 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 distance between two points, or a point and a plane.

Date
Jul 4, 2011
Author
Christian Askeland, SINTEF

Definition at line 39 of file cxDistanceMetric.h.

Constructor & Destructor Documentation

cx::DistanceMetric::~DistanceMetric ( )
virtual

Definition at line 39 of file cxDistanceMetric.cpp.

Member Function Documentation

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

adds xml information about the data and its variabels

Reimplemented from cx::DataMetric.

Definition at line 53 of file cxDistanceMetric.cpp.

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

Implements cx::Data.

Definition at line 162 of file cxDistanceMetric.cpp.

DistanceMetricPtr cx::DistanceMetric::create ( QString  uid,
QString  name,
PatientModelServicePtr  dataManager,
SpaceProviderPtr  spaceProvider 
)
static

Definition at line 34 of file cxDistanceMetric.cpp.

MetricReferenceArgumentListPtr cx::DistanceMetric::getArguments ( )
inline

Definition at line 58 of file cxDistanceMetric.h.

Vector3D cx::DistanceMetric::getDirection ( ) const

Return the direction of the distance vector. This is usually from (p1-p1).norm(), except when a plane is part of the definition. In that case the plane normal is used, allowing for signed distances.

Definition at line 151 of file cxDistanceMetric.cpp.

double cx::DistanceMetric::getDistance ( ) const

The distance from p0 to p1 along the direction

Definition at line 140 of file cxDistanceMetric.cpp.

std::vector< Vector3D > cx::DistanceMetric::getEndpoints ( ) const

return the two endpoints in reference space. None if invalid.

Definition at line 72 of file cxDistanceMetric.cpp.

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

Reimplemented from cx::DataMetric.

Definition at line 46 of file cxDistanceMetric.h.

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

Implements cx::DataMetric.

Definition at line 43 of file cxDistanceMetric.cpp.

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

Reimplemented from cx::Data.

Definition at line 65 of file cxDistanceMetric.h.

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

Definition at line 69 of file cxDistanceMetric.h.

QString cx::DistanceMetric::getValueAsString ( ) const
virtual

Implements cx::DataMetric.

Definition at line 157 of file cxDistanceMetric.cpp.

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

Reimplemented from cx::DataMetric.

Definition at line 48 of file cxDistanceMetric.cpp.

void cx::DistanceMetric::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 59 of file cxDistanceMetric.cpp.

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

Reimplemented from cx::DataMetric.

Definition at line 75 of file cxDistanceMetric.h.


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