Generic input interface. More...

#include <Interface.h>

Inheritance diagram for omni::input::Interface:

Collaboration diagram for omni::input::Interface:

Public Types
typedef Interface	interface_type

typedef std::vector< Interface const * >	inputlist_type

typedef std::map< QString, std::unique_ptr< Interface > >	container_type

typedef std::function< void()>	callback_type

typedef std::set< QString >	categoryset_type

Public Member Functions
	Interface (Interface const *_parent=nullptr)

virtual	~Interface ()
	Virtual destructor. More...

virtual GLuint	textureId () const =0
	An input must return an OpenGL texture ID. More...

virtual void	update ()
	Update interface. More...

virtual QSize	size () const =0
	An input must return width and height information. More...

size_t	numberOfChildren () const

int	width () const
	Return width from size. More...

int	height () const
	Return height from size. More...

virtual categoryset_type	categories () const
	Input can have a fixed set of categories. More...

QString	infoText () const
	Optional info text. More...

virtual QWidget *	widget ()
	Make new parameter widget. More...

virtual QWidget *	controlWidget ()
	Make new large control widget for live mode. More...

virtual bool	canAdd ()
	Returns true if this input can be added E.g., an input can be added after an initial settings dialog was approved or it has valid settings. More...

virtual bool	canHaveChildren () const

int	setUpdateCallback (callback_type _updatedCallback)
	Insert a new callback when input has updated and returns its unique id. More...

callback_type	updatedCallback (int _id)

void	triggerUpdateCallbacks () const

void	removeUpdateCallback (int _id)

Interface *	addInput (QString const &_id, Id const &_typeId)
	Add new input with given type id. Returns nullptr if input with typeid does not exist. More...

Interface *	addInput (QString const &_id, Interface *_i)
	Input with id and return pointer to input when successfully added. More...

QString	getId (Interface const *) const
	Get id of child interface. More...

virtual void	removeInput (QString const &_id)
	Remove input with id. More...

Interface *	getInput (QString const &_id)
	Return pointer of input with id, nullptr if input does not exist. More...

Interface const *	getInput (QString const &_id) const
	Return pointer of input with id, nullptr if input does not exist. More...

container_type const &	children () const
	Return children. More...

Interface const *	parent () const
	Return parent interface (const version) More...

QString	path () const
	Return absolute path of interface. More...

void	setParent (Interface *)
	Set new parent. More...

virtual void	toPropertyMap (PropertyMap &) const
	Serialize to property map. More...

virtual void	fromPropertyMap (PropertyMap const &)
	Deserialize from property map. More...

inputlist_type	getAllInputs () const
	Returns a list of input maintained by controller, except this one. More...

Public Member Functions inherited from omni::TypeIdInterface
virtual	~TypeIdInterface ()

virtual Id	getTypeId () const =0
	Returns type id of object. More...

virtual void	registerInFactory () const =0
	Register the inherited class in factory. More...

Private Member Functions
virtual void	activate ()

virtual void	deactivate ()

void	getInputsRecurse (Interface const *_root, inputlist_type &_list, bool _excludeThis=true) const

int	genCallbackId () const

Private Attributes
Interface const *	parent_ = nullptr

std::map< int, callback_type >	updatedCallbacks_

Friends
class	Controller

Detailed Description

Generic input interface.

Member Typedef Documentation

typedef std::function<void ()> omni::input::Interface::callback_type

typedef std::set<QString> omni::input::Interface::categoryset_type

typedef std::map<QString, std::unique_ptr<Interface> > omni::input::Interface::container_type

typedef std::vector<Interface const*> omni::input::Interface::inputlist_type

typedef Interface omni::input::Interface::interface_type

Constructor & Destructor Documentation

omni::input::Interface::Interface ( Interface const * _parent = nullptr )

                                                  : parent_(_parent) {
       Controller::instance()->add(this);
     }

omni::input::Interface::~Interface ( )

virtual

Virtual destructor.

Removing input from global controller also deactivates it

     {
       updatedCallbacks_.clear();
       /// Removing input from global controller also deactivates it
       Controller::instance()->remove(this);
     }

Member Function Documentation

virtual void omni::input::Interface::activate ( )

inlineprivatevirtual

200 {

201 }

Input * omni::input::Interface::addInput	(	QString const &	_id,
		Id const &	_typeId
	)

Add new input with given type id. Returns nullptr if input with typeid does not exist.

Parameters

_id	Id for the input
_typeId	Type id of input to determine which kind of input is created

     {
       std::unique_ptr<Input> _input(Factory::create(_typeId, this));
 
       if (!_input) return nullptr;
 
       _input->parent_ = this;
       container_type::operator[](_id) = std::move(_input);
       return container_type::at(_id).get();
     }

Interface * omni::input::Interface::addInput	(	QString const &	_id,
		Interface *	_i
	)

Input with id and return pointer to input when successfully added.

                                                                      {
       if (container_type::count(_id) != 0) {
         return nullptr;
       }
              container_type::operator[](_id).reset(_i);
       _i->parent_ = this;
 
       return container_type::operator[](_id).get();
     }

virtual bool omni::input::Interface::canAdd ( )

inlinevirtual

Returns true if this input can be added E.g., an input can be added after an initial settings dialog was approved or it has valid settings.

Returns: Flag if input can be added

                                      {
           return true;
         }

virtual bool omni::input::Interface::canHaveChildren ( ) const

inlinevirtual

Reimplemented in omni::input::List.

                                                      {
           return false;
         }

virtual categoryset_type omni::input::Interface::categories ( ) const

inlinevirtual

Input can have a fixed set of categories.

Reimplemented in omni::input::TestImage.

                                                     {
           return categoryset_type();
         }

Interface::container_type const & omni::input::Interface::children ( ) const

Return children.

                                                              {
       return *this;
     }

virtual QWidget* omni::input::Interface::controlWidget ( )

inlinevirtual

Make new large control widget for live mode.

                                                 {
           return nullptr;
         }

virtual void omni::input::Interface::deactivate ( )

inlineprivatevirtual

203 {

204 }

void omni::input::Interface::fromPropertyMap ( PropertyMap const & _map )

virtual

Deserialize from property map.

Deserialize from stream.

Reimplemented in omni::input::List, omni::input::TestImage, and omni::input::Framebuffer.

                                                            {
       using namespace omni::util;
       clear();
       PropertyMap _children = _map.getValue("children",PropertyMap());
       auto _ids = _children.ids();
 
       for (auto& _id : _ids) {
         _children.getPtr(_id,[&](Id const& _typeId) ->
                          input::Interface *
           {
             return addInput(_id, _typeId);
           });
       }
     }

int omni::input::Interface::genCallbackId ( ) const

inlineprivate

                                   {
           for (size_t i = 0; i <= updatedCallbacks_.size(); ++i) {
             if (!updatedCallbacks_.count(i)) {
               return i;
             }
           }
           return updatedCallbacks_.size();
         }

Interface::inputlist_type omni::input::Interface::getAllInputs ( ) const

Returns a list of input maintained by controller, except this one.

                                                            {
       inputlist_type _inputs;
       Interface const* _root = this;
       while (_root->parent()) {
         _root = _root->parent();
       }
       getInputsRecurse(_root,_inputs,true);
       return _inputs;
     }

QString omni::input::Interface::getId ( Interface const * _i ) const

Get id of child interface.

                                                       {
       if (_i->parent() != this) return "";
 
       for (auto& _child : *this) {
         if (_i == _child.second.get()) {
           return _child.first;
         }
       }
       return QString("");
     }

Interface * omni::input::Interface::getInput ( QString const & _id )

Return pointer of input with id, nullptr if input does not exist.

                                                       {
       if (container_type::count(_id) == 0) return nullptr;
 
       return container_type::at(_id).get();
     }

Interface const * omni::input::Interface::getInput ( QString const & _id ) const

Return pointer of input with id, nullptr if input does not exist.

                                                                   {
       if (container_type::count(_id) == 0) return nullptr;
 
       return container_type::at(_id).get();
     }

void omni::input::Interface::getInputsRecurse	(	Interface const *	_root,
		inputlist_type &	_list,
		bool	_excludeThis = `true`
	)		const

private

                                {
       for (auto& _idChild : *this) {
         auto* _child = _idChild.second.get();
         if (!((_child == this) && _excludeThis)) {
           _list.push_back(_child);
         }
 
         getInputsRecurse(_child,_list,_excludeThis);
       }
     }

int omni::input::Interface::height ( ) const

inline

Return height from size.

         {
           return size().height();
         }

QString omni::input::Interface::infoText ( ) const

inline

Optional info text.

                                  {
           return QString();
         }

size_t omni::input::Interface::numberOfChildren ( ) const

inline

                                                {
           return container_type::size();
         }

Interface const * omni::input::Interface::parent ( ) const

Return parent interface (const version)

                                               {
       return parent_;
     }

QString omni::input::Interface::path ( ) const

Return absolute path of interface.

                                   {
       if (!parent()) return "/";
 
       auto   *_parent = parent();
       QString _path;
 
       while (_parent != nullptr) {
         _path   = QString("/") + _parent->getId(this) + _path;
         _parent = _parent->parent();
       }
       return _path;
     }

void omni::input::Interface::removeInput ( QString const & _id )

virtual

Remove input with id.

Reimplemented in omni::input::List.

                                                   {
       container_type::erase(_id);
     }

void omni::input::Interface::removeUpdateCallback ( int _id )

inline

                                                   {
           updatedCallbacks_.erase(_id);
         }

void omni::input::Interface::setParent ( Interface * _parent )

Set new parent.

                                                 {
       parent_ = _parent;
     }

int omni::input::Interface::setUpdateCallback ( callback_type _updatedCallback )

inline

Insert a new callback when input has updated and returns its unique id.

                                                                      {
           int _id = genCallbackId();
           updatedCallbacks_[_id] = _updatedCallback;
           return _id;
         }

virtual QSize omni::input::Interface::size ( ) const

pure virtual

An input must return width and height information.

Implemented in omni::input::List, and omni::input::Framebuffer.

virtual GLuint omni::input::Interface::textureId ( ) const

pure virtual

An input must return an OpenGL texture ID.

Implemented in omni::input::List, and omni::input::Framebuffer.

void omni::input::Interface::toPropertyMap ( PropertyMap & _map ) const

virtual

Serialize to property map.

Serialize to stream.

Reimplemented in omni::input::List, omni::input::TestImage, and omni::input::Framebuffer.

                                                          {
       using namespace omni::util;
       PropertyMap _children;
       for (auto& _idChild : children()) {
         OMNI_DEBUG << _idChild.first << _idChild.second.get();
         _children.put(_idChild.first,_idChild.second);
       }
       _map.put("children",_children);
     }

void omni::input::Interface::triggerUpdateCallbacks ( ) const

inline

                                             {
           for (auto& _idCallback : updatedCallbacks_) {
             _idCallback.second();
           }
         }

virtual void omni::input::Interface::update ( )

inlinevirtual

Update interface.

Reimplemented in omni::input::TestImage.

80 {}

callback_type omni::input::Interface::updatedCallback ( int _id )

inline

                                                       {
           return updatedCallbacks_.at(_id);
         }

QWidget * omni::input::Interface::widget ( )

virtual

Make new parameter widget.

Reimplemented in omni::input::List.

                                 {
       return new ui::InputPreview(this);
     }

int omni::input::Interface::width ( ) const

inline

Return width from size.

         {
           return size().width();
         }

Friends And Related Function Documentation

friend class Controller

friend

Field Documentation

Interface const* omni::input::Interface::parent_ = nullptr

private

std::map<int,callback_type> omni::input::Interface::updatedCallbacks_

private

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

include/omni/input/Interface.h
src/lib/input/Interface.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation