VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
makVrv::DtVirtualRealitySettingsInterface Class Referenceabstract

Interface to the VirtualReality settings GUI. More...

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

Public Member Functions

virtual ~DtVirtualRealitySettingsInterface ()
 DTOR. More...
 
virtual void setEnabled (bool enabled)=0
 Setters. More...
 
virtual void setMirroring (makArchives::DtVirtualRealitySettingsRecord::DtMirroring view)=0
 Enable/disable mirroring of HMD view on display. More...
 
virtual void setMirrorChannel (const std::string &channelName)=0
 set the channel that the HMD view should be mirrored on More...
 
virtual void setVirtualRealityAvailable (bool vrAvailable, bool mrAvailable, bool depthAvailable)=0
 set whether or not virtual reality hardware is available More...
 
virtual void setChannelNames (const std::vector< std::string > &names)=0
 set the names of the potential channels that the HMD could be mirrored on More...
 
virtual void setObserverNames (const std::vector< std::string > &names)=0
 set the names of the potential observers that the HMD can be attached to More...
 
virtual void setAttachedObserver (const std::string &observerName)=0
 set the observer that the HMD view should be attached to More...
 
virtual void setFlipOverlay (bool flip)=0
 set if the overlays should be flipped on the vertical axis to look correct on the current HMD More...
 
virtual void setFlipOverlayEnabled (bool enabled)=0
 sets whether or not the user is allowed to flip the overlay More...
 
virtual void setUseMultiView (bool enabled)=0
 set multiview enabled state More...
 
virtual void setDisableDepthCopy (bool disable)=0
 set disable depth copy state More...
 
virtual void setEnableMixedRealityMask (bool enabled)=0
 set mixed reality mask enabled state More...
 
virtual void setMixedRealityDefinitionFilePath (std::string filePath)=0
 set the mixed reality definiton file path for display in text box More...
 
virtual void setEnableRealWorldDepthTesting (bool enabled)=0
 set real world depth testing enabled state More...
 

Public Attributes

boost::signalslib::signal
< void(bool)> 
signal_enabledChanged
 Signals. More...
 
boost::signalslib::signal
< void(makArchives::DtVirtualRealitySettingsRecord::DtMirroring)> 
signal_mirroringChanged
 Called when the user changes the mirroring drop down in the UI. More...
 
boost::signalslib::signal
< void(std::string)> 
signal_mirrorChannelChanged
 called when the user changes the mirroring type in the UI More...
 
boost::signalslib::signal
< void(std::string)> 
signal_attachedObserverChanged
 called when the user changes the attached observer in the UI More...
 
boost::signalslib::signal
< void(bool)> 
signal_flipOverlaysChanged
 called when the user changes the flip overlay check box in the UI More...
 
boost::signalslib::signal
< void(bool)> 
signal_useMultiViewChanged
 called when the user changes the use multiview check box in the UI More...
 
boost::signalslib::signal
< void(bool)> 
signal_disableDepthCopyChanged
 called when the user changes the disable depth copy check box in the UI More...
 
boost::signalslib::signal
< void(bool)> 
signal_enableMixedRealityMaskChanged
 called when the user changes the enable mixed reality mask check box in the UI More...
 
boost::signalslib::signal
< void(void)> 
signal_browseForMixedRealityDefinitionFilePushed
 called when the user clicks the browse for mixed reality mask definition file in the UI More...
 
boost::signalslib::signal
< void(bool)> 
signal_enableRealWorldDepthTestingChanged
 called when the user changes the enabled real world depth testing check box in the UI More...
 

Detailed Description

Interface to the VirtualReality settings GUI.

Constructor & Destructor Documentation

virtual makVrv::DtVirtualRealitySettingsInterface::~DtVirtualRealitySettingsInterface ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtVirtualRealitySettingsInterface::setEnabled ( bool  enabled)
pure virtual

Setters.

Sets the Virtual Reality check box enabled in the UI.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setMirroring ( makArchives::DtVirtualRealitySettingsRecord::DtMirroring  view)
pure virtual

Enable/disable mirroring of HMD view on display.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

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

set the channel that the HMD view should be mirrored on

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setVirtualRealityAvailable ( bool  vrAvailable,
bool  mrAvailable,
bool  depthAvailable 
)
pure virtual

set whether or not virtual reality hardware is available

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setChannelNames ( const std::vector< std::string > &  names)
pure virtual

set the names of the potential channels that the HMD could be mirrored on

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setObserverNames ( const std::vector< std::string > &  names)
pure virtual

set the names of the potential observers that the HMD can be attached to

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setAttachedObserver ( const std::string &  observerName)
pure virtual

set the observer that the HMD view should be attached to

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setFlipOverlay ( bool  flip)
pure virtual

set if the overlays should be flipped on the vertical axis to look correct on the current HMD

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setFlipOverlayEnabled ( bool  enabled)
pure virtual

sets whether or not the user is allowed to flip the overlay

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setUseMultiView ( bool  enabled)
pure virtual

set multiview enabled state

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setDisableDepthCopy ( bool  disable)
pure virtual

set disable depth copy state

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setEnableMixedRealityMask ( bool  enabled)
pure virtual

set mixed reality mask enabled state

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setMixedRealityDefinitionFilePath ( std::string  filePath)
pure virtual

set the mixed reality definiton file path for display in text box

Implemented in makVrv::DtVirtualRealitySettingsWidget.

virtual void makVrv::DtVirtualRealitySettingsInterface::setEnableRealWorldDepthTesting ( bool  enabled)
pure virtual

set real world depth testing enabled state

Implemented in makVrv::DtVirtualRealitySettingsWidget.

Member Data Documentation

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

Signals.

called when the user changes the Virtual Reality enabled check box in the UI

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

Called when the user changes the mirroring drop down in the UI.

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

called when the user changes the mirroring type in the UI

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

called when the user changes the attached observer in the UI

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

called when the user changes the flip overlay check box in the UI

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

called when the user changes the use multiview check box in the UI

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

called when the user changes the disable depth copy check box in the UI

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

called when the user changes the enable mixed reality mask check box in the UI

boost::signalslib::signal<void(void)> makVrv::DtVirtualRealitySettingsInterface::signal_browseForMixedRealityDefinitionFilePushed

called when the user clicks the browse for mixed reality mask definition file in the UI

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

called when the user changes the enabled real world depth testing check box in the UI


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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)