makVrv::DtSubmitOverlayCallback Class Reference

An OSG camera callback that will submit the channel to the underlying VR system as an overlay channel. More...

Inheritance diagram for makVrv::DtSubmitOverlayCallback:

Public Member Functions
	DtSubmitOverlayCallback (osg::Texture2D *tex, DtDe &de, DtVirtualRealityDriver &driver)
	CTOR takes the texture that it should submit to the VR System as an overlay. More...
virtual	~DtSubmitOverlayCallback ()
	DTOR. More...
virtual void	operator() (osg::RenderInfo &renderInfo) const
	the callback function called by OSG More...
virtual osg::Matrixd	offsetMatrix ()
	get the offset matrix that the overlay will be displayed with. More...
virtual void	setOffsetMatrix (const osg::Matrixd &mat)
	get the offset matrix that the overlay will be displayed with. More...
virtual void	setFlipOverlay (bool flip)
	flip overlays on the vertical axis. More...
virtual bool	flipOverlay () const
	get the flip overlays settings More...
virtual void	setEnabled (bool enable)
	enable or disable the overlay More...
bool	isInitialized () const

Protected Member Functions
virtual void	submitOverlay (osg::RenderInfo &renderInfo) const =0
	submit system specific overlay More...

Protected Attributes
DtDe &	myDe
DtVirtualRealityDriver &	myDriver
osg::ref_ptr< osg::Texture2D >	myOverlayTexture
osg::Matrix	myOffsetMatrix
bool	myFlipOverlay
bool	myEnabled
bool	myIsInitialized

Private Member Functions
	DtSubmitOverlayCallback ()
	prevent default constructor More...
	DtSubmitOverlayCallback (const DtSubmitOverlayCallback &orig)
	prevent copy construction More...
DtSubmitOverlayCallback &	operator= (const DtSubmitOverlayCallback &)
	prevent assignment More...

Detailed Description

An OSG camera callback that will submit the channel to the underlying VR system as an overlay channel.

Constructor & Destructor Documentation

makVrv::DtSubmitOverlayCallback::DtSubmitOverlayCallback ( )

private

prevent default constructor

makVrv::DtSubmitOverlayCallback::DtSubmitOverlayCallback ( const DtSubmitOverlayCallback &  orig )

private

prevent copy construction

makVrv::DtSubmitOverlayCallback::DtSubmitOverlayCallback	(	osg::Texture2D *	tex,
		DtDe &	de,
		DtVirtualRealityDriver &	driver
	)

CTOR takes the texture that it should submit to the VR System as an overlay.

virtual makVrv::DtSubmitOverlayCallback::~DtSubmitOverlayCallback ( )

virtual

DTOR.

Member Function Documentation

DtSubmitOverlayCallback& makVrv::DtSubmitOverlayCallback::operator= ( const DtSubmitOverlayCallback &  )

private

prevent assignment

virtual void makVrv::DtSubmitOverlayCallback::operator() ( osg::RenderInfo &  renderInfo ) const

virtual

the callback function called by OSG

virtual osg::Matrixd makVrv::DtSubmitOverlayCallback::offsetMatrix ( )

virtual

get the offset matrix that the overlay will be displayed with.

This is an offset and rotation relative to the HMD view position and view direction in an East-North-Up coordinate system.

virtual void makVrv::DtSubmitOverlayCallback::setOffsetMatrix ( const osg::Matrixd &  mat )

virtual

get the offset matrix that the overlay will be displayed with.

This is an offset and rotation relative to the HMD view position and view direction in an East-North-Up coordinate system.

Reimplemented in makVrv::DtSubmitVarjoOverlayCallback, makVrv::DtSubmitDesktopOverlayCallback, makVrv::DtSubmitOculusOverlayCallback, and makVrv::DtSubmitOpenVROverlayCallback.

virtual void makVrv::DtSubmitOverlayCallback::setFlipOverlay ( bool  flip )

virtual

flip overlays on the vertical axis.

Some devices expect the textures to be submitted with the uv min in the top left corner, some want it in the bottom left corner.

Reimplemented in makVrv::DtSubmitVarjoOverlayCallback, makVrv::DtSubmitDesktopOverlayCallback, makVrv::DtSubmitOculusOverlayCallback, and makVrv::DtSubmitOpenVROverlayCallback.

virtual bool makVrv::DtSubmitOverlayCallback::flipOverlay ( ) const

virtual

get the flip overlays settings

virtual void makVrv::DtSubmitOverlayCallback::setEnabled ( bool  enable )

virtual

enable or disable the overlay

Reimplemented in makVrv::DtSubmitVarjoOverlayCallback, makVrv::DtSubmitDesktopOverlayCallback, makVrv::DtSubmitOculusOverlayCallback, and makVrv::DtSubmitOpenVROverlayCallback.

bool makVrv::DtSubmitOverlayCallback::isInitialized

(

)

const

virtual void makVrv::DtSubmitOverlayCallback::submitOverlay ( osg::RenderInfo &  renderInfo ) const

protectedpure virtual

submit system specific overlay

Implemented in makVrv::DtSubmitVarjoOverlayCallback, makVrv::DtSubmitOpenVROverlayCallback, makVrv::DtSubmitDesktopOverlayCallback, and makVrv::DtSubmitOculusOverlayCallback.

Member Data Documentation

DtDe& makVrv::DtSubmitOverlayCallback::myDe

protected

DtVirtualRealityDriver& makVrv::DtSubmitOverlayCallback::myDriver

protected

osg::ref_ptr<osg::Texture2D> makVrv::DtSubmitOverlayCallback::myOverlayTexture

protected

osg::Matrix makVrv::DtSubmitOverlayCallback::myOffsetMatrix

protected

bool makVrv::DtSubmitOverlayCallback::myFlipOverlay

protected

bool makVrv::DtSubmitOverlayCallback::myEnabled

protected

bool makVrv::DtSubmitOverlayCallback::myIsInitialized

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvVirtualReality/DtSubmitOverlayCallback.h