omni::Session Class Reference

A session consists of a canvas, a mapping, a list of tunings and one or several inputs. More...

#include <Session.h>

Collaboration diagram for omni::Session:

Public Types
enum	Mode {   Mode::SCREENSETUP, Mode::ARRANGE, Mode::WARP, Mode::BLEND,   Mode::COLORCORRECTION, Mode::EXPORT, Mode::LIVE, Mode::NUM_MODES }
	General mode of the User Interface. More...
typedef omni::visual::Session	visualizer_type

Public Member Functions
	Session ()
	Default constructor. More...
	~Session ()
proj::TuningList &	tunings ()
	Returns reference to projector tunings. More...
proj::TuningList const &	tunings () const
	Returns const reference to projector tunings. More...
Mapping *	setMapping (Id const &_typeId)
	Makes new mapping with given type Id. More...
Mapping *	mapping ()
	Returns pointer to mapping. More...
Mapping const *	mapping () const
	Returns pointer to mapping (const version) More...
InputList &	inputs ()
	Returns reference to list of inputs. More...
InputList const &	inputs () const
	Returns const reference to list of inputs. More...
Canvas *	setCanvas (Id const &_typeId)
	Makes new canvas with given type id and returns pointer if successful. More...
Canvas *	canvas ()
	Return pointer to canvas. More...
Canvas const *	canvas () const
	Return pointer to canvas (const version) More...
ScreenSetup &	screenSetup ()
	Return reference to current screen setup. More...
ScreenSetup const &	screenSetup () const
	Return const reference to current screen setup. More...
Scene &	scene ()
	Return reference to export settings. More...
Scene const &	scene () const
	Return reference to export settings. More...
BlendSettings &	blendSettings ()
	Return reference to blend settings. More...
BlendSettings const &	blendSettings () const
	Return reference to blend settings. More...
ExportSettings &	exportSettings ()
	Return reference to export settings. More...
ExportSettings const &	exportSettings () const
	Return reference to export settings. More...
Mode	mode () const
	Return current mode. More...
void	setMode (Mode)
	Set mode of this session. More...
bool	hasOutput () const
	A session has an output when there is an input, a canvas and a mapping. More...
void	renderToFile (QString const &_filename)
	Export calibration data of session to a file. More...
void	save (QString const &_filename) const
	Save session to file. More...
void	load (QString const &_filename)
	Load session to file. More...
void	fromStream (QDataStream &)
	Deserialize from stream. More...
void	toStream (QDataStream &) const
	Serialize to stream. More...
visualizer_type *	makeVisualizer ()
	Make visualizer if it is not instantiated yet. More...
visualizer_type *	visualizer ()
visualizer_type const *	visualizer () const

Private Attributes
proj::TuningList	tunings_
	List with all projector tunings. More...
std::unique_ptr< Mapping >	mapping_
	Owning pointer for mapping. More...
InputList	inputs_
	List with all inputs (e.g. images, videos etc) More...
std::unique_ptr< Canvas >	canvas_
	Owning pointer for canvas. More...
ScreenSetup	screenSetup_
	Current screen setup. More...
Mode	mode_ = Mode::SCREENSETUP
	Current session mode. More...
visual::Scene	scene_
BlendSettings	blendSettings_
ExportSettings	exportSettings_
std::unique_ptr< visualizer_type >	viz_

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

Detailed Description

A session consists of a canvas, a mapping, a list of tunings and one or several inputs.

Member Typedef Documentation

typedef omni::visual::Session omni::Session::visualizer_type

Member Enumeration Documentation

enum omni::Session::Mode

strong

General mode of the User Interface.

Enumerator
SCREENSETUP
ARRANGE
WARP
BLEND
COLORCORRECTION
EXPORT
LIVE
NUM_MODES

      {
        SCREENSETUP,     // Mode for setup screens
        ARRANGE,         // Mode for setting up projectors and canvas
        WARP,            // Mode for adjusting warp grid
        BLEND,           // Mode for editing the blend mask
        COLORCORRECTION, // Mode for color correction for each projector
        EXPORT,          // Export mode
        LIVE,            // Live mode. Output is locked for faster display
        NUM_MODES
      };

Constructor & Destructor Documentation

omni::Session::Session

(

)

Default constructor.

                   :
    tunings_(*this),
    screenSetup_(this)
  {
    // Register Projector Setups
    {
      using namespace proj;
      SetupFactory::reg<FreeSetup>();
      SetupFactory::reg<PeripheralSetup>();
    }

    // END Register Projector Setups
  }

omni::Session::~Session

(

)

  {
  }

Member Function Documentation

BlendSettings & omni::Session::blendSettings

(

)

Return reference to blend settings.

                                        {
      return blendSettings_;
  }

BlendSettings const & omni::Session::blendSettings

(

)

const

Return reference to blend settings.

                                                    {
      return blendSettings_;
  }

Canvas * omni::Session::canvas

(

)

Return pointer to canvas.

  {
    return canvas_.get();
  }

Canvas const * omni::Session::canvas

(

)

const

Return pointer to canvas (const version)

  {
    return canvas_.get();
  }

ExportSettings & omni::Session::exportSettings

(

)

Return reference to export settings.

                                          {
      return exportSettings_;
  }

ExportSettings const & omni::Session::exportSettings

(

)

const

Return reference to export settings.

                                                      {
      return exportSettings_;
  }

void omni::Session::fromStream

(

QDataStream &

_is

)

Deserialize from stream.

Reset visualizer

                                           {
      /// Reset visualizer
      viz_.reset();

      PropertyMap _map;
      _is >> _map;
      _map.get("tunings",tunings_);
      _map.getPtr("mapping",[&](Id const& _id) {
         return setMapping(_id);
      });
      _map.get("inputs",inputs_);
      _map.getPtr("canvas",[&](Id const& _id) {
          return setCanvas(_id);
      });
      _map.get("mode",mode_);
      _map.get("scene",scene_);
      _map.get("blendSettings",blendSettings_);
      _map.get("exportSettings",exportSettings_);
  }

bool omni::Session::hasOutput

(

)

const

A session has an output when there is an input, a canvas and a mapping.

  {
    return inputs().current() && canvas() && mapping() && (tunings().size() > 0);
  }

InputList & omni::Session::inputs

(

)

Returns reference to list of inputs.

  {
    return inputs_;
  }

InputList const & omni::Session::inputs

(

)

const

Returns const reference to list of inputs.

  {
    return inputs_;
  }

void omni::Session::load

(

QString const &

_filename

)

Load session to file.

  {
    QFile _file(_filename);
    _file.open(QIODevice::ReadOnly);
    QDataStream _stream(&_file);
    _stream >> *this;
  }

Session::visualizer_type * omni::Session::makeVisualizer

(

)

Make visualizer if it is not instantiated yet.

                                                  {
    if (!viz_ && QOpenGLContext::currentContext()) {
      viz_.reset(new visualizer_type(*this));
    }
    return visualizer();
  }

Mapping * omni::Session::mapping

(

)

Returns pointer to mapping.

  {
    return mapping_.get();
  }

Mapping const * omni::Session::mapping

(

)

const

Returns pointer to mapping (const version)

  {
    return mapping_.get();
  }

Session::Mode omni::Session::mode

(

)

const

Return current mode.

  {
    return mode_;
  }

void omni::Session::renderToFile

(

QString const &

_filename

)

Export calibration data of session to a file.

  {
    render::Renderer _renderer(*this);
    _renderer.renderToFile(_filename);
  }

void omni::Session::save

(

QString const &

_filename

)

const

Save session to file.

  {
    QFile _file(_filename);
    _file.open(QIODevice::WriteOnly);
    QDataStream _stream(&_file);
    _stream << *this;
  }

Scene & omni::Session::scene

(

)

Return reference to export settings.

                        {
      return scene_;
  }

Scene const & omni::Session::scene

(

)

const

Return reference to export settings.

                                    {
      return scene_;
  }

ScreenSetup & omni::Session::screenSetup

(

)

Return reference to current screen setup.

  {
    return screenSetup_;
  }

ScreenSetup const & omni::Session::screenSetup

(

)

const

Return const reference to current screen setup.

  {
    return screenSetup_;
  }

Canvas * omni::Session::setCanvas

(

Id const &

_typeId

)

Makes new canvas with given type id and returns pointer if successful.

Attach scene to canvas

  {
    canvas_.reset(canvas::Factory::create(_id));
    /// Attach scene to canvas
    if (canvas_) {
      canvas_->setScene(&scene());
    }
    return canvas();
  }

Mapping * omni::Session::setMapping

(

Id const &

_typeId

)

Makes new mapping with given type Id.

  {
    mapping_.reset(MappingFactory::create(_id));
    if (mapping_) {
      mapping_->setScene(&scene_);
    }
    return mapping();
  }

void omni::Session::setMode

(

Mode

_mode

)

Set mode of this session.

  {
    mode_=_mode;
  }

void omni::Session::toStream

(

QDataStream &

_os

)

const

Serialize to stream.

                                               {
      PropertyMap _map;
      _map("version",OMNIDOME_VERSION_STRING);
      _map("tunings",tunings_)
          ("mapping",mapping_)
          ("inputs",inputs_)
          ("canvas",canvas_)
          ("mode",mode_)
          ("scene",scene_)
          ("blendSettings",blendSettings_)
          ("exportSettings",exportSettings_);
      _os << _map;
  }

proj::TuningList & omni::Session::tunings

(

)

Returns reference to projector tunings.

  {
    return tunings_;
  }

proj::TuningList const & omni::Session::tunings

(

)

const

Returns const reference to projector tunings.

  {
    return tunings_;
  }

Session::visualizer_type * omni::Session::visualizer

(

)

                                              {
    return viz_.get();
  }

Session::visualizer_type const * omni::Session::visualizer

(

)

const

                                                          {
    return viz_.get();
  }

Friends And Related Function Documentation

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

friend

Test for equality. ScreenSetup is ignored.

  {
    return
      OMNI_TEST_MEMBER_EQUAL(tunings_) &&
      OMNI_TEST_PTR_MEMBER_EQUAL(mapping_) &&
      OMNI_TEST_MEMBER_EQUAL(inputs_) &&
      OMNI_TEST_PTR_MEMBER_EQUAL(canvas_) &&
      OMNI_TEST_MEMBER_EQUAL(mode_) &&
      OMNI_TEST_MEMBER_EQUAL(scene_) &&
      OMNI_TEST_MEMBER_EQUAL(blendSettings_) &&
      OMNI_TEST_MEMBER_EQUAL(exportSettings_)
      ;
  }

Field Documentation

BlendSettings omni::Session::blendSettings_

private

std::unique_ptr<Canvas> omni::Session::canvas_

private

Owning pointer for canvas.

ExportSettings omni::Session::exportSettings_

private

InputList omni::Session::inputs_

private

List with all inputs (e.g. images, videos etc)

std::unique_ptr<Mapping> omni::Session::mapping_

private

Owning pointer for mapping.

Mode omni::Session::mode_ = Mode::SCREENSETUP

private

Current session mode.

visual::Scene omni::Session::scene_

private

ScreenSetup omni::Session::screenSetup_

private

Current screen setup.

proj::TuningList omni::Session::tunings_

private

List with all projector tunings.

std::unique_ptr<visualizer_type> omni::Session::viz_

private

---

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

• include/omni/Session.h
• src/lib/Session.cpp