initializationState.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file initializationState.h
//! \brief Defines the initialization state for the VR-Engage application
//!
//! This file contains the DtInitializationState class which serves as the entry
//! point to the application state system. It is the first state to be executed
//! when the application starts, responsible for initializing resources and
//! transitioning to the appropriate next state.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include "vrePlayerStation/playerStationState.h"
 
namespace makVre
{
//! \brief Initial application state for VR-Engage
//!
//! DtInitializationState is the first state executed when the VR-Engage application
//! starts. It handles the initialization of critical components, system resources,
//! and configuration settings before transitioning to the appropriate operational
//! state, typically a connection or selection state.
//!
//! This state should perform minimal user-visible operations, focusing primarily
//! on behind-the-scenes setup work to prepare the application environment.
class PLAYERSTATION_DLL DtInitializationState : virtual public DtPlayerStationState
{
public:
   //! \brief Constructor
   //! \param app Reference to the player station application
   //!
   //! Creates a new initialization state associated with the given application.
   //! This is typically created by the application during startup.
   DtInitializationState(DtPlayerStationApp& app);
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of initialization state resources.
   virtual ~DtInitializationState() override;
 
   //! \brief Called when the state is entered
   //!
   //! Initializes application resources, subsystems, and configuration settings.
   //! This is the main initialization function that executes when the application
   //! starts, setting up everything needed for operation before transitioning
   //! to the next appropriate state.
   virtual void onEnter() override;
 
   //! \brief Called when the state is exited
   //!
   //! Performs cleanup of any temporary resources used during initialization.
   //! This is called when the application transitions from the initialization
   //! state to the next operational state.
   virtual void onExit() override;
 
   //! \brief Updates the state each frame
   //! \param dt Time in seconds since the last update
   //!
   //! Handles per-frame processing during initialization, which may include
   //! monitoring initialization progress, continuing asynchronous operations,
   //! and determining when to transition to the next state.
   virtual void tick(double dt) override;
};
 
} // namespace makVre