Contains the DtVirtualRealitySettingsManager class declaration. This class can be used to programatically enable/disable virtual reality and change the mirroring state.

Inheritance diagram for makVrv::DtVirtualRealitySettingsManager:

[legend]

Public Member Functions
virtual	~DtVirtualRealitySettingsManager ()

Setting Getters/Setters
virtual void	setEnabled (bool enabled)

virtual bool	enabled () const

virtual void	setMirroring (makArchives::DtVirtualRealitySettingsRecord::DtMirroring enabled)

virtual makArchives::DtVirtualRealitySettingsRecord::DtMirroring	mirroring () const

virtual void	setMirrorChannel (const std::string &channelName)

virtual const std::string &	mirrorChannel () const

virtual void	setAttachedObserver (const std::string &obsName)

virtual const std::string &	attachedObserver ()

virtual void	setFlipOverlays (bool flip)

virtual bool	flipOverlays () const

virtual void	setOverlayWidth (float width)

virtual float	overlayWidth () const

virtual void	setOverlayAspect (float aspect)

virtual float	overlayAspect () const

virtual void	setOverlayDistance (float distance)

virtual float	overlayDistance () const

virtual void	setPreferOpenVR (bool prefer)

virtual bool	preferOpenVR () const

virtual void	setPreferedProvider (std::string provider)

virtual std::string	preferedProvider () const

virtual void	setDisableDepthCopy (bool use)

virtual bool	disableDepthCopy () const

virtual void	setEnableVRS (bool enable)

virtual bool	enableVRS () const

virtual void	setResolutionScale (int scale)

virtual int	resolutionScale () const

virtual void	setEnableMixedRealityMask (bool enable)

virtual bool	enableMixedRealityMask () const

virtual void	setMixedRealityDefinitionFilePath (const std::string &filePath, bool autoLoad=true)

virtual const std::string &	mixedRealityDefinitionFilePath () const

void	setEnableRealWorldDepthTesting (bool enable)

bool	enableRealWorldDepthTesting () const

Setting persistence methods.
Use the settings from the given settings record.
virtual void	setFromRecord (const makArchives::DtVirtualRealitySettingsRecord &rec)

virtual void	getRecord (makArchives::DtVirtualRealitySettingsRecord &rec) const

Public Member Functions inherited from makVrv::DtBaseSettingsManager< makArchives::DtVirtualRealitySettingsRecord >
	DtBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)

virtual	~DtBaseSettingsManager ()

virtual void	initializeBackup ()

Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtVirtualRealitySettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)

virtual	~DtCommonBaseSettingsManager ()

virtual void	autoSaveIfNecessary ()

virtual void	setAutoSave (bool doit)

virtual bool	autoSave () const

virtual void	setUseDefaultSettingsRecord (bool useit)

virtual bool	useDefaultSettingsRecord () const

virtual DtDeSettings *	settings ()

virtual const DtDeSettings *	settings () const

virtual DtSettingsBackup *	settingsBackup ()

virtual const DtSettingsBackup *	settingsBackup () const

virtual void	loadDefaults ()

virtual void	saveDefaultSettings ()

virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)

virtual void	importSettings (const std::string &filePath)

virtual void	exportSettings (const std::string &filePath) const

virtual void	getSplitRecord (std::vector< makArchives::DtVirtualRealitySettingsRecord > &rec, std::vector< std::string > &fileNames)

virtual void	addRecords (makArchives::DtVirtualRealitySettingsRecord &rec, makArchives::DtVirtualRealitySettingsRecord &combinedRec)

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()

virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtVirtualRealitySettingsManager &	instance (DtDe &de)

Public Attributes
Boost signals for changed settings
signaled when VR is enabled or disabled
boost::signalslib::signal < void(bool)>	signal_enabledChanged

boost::signalslib::signal < void(makArchives::DtVirtualRealitySettingsRecord::DtMirroring)>	signal_mirroringChanged

boost::signalslib::signal < void(std::string)>	signal_mirrorChannelChanged

boost::signalslib::signal < void(std::string)>	signal_attachedObserverChanged

boost::signalslib::signal < void(std::string)>	signal_preferedProviderChanged

boost::signalslib::signal < void(bool)>	signal_flipOverlaysChanged

boost::signalslib::signal < void(float)>	signal_overlayWidthChanged

boost::signalslib::signal < void(float)>	signal_overlayAspectChanged

boost::signalslib::signal < void(float)>	signal_overlayDistanceChanged

boost::signalslib::signal < void(bool)>	signal_disableDepthCopyChanged

boost::signalslib::signal < void(bool)>	signal_enableVRSChanged

boost::signalslib::signal < void(int)>	signal_resolutionScaleChanged

boost::signalslib::signal < void(bool)>	signal_enableMixedRealityMaskChanged

boost::signalslib::signal < void(bool)>	signal_enableRealWorldDepthTestingChanged

Protected Attributes
makArchives::DtVirtualRealitySettingsRecord	mySettingsRecord

DtDe &	myDe

Protected Attributes inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtVirtualRealitySettingsRecord >
DtSignalConnectionManager	myConnections

std::string	myName

std::string	myExtension

std::string	myDisplayName

bool	myUseDefaultSettingsRecordFlag

bool	myAutoSaveFlag

DtSettingsBackup *	mySettingsBackup

DtDe &	myDe

Private Member Functions
	DtVirtualRealitySettingsManager (DtDe &)

	DtVirtualRealitySettingsManager (const DtVirtualRealitySettingsManager &orig)

DtVirtualRealitySettingsManager &	operator= (const DtVirtualRealitySettingsManager &orig)

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)

template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseSettingsManager< makArchives::DtVirtualRealitySettingsRecord >
typedef DtRecordSettingsBackup < DtBaseSettingsManager < makArchives::DtVirtualRealitySettingsRecord > , makArchives::DtVirtualRealitySettingsRecord >	RecordBackupType

Constructor & Destructor Documentation

makVrv::DtVirtualRealitySettingsManager::DtVirtualRealitySettingsManager ( DtDe & )

private

Protected CTOR ( use instance(..) )

makVrv::DtVirtualRealitySettingsManager::DtVirtualRealitySettingsManager ( const DtVirtualRealitySettingsManager & orig )

private

prevent copy constructor

virtual makVrv::DtVirtualRealitySettingsManager::~DtVirtualRealitySettingsManager ( )

virtual

DTOR.

Member Function Documentation

DtVirtualRealitySettingsManager& makVrv::DtVirtualRealitySettingsManager::operator= ( const DtVirtualRealitySettingsManager & orig )

private

prevent assignment operator

static DtVirtualRealitySettingsManager& makVrv::DtVirtualRealitySettingsManager::instance ( DtDe & de )

static

Get an instance of the settings manager.

virtual void makVrv::DtVirtualRealitySettingsManager::setEnabled ( bool enabled )

virtual

sets wheter VR is in enabled or not

virtual bool makVrv::DtVirtualRealitySettingsManager::enabled ( ) const

virtual

gets whether VR is currently enabled

virtual void makVrv::DtVirtualRealitySettingsManager::setMirroring ( makArchives::DtVirtualRealitySettingsRecord::DtMirroring enabled )

virtual

Enables/disables mirroring of an HMD eye channel on a monitor so other people can see what the user of the HMD is seeing.

virtual makArchives::DtVirtualRealitySettingsRecord::DtMirroring makVrv::DtVirtualRealitySettingsManager::mirroring ( ) const

virtual

Get the current state of mirroring the HMD to a monitor.

virtual void makVrv::DtVirtualRealitySettingsManager::setMirrorChannel ( const std::string & channelName )

virtual

Sets the display channel using a window and channel name (i.e. "Window 1:Channel 1") that will mirror what the HMD is seeing.

virtual const std::string& makVrv::DtVirtualRealitySettingsManager::mirrorChannel ( ) const

virtual

Gets the mirror display channel using a window and channel name (i.e. "Window 1:Channel 1")

virtual void makVrv::DtVirtualRealitySettingsManager::setAttachedObserver ( const std::string & obsName )

virtual

Sets the observer that the HMD is attached to.

virtual const std::string& makVrv::DtVirtualRealitySettingsManager::attachedObserver ( )

virtual

gets the names of the current attached observer

virtual void makVrv::DtVirtualRealitySettingsManager::setFlipOverlays ( 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. this setting affects only the currently attached device and is saved in a per device map

virtual bool makVrv::DtVirtualRealitySettingsManager::flipOverlays ( ) const

virtual

get the flip overlays settings

virtual void makVrv::DtVirtualRealitySettingsManager::setOverlayWidth ( float width )

virtual

set overlay width for current provider

virtual float makVrv::DtVirtualRealitySettingsManager::overlayWidth ( ) const

virtual

get the overlay width for current provider

virtual void makVrv::DtVirtualRealitySettingsManager::setOverlayAspect ( float aspect )

virtual

set overlay aspect for current provider

virtual float makVrv::DtVirtualRealitySettingsManager::overlayAspect ( ) const

virtual

get the overlay aspect for current provider

virtual void makVrv::DtVirtualRealitySettingsManager::setOverlayDistance ( float distance )

virtual

set overlay distance for current provider

virtual float makVrv::DtVirtualRealitySettingsManager::overlayDistance ( ) const

virtual

get the overlay distance for current provider

virtual void makVrv::DtVirtualRealitySettingsManager::setPreferOpenVR ( bool prefer )

virtual

set using the openVR provider if available instead of the oculus provider. this setting is not in the GUI. This setting does not signal on change.

virtual bool makVrv::DtVirtualRealitySettingsManager::preferOpenVR ( ) const

virtual

use the openVR provider if available instead of the oculus provider this setting is not in the GUI

virtual void makVrv::DtVirtualRealitySettingsManager::setPreferedProvider ( std::string provider )

virtual

set which provider to try first

virtual std::string makVrv::DtVirtualRealitySettingsManager::preferedProvider ( ) const

virtual

which provider to try first

virtual void makVrv::DtVirtualRealitySettingsManager::setDisableDepthCopy ( bool use )

virtual

set preference to disable depth copy

virtual bool makVrv::DtVirtualRealitySettingsManager::disableDepthCopy ( ) const

virtual

is depth copy disabled

virtual void makVrv::DtVirtualRealitySettingsManager::setEnableVRS ( bool enable )

virtual

set preference to use VRS

virtual bool makVrv::DtVirtualRealitySettingsManager::enableVRS ( ) const

virtual

is VRS enabled

virtual void makVrv::DtVirtualRealitySettingsManager::setResolutionScale ( int scale )

virtual

set resolution scale

virtual int makVrv::DtVirtualRealitySettingsManager::resolutionScale ( ) const

virtual

resolution scale

virtual void makVrv::DtVirtualRealitySettingsManager::setEnableMixedRealityMask ( bool enable )

virtual

set mixed reality mask enaled state

virtual bool makVrv::DtVirtualRealitySettingsManager::enableMixedRealityMask ( ) const

virtual

use multiview extension if available

virtual void makVrv::DtVirtualRealitySettingsManager::setMixedRealityDefinitionFilePath	(	const std::string &	filePath,
		bool	autoLoad = `true`
	)

virtual

set mixed reality definition file path

virtual const std::string& makVrv::DtVirtualRealitySettingsManager::mixedRealityDefinitionFilePath ( ) const

virtual

returns the current mixed reality definition file path

void makVrv::DtVirtualRealitySettingsManager::setEnableRealWorldDepthTesting ( bool enable )

set preference to enable real world depth testing

bool makVrv::DtVirtualRealitySettingsManager::enableRealWorldDepthTesting ( ) const

should enable real world depth testing in MR

virtual void makVrv::DtVirtualRealitySettingsManager::setFromRecord ( const makArchives::DtVirtualRealitySettingsRecord & rec )

virtual

Populate the given record with the current settings.

Implements makVrv::DtBaseSettingsManager< makArchives::DtVirtualRealitySettingsRecord >.

virtual void makVrv::DtVirtualRealitySettingsManager::getRecord ( makArchives::DtVirtualRealitySettingsRecord & rec ) const

virtual

Populate the given record with the current settings.

Implements makVrv::DtBaseSettingsManager< makArchives::DtVirtualRealitySettingsRecord >.

Friends And Related Function Documentation

template<typename ManagerClass >

ManagerClass& defaultManagerInstanceFunction	(	DtDe &	de,
		bool	allowedInSlave
	)

friend

Befriend the manager instance functions for instance retrieval / creation.

Befriend the manager instance functions for instance retrieval and creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

class Manager
{
public:
   static Manager& instance(DtDe& de);
   void loadDefaults();
protected:
   template <typename ManagerClass>
   friend ManagerClass& defaultManagerInstanceFunction(DtDe& de, bool);
   template <typename ManagerClass>
   friend void defaultManagerRegisterInstanceFunction(DtDe& de, ManagerClass* mgr)
   Manager(DtDe&);
   DtSignalConnectionManager myConnections;
};

Then simply in the implementation of instance call defaultManagerInstanceFunction with the de object and return the return value.

Manager& Manager::instance(DtDe& de)
{
   return defaultManagerInstanceFunction<Manager>(de);
}

template<typename ManagerClass >

void defaultManagerRegisterInstanceFunction	(	DtDe &	de,
		ManagerClass *	mgr
	)

friend

Befriend the manager instance functions for instance retrieval / creation.

Befriend the manager instance functions for instance retrieval and creation.

Befriend the manager instance functions for instance retreival/creation.

Befriend the manager instance functions for instance retrieval/creation.

static void Manager::registerInstance(DtDe& de, Manager* mgr)
{
   defaultManagerRegisterInstanceFunction(de,mgr);
}
...else where call.
// Assuming class NewManager : public Manager
Manager::registerInstance(de,new NewManager(de));

Member Data Documentation

boost::signalslib::signal<void (bool)> makVrv::DtVirtualRealitySettingsManager::signal_enabledChanged

signals when the HMD mirror state changes

boost::signalslib::signal<void(makArchives::DtVirtualRealitySettingsRecord::DtMirroring)> makVrv::DtVirtualRealitySettingsManager::signal_mirroringChanged

signals when the HMD mirror state changes

boost::signalslib::signal<void (std::string)> makVrv::DtVirtualRealitySettingsManager::signal_mirrorChannelChanged

signaled when the channel that the user wants to display the HMD mirror on changes

boost::signalslib::signal<void (std::string)> makVrv::DtVirtualRealitySettingsManager::signal_attachedObserverChanged

signaled when the attached observer changes

boost::signalslib::signal<void(std::string)> makVrv::DtVirtualRealitySettingsManager::signal_preferedProviderChanged

signaled when prefered provider changes

boost::signalslib::signal<void(bool)> makVrv::DtVirtualRealitySettingsManager::signal_flipOverlaysChanged

signaled when the flip overlay changes

boost::signalslib::signal<void(float)> makVrv::DtVirtualRealitySettingsManager::signal_overlayWidthChanged

signaled when the overlay width changes

boost::signalslib::signal<void(float)> makVrv::DtVirtualRealitySettingsManager::signal_overlayAspectChanged

signaled when the overlay aspect changes

boost::signalslib::signal<void(float)> makVrv::DtVirtualRealitySettingsManager::signal_overlayDistanceChanged

signaled when the overlay distance changes

boost::signalslib::signal<void(bool)> makVrv::DtVirtualRealitySettingsManager::signal_disableDepthCopyChanged

signaled when use multiview changes

boost::signalslib::signal<void(bool)> makVrv::DtVirtualRealitySettingsManager::signal_enableVRSChanged

signaled when use vrs changes

boost::signalslib::signal<void(int)> makVrv::DtVirtualRealitySettingsManager::signal_resolutionScaleChanged

signaled when resolution scale changes

boost::signalslib::signal<void(bool)> makVrv::DtVirtualRealitySettingsManager::signal_enableMixedRealityMaskChanged

signaled when enable mixed reality mask changes

boost::signalslib::signal<void(bool)> makVrv::DtVirtualRealitySettingsManager::signal_enableRealWorldDepthTestingChanged

signaled when enable mixed reality mask changes

makArchives::DtVirtualRealitySettingsRecord makVrv::DtVirtualRealitySettingsManager::mySettingsRecord

protected

DtDe& makVrv::DtVirtualRealitySettingsManager::myDe

protected

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation