An abstract interface that provides VR System API services. Providers are created and provided to the DtVirtualRealityDriver for use. Derived classes will have a static isVrSupported() function that can be used to know if the right equipment and software are present for use.

Inheritance diagram for makVrv::DtVirtualRealityProvider:

[legend]

Public Member Functions
	DtVirtualRealityProvider (DtDe &de)

virtual	~DtVirtualRealityProvider ()

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

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

virtual DtBeginRenderingCallback *	createBeginRenderingCallback (DtVirtualRealityDriver &driver, vrvVirtualReality::DtEye eye)

virtual const std::string &	providerName ()=0

virtual const std::string &	deviceName ()=0

virtual bool	initializeVR ()=0

virtual bool	hasFocusViews ()=0

virtual bool	useVrs ()=0

virtual DtVariableRateShadingImageUpdater *	findVrsUpdater (DtVirtualRealityChannel *channel)=0

virtual void	getRecommendedRenderTargetSize (int &width, int &height, vrvVirtualReality::DtEye whichEye)=0

virtual DtSwapChain *	allocateSwapChain (vrvVirtualReality::DtEye whichEye, bool isOverlay)=0

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

virtual osg::Matrixd	getEyeToHeadTransform (vrvVirtualReality::DtEye eye)=0

virtual void	commitEyeTexture (osg::RenderInfo &renderInfo, DtSwapChain *swapChain)=0

virtual void	commitHudTexture (osg::RenderInfo &renderInfo, DtSwapChain *swapChain)=0

virtual void	updateOverlayDimensions (float width, float height, float distance, int pixWidth, int pixHeight)=0

virtual void	tick ()=0

virtual void	beginFrame ()=0

virtual void	beginRendering ()=0

virtual void	endRendering ()=0

virtual bool	getHmdPose (DtVector &pos, DtQuat &ori)=0

virtual void	setHmdPoseOffset (const DtVector &pos, const DtQuat &ori)=0

virtual bool	getTrackedPose (DtVector &pos, DtQuat &ori, int index)=0

virtual bool	reset ()=0

virtual void	triggerAction1 ()

virtual bool	shutdown ()=0

virtual bool	hasTrackedCamera ()=0

virtual DtTrackedCamera *	findTrackedCamera ()=0

virtual DtMixedRealityMask *	findMixedRealityMask ()=0

virtual bool	mixedRealityRunning () const

virtual void	startMixedReality ()

virtual void	stopMixedReality ()

virtual bool	supportsMixedReality ()

virtual bool	supportsDepthBufferSubmission ()

virtual bool	supportsRealWorldDepthTesting ()

virtual bool	realWorldDepthTestingEnabled () const

virtual void	startRealWorldDepthTesting ()

virtual void	stopRealWorldDepthTesting ()

virtual vrvVirtualReality::DtVrOverlayMode	overlayMode ()

Protected Attributes
DtDe &	myDe

DtVirtualRealityDriver *	myDriverHandle

DtTrackedCamera *	myTrackedCamera

DtMixedRealityMask *	myMixedRealityMask

bool	myMixedRealityRunning

bool	myRealWorldDepthTestingEnabled

std::map < DtVirtualRealityChannel *, osg::ref_ptr < DtVariableRateShadingImageUpdater > >	myChannelVrsUpdaters

Private Member Functions
	DtVirtualRealityProvider (const DtVirtualRealityProvider &other)

DtVirtualRealityProvider &	operator= (const DtVirtualRealityProvider &other)

Constructor & Destructor Documentation

makVrv::DtVirtualRealityProvider::DtVirtualRealityProvider ( const DtVirtualRealityProvider & other )

private

Copy Constructor not implemented – Copy Not Allowed.

makVrv::DtVirtualRealityProvider::DtVirtualRealityProvider ( DtDe & de )

CTOR.

virtual makVrv::DtVirtualRealityProvider::~DtVirtualRealityProvider ( )

virtual

DTOR.

Member Function Documentation

DtVirtualRealityProvider& makVrv::DtVirtualRealityProvider::operator= ( const DtVirtualRealityProvider & other )

private

Assignment Operator Not implemented � Assignment Not Allowed.

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

pure virtual

create a system specific overlay callback

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

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

pure virtual

create a system specific view callback

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

virtual DtBeginRenderingCallback* makVrv::DtVirtualRealityProvider::createBeginRenderingCallback	(	DtVirtualRealityDriver &	driver,
		vrvVirtualReality::DtEye	eye
	)

virtual

default BeginRenderingCallback or invoke provider specific override

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

pure virtual

get the name of this VR System provider

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

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

pure virtual

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

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

virtual bool makVrv::DtVirtualRealityProvider::initializeVR ( )

pure virtual

initialize the VR subsystem

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

virtual bool makVrv::DtVirtualRealityProvider::hasFocusViews ( )

pure virtual

does this headset support focus views

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

virtual bool makVrv::DtVirtualRealityProvider::useVrs ( )

pure virtual

should we use variable rate shading

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

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

pure virtual

return a vrs updater allocating it if needed

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

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

pure virtual

get recommended VR target size

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

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

pure virtual

allocate a swapchain for this provider

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

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

pure virtual

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

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

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

pure virtual

get the head to eye transform

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, makVrv::DtXtalProvider, and makVrv::DtDesktopProvider.

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

pure virtual

provider specific commit of eye texture to the HMD

Implemented in makVrv::DtVarjoProvider, makVrv::DtXtalProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, and makVrv::DtDesktopProvider.

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

pure virtual

provider specific commit of hud texture to the HMD

Implemented in makVrv::DtVarjoProvider, makVrv::DtXtalProvider, makVrv::DtOpenVRProvider, makVrv::DtOculusProvider, and makVrv::DtDesktopProvider.

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

pure virtual

update hud overlay dimensions

Implemented in makVrv::DtVarjoProvider, makVrv::DtXtalProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, and makVrv::DtOculusProvider.

virtual void makVrv::DtVirtualRealityProvider::tick ( )

pure virtual

update the VR system

Implemented in makVrv::DtVarjoProvider, makVrv::DtXtalProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, and makVrv::DtOculusProvider.

virtual void makVrv::DtVirtualRealityProvider::beginFrame ( )

pure virtual

pretick signal call to begin the frame

Implemented in makVrv::DtVarjoProvider, makVrv::DtXtalProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, and makVrv::DtOculusProvider.

virtual void makVrv::DtVirtualRealityProvider::beginRendering ( )

pure virtual

postupdate renderer call to begin rendering

Implemented in makVrv::DtVarjoProvider, makVrv::DtXtalProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, and makVrv::DtOculusProvider.

virtual void makVrv::DtVirtualRealityProvider::endRendering ( )

pure virtual

posttick signal call to end rendering

Implemented in makVrv::DtVarjoProvider, makVrv::DtXtalProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, and makVrv::DtOculusProvider.

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

pure virtual

get the HMD pose

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, makVrv::DtOculusProvider, and makVrv::DtXtalProvider.

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

pure virtual

set an constant offset to the hmd pose

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, makVrv::DtOculusProvider, and makVrv::DtXtalProvider.

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

pure virtual

get the pose of a tracked item

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, makVrv::DtOculusProvider, and makVrv::DtXtalProvider.

virtual bool makVrv::DtVirtualRealityProvider::reset ( )

pure virtual

reset the HMD

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, makVrv::DtOculusProvider, and makVrv::DtXtalProvider.

virtual void makVrv::DtVirtualRealityProvider::triggerAction1 ( )

virtual

trigger generic action for the provider

Reimplemented in makVrv::DtVarjoProvider, and makVrv::DtXtalProvider.

virtual bool makVrv::DtVirtualRealityProvider::shutdown ( )

pure virtual

shutdown the VR subsystem

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, makVrv::DtOculusProvider, and makVrv::DtXtalProvider.

virtual bool makVrv::DtVirtualRealityProvider::hasTrackedCamera ( )

pure virtual

check if there is a tracked camera

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, makVrv::DtOculusProvider, and makVrv::DtXtalProvider.

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

pure virtual

get the tracked camera of the VR system.

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, makVrv::DtOculusProvider, and makVrv::DtXtalProvider.

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

pure virtual

return the mixed reality mask object allocating one if not already allocated will return zero for providers that don't support mixed reality

Implemented in makVrv::DtVarjoProvider, makVrv::DtOpenVRProvider, makVrv::DtDesktopProvider, makVrv::DtOculusProvider, and makVrv::DtXtalProvider.

virtual bool makVrv::DtVirtualRealityProvider::mixedRealityRunning ( ) const

virtual

returns true if mixed reality is active and running

virtual void makVrv::DtVirtualRealityProvider::startMixedReality ( )

virtual

start mixed reality camera and blending etc

Reimplemented in makVrv::DtVarjoProvider, and makVrv::DtXtalProvider.

virtual void makVrv::DtVirtualRealityProvider::stopMixedReality ( )

virtual

stop mixed reality camera and blending etc

Reimplemented in makVrv::DtVarjoProvider, and makVrv::DtXtalProvider.

virtual bool makVrv::DtVirtualRealityProvider::supportsMixedReality ( )

virtual

reuturns true if the headset is capable of supporting mixed reality

Reimplemented in makVrv::DtVarjoProvider, and makVrv::DtXtalProvider.

virtual bool makVrv::DtVirtualRealityProvider::supportsDepthBufferSubmission ( )

virtual

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

Reimplemented in makVrv::DtVarjoProvider, makVrv::DtXtalProvider, makVrv::DtDesktopProvider, and makVrv::DtOculusProvider.

virtual bool makVrv::DtVirtualRealityProvider::supportsRealWorldDepthTesting ( )

virtual

\ breif returns true if the headset supports depth testing against the real world

Reimplemented in makVrv::DtVarjoProvider.

virtual bool makVrv::DtVirtualRealityProvider::realWorldDepthTestingEnabled ( ) const

virtual

\ brief returns true if real world depth testing is enabled

virtual void makVrv::DtVirtualRealityProvider::startRealWorldDepthTesting ( )

virtual

\ breif start performing real world depth testing

Reimplemented in makVrv::DtVarjoProvider.

virtual void makVrv::DtVirtualRealityProvider::stopRealWorldDepthTesting ( )

virtual

\ breif stop performing real world depth testing

Reimplemented in makVrv::DtVarjoProvider.

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

virtual

should the overlay be rendered as strereo to another render texture

Reimplemented in makVrv::DtVarjoProvider, makVrv::DtXtalProvider, makVrv::DtOculusProvider, and makVrv::DtDesktopProvider.

Member Data Documentation

DtDe& makVrv::DtVirtualRealityProvider::myDe

protected

DtVirtualRealityDriver* makVrv::DtVirtualRealityProvider::myDriverHandle

protected

DtTrackedCamera* makVrv::DtVirtualRealityProvider::myTrackedCamera

protected

DtMixedRealityMask* makVrv::DtVirtualRealityProvider::myMixedRealityMask

protected

bool makVrv::DtVirtualRealityProvider::myMixedRealityRunning

protected

bool makVrv::DtVirtualRealityProvider::myRealWorldDepthTestingEnabled

protected

std::map<DtVirtualRealityChannel*, osg::ref_ptr<DtVariableRateShadingImageUpdater> > makVrv::DtVirtualRealityProvider::myChannelVrsUpdaters

protected

out vrs updater

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvVirtualReality/DtVirtualRealityProvider.h

Public Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation