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

#include <cxVector3DComponentProperty.h>

Inheritance diagram for cx::Vector3DComponentProperty:
cx::DoublePropertyBase cx::Property

Public Member Functions

 Vector3DComponentProperty (Vector3DPropertyBasePtr base, int index, QString name, QString help)
 
virtual ~Vector3DComponentProperty ()
 
virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual bool setValue (double value)
 set the data value. More...
 
virtual double getValue () const
 get the data value. More...
 
virtual QString getHelp () const
 return a descriptive help string for the data, used for example as a tool tip. More...
 
virtual DoubleRange getValueRange () const
 
virtual double convertInternal2Display (double internal)
 range of value More...
 
virtual double convertDisplay2Internal (double display)
 conversion from internal value to display value More...
 
virtual int getValueDecimals () const
 number of relevant decimals in value More...
 
- Public Member Functions inherited from cx::DoublePropertyBase
 DoublePropertyBase ()
 
virtual ~DoublePropertyBase ()
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant val)
 
virtual QString getUid () const
 
virtual void setGuiRepresentation (GuiRepresentation type)
 
virtual GuiRepresentation getGuiRepresentation ()
 
- Public Member Functions inherited from cx::Property
 Property ()
 
virtual ~Property ()
 
virtual bool getEnabled () const
 Get the enabled/disabled state of the Property. More...
 
virtual bool getAdvanced () const
 Get the advanced flag of the adapter. More...
 
virtual QString getGroup () const
 Flag the adapter as part of a group. More...
 

Public Attributes

Vector3DPropertyBasePtr mBase
 
int mIndex
 
QString mName
 
QString mHelp
 

Additional Inherited Members

- Public Types inherited from cx::DoublePropertyBase
enum  GuiRepresentation { grSPINBOX, grSLIDER, grDIAL }
 
- Public Slots inherited from cx::Property
virtual bool setEnabled (bool enabled)
 Set the enabled/disabled state of the Property. More...
 
virtual bool setAdvanced (bool advanced)
 Set the advanced flag of the adapter. More...
 
virtual bool setGroup (QString name)
 Flag the adapter as part of a group. More...
 
- Signals inherited from cx::Property
void changed ()
 emit when the underlying data value is changed: The user interface will be updated. More...
 
- Static Public Member Functions inherited from cx::Property
static PropertyPtr findProperty (std::vector< PropertyPtr > properties, QString id)
 
- Protected Attributes inherited from cx::DoublePropertyBase
GuiRepresentation mGuiRepresentation
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Detailed Description

A property that links to one component of a Vector3DProperty. Useful for displaying widgets for vector components.

Definition at line 32 of file cxVector3DComponentProperty.h.

Constructor & Destructor Documentation

cx::Vector3DComponentProperty::Vector3DComponentProperty ( Vector3DPropertyBasePtr  base,
int  index,
QString  name,
QString  help 
)

Definition at line 17 of file cxVector3DComponentProperty.cpp.

virtual cx::Vector3DComponentProperty::~Vector3DComponentProperty ( )
inlinevirtual

Definition at line 37 of file cxVector3DComponentProperty.h.

Member Function Documentation

double cx::Vector3DComponentProperty::convertDisplay2Internal ( double  display)
virtual

conversion from internal value to display value

Reimplemented from cx::DoublePropertyBase.

Definition at line 56 of file cxVector3DComponentProperty.cpp.

double cx::Vector3DComponentProperty::convertInternal2Display ( double  internal)
virtual

range of value

conversion from internal value to display value (for example between 0..1 and percent)

Reimplemented from cx::DoublePropertyBase.

Definition at line 51 of file cxVector3DComponentProperty.cpp.

QString cx::Vector3DComponentProperty::getDisplayName ( ) const
virtual

name of data entity. Used for display to user.

Implements cx::DoublePropertyBase.

Definition at line 23 of file cxVector3DComponentProperty.cpp.

QString cx::Vector3DComponentProperty::getHelp ( ) const
virtual

return a descriptive help string for the data, used for example as a tool tip.

Reimplemented from cx::DoublePropertyBase.

Definition at line 41 of file cxVector3DComponentProperty.cpp.

double cx::Vector3DComponentProperty::getValue ( ) const
virtual

get the data value.

Implements cx::DoublePropertyBase.

Definition at line 36 of file cxVector3DComponentProperty.cpp.

int cx::Vector3DComponentProperty::getValueDecimals ( ) const
virtual

number of relevant decimals in value

Reimplemented from cx::DoublePropertyBase.

Definition at line 61 of file cxVector3DComponentProperty.cpp.

DoubleRange cx::Vector3DComponentProperty::getValueRange ( ) const
virtual

Reimplemented from cx::DoublePropertyBase.

Definition at line 46 of file cxVector3DComponentProperty.cpp.

bool cx::Vector3DComponentProperty::setValue ( double  value)
virtual

set the data value.

Implements cx::DoublePropertyBase.

Definition at line 28 of file cxVector3DComponentProperty.cpp.

Member Data Documentation

Vector3DPropertyBasePtr cx::Vector3DComponentProperty::mBase

Definition at line 51 of file cxVector3DComponentProperty.h.

QString cx::Vector3DComponentProperty::mHelp

Definition at line 54 of file cxVector3DComponentProperty.h.

int cx::Vector3DComponentProperty::mIndex

Definition at line 52 of file cxVector3DComponentProperty.h.

QString cx::Vector3DComponentProperty::mName

Definition at line 53 of file cxVector3DComponentProperty.h.


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