Detailed Description

This abstract class defines the interface for interacting with the virtual reality settings GUI. It provides signals that are emitted when the user changes settings in the UI, and setter methods that allow the application to update the UI to reflect current settings. Implementations of this interface serve as the bridge between the UI and the underlying virtual reality system.

#include <DtVirtualRealitySettingsInterface.h>

Inheritance diagram for makVrv::DtVirtualRealitySettingsInterface:

[legend]

Public Member Functions
virtual	~DtVirtualRealitySettingsInterface ()

UI Update Methods
virtual void	setEnabled (bool enabled)=0

virtual void	setMirroring (makArchives::DtVirtualRealitySettingsRecord::DtMirroring view)=0

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

virtual void	setVirtualRealityAvailable (bool available)=0

virtual void	setChannelNames (const std::vector< std::string > &names)=0

virtual void	setObserverNames (const std::vector< std::string > &names)=0

virtual void	setAttachedObserver (const std::string &observerName)=0

virtual void	setFlipOverlay (bool flip)=0

virtual void	setFlipOverlayEnabled (bool enabled)=0

Public Attributes

Signal Declarations

Signal emitted when the VR enabled state is changed

This signal is emitted when the user toggles the virtual reality enabled checkbox in the UI.

Parameters

enabled The new enabled state (true if enabled, false if 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(bool)> signal_flipOverlaysChanged

Constructor & Destructor Documentation

◆ ~DtVirtualRealitySettingsInterface()

virtual makVrv::DtVirtualRealitySettingsInterface::~DtVirtualRealitySettingsInterface ( )

virtual

Virtual destructor.

Ensures proper cleanup of resources in derived classes.

Member Function Documentation

◆ setEnabled()

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

pure virtual

Updates the VR enabled state in the UI.

Parameters

enabled True to check the enabled checkbox, false to uncheck it

Sets the state of the virtual reality enabled checkbox in the UI. This should be called when the VR enabled state changes outside the UI.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

◆ setMirroring()

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

pure virtual

Updates the mirroring mode in the UI.

Parameters

view	The mirroring mode to select in the UI

Sets the selected option in the mirroring mode dropdown in the UI. This should be called when the mirroring mode changes outside the UI.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

◆ setMirrorChannel()

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

pure virtual

Updates the selected mirror channel in the UI.

Parameters

channelName The name of the channel to select in the UI

Sets the selected option in the mirror channel dropdown in the UI. This should be called when the mirror channel changes outside the UI.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

◆ setVirtualRealityAvailable()

virtual void makVrv::DtVirtualRealitySettingsInterface::setVirtualRealityAvailable ( bool available )

pure virtual

Updates the VR hardware availability state in the UI.

Parameters

available True if VR hardware is available, false otherwise

Enables or disables the VR settings controls based on hardware availability. When hardware is unavailable, the UI should indicate this and disable controls that require hardware to function.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

◆ setChannelNames()

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

pure virtual

Updates the list of available mirror channels in the UI.

Parameters

names Vector of channel names to populate the dropdown with

Populates the mirror channel dropdown with the provided list of channel names. This should be called when the available channels change.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

◆ setObserverNames()

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

pure virtual

Updates the list of available observers in the UI.

Parameters

names Vector of observer names to populate the dropdown with

Populates the observer dropdown with the provided list of observer names. This should be called when the available observers change.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

◆ setAttachedObserver()

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

pure virtual

Updates the selected attached observer in the UI.

Parameters

observerName The name of the observer to select in the UI

Sets the selected option in the observer dropdown in the UI. This should be called when the attached observer changes outside the UI.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

◆ setFlipOverlay()

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

pure virtual

Updates the flip overlays setting in the UI.

Parameters

flip	True to check the flip overlays checkbox, false to uncheck it

Sets the state of the flip overlays checkbox in the UI. Flipping overlays may be necessary to correct their orientation on certain HMD models. This should be called when the flip overlays setting changes outside the UI.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

◆ setFlipOverlayEnabled()

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

pure virtual

Enables or disables the flip overlays control in the UI.

Parameters

enabled True to enable the control, false to disable it

Enables or disables the flip overlays checkbox in the UI. This control should be disabled when flipping overlays is not supported by the current HMD model or configuration.

Implemented in makVrv::DtVirtualRealitySettingsWidget.

Member Data Documentation

◆ signal_enabledChanged

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

Signal emitted when the mirroring mode is changed.

This signal is emitted when the user selects a different mirroring option from the dropdown in the UI.

Parameters

mirroring The new mirroring mode selected

◆ signal_mirroringChanged

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

Signal emitted when the mirroring mode is changed.

This signal is emitted when the user selects a different mirroring option from the dropdown in the UI.

Parameters

mirroring The new mirroring mode selected

◆ signal_mirrorChannelChanged

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

Signal emitted when the mirror channel is changed.

This signal is emitted when the user selects a different channel for mirroring the HMD view in the UI.

Parameters

channelName The name of the selected mirror channel

◆ signal_attachedObserverChanged

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

Signal emitted when the attached observer is changed.

This signal is emitted when the user selects a different observer to attach the HMD view to in the UI.

Parameters

observerName The name of the selected observer

◆ signal_flipOverlaysChanged

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

Signal emitted when the flip overlays setting is changed.

This signal is emitted when the user toggles the flip overlays checkbox in the UI. Flipping overlays may be necessary to correct their orientation on certain HMD models.

Parameters

flip	True if overlays should be flipped, false otherwise

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

include/vrvExtensions/vrvVirtualRealityQt/DtVirtualRealitySettingsInterface.h

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ ~DtVirtualRealitySettingsInterface()

Member Function Documentation

◆ setEnabled()

◆ setMirroring()

◆ setMirrorChannel()

◆ setVirtualRealityAvailable()

◆ setChannelNames()

◆ setObserverNames()

◆ setAttachedObserver()

◆ setFlipOverlay()

◆ setFlipOverlayEnabled()

Member Data Documentation

◆ signal_enabledChanged

◆ signal_mirroringChanged

◆ signal_mirrorChannelChanged

◆ signal_attachedObserverChanged

◆ signal_flipOverlaysChanged