Detailed Description

Shared base interface of Parameter and SubProperty so that Configurable can maintain a collection of those.

Public Member Functions
	ParameterBase (const std::string &name)

virtual void	configure (const Properties *p)=0
	Configure this parameter/sub property by de-serializing the given Properties.

virtual void	configuration (Properties *p) const =0
	Serialize the current parameter/sub property state into the given Properties object.

const Configurable *	parent () const
	Return the parent Configurable instance that this parameter is registered with.

virtual const std::string &	name () const
	Returns parameter name, can only be set during construction.

void	setAttribute (const std::string &key, const std::string &value)
	Add the given attribute key-value pair to the set of parameter attributes.

void	removeAttribute (const std::string &key)
	Remove the attribute with the given key.

const std::map< std::string, std::string > &	attributes () const
	Get the attribute map.

void	setLabel (const std::string &label)
	Sets an optional label for the Parameter if displayed in the UI.

void	addDeprecatedName (const std::string &deprecatedName)
	Adds an optional alternative parameter name that should be used for param lookup for during configure() in case de-serialization from m_name was not successful.

const std::vector< std::string > &	deprecatedNames () const
	Returns the list of deprecated parameter names that should be used for param lookup (see addDeprecatedName()).

Public Attributes
Signal	signalValueChanged
	Signal gets emitted when the underlying value of the Parameter/SubProperty has changed (either through setValue() or configure()).

Protected Member Functions
void	setParentFromCopy (const ParameterBase &other)
	Helper function to be called from a copy/move ctor in order to correctly set the parent relation ship to the new parent Configurable.

Protected Attributes
Configurable *	m_parent = nullptr

const std::string	m_name

std::vector< std::string >	m_deprecatedNames

std::map< std::string, std::string >	m_attributes

Member Function Documentation

◆ configure()

virtual void configure ( const Properties * p )

pure virtual

Configure this parameter/sub property by de-serializing the given Properties.

◆ configuration()

virtual void configuration ( Properties * p ) const

pure virtual

Serialize the current parameter/sub property state into the given Properties object.

◆ setAttribute()

void setAttribute	(	const std::string &	key,
		const std::string &	value )

Add the given attribute key-value pair to the set of parameter attributes.

Set special attributes to a single parameter.

The attributes are specified in the form: <attribute>: <value>, <attribute>: <value>. Whitespace in between the elements (e.g. around the :) is automatically trimmed. Attributes must not contain whitespace. The value can be either a number or a string. Strings must be quoted with single quotes (') and are allowed to contain ,.

The supported attributes depend on the type of the parameter. Currently supported attributes are:

General:
- label (string): text to use for the label when displaying this property in a default PropertiesWidget.
- useroption ('r', 'w', or 'rw'): if this is set for a parameter of an IoAlgorithm, the parameter will be displayed in the global settings dialog.
- read-only (bool): if set, the user cannot change the value
- tooltip (string): tooltip that describes the parameter
- hidden (bool): if set, the PropertiesWidget will not show a control for this parameter
Double, Integer:
- min (double or int): minimum allowed value
- max (double or int): maximum allowed value
- step (double or int): step by which the value is increased
- prefix (string): prefix displayed before the value (e.g. a unit)
- suffix (string): suffix displayed after the value (e.g. a unit)
- withSlider (bool): add a slider in the user interface
Double:
- decimals (int): number of decimals displayed. Setting this might alter min/max value (see https://doc.qt.io/qt-5/qdoublespinbox.html#decimals-prop)
Enum, EnumString:
- values (comma separated string, with or without whitespace around comma): String representation of enumerators.
- keys (comma separated string, with or without whitespace around comma): Integer values assigned to enumerators. If not specified, integer values 0,1,2,3,... are assumed.
Path:
- type: specifies the dialog type and must be one of: OpenDirectory, OpenFile or SaveFile. The default is OpenFile.
- caption: sets the title of the dialog (the default is a generic caption depending on the type)
- filter: string of wildcard patterns to filter available files, separated by ;;, e.g.: Text files (*.txt);;XML files (*.xml) (see also QFileDialog)
- dontUseNativeDialog: when set to true use the Qt dialog instead of the native dialog. The default is false.
String:
- textBox (bool): if set, uses a text box instead of a line edit, making it more user-friendly for long or multi-line text. The default is false.
Color:
- type: specifies the dialog type and must be one of: normal, reduced, in-place.

Note: Setting attributes will not change the value or restrict future values of the parameter in any way, e.g. setting a max value for an integer does not automatically clamp values assigned by setParam. Attributes are pure informational and can be used by other object to actually enforce these restrictions (e.g. PropertiesWidget).

// a double value that is restricted between -1 and 1, and increases in steps of 0.1
p.setParamAttributes("someDouble", "min: -1.0, max: 1.0, step: 0.1");
 
// an enum value that can have three values\n
p.setParamAttributes("someEnum", "values: 'value1, value2, value3'");

Returns true if the given string could be parsed or false otherwise.

See also: String::join, PropertiesWidget; Properties::setParamAttributes()

◆ removeAttribute()

void removeAttribute ( const std::string & key )

Remove the attribute with the given key.

See also: Properties::setParamAttributes()

◆ setLabel()

void setLabel ( const std::string & label )

Sets an optional label for the Parameter if displayed in the UI.

If not set, the name will be used.

See also: Properties::setParamAttributes()

◆ addDeprecatedName()

void addDeprecatedName ( const std::string & deprecatedName )

Adds an optional alternative parameter name that should be used for param lookup for during configure() in case de-serialization from m_name was not successful.

Will log a warning if param lookup using the deprecated name is successful. This feature is helpful if you must change the parameter name but want to keep existing workspaces functioning.

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

ImFusion/Core/ParameterBase.h

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions