omni::visual::Scene Class Reference

A class that holds settings and elements for session 3d visualization Belongs to a session. More...

#include <Scene.h>

Collaboration diagram for omni::visual::Scene:

Public Types
typedef std::map< QString, std::unique_ptr < CameraInterface > >	camera_map_type

Public Member Functions
	Scene ()
float	size () const
	Scene size (min, max dimensions) More...
void	setSize (float)
	Set scene size. More...
LengthUnit const &	unit () const
	Length unit for scene. More...
void	setUnit (QString const &)
	Set unit from string prefix. More...
void	setUnit (LengthUnit const &)
	Set unit from length unit type. More...
bool	displayInput () const
	Input is shown on canvas. More...
void	setDisplayInput (bool)
	Turn displaying of input on canvas on/off. More...
bool	displayGrid () const
	Display line grid. More...
void	setDisplayGrid (bool)
	Turn displaying of grid on/off. More...
ProjectorSelectionMode	displayProjectors () const
	Display projector frustra (selected projector is always shown) More...
void	setDisplayProjectors (ProjectorSelectionMode)
	Turn displaying of projectors on/off. More...
ProjectorSelectionMode	displayProjectedAreas () const
	Display projected areas. More...
void	setDisplayProjectedAreas (ProjectorSelectionMode)
	Turn displaying of projector areas on/off. More...
EditMode	editMode () const
	Return scene element. More...
void	setEditMode (EditMode)
	Set mode which scene element is to be manipulated. More...
RotateMode	rotateMode () const
void	setRotateMode (RotateMode)
MoveMode	moveMode () const
void	setMoveMode (MoveMode)
float	insideOutside () const
	Inside / outside transparency for 3D canvas view. More...
void	setInsideOutside (float _insideOutside)
float	wireframe () const
	Opacity value for wireframe between 0.0 and 1.0. More...
void	setWireframe (float _wireframe)
void	updateLights ()
	Update light for use in OpenGL. More...
visual::CameraInterface *	camera ()
	Return reference to camera. More...
visual::CameraInterface const *	camera () const
	Return const reference to camera. More...
QString	currentCameraId () const
	Return current camera id. More...
void	setCurrentCameraId (QString const &)
	Set id to current camera. More...
camera_map_type &	cameras ()
camera_map_type const &	cameras () const
void	fromStream (QDataStream &)
	Deserialize from stream. More...
void	toStream (QDataStream &) const
	Serialize to stream. More...
void	drawGrid () const
	Draw grid with given scene size if it is to be displayed. More...
void	updateGrid ()
	Update grid. More...

Private Attributes
float	insideOutside_ = 0.5
float	size_ = 10.0
float	wireframe_ = 0.0
LengthUnit	unit_
bool	displayInput_ = true
bool	displayGrid_ = true
ProjectorSelectionMode	displayProjectors_ = ProjectorSelectionMode::ALL
ProjectorSelectionMode	displayProjectedAreas_ = ProjectorSelectionMode::ALL
EditMode	editMode_ = EditMode::CAMERA
RotateMode	rotateMode_ = RotateMode::YAW
MoveMode	moveMode_ = MoveMode::MOVE_XY
QString	cameraId_
std::vector< visual::Light >	lights_
std::map< QString, std::unique_ptr < visual::CameraInterface > >	cameras_
std::unique_ptr< visual::Grid >	grid_

Friends
bool	operator== (Scene const &, Scene const &)
	Test for equality. ScreenSetup is ignored. More...

Detailed Description

A class that holds settings and elements for session 3d visualization Belongs to a session.

Member Typedef Documentation

typedef std::map<QString,std::unique_ptr<CameraInterface> > omni::visual::Scene::camera_map_type

Constructor & Destructor Documentation

omni::visual::Scene::Scene

(

)

                 {
      setSize(size_);
      float _radius = size_;
      std::unique_ptr<CameraInterface> _cam(new PerspectiveCamera(
                                              Tracker(QVector3D(0,
                                                                0,
                                                                0), PolarVec(
                                                        -45.0,
                                                        45.0,
                                                        _radius * 5.0))));
      cameras_["camera"] = std::move(_cam);
      setCurrentCameraId("camera");

      lights_.emplace_back(Tracker(QVector3D(0.0, 0.0, 0.0),
                                   PolarVec(-45.0, 45.0, _radius * 10.0)), 0.5);
      lights_.emplace_back(Tracker(QVector3D(0.0, 0.0, 0.0),
                                   PolarVec(45.0, 45.0, _radius * 10.0)), 0.3);
      lights_.emplace_back(Tracker(QVector3D(0.0, 0.0, 0.0),
                                   PolarVec(45.0, -45.0, _radius * 10.0)), 0.3);
    }

Member Function Documentation

visual::CameraInterface * omni::visual::Scene::camera

(

)

Return reference to camera.

                                          {
      if (cameras_.count(cameraId_) == 0) return nullptr;

      return cameras_.at(cameraId_).get();
    }

visual::CameraInterface const * omni::visual::Scene::camera

(

)

const

Return const reference to camera.

                                                      {
      if (cameras_.count(cameraId_) == 0) return nullptr;

      return cameras_.at(cameraId_).get();
    }

Scene::camera_map_type & omni::visual::Scene::cameras

(

)

                                         {
      return cameras_;
    }

Scene::camera_map_type const & omni::visual::Scene::cameras

(

)

const

                                                     {
      return cameras_;
    }

QString omni::visual::Scene::currentCameraId

(

)

const

Return current camera id.

                                         {
      return cameraId_;
    }

bool omni::visual::Scene::displayGrid

(

)

const

Display line grid.

                                  {
      return displayGrid_;
    }

bool omni::visual::Scene::displayInput

(

)

const

Input is shown on canvas.

                                   {
      return displayInput_;
    }

ProjectorSelectionMode omni::visual::Scene::displayProjectedAreas

(

)

const

Display projected areas.

                                                              {
      return displayProjectedAreas_;
    }

ProjectorSelectionMode omni::visual::Scene::displayProjectors

(

)

const

Display projector frustra (selected projector is always shown)

                                                          {
      return displayProjectors_;
    }

void omni::visual::Scene::drawGrid

(

)

const

Draw grid with given scene size if it is to be displayed.

                               {
      if (!grid_ || !displayGrid()) return;

      grid_->draw(insideOutside());
      glDisable(GL_DEPTH_TEST);
      grid_->draw(1.0 - insideOutside());
      glEnable(GL_DEPTH_TEST);
    }

EditMode omni::visual::Scene::editMode

(

)

const

Return scene element.

Set mode whether to manip.

                                   {
      return editMode_;
    }

void omni::visual::Scene::fromStream

(

QDataStream &

_is

)

Deserialize from stream.

                                           {
      PropertyMap _map;

      _is >> _map;
      _map.get("size",                 size_);
      _map.get("displayInput",          displayInput_);
      _map.get("displayGrid",           displayGrid_);
      _map.get("displayProjectors",     displayProjectors_);
      _map.get("displayProjectedAreas", displayProjectedAreas_);
      _map.get("editMode",              editMode_);
      _map.get("rotateMode",            rotateMode_);
      _map.get("moveMode",              moveMode_);
      _map.get("insideOutside",     insideOutside_);
      _map.get("lights", lights_);

      // _map.get("cameras", cameras_);
    }

float omni::visual::Scene::insideOutside

(

)

const

Inside / outside transparency for 3D canvas view.

                                     {
      return insideOutside_;
    }

MoveMode omni::visual::Scene::moveMode

(

)

const

                                   {
      return moveMode_;
    }

RotateMode omni::visual::Scene::rotateMode

(

)

const

                                       {
      return rotateMode_;
    }

void omni::visual::Scene::setCurrentCameraId

(

QString const &

_cameraId

)

Set id to current camera.

                                                           {
      cameraId_ = _cameraId;

      updateGrid();
    }

void omni::visual::Scene::setDisplayGrid

(

bool

_displayGrid

)

Turn displaying of grid on/off.

                                                {
      displayGrid_ = _displayGrid;
    }

void omni::visual::Scene::setDisplayInput

(

bool

_displayInput

)

Turn displaying of input on canvas on/off.

                                                  {
      displayInput_ = _displayInput;
    }

void omni::visual::Scene::setDisplayProjectedAreas

(

ProjectorSelectionMode

_displayProjectedAreas

)

Turn displaying of projector areas on/off.

                                                                                      {
      displayProjectedAreas_ = _displayProjectedAreas;
    }

void omni::visual::Scene::setDisplayProjectors

(

ProjectorSelectionMode

_displayProjectors

)

Turn displaying of projectors on/off.

                                                                              {
      displayProjectors_ = _displayProjectors;
    }

void omni::visual::Scene::setEditMode

(

EditMode

_editMode

)

Set mode which scene element is to be manipulated.

                                              {
      editMode_ = _editMode;
    }

void omni::visual::Scene::setInsideOutside

(

float

_insideOutside

)

                                                     {
      insideOutside_ = qBound(0.0f,_insideOutside,1.0f);
    }

void omni::visual::Scene::setMoveMode

(

MoveMode

_moveMode

)

                                              {
      moveMode_ = _moveMode;
    }

void omni::visual::Scene::setRotateMode

(

RotateMode

_rotateMode

)

                                                    {
      rotateMode_ = _rotateMode;
    }

void omni::visual::Scene::setSize

(

float

_size

)

Set scene size.

                                   {
      size_ = _size;
      updateGrid();
    }

void omni::visual::Scene::setUnit

(

QString const &

_unit

)

Set unit from string prefix.

                                            {
      unit_ = LengthUnit(_unit);
    }

void omni::visual::Scene::setUnit

(

LengthUnit const &

_unit

)

Set unit from length unit type.

                                               {
      unit_ = _unit;
    }

void omni::visual::Scene::setWireframe

(

float

_wireframe

)

                                             {
      wireframe_ = qBound(0.0f,_wireframe,1.0f);
    }

float omni::visual::Scene::size

(

)

const

Scene size (min, max dimensions)

                            {
      return size_;
    }

void omni::visual::Scene::toStream

(

QDataStream &

_os

)

const

Serialize to stream.

                                               {
      PropertyMap _map;

      _map("size", size_)
        ("displayInput", displayInput_)
        ("displayGrid", displayGrid_)
        ("displayProjectors", displayProjectors_)
        ("displayProjectedAreas", displayProjectedAreas_)
        ("editMode", editMode_)
        ("rotateMode", rotateMode_)
        ("moveMode", moveMode_)
        ("insideOutside", insideOutside_)
        ("lights", lights_);

      //      ("cameras", cameras_);
      _os << _map;
    }

LengthUnit const & omni::visual::Scene::unit

(

)

const

Length unit for scene.

                                        {
      return unit_;
    }

void omni::visual::Scene::updateGrid

(

)

Update grid.

                           {
      if (!grid_) {
        grid_.reset(new visual::Grid(camera()));
      }
      grid_->setSize(QVector2D(size_, size_));
      grid_->update();
      grid_->setCamera(camera());
    }

void omni::visual::Scene::updateLights

(

)

Update light for use in OpenGL.

Setup light for use in OpenGL.

                             {
      GLuint _index = GL_LIGHT0;

      for (auto& _light : lights_) _light.setup(++_index);
    }

float omni::visual::Scene::wireframe

(

)

const

Opacity value for wireframe between 0.0 and 1.0.

                                 {
      return wireframe_;
    }

Friends And Related Function Documentation

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

friend

Test for equality. ScreenSetup is ignored.

                                                          {
      return
        OMNI_TEST_MEMBER_EQUAL(size_) &&
        OMNI_TEST_MEMBER_EQUAL(displayInput_) &&
        OMNI_TEST_MEMBER_EQUAL(displayGrid_) &&
        OMNI_TEST_MEMBER_EQUAL(displayProjectors_) &&
        OMNI_TEST_MEMBER_EQUAL(displayProjectedAreas_) &&
        OMNI_TEST_MEMBER_EQUAL(editMode_) &&
        OMNI_TEST_MEMBER_EQUAL(rotateMode_) &&
        OMNI_TEST_MEMBER_EQUAL(moveMode_) &&
        OMNI_TEST_MEMBER_EQUAL(lights_) &&
        OMNI_TEST_MEMBER_EQUAL(cameras_);
    }

Field Documentation

QString omni::visual::Scene::cameraId_

private

std::map<QString,std::unique_ptr<visual::CameraInterface> > omni::visual::Scene::cameras_

private

bool omni::visual::Scene::displayGrid_ = true

private

bool omni::visual::Scene::displayInput_ = true

private

ProjectorSelectionMode omni::visual::Scene::displayProjectedAreas_ = ProjectorSelectionMode::ALL

private

ProjectorSelectionMode omni::visual::Scene::displayProjectors_ = ProjectorSelectionMode::ALL

private

EditMode omni::visual::Scene::editMode_ = EditMode::CAMERA

private

std::unique_ptr<visual::Grid> omni::visual::Scene::grid_

private

float omni::visual::Scene::insideOutside_ = 0.5

private

std::vector<visual::Light> omni::visual::Scene::lights_

private

MoveMode omni::visual::Scene::moveMode_ = MoveMode::MOVE_XY

private

RotateMode omni::visual::Scene::rotateMode_ = RotateMode::YAW

private

float omni::visual::Scene::size_ = 10.0

private

LengthUnit omni::visual::Scene::unit_

private

float omni::visual::Scene::wireframe_ = 0.0

private

---

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

• include/omni/visual/Scene.h
• src/lib/visual/Scene.cpp