omni::canvas::Envelope Class Reference

An enveloped canvas can enclose the viewer and can be projected from. More...

#include <Envelope.h>

Inheritance diagram for omni::canvas::Envelope:

Collaboration diagram for omni::canvas::Envelope:

Public Member Functions
	Envelope ()
	~Envelope ()
Box	bounds () const
	Returns copy of cached bounding box. More...
virtual void	draw () const
	Draw envelope. More...
Public Member Functions inherited from omni::canvas::Interface
	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 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	update ()
	Update geometry. More...

Protected Attributes
omni::Box	bounds_
	Protected bounding box member. More...
Protected Attributes inherited from omni::canvas::Interface
bool	needsUpdate_ = true

Additional Inherited Members
Public Types inherited from omni::canvas::Interface
enum	ViewMode { ViewMode::INSIDE, ViewMode::OUTSIDE, ViewMode::BOTH }
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

An enveloped canvas can enclose the viewer and can be projected from.

Constructor & Destructor Documentation

omni::canvas::Envelope::Envelope

(

)

    {
    }

omni::canvas::Envelope::~Envelope

(

)

    {
    }

Member Function Documentation

Box omni::canvas::Envelope::bounds ( ) const

virtual

Returns copy of cached bounding box.

Implements omni::canvas::Interface.

    {
      return bounds_;
    }

void omni::canvas::Envelope::draw ( ) const

virtual

Draw envelope.

Implements omni::visual::Interface.

Reimplemented in omni::canvas::Dome.

    {
    }

Field Documentation

omni::Box omni::canvas::Envelope::bounds_

protected

Protected bounding box member.

---

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

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