omni::ui::CanvasParameters Class Reference

Parameter widget for getting and setting canvas parameters. More...

#include <CanvasParameters.h>

Inheritance diagram for omni::ui::CanvasParameters:

Collaboration diagram for omni::ui::CanvasParameters:

Public Slots
void	setDataModel (canvas::Interface *)
virtual void	setRescaleValues (bool _rescale)
	Set flag if values are rescaled. More...
virtual void	setScale (float _factor)
	Set slider ranges. More...
virtual void	setUnit (QString const &)
	Set slider units. More...
Public Slots inherited from omni::ui::ParameterWidget
void	clear ()
	Removes all parameter widgets. More...
virtual void	updateParameters ()
double	getParamAsFloat (QString const &) const
	Utility method for retrieving the value from a slider with id. More...
void	setParamAsFloat (QString const &_str, double _value)
	Set slider value from given value. More...
int	getParamAsInt (QString const &) const
	Utility method for retrieving the value from a slider with id. More...
void	setParamAsInt (QString const &_str, int _value)
	Set slider value from given value. More...
bool	getParamAsBool (QString const &) const
	Utility method for retrieving the value from checkbox with id. More...
QWidget *	getWidget (QString const &)
	Get parameter widget from parameter map with Id. More...
void	setParametersVisible (bool)
	Show / hide parameter widgets. More...
bool	focusNext (bool _circular=false)
	Put focus on next element. More...
bool	focusPrev (bool _circular=false)
	Put focus on prev element. More...
void	focus (int _index)
	Focus item in layout with index. More...
void	focusFirst ()
	Set focus on first widget in parameter list. More...
void	focusLast ()
	Set focus on last widget in parameter list. More...
virtual void	setScale (float)
	Set slider ranges. More...
virtual void	setUnit (QString const &)
	Set slider ranges. More...

Signals
void	dataModelChanged ()
Signals inherited from omni::ui::ParameterWidget
void	parametersUpdated ()

Public Member Functions
	CanvasParameters (QWidget *_parent=nullptr)
virtual	~CanvasParameters ()
Public Member Functions inherited from omni::ui::ParameterWidget
	ParameterWidget (QWidget *_parent=nullptr)
	Default constructor. More...
virtual	~ParameterWidget ()
	Default Constructor. More...
RangedFloat *	addWidget (QString const &, float, float, float)
	Adds a widget with a name, a value and min-max range. More...
RangedInt *	addIntegerWidget (QString const &, int, int, int)
	Adds a integer widget with a name, a value and min-max range. More...
RangedFloat *	addAngleWidget (QString const &, float, float, float)
	Adds an angle widget with a name, a value and min-max range. More...
RangedFloat *	addOffsetWidget (QString const &, float, float, float)
	Adds an offset widget with a name, a value and min-max range. More...
Rotation *	addRotationWidget (QString const &)
	Adds an Rotation widget with three dials for X,Y and Z axis. More...
omni::ui::AffineTransform *	addAffineTransformWidget (QString const &, omni::AffineTransform *)
	Add a new affine transform widget with an id. More...
QCheckBox *	addCheckBox (QString const &, bool _checked=false)
	Adds a checkbox. More...
int	focusId () const
	Return id of focused parameter, -1 if no parameter is focused. More...
Public Member Functions inherited from omni::ui::mixin::Scale< omni::ui::RangedFloat >
	Scale ()
virtual void	setScale (float _scale)
	Set scale and apply to sliders. More...
bool	rescaleValues () const
void	setRescaleValues (bool _rescaleValues)
float	scale () const
	Return scale value. More...
QString	suffix () const
	Common unit of sliders. More...
void	setSuffix (QString const &_suffix)
	Set suffix (unit) of slider. More...
void	registerScaledSlider (slider_type *_slider)
	Register slider to be scaled. More...
void	unregisterScaledSlider (slider_type *_slider)
	Remove slider from list, keep scale. More...
Public Member Functions inherited from omni::ui::mixin::DataModel< DATAMODEL, SHARED >
	DataModel ()
void	setDataModel (pointer_type _dataModel)
	Set new data model. More...
pointer_type	dataModel ()
	Return pointer to data model. More...
const pointer_type	dataModel () const
	Return pointer to data model (const version) More...
virtual void	updateFrontend ()
	Push data to frontend widgets and all child widgets. More...
virtual void	updateDataModel ()
	Update the data model interface. More...

Protected Member Functions
virtual void	dataToFrontend ()
	Pure virtual method which determines how data model is represented in frontend. More...
virtual bool	frontendToData ()
	Return true if data has changed by front end. More...
Protected Member Functions inherited from omni::ui::ParameterWidget
virtual int	firstFocusId () const
	Id of first focussed widget. More...
void	keyPressEvent (QKeyEvent *_event)
Protected Member Functions inherited from omni::ui::mixin::Locked
template<typename F >
void	locked (F f)
	Lock widget and execute given functor. More...
bool	isLocked () const
	Return true if widget is locked. More...

Private Attributes
QUniquePtr < omni::ui::AffineTransform >	transform_
	Transform widget. More...
QUniquePtr< QComboBox >	boxViewMode_

Additional Inherited Members
Public Types inherited from omni::ui::mixin::Scale< omni::ui::RangedFloat >
typedef omni::ui::RangedFloat	slider_type
typedef float	scalar_type
Public Types inherited from omni::ui::mixin::DataModel< DATAMODEL, SHARED >
typedef DATAMODEL	data_model_type
	Data type. More...
typedef DataModel < data_model_type, SHARED >	type
	This type. More...
typedef detail::PointerType < data_model_type, SHARED >	pointer_type_handler
	Pointer type handler. More...
typedef pointer_type_handler::type	pointer_type
	Derived pointer type. More...
Static Public Member Functions inherited from omni::ui::mixin::Scale< omni::ui::RangedFloat >
static int	getPrecision (float _scale)
	Return precesion by scale. More...
Protected Attributes inherited from omni::ui::ParameterWidget
std::vector< QUniquePtr < QWidget > >	parameters_
	Slider parameter widgets. More...
std::map< QString, QWidget * >	parameterMap_
	Slider widgets, sorted by their label. More...

Detailed Description

Parameter widget for getting and setting canvas parameters.

Constructor & Destructor Documentation

omni::ui::CanvasParameters::CanvasParameters

(

QWidget *

_parent = nullptr

)

                                                       :
      ParameterWidget(_parent)
    {
        QLayout *_layout = new QVBoxLayout;
        _layout->setSpacing(2);
        _layout->setContentsMargins(0, 0, 0, 0);
        _layout->setSizeConstraint(QLayout::SetMaximumSize);
        setLayout(_layout);
        connect(this,&ParameterWidget::parametersUpdated,this,&CanvasParameters::updateDataModel);
    }

omni::ui::CanvasParameters::~CanvasParameters ( )

virtual

    {
    }

Member Function Documentation

void omni::ui::CanvasParameters::dataModelChanged ( )

signal

void omni::ui::CanvasParameters::dataToFrontend ( )

protectedvirtual

Pure virtual method which determines how data model is represented in frontend.

Implements omni::ui::mixin::DataModel< DATAMODEL, SHARED >.

                                          {
        if (!transform_) {
          transform_.reset(addAffineTransformWidget("Transform", &dataModel()->transform()));
        }

        if (!boxViewMode_) {
            boxViewMode_.reset(new QComboBox());
            boxViewMode_->addItem("Inside");
            boxViewMode_->addItem("Outside");
            boxViewMode_->addItem("Both");
            layout()->addWidget(boxViewMode_.get());
            connect(boxViewMode_.get(),
                static_cast<void (QComboBox::*)(int)>(&QComboBox::currentIndexChanged),
                this, &CanvasParameters::updateDataModel);
        }
        boxViewMode_->setCurrentIndex(util::enumToInt(dataModel()->
                                                               viewMode()));
    }

bool omni::ui::CanvasParameters::frontendToData ( )

protectedvirtual

Return true if data has changed by front end.

Implements omni::ui::mixin::DataModel< DATAMODEL, SHARED >.

                                          {
        if (!dataModel()) {
          return false;
        }
        transform_->updateDataModel();

        dataModel()->setViewMode(util::intToEnum<Canvas::ViewMode>(boxViewMode_
                                                                     ->
                                                                     currentIndex()));
        return true;
    }

void omni::ui::CanvasParameters::setDataModel ( canvas::Interface *  _canvas )

slot

                                                                {
      this->locked([&]() {
        mixin::UnsharedDataModel<canvas::Interface>::setDataModel(_canvas);
        if (_canvas->scene()) {
          setScale(_canvas->scene()->size());
          setUnit(_canvas->scene()->unit().abbreviation());
          updateFrontend();
        }
      });
      emit dataModelChanged();
    }

void omni::ui::CanvasParameters::setRescaleValues ( bool  _rescale )

virtualslot

Set flag if values are rescaled.

Parameters

_rescale

Boolean which tells if values are rescaled

                                                         {
      ParameterWidget::setRescaleValues(_rescale);
      if (transform_) {
        transform_->setRescaleOffsetValues(_rescale);
      }
      if (!this->isLocked()) {
        emit dataModelChanged();
      }
    }

void omni::ui::CanvasParameters::setScale ( float  _factor )

virtualslot

Set slider ranges.

Parameters

_factor

Scale factor

                                                {
      ParameterWidget::setScale(_scale);
      if (transform_) {
        transform_->setOffsetRangeScale(_scale);
      }
      if (!this->isLocked()) {
        emit dataModelChanged();
      }
    }

void omni::ui::CanvasParameters::setUnit ( QString const &  _unit )

virtualslot

Set slider units.

Set slider ranges.

                                                       {
      ParameterWidget::setUnit(_unit);
      if (transform_) {
        transform_->setOffsetUnit(_unit);
      }
    }

Field Documentation

QUniquePtr<QComboBox> omni::ui::CanvasParameters::boxViewMode_

private

QUniquePtr<omni::ui::AffineTransform> omni::ui::CanvasParameters::transform_

private

Transform widget.

---

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

• include/omni/ui/CanvasParameters.h
• src/lib/ui/CanvasParameters.cpp