VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtEndingSessionState Class Reference

Detailed Description

DtEndingSessionState represents the application state when VR-Engage is in the process of terminating a simulation session. It manages the orderly shutdown of session resources, sending appropriate disconnect messages to network peers, and transitioning to the appropriate next state once the session has been fully terminated.

#include <endingSessionState.h>

Inheritance diagram for makVre::DtEndingSessionState:
[legend]

Public Member Functions

 DtEndingSessionState (DtPlayerStationApp &app)
 
virtual ~DtEndingSessionState () override
 
virtual void onEnter (const DtPlayerStationStateArgs *args) override
 
virtual void onExit () override
 
virtual void tick (double dt) override
 
- Public Member Functions inherited from makVre::DtPlayerStationState
 DtPlayerStationState (DtPlayerStationApp &app, std::string stateType)
 
virtual ~DtPlayerStationState ()
 
 DtPlayerStationState (const DtPlayerStationState &)=delete
 
DtPlayerStationStateoperator= (const DtPlayerStationState &)=delete
 
virtual void onEnter ()
 
virtual void onStacked ()
 
virtual void onExposed (const DtPlayerStationStateArgs *args)
 
virtual void onExposed ()
 
bool active () const
 
bool exposed () const
 
bool exiting () const
 
bool stacking () const
 
const std::string & stateType () const
 
DtPlayerStationAppapp () const
 

Protected Member Functions

virtual DtVreMessageResult handleVrfSessionStatus (DtVreMessage *msg)
 
- Protected Member Functions inherited from makVre::DtPlayerStationState
bool pushState (const std::string &newState, DtPlayerStationStateArgs *args=NULL)
 
bool popSelf ()
 
bool popUntilSelf ()
 
bool popUntilState (const std::string &parentState, DtPlayerStationStateArgs *args=NULL)
 
bool switchToState (const std::string &newState, DtPlayerStationStateArgs *args=NULL)
 
bool pushSelf ()
 

Additional Inherited Members

- Protected Attributes inherited from makVre::DtPlayerStationState
DtPlayerStationAppmyApp
 

Constructor & Destructor Documentation

◆ DtEndingSessionState()

makVre::DtEndingSessionState::DtEndingSessionState ( DtPlayerStationApp & app)

Constructor.

Parameters
appReference to the player station application

Creates a new ending session state associated with the given application. This state is entered when a session is being terminated, either by user request or due to network disconnection.

References makVre::DtPlayerStationState::app().

◆ ~DtEndingSessionState()

virtual makVre::DtEndingSessionState::~DtEndingSessionState ( )
overridevirtual

Virtual destructor.

Ensures proper cleanup of resources used by the ending session state.

Member Function Documentation

◆ onEnter()

virtual void makVre::DtEndingSessionState::onEnter ( const DtPlayerStationStateArgs * args)
overridevirtual

Called when the state is entered.

Parameters
argsPointer to arguments from the previous state

Initializes the session termination process, sends disconnect notifications to network peers, and begins cleanup of session resources. Takes session information from the previous state's arguments if available.

Reimplemented from makVre::DtPlayerStationState.

◆ onExit()

virtual void makVre::DtEndingSessionState::onExit ( )
overridevirtual

Called when the state is exited.

Completes final cleanup of any remaining session resources and prepares the application for the next state. This is called after session termination is complete.

Reimplemented from makVre::DtPlayerStationState.

◆ tick()

virtual void makVre::DtEndingSessionState::tick ( double dt)
overridevirtual

Updates the state each frame.

Parameters
dtTime in seconds since the last update

Monitors the progress of session termination processes, updates UI elements with status information, and transitions to the next state when termination is complete.

Reimplemented from makVre::DtPlayerStationState.

◆ handleVrfSessionStatus()

virtual DtVreMessageResult makVre::DtEndingSessionState::handleVrfSessionStatus ( DtVreMessage * msg)
protectedvirtual

Handles session status messages.

Parameters
msgPointer to the session status message
Returns
Message handling result

Processes notifications about changes to the VRF session status, updating the termination process based on current session state. This is particularly important for monitoring when disconnection from the session is complete.


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