VRUtils.hpp

Go to the documentation of this file.

/***********************************
 Copyright 2018 Ravishankar Mathur
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
 http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 ***********************************/

#ifndef _OF_VRUTILS_
#define _OF_VRUTILS_

#include <OpenFrames/Export.h>
#include <OpenFrames/DepthPartitioner.hpp>

#include <osg/ref_ptr>
#include <osg/Referenced>
#include <osg/Camera>
#include <osg/Texture2D>

namespace OpenFrames
{
  class OpenVRDevice; // Used by VRCameraManager below

  struct OF_EXPORT VRTextureBuffer : public osg::Referenced
  {
  public:
    VRTextureBuffer(int width = 1080, int height = 1200);
    virtual ~VRTextureBuffer();
    
    // Textures for each eye's image
    osg::ref_ptr<osg::Texture2D> _rightColorTex, _rightDepthTex;
    osg::ref_ptr<osg::Texture2D> _leftColorTex, _leftDepthTex;
    
    // Cameras that allow color textures to be chained between VRCameras
    // in case MSAA is being used
    osg::ref_ptr<osg::Camera> _rightTexCamera, _leftTexCamera;
  };

  class OF_EXPORT VRCamera : public osg::Referenced
  {
  public:
    enum StereoMode
    {
      STEREO = 0, // Always stereo
      MONO = 1,   // Always mono
      AUTO = 2    // Auto-switch between Stereo/Mono based on distance
    };
    
    VRCamera(VRTextureBuffer *texBuffer, OpenVRDevice *ovrDevice, int camNum, StereoMode mode, bool useMSAA = false);
    
    // Get whether MSAA is being used
    bool getUseMSAA() { return _useMSAA; }
    
    void setClearMask(GLbitfield mask);
    GLbitfield getClearMask() { return _rightCamera->getClearMask(); }
    
    unsigned int getNumCameras();
    
    osg::Camera* getCamera(unsigned int pos);
    
    void disableCameras();
    
    void updateCameras(osg::Matrixd& rightProj,
      osg::Matrixd& leftProj, osg::Matrixd& centerProj, const double &zNear);
    
    void addSlaveCamerasToView(osg::View *view, bool useMastersSceneData);

  protected:
    virtual ~VRCamera();
    
    osg::ref_ptr<osg::Camera> _rightCamera, _leftCamera;
    
    osg::ref_ptr<osg::Camera> _monoCamera;
    
    osg::observer_ptr<VRTextureBuffer> _texBuffer;
    
    osg::observer_ptr<OpenVRDevice> _ovrDevice; // OpenVR interface
    
    StereoMode _mode; // Stereo rendering mode
    
    bool _useMSAA;
  };

  struct OF_EXPORT VRCameraManager : public DepthPartitionCallback::CameraManager
  {
    VRCameraManager(VRTextureBuffer *texBuffer, OpenVRDevice *ovrDevice);
    virtual ~VRCameraManager();

    virtual std::string getCameraName(unsigned int camNum);

    virtual void enableCamera(unsigned int camNum,
                              osg::Camera* mainCam,
                              const double &zNear, const double &zFar);
    virtual void disableCameras(unsigned int start);
    virtual void reset();
    virtual double getMinZNear();

    typedef std::vector< osg::ref_ptr<VRCamera> > VRCameraList;
    VRCameraList _vrCameraList;

    // The VR eye texture buffers and related utilities
    osg::observer_ptr<VRTextureBuffer> _texBuffer;

    osg::observer_ptr<OpenVRDevice> _ovrDevice; // OpenVR interface
  };

} // !namespace OpenFrames

#endif  // !define _OF_VRUTILS_