omni::canvas::Interface Class Reference

Abstract interface for a canvas A canvas represents the surface on which the projection is performed. It might be a dome or a planar surface. More...

#include <Interface.h>

Inheritance diagram for omni::canvas::Interface:

Collaboration diagram for omni::canvas::Interface:

Public Types
enum	ViewMode { ViewMode::INSIDE, ViewMode::OUTSIDE, ViewMode::BOTH }

Public Member Functions
	Interface ()
virtual	~Interface ()
	Virtual destructor. More...
ViewMode	viewMode () const
	Return current view mode. More...
void	setViewMode (ViewMode _viewMode)
	Set view mode. More...
void	drawWithViewMode () const
	Draws with culled front or back faces, depending on view mode. More...
virtual void	drawAux () const
	Draws auxiliary elements which are not used for mapping (e.g. More...
virtual Box	bounds () const =0
	Abstract method for returning bounding box of canvas. More...
virtual QVector3D	center () const
	Spectator's center of canvas (center of bounding box by default) More...
virtual qreal	radius () const
	Canvas radius (is half of size by default) 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...
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...
virtual QMatrix4x4	matrix () const
	Transformation matrix for canvas. More...
virtual ui::CanvasParameters *	widget ()=0
	Returns pointer to new parameter widget. More...
virtual void	toPropertyMap (PropertyMap &) const
	Write mapping to stream. More...
virtual void	fromPropertyMap (PropertyMap const &)
	Read mapping from stream. 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...
Public Member Functions inherited from omni::visual::Interface
virtual void	draw () const =0
	Abstract method for visualing. More...
virtual void	update ()
	Update geometry. More...

Protected Attributes
bool	needsUpdate_ = true

Private Attributes
AffineTransform	transform_
ViewMode	viewMode_ = ViewMode::BOTH
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

Abstract interface for a canvas A canvas represents the surface on which the projection is performed. It might be a dome or a planar surface.

Member Enumeration Documentation

enum omni::canvas::Interface::ViewMode

strong

Enumerator
INSIDE
OUTSIDE
BOTH

                            {
            INSIDE,
            OUTSIDE,
            BOTH
        };

Constructor & Destructor Documentation

omni::canvas::Interface::Interface

(

)

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

omni::canvas::Interface::~Interface ( )

virtual

Virtual destructor.

Reimplemented from omni::visual::Interface.

{}

Member Function Documentation

virtual Box omni::canvas::Interface::bounds ( ) const

pure virtual

Abstract method for returning bounding box of canvas.

Implemented in omni::canvas::Dome, and omni::canvas::Envelope.

QVector3D omni::canvas::Interface::center ( ) const

virtual

Spectator's center of canvas (center of bounding box by default)

        {
            return (bounds().max() + bounds().min()) * 0.5;
        }

virtual void omni::canvas::Interface::drawAux ( ) const

inlinevirtual

Draws auxiliary elements which are not used for mapping (e.g.

Reimplemented in omni::canvas::Dome.

        {}

void omni::canvas::Interface::drawWithViewMode

(

)

const

Draws with culled front or back faces, depending on view mode.

                                               {
          withCurrentContext([&](QOpenGLFunctions& _) {
            switch (viewMode_) {
              case ViewMode::INSIDE:
              _.glEnable(GL_CULL_FACE);
              _.glCullFace(GL_FRONT);
              break;
              case ViewMode::OUTSIDE:
              _.glEnable(GL_CULL_FACE);
              _.glCullFace(GL_BACK);
              break;
              case ViewMode::BOTH:
              _.glDisable(GL_CULL_FACE);
              break;
            }
            this->draw();
            _.glDisable(GL_CULL_FACE);
          });
        }

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

virtual

Read mapping from stream.

Reimplemented in omni::canvas::Dome.

                                                               {
            _map.get("transform",transform_);
        }

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

virtual

Transformation matrix for canvas.

        {
            return transform_.matrix();
        }

qreal omni::canvas::Interface::radius ( ) const

virtual

Canvas radius (is half of size by default)

Reimplemented in omni::canvas::Dome.

        {
            return bounds().size().length() * 0.5;
        }

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

(

)

const

The scene this canvas belongs to.

                                                  {
          return scene_;
        }

void omni::canvas::Interface::setScene

(

visual::Scene const *

_scene

)

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

                                                          {
          scene_=_scene;
        }

void omni::canvas::Interface::setTransform

(

AffineTransform const &

_transform

)

Set new affine transform.

                                                                      {
            transform_ = _transform;
        }

void omni::canvas::Interface::setViewMode

(

ViewMode

_viewMode

)

Set view mode.

                                                      {
          needsUpdate_ = viewMode_ != _viewMode;
          viewMode_ = _viewMode;
        }

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

virtual

Write mapping to stream.

Reimplemented in omni::canvas::Dome.

                                                             {
            _map("transform",transform_);
        }

AffineTransform const & omni::canvas::Interface::transform

(

)

const

Return const ref to affine transform.

                                                          {
            return transform_;
        }

AffineTransform & omni::canvas::Interface::transform

(

)

Return ref to affine transform.

                                              {
            return transform_;
        }

Interface::ViewMode omni::canvas::Interface::viewMode

(

)

const

Return current view mode.

                                                    {
          return viewMode_;
        }

virtual ui::CanvasParameters* omni::canvas::Interface::widget ( )

pure virtual

Returns pointer to new parameter widget.

Field Documentation

bool omni::canvas::Interface::needsUpdate_ = true

protected

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

private

AffineTransform omni::canvas::Interface::transform_

private

ViewMode omni::canvas::Interface::viewMode_ = ViewMode::BOTH

private

---

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

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