omni::ui::mixin Namespace Reference

Namespace for helper classes and mixins. More...

Namespaces
	detail

Data Structures
class	DataModelInterface
	Data model interface. More...
class	DataModel
	Holds a specific data model with frontend update mechanism. More...
class	Editor
	Mixin for a widget that holds an editor widget. More...
class	Locked
	Mixin with a function to lock the widget temporarily. More...
class	ParameterWidget
	Setup and remove a parameter widget for a certain plugin interface. More...
struct	Range
	Mixin for a ranged value with min and maximum. More...
struct	RangedValue
	Template class for a value within a certain min/max range. More...
class	Scale
	Scales a set of sliders and sets a common unit suffix. More...
struct	Step
	Mixin Stepping value class template Singla and page step. More...
class	TransformedRect
	Mixin which calculates transformed screen rectangles Used in export output preview and screen setup widgets. More...
class	TuningFromIndex

Typedefs
template<typename T >
using	SharedDataModel = DataModel< T, true >
	Template alias for shared data model. More...
template<typename T >
using	UnsharedDataModel = DataModel< T, false >
	Template alias for unshared data model. More...

Functions
template<typename WIDGET , typename DATAMODEL , typename... ARGS>
static WIDGET *	makeWidget (DATAMODEL *_dataModel, ARGS &&..._args)
	Instantiate a new widget and set data model Uses raw pointer (unshared data model) More...
template<typename WIDGET , typename DATAMODEL , typename... ARGS>
static WIDGET *	makeWidget (std::shared_ptr< DATAMODEL >_dataModel, ARGS &&..._args)
	Instantiate a new widget and set data model Uses shared pointer (shared data model) More...

Detailed Description

Namespace for helper classes and mixins.

Typedef Documentation

template<typename T >

using omni::ui::mixin::SharedDataModel = typedef DataModel<T, true>

Template alias for shared data model.

template<typename T >

using omni::ui::mixin::UnsharedDataModel = typedef DataModel<T, false>

Template alias for unshared data model.

Function Documentation

template<typename WIDGET , typename DATAMODEL , typename... ARGS>

static WIDGET* omni::ui::mixin::makeWidget ( DATAMODEL *  _dataModel, ARGS &&...  _args  )

static

Instantiate a new widget and set data model Uses raw pointer (unshared data model)

                                                                         {
        auto *_widget = new WIDGET(_args ...);

        _widget->setDataModel(_dataModel);
        return _widget;
      }

template<typename WIDGET , typename DATAMODEL , typename... ARGS>

static WIDGET* omni::ui::mixin::makeWidget ( std::shared_ptr< DATAMODEL >  _dataModel, ARGS &&...  _args  )

static

Instantiate a new widget and set data model Uses shared pointer (shared data model)

                                                  {
        auto *_widget = new WIDGET(_args ...);

        _widget->setDataModel(_dataModel);
        return _widget;
      }