ImFusion::ParamControl Class Reference

#include <ImFusion/GUI/PropertiesWidgetParamControls.h>

Base class for parameter controls. More...

Inheritance diagram for ImFusion::ParamControl:

Detailed Description

Base class for parameter controls.

Signals
void	valueChanged ()
	Emitted when the parameter value was changed by the user.

Public Member Functions
	ParamControl (Properties::ParamType t, const std::string &n)
	Each control can only be used for a fixed type and parameter.
	~ParamControl () override=default
	Subclasses are expected to delete their widget.
virtual void	updateValue (const std::string &value, const std::vector< Properties::Attribute > &attributes)=0
	Updates the current value and adjusts the attributes.
virtual void	retrieveValue (Properties *p) const =0
	Retrieves the value from the widget and writes it into the properties.
virtual QWidget *	widget () const =0
	Returns the widget for this control.

Public Attributes
const Properties::ParamType	type
const std::string	name
std::vector< Properties::Attribute >	attributes

Member Function Documentation

updateValue()

virtual void ImFusion::ParamControl::updateValue ( const std::string & value, const std::vector< Properties::Attribute > & attributes )

pure virtual

Updates the current value and adjusts the attributes.

Implemented in ImFusion::ActiveEnvironmentControl, ImFusion::BoolParamControl, ImFusion::ColorPickerParamControl, ImFusion::DoubleAdjusterParamControl, ImFusion::DoubleParamControl, ImFusion::EigenMatrixParamControl, ImFusion::EnumParamControl, ImFusion::IntegerAdjusterParamControl, ImFusion::IntegerParamControl, ImFusion::LabeledParamControl, ImFusion::MatrixParamControl, ImFusion::OptionalParamControl, ImFusion::PathParamControl, ImFusion::StringParamControl, and ImFusion::TextParamControl.

retrieveValue()

virtual void ImFusion::ParamControl::retrieveValue ( Properties * p ) const

pure virtual

Retrieves the value from the widget and writes it into the properties.

Implemented in ImFusion::ActiveEnvironmentControl, ImFusion::BoolParamControl, ImFusion::ColorPickerParamControl, ImFusion::DoubleAdjusterParamControl, ImFusion::DoubleParamControl, ImFusion::EigenMatrixParamControl, ImFusion::EnumParamControl, ImFusion::IntegerAdjusterParamControl, ImFusion::IntegerParamControl, ImFusion::LabeledParamControl, ImFusion::MatrixParamControl, ImFusion::OptionalParamControl, ImFusion::PathParamControl, ImFusion::StringParamControl, and ImFusion::TextParamControl.

widget()

virtual QWidget * ImFusion::ParamControl::widget ( ) const

pure virtual

Returns the widget for this control.

The ParamControl does not own this widget, e.g. it must be re-parented to some other QWidget or deleted manually.

Implemented in ImFusion::ActiveEnvironmentControl, ImFusion::BoolParamControl, ImFusion::ColorPickerParamControl, ImFusion::DoubleAdjusterParamControl, ImFusion::DoubleParamControl, ImFusion::EigenMatrixParamControl, ImFusion::EnumParamControl, ImFusion::IntegerAdjusterParamControl, ImFusion::IntegerParamControl, ImFusion::LabeledParamControl, ImFusion::MatrixParamControl, ImFusion::OptionalParamControl, ImFusion::PathParamControl, ImFusion::StringParamControl, and ImFusion::TextParamControl.

---

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

• ImFusion/GUI/PropertiesWidgetParamControls.h