omni::ui::mixin::DataModel< DATAMODEL, SHARED > Class Template Reference

Holds a specific data model with frontend update mechanism. More...

#include <DataModel.h>

Inheritance diagram for omni::ui::mixin::DataModel< DATAMODEL, SHARED >:

Collaboration diagram for omni::ui::mixin::DataModel< DATAMODEL, SHARED >:

Public Types
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...

Public Member Functions
	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...

Private Member Functions
virtual void	dataToFrontend ()=0
	Pure virtual method which determines how data model is represented in frontend. More...
virtual bool	frontendToData ()=0
	Return true if data has changed by front end. More...
virtual void	emitDataModelChangedSignal ()
	Internal method used to emit dataModelChanged signal. More...

Private Attributes
pointer_type	dataModel_

Additional Inherited Members
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...

Detailed Description

template<typename DATAMODEL, bool SHARED>
class omni::ui::mixin::DataModel< DATAMODEL, SHARED >

Holds a specific data model with frontend update mechanism.

Template Parameters

DATAMODEL	Type of data which is stored
SHARED	Boolean flag to tell of data model is encapsulared in a shared_ptr

Member Typedef Documentation

template<typename DATAMODEL , bool SHARED>

typedef DATAMODEL omni::ui::mixin::DataModel< DATAMODEL, SHARED >::data_model_type

Data type.

template<typename DATAMODEL , bool SHARED>

typedef pointer_type_handler::type omni::ui::mixin::DataModel< DATAMODEL, SHARED >::pointer_type

Derived pointer type.

template<typename DATAMODEL , bool SHARED>

typedef detail::PointerType<data_model_type, SHARED> omni::ui::mixin::DataModel< DATAMODEL, SHARED >::pointer_type_handler

Pointer type handler.

template<typename DATAMODEL , bool SHARED>

typedef DataModel<data_model_type, SHARED> omni::ui::mixin::DataModel< DATAMODEL, SHARED >::type

This type.

Constructor & Destructor Documentation

template<typename DATAMODEL , bool SHARED>

omni::ui::mixin::DataModel< DATAMODEL, SHARED >::DataModel ( )

inline

                {
    pointer_type_handler::initialize(dataModel_);
    }

Member Function Documentation

template<typename DATAMODEL , bool SHARED>

pointer_type omni::ui::mixin::DataModel< DATAMODEL, SHARED >::dataModel ( )

inline

Return pointer to data model.

                                   {
            return dataModel_;
          }

template<typename DATAMODEL , bool SHARED>

const pointer_type omni::ui::mixin::DataModel< DATAMODEL, SHARED >::dataModel ( ) const

inline

Return pointer to data model (const version)

                                               {
            return dataModel_;
          }

template<typename DATAMODEL , bool SHARED>

virtual void omni::ui::mixin::DataModel< DATAMODEL, SHARED >::dataToFrontend ( )

privatepure virtual

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

Implemented in omni::ui::proj::Tuning, omni::ui::proj::TuningList, omni::ui::TuningGLView, omni::ui::AffineTransform, omni::ui::ScreenSetup, omni::ui::Input, omni::ui::OutputPreview, omni::ui::ColorCorrection, omni::ui::Canvas, omni::ui::SceneViewer, omni::ui::Scene, omni::ui::proj::ChannelCorrectionParameters, omni::ui::ToolBar, omni::ui::CanvasParameters, omni::ui::proj::ColorCorrectionGraph, omni::ui::Mapping, omni::ui::Export, omni::ui::SceneGLView, omni::ui::Warp, omni::ui::Blend, and omni::ui::MappingParameters.

template<typename DATAMODEL , bool SHARED>

virtual void omni::ui::mixin::DataModel< DATAMODEL, SHARED >::emitDataModelChangedSignal ( )

inlineprivatevirtual

Internal method used to emit dataModelChanged signal.

{}

template<typename DATAMODEL , bool SHARED>

virtual bool omni::ui::mixin::DataModel< DATAMODEL, SHARED >::frontendToData ( )

privatepure virtual

Return true if data has changed by front end.

Implemented in omni::ui::proj::Tuning, omni::ui::proj::TuningList, omni::ui::TuningGLView, omni::ui::AffineTransform, omni::ui::ScreenSetup, omni::ui::Input, omni::ui::ColorCorrection, omni::ui::OutputPreview, omni::ui::Canvas, omni::ui::proj::ChannelCorrectionParameters, omni::ui::SceneViewer, omni::ui::proj::ColorCorrectionGraph, omni::ui::Scene, omni::ui::ToolBar, omni::ui::CanvasParameters, omni::ui::Mapping, omni::ui::Warp, omni::ui::Export, omni::ui::SceneGLView, omni::ui::Blend, and omni::ui::MappingParameters.

template<typename DATAMODEL , bool SHARED>

void omni::ui::mixin::DataModel< DATAMODEL, SHARED >::setDataModel ( pointer_type  _dataModel )

inline

Set new data model.

                                                     {
            this->locked([&]() {
            dataModel_ = _dataModel;
            updateFrontend();
          });
          }

template<typename DATAMODEL , bool SHARED>

virtual void omni::ui::mixin::DataModel< DATAMODEL, SHARED >::updateDataModel ( )

inlinevirtual

Update the data model interface.

Implements omni::ui::mixin::DataModelInterface.

                                         {
            if (this->isLocked()) {
              return;
            }
            this->locked([&]() {
            if (frontendToData()) {
              emitDataModelChangedSignal();
            }
          });
          }

template<typename DATAMODEL , bool SHARED>

virtual void omni::ui::mixin::DataModel< DATAMODEL, SHARED >::updateFrontend ( )

inlinevirtual

Push data to frontend widgets and all child widgets.

Implements omni::ui::mixin::DataModelInterface.

                                        {
            if (dataModel_ && this->isLocked()) {
              dataToFrontend();
            }
          }

Field Documentation

template<typename DATAMODEL , bool SHARED>

pointer_type omni::ui::mixin::DataModel< DATAMODEL, SHARED >::dataModel_

private

---

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

• include/omni/ui/mixin/DataModel.h