omni::proj::TuningList Class Reference

Tuning List contains a list of tunings Tuning List is serializable via QDataStream. More...

#include <TuningList.h>

Inheritance diagram for omni::proj::TuningList:

Collaboration diagram for omni::proj::TuningList:

Public Types
typedef std::vector < std::unique_ptr< Tuning > >	container_type

Public Member Functions
	TuningList (Session const &)
Tuning *	add (bool _makeCurrent=true)
	Add tuning to list Returns pointer new tuning. More...
void	remove ()
	Remove tuning with current index. More...
void	remove (int)
	Remove tuning with custom index. More...
Tuning *	current ()
	Returns pointer to current tuning Returns nullptr if currentIdx_ == -1 or tuning list is empty. More...
Tuning const *	current () const
	Returns pointer to current tuning (const version) Returns nullptr if currentIdx_ == -1 or tuning list is empty. More...
void	setCurrentIndex (int)
	Set new current index, must be between 0 and size()-1. More...
int	currentIndex () const
	Return current index. More...
void	clear ()
	Deletes all tunings. More...
Tuning *	operator[] (int)
	Returns tuning at a specific index. More...
Tuning const *	operator[] (int) const
	Returns tuning at a specific index (const version) More...
void	fromStream (QDataStream &)
	Deserialize list from stream. More...
void	toStream (QDataStream &) const
	Serialize list to stream. More...

Private Member Functions
bool	validIndex (int) const
	Test of index is between 0 and size()-1. More...

Private Attributes
int	currentIdx_ = -1
Session const &	session_

Friends
bool	operator== (TuningList const &, TuningList const &)
	Test both lists for equality. More...

Detailed Description

Tuning List contains a list of tunings Tuning List is serializable via QDataStream.

Member Typedef Documentation

typedef std::vector<std::unique_ptr<Tuning> > omni::proj::TuningList::container_type

Constructor & Destructor Documentation

omni::proj::TuningList::TuningList

(

Session const &

_session

)

                                                  :
      session_(_session) {

    }

Member Function Documentation

Tuning * omni::proj::TuningList::add

(

bool

_makeCurrent = true

)

Add tuning to list Returns pointer new tuning.

Parameters

_makeCurrent

Flag whether to set current index when added successfully

    {
      container_type::emplace_back(new Tuning(session_));
      auto* _tuning = container_type::back().get();
      if (_makeCurrent)
        setCurrentIndex(container_type::size()-1);

      // Assign virtual screen initially, this also sets up projector aspectRatio correctly
      _tuning->assignVirtualScreen();
      _tuning->projector().setup("PeripheralSetup",session_.scene().size());

      return _tuning;
    }

void omni::proj::TuningList::clear

(

)

Deletes all tunings.

    {
      container_type::clear();
      currentIdx_ = -1;
    }

Tuning * omni::proj::TuningList::current

(

)

Returns pointer to current tuning Returns nullptr if currentIdx_ == -1 or tuning list is empty.

    {
      return validIndex(currentIdx_) ? container_type::at(currentIdx_).get() : nullptr;
    }

Tuning const * omni::proj::TuningList::current

(

)

const

Returns pointer to current tuning (const version) Returns nullptr if currentIdx_ == -1 or tuning list is empty.

    {
      return validIndex(currentIdx_) ? container_type::at(currentIdx_).get() : nullptr;
    }

int omni::proj::TuningList::currentIndex

(

)

const

Return current index.

    {
      return currentIdx_;
    }

void omni::proj::TuningList::fromStream

(

QDataStream &

_stream

)

Deserialize list from stream.

    {
      clear();
      PropertyMap _map;
      _stream >> _map;
      uint32_t _size = _map.getValue<uint32_t>("size",0);
      int _currentIdx = _map.getValue<int>("currentIndex",-1);

      for (int i = 0; i < _size; ++i)
      {
        auto* _tuning = add(false /* Dont modify current tuning index */);
        if (!_tuning) continue;
        _stream >> *_tuning;
      }
      setCurrentIndex(_currentIdx);
    }

Tuning * omni::proj::TuningList::operator[]

(

int

_index

)

Returns tuning at a specific index.

    {
      return validIndex(_index) ?
        container_type::at(_index).get() : nullptr;
    }

Tuning const * omni::proj::TuningList::operator[]

(

int

_index

)

const

Returns tuning at a specific index (const version)

    {
      return validIndex(_index) ?
        container_type::at(_index).get() : nullptr;
    }

void omni::proj::TuningList::remove

(

)

Remove tuning with current index.

    {
      remove(currentIdx_);
    }

void omni::proj::TuningList::remove

(

int

_idx

)

Remove tuning with custom index.

    {
      if (!validIndex(_idx)) return;
      container_type::erase(container_type::begin() + _idx);
    }

void omni::proj::TuningList::setCurrentIndex

(

int

_currentIdx

)

Set new current index, must be between 0 and size()-1.

    {
      if (_currentIdx < 0)
      {
        currentIdx_ = 0;
        return;
      }
      if (_currentIdx >= size())
      {
        currentIdx_ = size() - 1;
        return;
      }
      currentIdx_ = _currentIdx;
    }

void omni::proj::TuningList::toStream

(

QDataStream &

_stream

)

const

Serialize list to stream.

    {
      PropertyMap _map;
      _map("size",uint32_t(container_type::size()));
      _map("currentIndex",currentIdx_);
      _stream << _map;

      for (auto& _tuning : *this)
        _stream << *_tuning;
    }

bool omni::proj::TuningList::validIndex ( int  _idx ) const

private

Test of index is between 0 and size()-1.

    {
      return (_idx >= 0) && (_idx < container_type::size());
    }

Friends And Related Function Documentation

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

friend

Test both lists for equality.

    {
      // Lambda for testing if pointers of two tunings are equal
      auto _tuningsEqual = [](Tuning const* _a, Tuning const* _b) -> bool
      {
        return _a && _b // Test if pointer have same address
          ?
          // Derefence pointers and use equality operator to test equality
          ((*_a) == (*_b))
          :
          // Compare pointers and if test of pointer are not nullptrs
          (_a == _b);
      };

      return
        OMNI_TEST_MEMBER_EQUAL(currentIdx_) &&
        util::testPtrVectorEqual(_lhs,_rhs,_tuningsEqual);
    }

Field Documentation

int omni::proj::TuningList::currentIdx_ = -1

private

Session const& omni::proj::TuningList::session_

private

---

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

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