![]() |
CustusX
22.09
An IGT application
|
#include <cxDoublePropertyBase.h>
Public Types | |
enum | GuiRepresentation { grSPINBOX, grSLIDER, grDIAL } |
Public Member Functions | |
DoublePropertyBase () | |
virtual | ~DoublePropertyBase () |
virtual QString | getDisplayName () const =0 |
name of data entity. Used for display to user. More... | |
virtual QVariant | getValueAsVariant () const |
virtual void | setValueFromVariant (QVariant val) |
virtual QString | getUid () const |
virtual bool | setValue (double value)=0 |
set the data value. More... | |
virtual double | getValue () const =0 |
get the data value. More... | |
virtual void | setGuiRepresentation (GuiRepresentation type) |
virtual GuiRepresentation | getGuiRepresentation () |
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... | |
![]() | |
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... | |
Protected Attributes | |
GuiRepresentation | mGuiRepresentation |
![]() | |
bool | mEnabled |
bool | mAdvanced |
QString | mGroup |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
void | changed () |
emit when the underlying data value is changed: The user interface will be updated. More... | |
![]() | |
static PropertyPtr | findProperty (std::vector< PropertyPtr > properties, QString id) |
Abstract interface for interaction with internal double-valued data
The class provides a bridge between general user interface code and specific data structures. An implementation connects to a single data value.
Minimal implementation:
virtual QString getDisplayName() const; virtual bool setValue(double value); virtual double getValue() const; void changed();
By implementing these methods you can set and get values, and the data has a name. The changed() signal is used to make sure the user interface is updated even when data is changed by some other source.
For more control use the methods:
virtual DoubleRange getValueRange() const; virtual int getValueDecimals() const;
If there is a difference between the internal data representation and how you want to present them, use:
virtual double convertInternal2Display(double internal); virtual double convertDisplay2Internal(double display);
When testing, or during development, you can use the DoublePropertyNull as a dummy implementation.
Definition at line 70 of file cxDoublePropertyBase.h.
Enumerator | |
---|---|
grSPINBOX | |
grSLIDER | |
grDIAL |
Definition at line 78 of file cxDoublePropertyBase.h.
|
inline |
Definition at line 74 of file cxDoublePropertyBase.h.
|
inlinevirtual |
Definition at line 75 of file cxDoublePropertyBase.h.
|
inlinevirtual |
conversion from internal value to display value
Reimplemented in cx::DoubleProperty, and cx::Vector3DComponentProperty.
Definition at line 119 of file cxDoublePropertyBase.h.
|
inlinevirtual |
range of value
conversion from internal value to display value (for example between 0..1 and percent)
Reimplemented in cx::DoubleProperty, and cx::Vector3DComponentProperty.
Definition at line 115 of file cxDoublePropertyBase.h.
|
pure virtual |
name of data entity. Used for display to user.
Implements cx::Property.
Implemented in cx::DoublePropertyNull, cx::DoubleProperty2DLevel, cx::DoubleProperty2DWindow, cx::DoublePropertyImageTFDataAlpha, cx::DoublePropertyZDim, cx::DoublePropertyImageTFDataLLR, cx::DoublePropertyShadingSpecularPower, cx::DoublePropertyYDim, cx::DoublePropertyImageTFDataLevel, cx::DoublePropertyShadingSpecular, cx::DoublePropertyXDim, cx::DoublePropertyToolOffset, cx::DoublePropertyImageTFDataWindow, cx::DoublePropertyShadingDiffuse, cx::DoublePropertySpacing, cx::DoubleProperty, cx::DoublePropertyShadingAmbient, cx::DoublePropertyActiveToolOffset, cx::Vector3DComponentProperty, and cx::DoublePropertyTimeCalibration.
|
inlinevirtual |
Definition at line 103 of file cxDoublePropertyBase.h.
|
inlinevirtual |
return a descriptive help string for the data, used for example as a tool tip.
Reimplemented in cx::DoublePropertyZDim, cx::DoublePropertyYDim, cx::DoublePropertyXDim, cx::DoublePropertyToolOffset, cx::DoubleProperty, cx::DoublePropertySpacing, cx::DoublePropertyActiveToolOffset, cx::Vector3DComponentProperty, and cx::DoublePropertyTimeCalibration.
Definition at line 107 of file cxDoublePropertyBase.h.
|
inlinevirtual |
Implements cx::Property.
Reimplemented in cx::DoubleProperty.
Definition at line 98 of file cxDoublePropertyBase.h.
|
pure virtual |
get the data value.
Implemented in cx::DoublePropertyNull, cx::DoublePropertyActiveImageBase, cx::DoublePropertyShadingSpecularPower, cx::DoublePropertyShadingSpecular, cx::DoublePropertyToolOffset, cx::DoublePropertyShadingDiffuse, cx::DoubleProperty, cx::DoublePropertyShadingAmbient, cx::DoublePropertyActiveToolOffset, cx::DoublePropertyImageTFDataBase, cx::Vector3DComponentProperty, cx::DoublePropertyOutputValueParams, and cx::DoublePropertyTimeCalibration.
|
inlinevirtual |
Implements cx::Property.
Definition at line 88 of file cxDoublePropertyBase.h.
|
inlinevirtual |
number of relevant decimals in value
Reimplemented in cx::DoubleProperty, cx::DoublePropertySpacing, and cx::Vector3DComponentProperty.
Definition at line 123 of file cxDoublePropertyBase.h.
|
inlinevirtual |
Reimplemented in cx::DoubleProperty2DLevel, cx::DoubleProperty2DWindow, cx::DoublePropertyImageTFDataAlpha, cx::DoublePropertyZDim, cx::DoublePropertyImageTFDataLLR, cx::DoublePropertyShadingSpecularPower, cx::DoublePropertyYDim, cx::DoublePropertyImageTFDataLevel, cx::DoublePropertyShadingSpecular, cx::DoublePropertyToolOffset, cx::DoublePropertyXDim, cx::DoublePropertyImageTFDataWindow, cx::DoublePropertyShadingDiffuse, cx::DoubleProperty, cx::DoublePropertySpacing, cx::DoublePropertyShadingAmbient, cx::DoublePropertyActiveToolOffset, cx::Vector3DComponentProperty, and cx::DoublePropertyTimeCalibration.
Definition at line 111 of file cxDoublePropertyBase.h.
|
inlinevirtual |
Definition at line 102 of file cxDoublePropertyBase.h.
|
pure virtual |
set the data value.
Implemented in cx::DoublePropertyNull, cx::DoublePropertyActiveImageBase, cx::DoublePropertyShadingSpecularPower, cx::DoublePropertyShadingSpecular, cx::DoublePropertyToolOffset, cx::DoublePropertyShadingDiffuse, cx::DoubleProperty, cx::DoublePropertyShadingAmbient, cx::DoublePropertyActiveToolOffset, cx::DoublePropertyImageTFDataBase, cx::DoublePropertyOutputValueParams, cx::Vector3DComponentProperty, and cx::DoublePropertyTimeCalibration.
|
inlinevirtual |
Implements cx::Property.
Definition at line 92 of file cxDoublePropertyBase.h.
|
protected |
Definition at line 129 of file cxDoublePropertyBase.h.