omni::input::Framebuffer Class Reference

Input object that is renderer to a framebuffer. More...

#include <Framebuffer.h>

Inheritance diagram for omni::input::Framebuffer:

Collaboration diagram for omni::input::Framebuffer:

Public Member Functions
	Framebuffer (input::Interface const *=nullptr)
virtual	~Framebuffer ()
virtual QSize	size () const
	An input must return width and height information. More...
virtual void	setSize (QSize const &)
GLuint	textureId () const
	An input must return an OpenGL texture ID. More...
virtual void	destroy ()
virtual void	toPropertyMap (PropertyMap &) const
	Serialize to property map. More...
virtual void	fromPropertyMap (PropertyMap const &)
	Deserialize from 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 *	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...
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...

Protected Member Functions
QOpenGLFramebufferObject *	framebuffer ()
QOpenGLFramebufferObject const *	framebuffer () const
void	setupFramebuffer (QSize const &_size)
void	setupFramebuffer ()

Private Attributes
QSize	size_
ContextBoundPtr < QOpenGLFramebufferObject >	framebuffer_

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 object that is renderer to a framebuffer.

Constructor & Destructor Documentation

omni::input::Framebuffer::Framebuffer

(

input::Interface const *

_input = nullptr

)

                                                         :
      input::Interface(_input),
      size_(0,0) {
    }

virtual omni::input::Framebuffer::~Framebuffer ( )

inlinevirtual

{};

Member Function Documentation

void omni::input::Framebuffer::destroy ( )

virtual

Reimplemented in omni::input::TestImage.

                              {
      framebuffer_.reset();
    }

QOpenGLFramebufferObject * omni::input::Framebuffer::framebuffer ( )

protected

                                                       {
      return framebuffer_.get();
    }

QOpenGLFramebufferObject const * omni::input::Framebuffer::framebuffer ( ) const

protected

                                                                   {
      return framebuffer_.get();
    }

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

virtual

Deserialize from property map.

Deserialize from stream.

Reimplemented from omni::input::Interface.

Reimplemented in omni::input::TestImage.

                                                             {
      input::Interface::fromPropertyMap(_map);
      size_ = _map.getValue("size",QSize(0,0));
      setupFramebuffer(size_);
    }

void omni::input::Framebuffer::setSize ( QSize const &  _size )

virtual

                                                 {
      setupFramebuffer(_size);
    }

void omni::input::Framebuffer::setupFramebuffer ( QSize const &  _size )

protected

                                                         {
      if (_size == QSize(0,0)) {
        framebuffer_.reset();
        return;
      }

      bool _reset = !framebuffer_;
      if (framebuffer_) {
        _reset |= framebuffer_->size() != _size;
      }

      // Framebuffer is already setup, no work to do
      if (!_reset) return;

      primaryContextSwitch([&](QOpenGLFunctions& _) {
        QOpenGLFramebufferObjectFormat _format;
        _format.setMipmap(false);
        _format.setSamples(0);
        _format.setTextureTarget(GL_TEXTURE_RECTANGLE);
        _format.setAttachment(QOpenGLFramebufferObject::NoAttachment);
        framebuffer_.reset(new QOpenGLFramebufferObject(
              _size.width(),
              _size.height(),_format));
        _.glBindTexture(GL_TEXTURE_RECTANGLE, framebuffer_->texture());
        _.glTexParameteri(GL_TEXTURE_RECTANGLE, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
        _.glTexParameteri(GL_TEXTURE_RECTANGLE, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
        _.glBindTexture(GL_TEXTURE_RECTANGLE, 0);
        size_ = _size;
      });
    }

void omni::input::Framebuffer::setupFramebuffer ( )

protected

                                       {
      setupFramebuffer(size());
    }

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

virtual

An input must return width and height information.

Implements omni::input::Interface.

                                  {
      return !framebuffer_ ? size_ : framebuffer_->size();
    }

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

virtual

An input must return an OpenGL texture ID.

Implements omni::input::Interface.

    {
      return !framebuffer_ ? 0 : framebuffer_->texture();
    }

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

virtual

Serialize to property map.

Serialize to stream.

Reimplemented from omni::input::Interface.

Reimplemented in omni::input::TestImage.

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

Field Documentation

ContextBoundPtr<QOpenGLFramebufferObject> omni::input::Framebuffer::framebuffer_

private

QSize omni::input::Framebuffer::size_

private

---

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

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