omni::proj::Projector Class Reference

A projector with a transformation matrix and setup. More...

#include <Projector.h>

Collaboration diagram for omni::proj::Projector:

Public Member Functions
	Projector ()
	Projector (qreal _aspectRatio, Angle _fov=45.0)
Setup *	setup (Id const &_setupId, float _sceneScale=1.0)
	Make a new projector setup with a certain id and delete old one. More...
Setup *	setup ()
	Update projector matrix by current setup and return setup. More...
Setup const *	setup () const
	Returns projector setup (const version) More...
qreal	aspectRatio () const
	Aspect ratio of screen. More...
void	setAspectRatio (qreal)
	Set aspect ratio of screen. More...
qreal	throwRatio () const
	Return throw ratio of projector ( = 1/2 * tan(fov / 2)) More...
void	setThrowRatio (qreal)
	Set new throw ratio. More...
Angle	fov () const
	Return field of view. More...
void	setFov (Angle _fov)
	Set new field of view. More...
qreal	keystone () const
	Return keystone correction value for projector. More...
void	setKeystone (qreal)
	Set new keystone correction value (0.0 = default) More...
QMatrix4x4 const &	matrix () const
	Return transformation matrix. More...
void	setMatrix (QMatrix4x4 const &)
	Set transformation matrix. More...
QMatrix4x4	projectionMatrix () const
	Return projector matrix. More...
QVector3D	pos () const
	Return projector position (3rd column of projector matrix) More...
void	toStream (QDataStream &) const
	Write projector to stream. More...
void	fromStream (QDataStream &)
	Read projector from stream. More...

Private Attributes
QMatrix4x4	matrix_
qreal	aspectRatio_ = 0.75
Angle	fov_
qreal	keystone_ = 0.0
std::unique_ptr< Setup >	setup_

Friends
bool	operator== (Projector const &, Projector const &)
	Test for equality. More...

Detailed Description

A projector with a transformation matrix and setup.

Constructor & Destructor Documentation

omni::proj::Projector::Projector

(

)

                         :
      fov_(45.0)
    {}

omni::proj::Projector::Projector	(	qreal	_aspectRatio,
		Angle	_fov = 45.0
	)

                                     :
      aspectRatio_(_aspectRatio),
      fov_(_fov)
    {}

Member Function Documentation

qreal omni::proj::Projector::aspectRatio

(

)

const

Aspect ratio of screen.

    {
      return aspectRatio_;
    }

Angle omni::proj::Projector::fov

(

)

const

Return field of view.

    {
      return fov_;
    }

void omni::proj::Projector::fromStream

(

QDataStream &

_is

)

Read projector from stream.

                                               {
      PropertyMap _map;
      _is >> _map;
      _map.get("fov", fov_);
      _map.get("keystone", keystone_);
      _map.get("aspectRatio",aspectRatio_);
      _map.getPtr("setup", [this](const Id& _id) -> Setup * {
        return this->setup(_id);
      });
    }

qreal omni::proj::Projector::keystone

(

)

const

Return keystone correction value for projector.

                                    {
      return keystone_;
    }

QMatrix4x4 const & omni::proj::Projector::matrix

(

)

const

Return transformation matrix.

    {
      return matrix_;
    }

QVector3D omni::proj::Projector::pos

(

)

const

Return projector position (3rd column of projector matrix)

    {
      return matrix().column(3).toVector3D();
    }

QMatrix4x4 omni::proj::Projector::projectionMatrix

(

)

const

Return projector matrix.

    {
      QMatrix4x4 _m;

      Frustum _frustum(*this);
      float   _near = 0.01;
      QRectF  _rect = _frustum.rect(_near, 1000.0);

      _m.frustum(_rect.left(), _rect.right(), _rect.bottom(),
                 _rect.top(), _near, 1000.0);
      _m.lookAt(pos(), pos() + matrix().column(0).toVector3D(), matrix().column(
                  2).toVector3D());
      return _m;
    }

void omni::proj::Projector::setAspectRatio

(

qreal

_aspectRatio

)

Set aspect ratio of screen.

                                                     {
      aspectRatio_ = _aspectRatio;
    }

void omni::proj::Projector::setFov

(

Angle

_fov

)

Set new field of view.

    {
      fov_ = _fov;

      if (fov_.degrees() < 1.0) fov_ = 1.0;

      if (fov_.degrees() >= 180.0) fov_ = 180.0;
    }

void omni::proj::Projector::setKeystone

(

qreal

_keystone

)

Set new keystone correction value (0.0 = default)

                                               {
      keystone_ = _keystone;
    }

void omni::proj::Projector::setMatrix

(

QMatrix4x4 const &

_matrix

)

Set transformation matrix.

    {
      matrix_ = _matrix;
    }

void omni::proj::Projector::setThrowRatio

(

qreal

_throwRatio

)

Set new throw ratio.

    {
      fov_ = Angle::fromRad(2.0 * atan(1.0 / (_throwRatio * 2.0)));
    }

Setup * omni::proj::Projector::setup	(	Id const &	_setupId,
		float	_sceneScale = 1.0
	)

Make a new projector setup with a certain id and delete old one.

Parameters

Id	_setupId Id of setup class
float	_sceneSize Scale factor of setup positioning

Returns

Pointer to new projector setup

    {
      setup_.reset(SetupFactory::create(_setupId));
      setup()->scale(_scale);
      return setup();
    }

Setup * omni::proj::Projector::setup

(

)

Update projector matrix by current setup and return setup.

    {
      if (!setup_) return nullptr;

      setup_->setup(*this);
      return setup_.get();
    }

Setup const * omni::proj::Projector::setup

(

)

const

Returns projector setup (const version)

    {
      return setup_.get();
    }

qreal omni::proj::Projector::throwRatio

(

)

const

Return throw ratio of projector ( = 1/2 * tan(fov / 2))

    {
      return 0.5 / tan(fov_.radians() / 2.0);
    }

void omni::proj::Projector::toStream

(

QDataStream &

_os

)

const

Write projector to stream.

                                                   {
      PropertyMap _map;

      _map("fov", fov_);
      _map("keystone", keystone_);
      _map("aspectRatio", aspectRatio_);
      _map("setup", setup_);
      _os << _map;
    }

Friends And Related Function Documentation

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

friend

Test for equality.

    {
      return
        OMNI_TEST_MEMBER_EQUAL(matrix_) &&
        OMNI_TEST_MEMBER_EQUAL(fov_) &&
        OMNI_TEST_MEMBER_EQUAL(keystone_) &&
        OMNI_TEST_MEMBER_EQUAL(aspectRatio_) &&
        OMNI_TEST_PTR_MEMBER_EQUAL(setup_);
    }

Field Documentation

qreal omni::proj::Projector::aspectRatio_ = 0.75

private

Angle omni::proj::Projector::fov_

private

qreal omni::proj::Projector::keystone_ = 0.0

private

QMatrix4x4 omni::proj::Projector::matrix_

private

std::unique_ptr<Setup> omni::proj::Projector::setup_

private

---

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

• include/omni/proj/Projector.h
• src/lib/proj/Projector.cpp