omni::input::List Class Reference

Input List contains a list of inputs, accessible over an QString id Input List is the root input of a session's input tree. Input List is serializable via QDataStream. More...

#include <List.h>

Inheritance diagram for omni::input::List:

Collaboration diagram for omni::input::List:

Public Member Functions
	List (Interface const *=nullptr)
void	registerInFactory () const
	A list cannot be registered in factory. More...
Id	getTypeId () const
	Type id is "List". More...
std::pair< QString, Input * >	addInput (Id const &_typeId)
	Add new input with given type id. Returns nullptr if input with typeid does not exist Id is automatically generated. More...
void	removeInput (QString const &_id)
	Remove input and reset current index if necessary. More...
bool	canHaveChildren () const
	List can have children. More...
QSize	size () const
	List has no size. More...
GLuint	textureId () const
	List does not have a texture. More...
QWidget *	widget ()
	Make new parameter widget. More...
Input *	operator[] (QString const &_id)
	Return input at index. More...
Input const *	operator[] (QString const &_id) const
	Returns input at index (const version) More...
void	clear ()
	Delete all inputs. More...
Input *	current ()
	Returns pointer to current input Returns nullptr if currentIdx_ == -1 or input list is empty. More...
Input const *	current () const
	Returns pointer to current input (const version) Returns nullptr if currentIdx_ == -1 or input list is empty. More...
QString	currentId () const
	Return ID of current input. More...
void	setCurrentId (QString const &)
	Set current input by ID. More...
Controller *	controller ()
	Return pointer to controller. More...
Controller const *	controller () const
	Return pointer to controller (const version) More...
void	fromPropertyMap (PropertyMap const &)
	Deserialize from property map. More...
void	toPropertyMap (PropertyMap &) const
	Serialize to property map. More...
Public Member Functions inherited from omni::input::Interface
	Interface (Interface const *_parent=nullptr)
virtual	~Interface ()
	Virtual destructor. More...
virtual void	update ()
	Update interface. 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 *	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...
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...
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...
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 ()

Private Member Functions
QString	generateId () const
	Generate a new id for input. More...

Private Attributes
QString	currentId_

Friends
bool	operator== (List const &, List const &)
	Test for equality. More...

Additional Inherited Members
Public Types inherited from omni::input::Interface
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

Detailed Description

Input List contains a list of inputs, accessible over an QString id Input List is the root input of a session's input tree. Input List is serializable via QDataStream.

Constructor & Destructor Documentation

omni::input::List::List

(

Interface const *

_parent = nullptr

)

                                       : Interface(_parent)
    {}

Member Function Documentation

std::pair< QString, Input * > omni::input::List::addInput

(

Id const &

_typeId

)

Add new input with given type id. Returns nullptr if input with typeid does not exist Id is automatically generated.

Parameters

_typeId

Type id of input to determine which kind of input is created

Returns

Pair with input id and pointer to added input

                                                             {
      auto _id = generateId();

      return std::make_pair(_id, input::Interface::addInput(_id, _typeId));
    }

bool omni::input::List::canHaveChildren ( ) const

inlinevirtual

List can have children.

Reimplemented from omni::input::Interface.

                                            {
          return true;
        }

void omni::input::List::clear

(

)

Delete all inputs.

    {
      Interface::clear();
    }

Controller * omni::input::List::controller

(

)

Return pointer to controller.

                                     {
      return Controller::instance();
    }

Controller const * omni::input::List::controller

(

)

const

Return pointer to controller (const version)

                                              {
      return Controller::instance();
    }

Input * omni::input::List::current

(

)

Returns pointer to current input Returns nullptr if currentIdx_ == -1 or input list is empty.

    {
      return getInput(currentId_);
    }

Input const * omni::input::List::current

(

)

const

Returns pointer to current input (const version) Returns nullptr if currentIdx_ == -1 or input list is empty.

    {
       return getInput(currentId_);
    }

QString omni::input::List::currentId

(

)

const

Return ID of current input.

    {
      return currentId_;
    }

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

virtual

Deserialize from property map.

Reimplemented from omni::input::Interface.

    {
      input::Interface::fromPropertyMap(_map);
      _map("currentId",currentId_);
      setCurrentId(currentId_);
    }

QString omni::input::List::generateId ( ) const

private

Generate a new id for input.

                                   {
      QString _id("0");

      for (size_t i = 0; i <= numberOfChildren(); ++i) {
        _id = QString("%1").arg(i);

        if (getInput(_id) == nullptr)
        {
          return _id;
        }
      }
      return _id;
    }

Id omni::input::List::getTypeId ( ) const

inlinevirtual

Type id is "List".

Implements omni::TypeIdInterface.

                                    {
          return Id("List");
        }

Input * omni::input::List::operator[]

(

QString const &

_id

)

Return input at index.

    {
      return Interface::getInput(_id);
    }

Input const * omni::input::List::operator[]

(

QString const &

_id

)

const

Returns input at index (const version)

    {
      return Interface::getInput(_id);
    }

void omni::input::List::registerInFactory ( ) const

inlinevirtual

A list cannot be registered in factory.

Implements omni::TypeIdInterface.

                                              {
        }

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

virtual

Remove input and reset current index if necessary.

Reimplemented from omni::input::Interface.

    {
      input::Interface::removeInput(_id);
      if (_id == currentId_) {
        setCurrentId("");
      }
    }

void omni::input::List::setCurrentId

(

QString const &

_id

)

Set current input by ID.

Deactivate current input

    {
      if (getInput(_id) == nullptr) {
        currentId_ = "";
        return;
      }
      qDebug() << currentId_;

      /// Deactivate current input
      if (current()) {
        controller()->deactivate(current());
      }

      currentId_ = _id;
      qDebug() << currentId_;

      if (current()) {
        current()->update();
        controller()->activate(current());
      }
      qDebug() << current();
    }

QSize omni::input::List::size ( ) const

inlinevirtual

List has no size.

Implements omni::input::Interface.

                                  {
          return QSize(0, 0);
        }

GLuint omni::input::List::textureId ( ) const

inlinevirtual

List does not have a texture.

Implements omni::input::Interface.

                                        {
          return 0;
        }

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

virtual

Serialize to property map.

Reimplemented from omni::input::Interface.

                                                    {
      _map("currentId",currentId_);
      input::Interface::toPropertyMap(_map);
    }

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

inlinevirtual

Make new parameter widget.

Reimplemented from omni::input::Interface.

                                 {
          return nullptr;
        }

Friends And Related Function Documentation

bool operator== ( List const &  _lhs, List const &  _rhs  )

friend

Test for equality.

    {
      if (_lhs.currentId_ != _rhs.currentId_) return false;

      if (_lhs.size() != _rhs.size()) return false;

      auto it = _lhs.begin();
      auto jt = _rhs.begin();

      for (; (it != _lhs.end()) && (jt != _rhs.end()); ++it, ++jt)
      {
        if (it->first != jt->first) return false;

        if (!it->second->equal(jt->second.get())) return false;
      }
      return true;
    }

Field Documentation

QString omni::input::List::currentId_

private

---

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

• include/omni/input/List.h
• src/lib/input/List.cpp