Detailed Description

This class manages the UI for selecting observer views (roles) in VR-Engage. It displays a list of available roles, handles user selection, and provides mechanisms for filtering and navigating the available views.

#include <vreChooseRolePage.h>

Inheritance diagram for makVre::DtVreChooseRolePage:

[legend]

Public Slots
virtual void	slot_exitOpened () override

virtual void	slot_exitClosed () override

virtual void	slot_helpOpened () override

virtual void	slot_helpClosed () override

virtual void	slot_settingsOpened () override

virtual void	slot_settingsClosed () override

virtual void	slot_connectionClicked () override

Public Slots inherited from makVre::DtVreHeaderFooterUIBase
virtual void	slot_settingsOpened ()

virtual void	slot_settingsClosed ()

virtual void	slot_displayEngineConfigClicked ()

virtual void	slot_weatherAndEnvClicked ()

virtual void	slot_advancedVisualSettingsClicked ()

virtual void	slot_aboutClicked ()

virtual void	slot_soundVolumeChanged (qreal volume)

virtual void	slot_soundEnabledChanged (bool enabled)

virtual void	slot_exitOpened ()

virtual void	slot_exitClosed ()

virtual void	slot_exitAccepted ()

virtual void	slot_exitRejected ()

virtual void	slot_playClicked ()

virtual void	slot_pauseClicked ()

virtual void	slot_rewindClicked ()

virtual void	slot_connectionClicked ()

virtual void	slot_helpOpened ()

virtual void	slot_helpClosed ()

virtual void	slot_backClicked ()

Public Member Functions
	DtVreChooseRolePage (DtPlayerStationApp &app, const std::string &target_window="")

virtual	~DtVreChooseRolePage () override

virtual void	tick (double dt) override

virtual void	initMain () override

virtual void	setChooseRoleBackgroundVisibility (bool visible)

virtual void	setObserverViewsVisibility (bool visible)

virtual void	setLockdownModeIndicatorVisibility (bool visible, bool overrideLockdown=false)

virtual void	setLockdownModeIndicatorText (const QString &text)

virtual Q_INVOKABLE void	observerViewClicked (QString observerName, bool animated=false)

virtual void	setVisibility (bool visible) override

virtual void	appModeUpdated (const std::string &newAppMode, const std::string &oldAppMode) override

Public Member Functions inherited from makVre::DtVreHeaderFooterUIBase
	DtVreHeaderFooterUIBase (DtPlayerStationApp &app, const std::string &file, const std::string &target_window="")

	DtVreHeaderFooterUIBase (DtPlayerStationApp &app, const std::string &file, const std::string &headerId, const std::string &footerId, const std::string &mainContentId, const std::string &target_window)

virtual	~DtVreHeaderFooterUIBase () override

QQuickItem *	root ()

virtual bool	isVisible ()

virtual void	close ()

virtual void	open ()

virtual void	initHeader ()

virtual bool	isHeaderVisible ()

virtual void	setHeaderVisiblility (bool visible)

virtual void	setMenuTitle (const QString &title)

virtual void	setShowCutoutVisible (bool visible)

virtual void	setButtonEnabled (const std::string &id, bool enabled)

virtual bool	isButtonEnabled (const std::string &id)

virtual void	setAllCutoutControlsEnabled (bool enabled)

virtual void	setShowTopRightControlsVisible (bool visible)

virtual void	initFooter ()

virtual bool	isFooterVisible ()

virtual void	setFooterVisiblility (bool visible)

virtual void	setShowBottomBackButtonVisible (bool visible)

virtual bool	isMainContentVisible ()

virtual void	setMainContentVisibility (bool visible)

virtual void	registerMessageHandlers ()

virtual void	deregisterMessageHandlers ()

DtVreMessageResult	handleBackButtonClicked (DtVreMessage *msg)

DtVreMessageResult	handleEscapeMessage (DtVreMessage *msg)

Protected Member Functions
DtVreMessageResult	handleBackButtonClicked (DtVreMessage *msg)

virtual void	slot_observerViewsChanged (const makArchives::DtObserverStateRecordsList &observerViewList)

virtual void	slot_observerViewsCleared ()

virtual void	slot_observerViewAdded (const makArchives::DtObserverStateRecord &observerView)

virtual void	slot_observerViewRemoved (const makArchives::DtObserverStateRecord &observerView)

virtual void	slot_observerViewRenamed (const std::string &oldName, const makArchives::DtObserverStateRecord &observerView)

Protected Member Functions inherited from makVre::DtVreHeaderFooterUIBase
virtual void	runningStateUpdated (bool runState)

virtual void	closeAllSettingsPages (std::string pageName="")

virtual void	updateModalState (bool open)

DtVreMessageResult	handleApplicationMode (DtVreMessage *msg)

DtVreMessageResult	handleSessionPlayState (DtVreMessage *msg)

DtVreMessageResult	handleToggleHelp (DtVreMessage *msg)

Protected Attributes
DtObserverViewsQmlModel	myObserverViewsModel

makVrv::DtObserverViewsManager &	myObserverViewsManager

Protected Attributes inherited from makVre::DtVreHeaderFooterUIBase
DtPlayerStationApp &	myApp

QQuickItem *	myRoot

std::string	myTargetWindow

std::string	myTargetFile

std::string	myHeaderId

std::string	myFooterId

std::string	myMainContentId

Constructor & Destructor Documentation

◆ DtVreChooseRolePage()

makVre::DtVreChooseRolePage::DtVreChooseRolePage	(	DtPlayerStationApp &	app,
		const std::string &	target_window = "" )

Constructor.

Parameters

app	Reference to the player station application
target_window	The target window name (optional)

Creates a new choose role page for the specified application and window.

◆ ~DtVreChooseRolePage()

virtual makVre::DtVreChooseRolePage::~DtVreChooseRolePage ( )

overridevirtual

Destructor.

Cleans up resources used by the choose role page.

Member Function Documentation

◆ tick()

virtual void makVre::DtVreChooseRolePage::tick ( double dt )

overridevirtual

Updates the page state.

Parameters

dt	The time elapsed since the last update in seconds

Performs periodic updates of the page state and components.

Implements makVre::DtVreHeaderFooterUIBase.

◆ initMain()

virtual void makVre::DtVreChooseRolePage::initMain ( )

overridevirtual

Initializes the main UI components.

Sets up the initial state of the page and its components.

Implements makVre::DtVreHeaderFooterUIBase.

◆ setChooseRoleBackgroundVisibility()

virtual void makVre::DtVreChooseRolePage::setChooseRoleBackgroundVisibility ( bool visible )

virtual

Sets the visibility of the role selection background.

Parameters

visible True to show the background, false to hide it

◆ setObserverViewsVisibility()

virtual void makVre::DtVreChooseRolePage::setObserverViewsVisibility ( bool visible )

virtual

Sets the visibility of the observer views list.

Parameters

visible True to show the observer views, false to hide them

◆ setLockdownModeIndicatorVisibility()

virtual void makVre::DtVreChooseRolePage::setLockdownModeIndicatorVisibility	(	bool	visible,
		bool	overrideLockdown = false )

virtual

Sets the visibility of the lockdown mode indicator.

Parameters

visible	True to show the indicator, false to hide it
overrideLockdown	If true, shows the indicator even if not in lockdown mode

◆ setLockdownModeIndicatorText()

virtual void makVre::DtVreChooseRolePage::setLockdownModeIndicatorText ( const QString & text )

virtual

Sets the text of the lockdown mode indicator.

Parameters

text	The text to display in the lockdown mode indicator

◆ observerViewClicked()

virtual Q_INVOKABLE void makVre::DtVreChooseRolePage::observerViewClicked	(	QString	observerName,
		bool	animated = false )

virtual

Handles a click on an observer view.

Parameters

observerName	The name of the observer view that was clicked
animated	Whether to animate the transition (default: false)

This method is invokable from QML and handles selection of an observer view.

◆ setVisibility()

virtual void makVre::DtVreChooseRolePage::setVisibility ( bool visible )

overridevirtual

Sets the visibility of the page.

Parameters

visible True to show the page, false to hide it \override Override of the base class method with additional functionality

Reimplemented from makVre::DtVreHeaderFooterUIBase.

◆ appModeUpdated()

virtual void makVre::DtVreChooseRolePage::appModeUpdated	(	const std::string &	newAppMode,
		const std::string &	oldAppMode )

overridevirtual

Handles application mode changes.

Parameters

newAppMode	The new application mode
oldAppMode	The previous application mode \override Override of the base class method to update UI based on app mode

Reimplemented from makVre::DtVreHeaderFooterUIBase.

◆ slot_exitOpened

virtual void makVre::DtVreChooseRolePage::slot_exitOpened ( )

overridevirtualslot

Handles the exit dialog being opened \override Override of the base class method.

◆ slot_exitClosed

virtual void makVre::DtVreChooseRolePage::slot_exitClosed ( )

overridevirtualslot

Handles the exit dialog being closed \override Override of the base class method.

◆ slot_helpOpened

virtual void makVre::DtVreChooseRolePage::slot_helpOpened ( )

overridevirtualslot

Handles the help dialog being opened \override Override of the base class method.

◆ slot_helpClosed

virtual void makVre::DtVreChooseRolePage::slot_helpClosed ( )

overridevirtualslot

Handles the help dialog being closed \override Override of the base class method.

◆ slot_settingsOpened

virtual void makVre::DtVreChooseRolePage::slot_settingsOpened ( )

overridevirtualslot

Handles the settings dialog being opened \override Override of the base class method.

◆ slot_settingsClosed

virtual void makVre::DtVreChooseRolePage::slot_settingsClosed ( )

overridevirtualslot

Handles the settings dialog being closed \override Override of the base class method.

◆ slot_connectionClicked

virtual void makVre::DtVreChooseRolePage::slot_connectionClicked ( )

overridevirtualslot

Handles the connection button being clicked \override Override of the base class method.

◆ handleBackButtonClicked()

DtVreMessageResult makVre::DtVreChooseRolePage::handleBackButtonClicked ( DtVreMessage * msg )

protected

Handles back button clicks.

Parameters

msg	The message containing back button click information

Returns: Message handling result (HANDLED or IGNORED)

◆ slot_observerViewsChanged()

virtual void makVre::DtVreChooseRolePage::slot_observerViewsChanged ( const makArchives::DtObserverStateRecordsList & observerViewList )

protectedvirtual

Handles changes to the observer views list.

Parameters

observerViewList The updated list of observer views

◆ slot_observerViewsCleared()

virtual void makVre::DtVreChooseRolePage::slot_observerViewsCleared ( )

protectedvirtual

Handles clearing of all observer views.

◆ slot_observerViewAdded()

virtual void makVre::DtVreChooseRolePage::slot_observerViewAdded ( const makArchives::DtObserverStateRecord & observerView )

protectedvirtual

Handles addition of a new observer view.

Parameters

observerView The observer view that was added

◆ slot_observerViewRemoved()

virtual void makVre::DtVreChooseRolePage::slot_observerViewRemoved ( const makArchives::DtObserverStateRecord & observerView )

protectedvirtual

Handles removal of an observer view.

Parameters

observerView The observer view that was removed

◆ slot_observerViewRenamed()

virtual void makVre::DtVreChooseRolePage::slot_observerViewRenamed	(	const std::string &	oldName,
		const makArchives::DtObserverStateRecord &	observerView )

protectedvirtual

Handles renaming of an observer view.

Parameters

oldName	The previous name of the observer view
observerView	The observer view with its new name

Member Data Documentation

◆ myObserverViewsModel

DtObserverViewsQmlModel makVre::DtVreChooseRolePage::myObserverViewsModel

protected

Model containing the observer views to display.

◆ myObserverViewsManager

makVrv::DtObserverViewsManager& makVre::DtVreChooseRolePage::myObserverViewsManager

protected

Reference to the manager of observer views.

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

include/framework/vrePlayerStation/vreChooseRolePage.h

Detailed Description

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ DtVreChooseRolePage()

◆ ~DtVreChooseRolePage()

Member Function Documentation

◆ tick()

◆ initMain()

◆ setChooseRoleBackgroundVisibility()

◆ setObserverViewsVisibility()

◆ setLockdownModeIndicatorVisibility()

◆ setLockdownModeIndicatorText()

◆ observerViewClicked()

◆ setVisibility()

◆ appModeUpdated()

◆ slot_exitOpened

◆ slot_exitClosed

◆ slot_helpOpened

◆ slot_helpClosed

◆ slot_settingsOpened

◆ slot_settingsClosed

◆ slot_connectionClicked

◆ handleBackButtonClicked()

◆ slot_observerViewsChanged()

◆ slot_observerViewsCleared()

◆ slot_observerViewAdded()

◆ slot_observerViewRemoved()

◆ slot_observerViewRenamed()

Member Data Documentation

◆ myObserverViewsModel

◆ myObserverViewsManager