vrvPlayerStationDriver.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vrvPlayerStationDriver.h
//! \brief Contains DtPlayerStationDriver class - the main driver for the VR-Engage player station application
//!
//! This file defines the DtPlayerStationDriver class which manages the lifecycle
//! of the player station application, controls entity resolution, message processing,
//! and handles the connection between the VRV engine and the player station components.
 
#pragma once
 
 
#include <vrvCore/DtDriver.h>
#include "vrePlayerStation/playerStationApp.h"
#include "vrePlayerStation/playerStation.h"
#include "vrePlayerStation/export.h"
 
//! Forward declaration of exercise connection class
class DtExerciseConn;
 
namespace makVre
{
//! Forward declaration of audio manager class
class DtAudioManager;
} // namespace makVre
 
namespace makVrv
{
//! Forward declaration of display engine class
class DtDe;
 
//! Forward declaration of agent manager class
class DtAgentManager;
} // namespace makVrv
 
namespace makVre
{
//! Forward declaration of simulation event connector class
class DtSimEventConnector;
 
//! Forward declaration of intersector class
class DtIntersector;
 
//! Forward declaration of entity resolver class
class DtEntityResolver;
 
//! \brief A driver that controls the lifecycle and execution of the VR-Engage player station application
//!
//! The DtPlayerStationDriver class manages the lifecycle of the DtPlayerStationApp,
//! including initialization, update, and shutdown. It maintains the entity resolver,
//! provides intersection services, registers message handlers, and handles debug
//! functionality for the application.
class PLAYERSTATION_DLL DtPlayerStationDriver : public makVrv::DtDriver
{
public:
   //! \brief Constructor that initializes the driver and associated resources
   //! \param am Reference to the agent manager used for entity management
   //!
   //! Creates and initializes an instance of the DtEntityResolver for entity tracking.
   //! Initializes the DtEntityHelper instance with the new DtEntityResolver.
   //! Creates and initializes the instance of the DtVreMessageManager, and
   //! calls populateVreMessageFactory() to register the stock set of
   //! DtVreMessage creators.
   DtPlayerStationDriver(makVrv::DtAgentManager& am);
   //! \brief Virtual destructor that cleans up resources
   //!
   //! Deletes the entity resolver and application instance if they exist
   virtual ~DtPlayerStationDriver() override;
 
   //! \brief Gets the name of this C++ class
   //! \return String containing "DtPlayerStationDriver"
   virtual const std::string& className() const override;
 
   //! \brief Sets the player station application instance
   //! \param app Pointer to the top-level player station application instance
   //!
   //! Caches the application in myApp. Creates a new DtVrvIntersector instance
   //! and sets a pointer to it in the application's DtAttributeStore with the
   //! name "DtIntersector". Sets a pointer to the DtEntityResolver in the
   //! application's DtAttributeStore with the name "DtEntityResolver".
   virtual void setPlayerStationApp(makVre::DtPlayerStationApp* app);
 
   //! \brief Gets the current player station application instance
   //! \return Reference to the player station application
   //!
   //! Provides access to the current player station application instance
   virtual makVre::DtPlayerStationApp& playerStationApp();
 
   //! \brief Gets the entity resolver used by this driver
   //! \return Reference to the entity resolver instance
   //!
   //! Returns a reference to DtEntityResolver, the object used to
   //! maintain a mapping between the various identifiers associated with
   //! simulation objects in the VR-Engage front-end.
   virtual makVre::DtEntityResolver& connectionObjects();
 
   //! \brief Initializes the driver and associated components
   //! \return True if initialization was successful
   //!
   //! Installs the DtVreDebugManager and DtQtQuickRenderer instances,
   //! enables the display of audio capture device config in the GUI,
   //! and registers callback for DtVreMessage instances received for display
   //! in the SHIFT+F4 debug menu. Also logs graphics driver information.
   virtual bool onStart() override;
 
   //! \brief Shuts down the driver and associated components
   //! \return True if shutdown was successful
   //!
   //! Calls shutdown() on the DtPlayerStationApp instance and
   //! deletes it, and calls shutdown() on the DtVreDebugManager.
   virtual bool onStop() override;
 
   //! \brief Updates the driver and associated components every frame
   //! \return True if update was successful
   //!
   //! Calculates the time delta since the last frame, updates the
   //! DtVreMessageManager and DtPlayerStationApp instances.
   virtual bool onTick() override;
 
protected:
   //! \brief Registers all message types with the message factory
   //!
   //! Registers stock DtVreMessage class creators with the
   //! DtVreMessageFactory instance to allow creation and processing of
   //! all supported message types in the application.
   virtual void populateVreMessageFactory();
 
   //! \brief Logs graphics hardware and driver information
   //!
   //! Gathers vendor, renderer, OpenGL version, and driver information
   //! and writes it to the application log file for diagnostic purposes.
   virtual void logGraphics();
 
   //! \brief Displays debug information about received messages
   //!
   //! Presents the set of all DtVreMessages received this frame
   //! in the SHIFT+F4 Debug menu, including message types and counts.
   virtual void debugCallback();
 
protected:
   //! \brief Reference to the VR-Vantage display engine instance
   makVrv::DtDe& myDe;
 
   //! \brief The player station application instance
   //!
   //! Represents the VR-Engage application as a whole
   DtPlayerStationApp* myApp;
 
   //! \brief The intersection handler for the application
   //!
   //! DtVrvIntersector instance created by this class for use throughout the application.
   //! A pointer to it is stored in the DtPlayerStationApp instance's DtAttributeStore
   //! under the name "DtIntersector".
   DtIntersector* myIntersector;
 
   //! \brief The entity resolution system for the application
   //!
   //! DtEntityResolver instance created for looking up various types of identifiers
   //! objects may have in the application. A pointer to this instance is stored
   //! in the DtPlayerStationApp instance's DtAttributeStore under the name "DtEntityResolver".
   DtEntityResolver* myEntityResolver;
};
 
} // namespace makVre