endingSessionState.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file endingSessionState.h
//! \brief Defines the state for cleanly terminating a simulation session
//!
//! This file contains the DtEndingSessionState class which manages the application
//! state when a simulation session is being terminated. It handles the orderly
//! shutdown of session resources, network connections, and UI transitions required
//! when exiting a session.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include "vrePlayerStation/playerStationState.h"
#include "vreMessageManager/vreMessage.h"
 
// #include <memory>
 
namespace makVre
{
//! \brief Forward declaration of the session load data message class
class SessionLoadDataMessage;
 
//! \brief Application state for terminating a simulation session
//!
//! 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.
class PLAYERSTATION_DLL DtEndingSessionState : virtual public DtPlayerStationState
{
public:
   //! \brief Constructor
   //! \param app Reference 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.
   DtEndingSessionState(DtPlayerStationApp& app);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of resources used by the ending session state.
   virtual ~DtEndingSessionState() override;
 
   //! \brief Called when the state is entered
   //! \param args Pointer 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.
   virtual void onEnter(const DtPlayerStationStateArgs* args) override;
 
   //! \brief 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.
   virtual void onExit() override;
 
   //! \brief Updates the state each frame
   //! \param dt Time 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.
   virtual void tick(double dt) override;
 
protected:
   //! \brief Handles session status messages
   //! \param msg Pointer to the session status message
   //! \return 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.
   virtual DtVreMessageResult handleVrfSessionStatus(DtVreMessage* msg);
};
 
} // namespace makVre