AbstractMVREngine.H

Go to the documentation of this file.

//========================================================================
// MinVR
// Platform:    Any
// API version: 1.0
//------------------------------------------------------------------------
// The MIT License (MIT)
//
// Copyright (c) 2013 Regents of the University of Minnesota
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//========================================================================

#ifndef ABSTRACTMVRENGINE_H
#define ABSTRACTMVRENGINE_H

#include "MVRCore/AbstractMVRApp.H"
#include "MVRCore/AbstractWindow.H"
#include "MVRCore/ConfigMap.H"
#include "MVRCore/ConfigVal.H"
#include "MVRCore/WindowSettings.H"
#include "MVRCore/AbstractCamera.H"
#include "MVRCore/CameraOffAxis.H"
#include "MVRCore/AbstractInputDevice.H"
#include "MVRCore/InputDeviceTUIOClient.H"
#include "MVRCore/InputDeviceSpaceNav.H"
#include "MVRCore/InputDeviceVRPNAnalog.H"
#include "MVRCore/InputDeviceVRPNButton.H"
#include "MVRCore/InputDeviceVRPNTracker.H"
#include "MVRCore/RenderThread.H"
#include "MVRCore/DataFileUtils.H"
#include "MVRCore/Event.H"
#include <glm/glm.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition_variable.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/make_shared.hpp>
#include <boost/log/core.hpp>
#include <boost/log/trivial.hpp>
#include <boost/log/sinks/sync_frontend.hpp>
#include <boost/log/sinks/text_ostream_backend.hpp>
#include <boost/log/utility/setup/common_attributes.hpp>
#include <boost/log/sources/logger.hpp>
#include <boost/log/sources/record_ostream.hpp>
#include <boost/log/utility/empty_deleter.hpp>
#include <boost/log/sources/severity_logger.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/utility/setup/file.hpp>
#include <vector>
#include <fstream>
#include <iostream>
#include <algorithm>

#define BOOST_ASSERT_MSG_OSTREAM std::cout
#include <boost/assert.hpp>

namespace MinVR {

class AbstractMVREngine {
public:

        AbstractMVREngine();
        virtual ~AbstractMVREngine();

        virtual void init(int argc, char **argv);

        virtual void init(ConfigMapRef configMap);

        virtual void runApp(AbstractMVRAppRef app);

        virtual void runOneFrameOfApp(AbstractMVRAppRef app);

        virtual void initializeContextSpecificVars(int threadId, WindowRef window);

        virtual void initializeLogging();

protected:

        virtual void setupWindowsAndViewports();

        virtual WindowRef createWindow(WindowSettingsRef settings, std::vector<AbstractCameraRef> cameras) = 0;

        virtual void setupInputDevices();

        virtual void setupRenderThreads();

        virtual void pollUserInput();

        virtual void updateProjectionForHeadTracking();

        AbstractMVRAppRef         _app;
        ConfigMapRef      _configMap;
        std::vector<EventRef> _events;
        std::vector<WindowRef>  _windows;
        std::vector<AbstractInputDeviceRef> _inputDevices;
        std::vector<RenderThreadRef> _renderThreads;
        boost::mutex _threadsInitializedMutex;
        boost::condition_variable _threadsInitializedCond;
        boost::mutex _startRenderingMutex;
        boost::condition_variable _startRenderingCond;
        boost::mutex _renderingCompleteMutex;
        boost::condition_variable _renderingCompleteCond;
        boost::shared_ptr<boost::barrier> _swapBarrier;
        boost::posix_time::ptime _syncTimeStart;
        unsigned long _frameCount;
};

} // end namespace

#endif