Contains the DtVirtualRealitySettingsManager class declaration. More...

Inheritance diagram for makVrv::DtVirtualRealitySettingsManager:

Public Member Functions
virtual	~DtVirtualRealitySettingsManager ()
	DTOR. More...

Setting Getters/Setters
virtual void	setEnabled (bool enabled)
	sets wheter VR is in enabled or not More...

virtual bool	enabled () const
	gets whether VR is currently enabled More...

virtual void	setMirroring (makArchives::DtVirtualRealitySettingsRecord::DtMirroring enabled)
	Enables/disables mirroring of an HMD eye channel on a monitor so other people can see what the user of the HMD is seeing. More...

virtual makArchives::DtVirtualRealitySettingsRecord::DtMirroring	mirroring () const
	Get the current state of mirroring the HMD to a monitor. More...

virtual void	setMirrorChannel (const std::string &channelName)
	Sets the display channel using a window and channel name (i.e. More...

virtual const std::string &	mirrorChannel () const
	Gets the mirror display channel using a window and channel name (i.e. "Window 1:Channel 1") More...

virtual void	setAttachedObserver (const std::string &obsName)
	Sets the observer that the HMD is attached to. More...

virtual const std::string &	attachedObserver ()
	gets the names of the current attached observer More...

virtual void	setFlipOverlays (bool flip)
	flip overlays on the vertical axis. More...

virtual bool	flipOverlays () const
	get the flip overlays settings More...

virtual void	setPreferOpenVR (bool prefer)
	set using the openVR provider if available instead of the oculus provider. More...

virtual bool	preferOpenVR () const
	use the openVR provider if available instead of the oculus provider this setting is not in the GUI More...

virtual void	setUseMultiView (bool use)
	set preference to use multiview extension if available More...

virtual bool	useMultiView () const
	use multiview extension if available More...

virtual void	setDisableDepthCopy (bool use)
	set preference to disable depth copy More...

virtual bool	disableDepthCopy () const
	is depth copy disabled More...

virtual void	setEnableMixedRealityMask (bool enable)
	set mixed reality mask enaled state More...

virtual bool	enableMixedRealityMask () const
	use multiview extension if available More...

virtual void	setMixedRealityDefinitionFilePath (const std::string &filePath, bool autoLoad=true)
	set mixed reality definition file path More...

virtual const std::string &	mixedRealityDefinitionFilePath () const
	returns the current mixed reality definition file path More...

void	setEnableRealWorldDepthTesting (bool enable)
	set preference to enable real world depth testing More...

bool	enableRealWorldDepthTesting () const
	should enable real world depth testing in MR More...

Setting persistence methods.
Use the settings from the given settings record.
virtual void	setFromRecord (const makArchives::DtVirtualRealitySettingsRecord &rec)
	Set the current settings' state from the given record (abstract). More...

virtual void	getRecord (makArchives::DtVirtualRealitySettingsRecord &rec) const
	Populate the given record with the current settings. More...

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

virtual	~DtBaseSettingsManager ()
	Virtual DTOR. More...

virtual void	initializeBackup ()
	Creates a backup of the settings' current state. More...

Public Member Functions inherited from makVrv::DtCommonBaseSettingsManager< makArchives::DtVirtualRealitySettingsRecord >
	DtCommonBaseSettingsManager (DtDe &de, const std::string &name, const std::string &displayName, const std::string &ext)
	CTOR The name, displayName, and extension parameters are used for creating the settings object (DtDeSettings) and backup, and for constructing the filename when readin/writing the records to disk. More...

virtual	~DtCommonBaseSettingsManager ()
	Virtual DTOR. More...

virtual void	autoSaveIfNecessary ()
	Saves the current settings as defaults if autosave is enabled. More...

virtual void	setAutoSave (bool doit)
	Sets whether autosave is enabled for the settings manager. More...

virtual bool	autoSave () const
	Gets whether autosave is enabled for the settings manager. More...

virtual void	setUseDefaultSettingsRecord (bool useit)
	Sets whether setting initialization should check for a default record. More...

virtual bool	useDefaultSettingsRecord () const
	Gets whether setting initialization should check for a default record. More...

virtual DtDeSettings *	settings ()
	Accessor for the manager's DtDeSettings object. More...

virtual const DtDeSettings *	settings () const
	Accessor for the manager's DtDeSettings object (const). More...

virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the manager's settings backup. More...

virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the manager's settings backup (const). More...

virtual void	loadDefaults ()
	Initializes the settings and creates a backup. More...

virtual void	saveDefaultSettings ()
	Saves the current settings' state as the default (on disk). More...

virtual void	loadDefaultSettings (bool loadOnlyFactorySettings)
	Loads the default settings from disk. More...

virtual void	importSettings (const std::string &filePath)
	Load the settings' state from the given file. More...

virtual void	exportSettings (const std::string &filePath) const
	Save the current settings' state to the given file. More...

virtual void	getSplitRecord (std::vector< makArchives::DtVirtualRealitySettingsRecord > &rec, std::vector< std::string > &fileNames)
	For directory support, split the main record into different sub-records and give them each a file name. More...

virtual void	addRecords (makArchives::DtVirtualRealitySettingsRecord &rec, makArchives::DtVirtualRealitySettingsRecord &combinedRec)
	For directory support, when reading in a directory, add the records from each file to the combined record. More...

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...

virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Member Functions
static DtVirtualRealitySettingsManager &	instance (DtDe &de)
	Get an instance of the settings manager. More...

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
	signals when the HMD mirror state changes More...

boost::signalslib::signal < void(std::string)>	signal_mirrorChannelChanged
	signaled when the channel that the user wants to display the HMD mirror on changes More...

boost::signalslib::signal < void(std::string)>	signal_attachedObserverChanged
	signaled when the attached observer changes More...

boost::signalslib::signal < void(bool)>	signal_flipOverlaysChanged
	signaled when the flip overlay changes More...

boost::signalslib::signal < void(bool)>	signal_useMultiViewChanged
	signaled when use multiview changes More...

boost::signalslib::signal < void(bool)>	signal_disableDepthCopyChanged
	signaled when use multiview changes More...

boost::signalslib::signal < void(bool)>	signal_enableMixedRealityMaskChanged
	signaled when enable mixed reality mask changes More...

boost::signalslib::signal < void(bool)>	signal_enableRealWorldDepthTestingChanged
	signaled when enable mixed reality mask changes More...

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 &)
	Protected CTOR ( use instance(..) ) More...

	DtVirtualRealitySettingsManager (const DtVirtualRealitySettingsManager &orig)
	prevent copy constructor More...

DtVirtualRealitySettingsManager &	operator= (const DtVirtualRealitySettingsManager &orig)
	prevent assignment operator More...

Friends
template<typename ManagerClass >
ManagerClass &	defaultManagerInstanceFunction (DtDe &, bool)
	Befriend the manager instance functions for instance retrieval / creation. More...

template<typename ManagerClass >
void	defaultManagerRegisterInstanceFunction (DtDe &, ManagerClass *)
	Befriend the manager instance functions for instance retrieval / creation. More...

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

Detailed Description

Contains the DtVirtualRealitySettingsManager class declaration.

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

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::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::setUseMultiView ( bool use )

virtual

set preference to use multiview extension if available

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

virtual

use multiview extension if available

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::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 & record )

virtual

Set the current settings' state from the given record (abstract).

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.

Manager requirements: 1) Static instance function 2) Protected DtSignalConnectionManager named myConnections. 3) Member functioned called loadDefaults which takes no arguments. and loads the default settings of the manager or factory from disk. 4) define defaultManagerInstanceFunction as friend. 5) define defaultManagerRegisterInstanceFunction as friend (see below). 5) Protected Constructor which only takes a DtDe reference.

*  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

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(bool)> makVrv::DtVirtualRealitySettingsManager::signal_flipOverlaysChanged

signaled when the flip overlay changes

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

signaled when use multiview changes

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

signaled when use multiview 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.vrf4-10-branch/include/vrvVirtualReality/DtVirtualRealitySettingsManager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation