VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
makVrv::DtOculusProvider Class Reference
vrvVirtualReality contains classes for the VRV Virtual reality

An Oculus implementation of the DtVirtualRealityProvider abstract base class.

Inheritance diagram for makVrv::DtOculusProvider:
Inheritance graph
[legend]

Public Member Functions

 DtOculusProvider (DtDe &de)
 
virtual ~DtOculusProvider ()
 
virtual DtSubmitOverlayCallback * createOverlayCallback (osg::Texture *tex, DtDe &de, DtVirtualRealityDriver &driver)
 
virtual DtSubmitViewCallback * createViewCallback (DtVirtualRealityPostProcessor &pp, DtVirtualRealityDriver &driver, vrvVirtualReality::DtEye eye)
 
virtual const std::string & providerName ()
 
virtual const std::string & deviceName ()
 
virtual bool initializeVR ()
 
virtual bool hasFocusViews ()
 
virtual bool useVrs ()
 
virtual
DtVariableRateShadingImageUpdater * 		findVrsUpdater (DtVirtualRealityChannel *channel)
 
virtual void getRecommendedRenderTargetSize (int &width, int &height, vrvVirtualReality::DtEye whichEye)
 
virtual DtSwapChain * allocateSwapChain (vrvVirtualReality::DtEye whichEye, bool isOverlay)
 
virtual void getProjectionAngles (vrvVirtualReality::DtEye eye, double &left, double &right, double &bottom, double &top, double znear, double zfar)
 
virtual osg::Matrixd getEyeToHeadTransform (vrvVirtualReality::DtEye eye)
 
virtual void commitEyeTexture (osg::RenderInfo &renderInfo, DtSwapChain *swapChain)
 
virtual void commitHudTexture (osg::RenderInfo &renderInfo, DtSwapChain *swapChain)
 
virtual void updateOverlayDimensions (float width, float height, float distance, int pixWidth, int pixHeight)
 
virtual void tick ()
 
virtual bool getHmdPose (DtVector &pos, DtQuat &ori)
 
virtual void setHmdPoseOffset (const DtVector &pos, const DtQuat &ori)
 
virtual bool getTrackedPose (DtVector &pos, DtQuat &ori, int index)
 
virtual bool reset ()
 
virtual bool shutdown ()
 
virtual bool hasTrackedCamera ()
 
virtual DtTrackedCamera * findTrackedCamera ()
 
virtual DtMixedRealityMask * findMixedRealityMask ()
 
virtual bool supportsDepthBufferSubmission ()
 
virtual
vrvVirtualReality::DtVrOverlayMode 		overlayMode ()
 
ovrSession findOculusSystem () const
 
ovrTrackingState getTrackingState ()
 
ovrInputState getInputState ()
 
void setHudOffset (const ovrPosef &pose)
 
void setOverlayEnabled (bool enabled)
 
void eyeCreated ()
 
- Public Member Functions inherited from makVrv::DtVirtualRealityProvider
 DtVirtualRealityProvider (DtDe &de)
 
virtual ~DtVirtualRealityProvider ()
 
virtual DtBeginFrameCallback * createBeginFrameCallback (DtVirtualRealityDriver &driver, vrvVirtualReality::DtEye eye)
 
virtual void triggerAction1 ()
 
virtual bool mixedRealityRunning () const
 
virtual void startMixedReality ()
 
virtual void stopMixedReality ()
 
virtual bool supportsMixedReality ()
 
virtual bool supportsRealWorldDepthTesting ()
 
virtual bool realWorldDepthTestingEnabled () const
 
virtual void startRealWorldDepthTesting ()
 
virtual void stopRealWorldDepthTesting ()
 

Static Public Member Functions

static bool isVrAvailable ()
 

Protected Member Functions

void beginFrame ()
 
void beginRendering ()
 
void endRendering ()
 
void errorAndStop ()
 

Protected Attributes

ovrSession mySession
 
ovrHmdDesc myHmdDesc
 
ovrEyeRenderDesc myEyeRenderDesc [2]
 
int myWidth
 
int myHeight
 
long long myFrameIndex
 
bool myFrameBegan
 
int myEyesCreated
 
bool myHudEnabled
 
ovrLayerHeader * myLayers [2]
 
ovrLayerEyeFovDepth myViewLayer
 
ovrLayerQuad myHudLayer
 
std::string myDeviceName
 
- Protected Attributes inherited from makVrv::DtVirtualRealityProvider
DtDe & myDe
 
DtVirtualRealityDriver * myDriverHandle
 
DtTrackedCamera * myTrackedCamera
 
DtMixedRealityMask * myMixedRealityMask
 
bool myMixedRealityRunning
 
bool myRealWorldDepthTestingEnabled
 
std::map
< DtVirtualRealityChannel
*, osg::ref_ptr
< DtVariableRateShadingImageUpdater > > 		myChannelVrsUpdaters
 

Private Member Functions

 DtOculusProvider ()
 
 DtOculusProvider (const DtOculusProvider &)
 
DtOculusProvider & operator= (const DtOculusProvider &)
 

Constructor & Destructor Documentation

makVrv::DtOculusProvider::DtOculusProvider ( )
private

default CTOR.

makVrv::DtOculusProvider::DtOculusProvider ( const DtOculusProvider &  )
private

default copy constructor

makVrv::DtOculusProvider::DtOculusProvider ( DtDe &  de)

CTOR.

virtual makVrv::DtOculusProvider::~DtOculusProvider ( )
virtual

DTOR.

Member Function Documentation

DtOculusProvider& makVrv::DtOculusProvider::operator= ( const DtOculusProvider &  )
private

assignment operator

static bool makVrv::DtOculusProvider::isVrAvailable ( )
static

Is this VR system available and an HMD connected for use. May be called without instantiating the provider.

virtual DtSubmitOverlayCallback* makVrv::DtOculusProvider::createOverlayCallback ( osg::Texture *  tex,
DtDe &  de,
DtVirtualRealityDriver &  driver 
)
virtual

create a system specific overlay callback

Implements makVrv::DtVirtualRealityProvider.

virtual DtSubmitViewCallback* makVrv::DtOculusProvider::createViewCallback ( DtVirtualRealityPostProcessor &  pp,
DtVirtualRealityDriver &  driver,
vrvVirtualReality::DtEye  eye 
)
virtual

create a system specific view callback

Implements makVrv::DtVirtualRealityProvider.

virtual const std::string& makVrv::DtOculusProvider::providerName ( )
virtual

get the name of this VR System provider

Implements makVrv::DtVirtualRealityProvider.

virtual const std::string& makVrv::DtOculusProvider::deviceName ( )
virtual

some systems can support multiple devices. Get the name of the attached device

Implements makVrv::DtVirtualRealityProvider.

virtual bool makVrv::DtOculusProvider::initializeVR ( )
virtual

initialize the VR subsystem

Implements makVrv::DtVirtualRealityProvider.

virtual bool makVrv::DtOculusProvider::hasFocusViews ( )
virtual

does this headset support focus views

Implements makVrv::DtVirtualRealityProvider.

virtual bool makVrv::DtOculusProvider::useVrs ( )
virtual

should we use variable rate shading

Implements makVrv::DtVirtualRealityProvider.

virtual DtVariableRateShadingImageUpdater* makVrv::DtOculusProvider::findVrsUpdater ( DtVirtualRealityChannel *  channel)
virtual

return a vrs updater allocating it if needed

Implements makVrv::DtVirtualRealityProvider.

virtual void makVrv::DtOculusProvider::getRecommendedRenderTargetSize ( int &  width,
int &  height,
vrvVirtualReality::DtEye  whichEye 
)
virtual

get recommended VR target size

Implements makVrv::DtVirtualRealityProvider.

virtual DtSwapChain* makVrv::DtOculusProvider::allocateSwapChain ( vrvVirtualReality::DtEye  whichEye,
bool  isOverlay 
)
virtual

allocate a swapchain for this provider

Implements makVrv::DtVirtualRealityProvider.

virtual void makVrv::DtOculusProvider::getProjectionAngles ( vrvVirtualReality::DtEye  eye,
double &  left,
double &  right,
double &  bottom,
double &  top,
double  znear,
double  zfar 
)
virtual

get recommended projection frustum angles in degrees. Znear and zFar are passed in

Implements makVrv::DtVirtualRealityProvider.

virtual osg::Matrixd makVrv::DtOculusProvider::getEyeToHeadTransform ( vrvVirtualReality::DtEye  eye)
virtual

get the head to eye transform

Implements makVrv::DtVirtualRealityProvider.

virtual void makVrv::DtOculusProvider::commitEyeTexture ( osg::RenderInfo &  renderInfo,
DtSwapChain *  swapChain 
)
virtual

provider specific commit of eye texture to the HMD

Implements makVrv::DtVirtualRealityProvider.

virtual void makVrv::DtOculusProvider::commitHudTexture ( osg::RenderInfo &  renderInfo,
DtSwapChain *  swapChain 
)
virtual

provider specific commit of hud texture to the HMD

Implements makVrv::DtVirtualRealityProvider.

virtual void makVrv::DtOculusProvider::updateOverlayDimensions ( float  width,
float  height,
float  distance,
int  pixWidth,
int  pixHeight 
)
virtual

update hud overlay dimensions

Implements makVrv::DtVirtualRealityProvider.

virtual void makVrv::DtOculusProvider::tick ( )
virtual

update the VR system

Implements makVrv::DtVirtualRealityProvider.

virtual bool makVrv::DtOculusProvider::getHmdPose ( DtVector &  pos,
DtQuat &  ori 
)
virtual

get the HMD pose

Implements makVrv::DtVirtualRealityProvider.

virtual void makVrv::DtOculusProvider::setHmdPoseOffset ( const DtVector &  pos,
const DtQuat &  ori 
)
virtual

set an constant offset to the hmd pose

Implements makVrv::DtVirtualRealityProvider.

virtual bool makVrv::DtOculusProvider::getTrackedPose ( DtVector &  pos,
DtQuat &  ori,
int  index 
)
virtual

get the pose of a tracked item

Implements makVrv::DtVirtualRealityProvider.

virtual bool makVrv::DtOculusProvider::reset ( )
virtual

reset the HMD

Implements makVrv::DtVirtualRealityProvider.

virtual bool makVrv::DtOculusProvider::shutdown ( )
virtual

shutdown the VR subsystem

Implements makVrv::DtVirtualRealityProvider.

virtual bool makVrv::DtOculusProvider::hasTrackedCamera ( )
virtual

check if there is a tracked camera

Implements makVrv::DtVirtualRealityProvider.

virtual DtTrackedCamera* makVrv::DtOculusProvider::findTrackedCamera ( )
virtual

get the tracked camera of the VR system.

Implements makVrv::DtVirtualRealityProvider.

virtual DtMixedRealityMask* makVrv::DtOculusProvider::findMixedRealityMask ( )
virtual

create a mixed reality mask allowing provider specific implementations

Implements makVrv::DtVirtualRealityProvider.

virtual bool makVrv::DtOculusProvider::supportsDepthBufferSubmission ( )
virtual

\ breif returns true if the headset supports depth buffer submission for positional warp etc

Reimplemented from makVrv::DtVirtualRealityProvider.

virtual vrvVirtualReality::DtVrOverlayMode makVrv::DtOculusProvider::overlayMode ( )
virtual

should the overlay be rendered as strereo to another render texture

Reimplemented from makVrv::DtVirtualRealityProvider.

ovrSession makVrv::DtOculusProvider::findOculusSystem ( ) const

non-virtual functions provide Oculus specific functionality.

return the oculus specific session

ovrTrackingState makVrv::DtOculusProvider::getTrackingState ( )

get a copy of the most recent tracking state

ovrInputState makVrv::DtOculusProvider::getInputState ( )

get a copy of the most recent touch input state

void makVrv::DtOculusProvider::setHudOffset ( const ovrPosef &  pose)

internally used to set the offset for the hud texture

void makVrv::DtOculusProvider::setOverlayEnabled ( bool  enabled)

set whether or not the overlay is enabled and submitted to the oculus system

void makVrv::DtOculusProvider::eyeCreated ( )

internal called when a swapchain surface is created

void makVrv::DtOculusProvider::beginFrame ( )
protected
void makVrv::DtOculusProvider::beginRendering ( )
protected
void makVrv::DtOculusProvider::endRendering ( )
protected
void makVrv::DtOculusProvider::errorAndStop ( )
protected

Member Data Documentation

ovrSession makVrv::DtOculusProvider::mySession
protected
ovrHmdDesc makVrv::DtOculusProvider::myHmdDesc
protected
ovrEyeRenderDesc makVrv::DtOculusProvider::myEyeRenderDesc[2]
protected
int makVrv::DtOculusProvider::myWidth
protected
int makVrv::DtOculusProvider::myHeight
protected
long long makVrv::DtOculusProvider::myFrameIndex
protected
bool makVrv::DtOculusProvider::myFrameBegan
protected
int makVrv::DtOculusProvider::myEyesCreated
protected
bool makVrv::DtOculusProvider::myHudEnabled
protected
ovrLayerHeader* makVrv::DtOculusProvider::myLayers[2]
protected
ovrLayerEyeFovDepth makVrv::DtOculusProvider::myViewLayer
protected
ovrLayerQuad makVrv::DtOculusProvider::myHudLayer
protected
std::string makVrv::DtOculusProvider::myDeviceName
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)