omni::mapping::Interface Class Reference

Mapping interface with one or several inputs and shader Holds inputs and shader. More...

#include <Interface.h>

Inheritance diagram for omni::mapping::Interface:

Collaboration diagram for omni::mapping::Interface:

Public Member Functions
	Interface ()
virtual	~Interface ()
void	initialize ()
	Initialized OpenGL shader. More...
virtual void	bind ()
	Bind shaders and set uniforms. More...
void	bind (input::Interface const *, OutputMode, bool _grayscale)
void	bind (input::Interface const *, float _transparency)
void	release ()
	Release shader. More...
bool	flipHorizontal () const
	Flip horizontally. More...
void	setFlipHorizontal (bool)
	Flip horizontally. More...
bool	flipVertical () const
	Flip vertically. More...
void	setFlipVertical (bool)
	Flip vertically. More...
virtual bool	isUVW () const
	Flag which tells if this mapping uses UVW texture coordinates (true by default) . More...
virtual QWidget *	widget ()=0
	Return pointer to parameter widget. More...
void	draw () const
	Abstract method for visualing. More...
virtual void	draw (float _opacity) const
	Draw mapping with opacity. More...
virtual void	update ()
	Update mapping visualizer. More...
AffineTransform const &	transform () const
	Return const ref to affine transform. More...
AffineTransform &	transform ()
	Return ref to affine transform. More...
void	setTransform (AffineTransform const &_transform)
	Set new affine transform. More...
virtual QMatrix4x4	matrix () const
	Return matrix of transform. More...
bool	isBoundToCanvas () const
	If true, mapping transform is attached to canvas transform Is true by default. More...
void	setBoundToCanvas (bool)
	Set whether mapping transform is attached to canvas transform. More...
virtual void	toPropertyMap (PropertyMap &) const
	Write mapping to stream. More...
virtual void	fromPropertyMap (PropertyMap const &)
	Read mapping from stream. More...
visual::Scene const *	scene () const
	The scene this canvas belongs to. More...
void	setScene (visual::Scene const *)
	Set the scene this canvas belongs to. Is set automatically when a canvas is added to a session. 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...

Static Public Member Functions
static IdSet	getUVWMappings ()
	Static function to retrieve all registered mappings that support UVW. More...
static IdSet	getPlanarMappings ()
	Static function to retrieve all registered mappings that dont. More...

Protected Attributes
std::unique_ptr < QOpenGLShaderProgram >	shader_

Private Member Functions
virtual QString	vertexShaderSourceCode () const
	Returns vertex shader source code Is taken from file :/shaders/mapping/common.vert by default) More...
virtual QString	fragmentShaderSourceCode () const
	Returns fragment shader source code Is taken from file :/shaders/mapping/$MAPPING_TYPEID by default) More...

Private Attributes
AffineTransform	transform_
bool	boundToCanvas_ = true
bool	flipHorizontal_ = false
bool	flipVertical_ = false
visual::Scene const *	scene_ = nullptr

Additional Inherited Members
Static Protected Member Functions inherited from omni::visual::Interface
static void	vertex3 (QVector3D const &)
	glVertex3f from QVector3D More...
static void	visualLine (QVector3D const &_from, QVector3D const &_to)
	Draws a line. More...
static void	color (QColor _color, float _alpha=1.0)
	glColor4f from QColor More...

Detailed Description

Mapping interface with one or several inputs and shader Holds inputs and shader.

Constructor & Destructor Documentation

omni::mapping::Interface::Interface

(

)

        {
            // Disable scaling and translation by default
            transform_.setTranslationEnabled(false);
            transform_.setScaleEnabled(false);
        }

omni::mapping::Interface::~Interface ( )

virtual

Reimplemented from omni::visual::Interface.

        {}

Member Function Documentation

void omni::mapping::Interface::bind ( )

virtual

Bind shaders and set uniforms.

                             {
            if (!shader_) initialize();

            if (shader_)
            {
                shader_->bind();
                shader_->setUniformValue("flip_horizontal", flipHorizontal_);
                shader_->setUniformValue("flip_vertical",   flipVertical_);

                if (isUVW()) {
                  float _size = scene_ ? scene_->size() : 1.0;
                    shader_->setUniformValue("bound_to_canvas", boundToCanvas_);
                    shader_->setUniformValue("matrix",          matrix());
                    shader_->setUniformValue("offset",          _size*matrix().column(3).toVector3D());
                }
            }
        }

void omni::mapping::Interface::bind	(	input::Interface const *	_input,
		OutputMode	_outputMode,
		bool	_grayscale
	)

        {
            bind();
            if (shader_)
            {
                shader_->setUniformValue("output_mode",
                                                        util::enumToInt(
                                             _outputMode));

                shader_->setUniformValue("texture",   0);
                shader_->setUniformValue("texture_size",QVector2D(_input->width(),_input->height()));
                shader_->setUniformValue("gray_output", _grayscale);
                shader_->setUniformValue("transparency",GLfloat(1.0));
            }
        }

void omni::mapping::Interface::bind	(	input::Interface const *	_input,
		float	_transparency
	)

                                                                              {
            bind();
            if (shader_)
            {
                shader_->setUniformValue("output_mode",
                                                        util::enumToInt(OutputMode::MAPPED_INPUT));
                shader_->setUniformValue("texture",   0);
                shader_->setUniformValue("texture_size",QVector2D(_input->width(),_input->height()));
                shader_->setUniformValue("gray_output", false);
                shader_->setUniformValue("transparency",_transparency);
            }
        }

void omni::mapping::Interface::draw ( ) const

inlinevirtual

Abstract method for visualing.

Implements omni::visual::Interface.

                                 {
          draw(1.0);
        }

virtual void omni::mapping::Interface::draw ( float  _opacity ) const

inlinevirtual

Draw mapping with opacity.

{}

bool omni::mapping::Interface::flipHorizontal

(

)

const

Flip horizontally.

        {
            return flipHorizontal_;
        }

bool omni::mapping::Interface::flipVertical

(

)

const

Flip vertically.

        {
            return flipVertical_;
        }

QString omni::mapping::Interface::fragmentShaderSourceCode ( ) const

privatevirtual

Returns fragment shader source code Is taken from file :/shaders/mapping/$MAPPING_TYPEID by default)

        {
            return
                visual::ShaderCompiler::compile(":/shaders/mapping/Template.frag") +
                visual::ShaderCompiler::compile(QString(
                                    ":/shaders/mapping/") + getTypeId().str() +
                                ".frag");
        }

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

virtual

Read mapping from stream.

                                                               {
            _map.get("transform",transform_)
                .get("boundToCanvas",boundToCanvas_)
                .get("flipHorizontal",flipHorizontal_)
                .get("flipVertical",flipVertical_);
        }

IdSet omni::mapping::Interface::getPlanarMappings ( )

static

Static function to retrieve all registered mappings that dont.

        {
            IdSet _ids;

            for (auto& _mappingId : Factory::classes())
            {
                auto& _id = _mappingId.first;
                std::unique_ptr<Mapping> _mapping(Factory::create(_id));

                if (!_mapping->isUVW()) _ids.insert(_id);
            }
            return _ids;
        }

IdSet omni::mapping::Interface::getUVWMappings ( )

static

Static function to retrieve all registered mappings that support UVW.

        {
            IdSet _ids;

            for (auto& _mappingId : Factory::classes())
            {
                auto& _id = _mappingId.first;
                std::unique_ptr<Mapping> _mapping(Factory::create(_id));

                if (_mapping->isUVW()) _ids.insert(_id);
            }
            return _ids;
        }

void omni::mapping::Interface::initialize

(

)

Initialized OpenGL shader.

Make shader

        {
            /// Make shader
            shader_.reset(new QOpenGLShaderProgram());
            shader_->addShaderFromSourceCode(QOpenGLShader::Vertex,
                                             vertexShaderSourceCode());
            shader_->addShaderFromSourceCode(QOpenGLShader::Fragment,
                                             fragmentShaderSourceCode());
            shader_->link();
        }

bool omni::mapping::Interface::isBoundToCanvas

(

)

const

If true, mapping transform is attached to canvas transform Is true by default.

                                              {
            return boundToCanvas_;
        }

virtual bool omni::mapping::Interface::isUVW ( ) const

inlinevirtual

Flag which tells if this mapping uses UVW texture coordinates (true by default) .

        {
          return true;
        }

QMatrix4x4 omni::mapping::Interface::matrix ( ) const

virtual

Return matrix of transform.

                                           {
            return transform_.matrix();
        }

void omni::mapping::Interface::release

(

)

Release shader.

        {
            if (shader_) shader_->release();
        }

visual::Scene const * omni::mapping::Interface::scene

(

)

const

The scene this canvas belongs to.

                                                  {
          return scene_;
        }

void omni::mapping::Interface::setBoundToCanvas

(

bool

_boundToCanvas

)

Set whether mapping transform is attached to canvas transform.

                                                            {
            boundToCanvas_ = _boundToCanvas;
        }

void omni::mapping::Interface::setFlipHorizontal

(

bool

_flipHorizontal

)

Flip horizontally.

        {
            flipHorizontal_ = _flipHorizontal;
        }

void omni::mapping::Interface::setFlipVertical

(

bool

_flipVertical

)

Flip vertically.

        {
            flipVertical_ = _flipVertical;
        }

void omni::mapping::Interface::setScene

(

visual::Scene const *

)

Set the scene this canvas belongs to. Is set automatically when a canvas is added to a session.

void omni::mapping::Interface::setTransform

(

AffineTransform const &

_transform

)

Set new affine transform.

                                                                      {
            transform_ = _transform;
        }

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

virtual

Write mapping to stream.

                                                             {
            _map("transform",transform_)
                ("boundToCanvas",boundToCanvas_)
                ("flipHorizontal",flipHorizontal_)
                ("flipVertical",flipVertical_);
        }

AffineTransform const & omni::mapping::Interface::transform

(

)

const

Return const ref to affine transform.

                                                          {
            return transform_;
        }

AffineTransform & omni::mapping::Interface::transform

(

)

Return ref to affine transform.

                                              {
            return transform_;
        }

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

inlinevirtual

Update mapping visualizer.

Reimplemented from omni::visual::Interface.

{}

QString omni::mapping::Interface::vertexShaderSourceCode ( ) const

privatevirtual

Returns vertex shader source code Is taken from file :/shaders/mapping/common.vert by default)

        {
            return visual::ShaderCompiler::compile(":/shaders/mapping/common.vert");
        }

virtual QWidget* omni::mapping::Interface::widget ( )

pure virtual

Return pointer to parameter widget.

Field Documentation

bool omni::mapping::Interface::boundToCanvas_ = true

private

bool omni::mapping::Interface::flipHorizontal_ = false

private

bool omni::mapping::Interface::flipVertical_ = false

private

visual::Scene const* omni::mapping::Interface::scene_ = nullptr

private

std::unique_ptr<QOpenGLShaderProgram> omni::mapping::Interface::shader_

protected

AffineTransform omni::mapping::Interface::transform_

private

---

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

• include/omni/mapping/Interface.h
• src/lib/mapping/Interface.cpp