scenarioEventManager.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file scenarioEventManager.h
//! \brief Defines the scenario event management system for VR-Engage
//!
//! This file contains the DtScenarioEventManager class which manages
//! scenario events within VR-Engage. It maintains a list of events
//! that can be accessed by the action menu and other components.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
 
#include <string>
#include <list>
#include <vreMessageManager/vreMessage.h>
 
namespace makVre
{
//! \brief Manager class for scenario events in VR-Engage
//!
//! DtScenarioEventManager maintains a registry of scenario events available
//! in the current simulation. These events can be triggered by the user through
//! the action menu or programmatically through other components. The manager
//! responds to discovery and removal messages to keep its list up to date.
class PLAYERSTATION_DLL DtScenarioEventManager
{
public:
   //! \brief Structure representing a scenario event
   //!
   //! ScenarioEvent encapsulates the information about a single scenario event,
   //! including its user-friendly name and unique identifier.
   struct ScenarioEvent
   {
      //! \brief Constructor
      //! \param newName Display name of the event
      //! \param newUuid Unique identifier for the event
      //!
      //! Creates a new scenario event entry with the specified name and UUID.
      ScenarioEvent(const std::string& newName, const std::string& newUuid)
         : name(newName)
         , uuid(newUuid)
      {
      }
 
      //! \brief Display name of the event
      std::string name;
 
      //! \brief Unique identifier for the event
      std::string uuid;
   };
 
   //! \brief Constructor
   //!
   //! Creates a new scenario event manager with an empty event list.
   DtScenarioEventManager();
 
   //! \brief Virtual destructor
   //!
   //! Ensures proper cleanup of the scenario event manager.
   virtual ~DtScenarioEventManager();
 
   //! \brief Gets the list of available scenario events
   //! \return Reference to the list of scenario events
   //!
   //! Provides access to the current list of available scenario events.
   //! This is typically used by the action menu to populate event-related options.
   virtual std::list<ScenarioEvent>& scenarioEvents() { return myEvents; }
 
protected:
   //! \brief Handles event discovery messages
   //! \param msg Pointer to the discovery message
   //! \return Message handling result
   //!
   //! Processes messages about newly discovered scenario events,
   //! adding them to the event registry if they aren't already present.
   virtual makVre::DtVreMessageResult handleDiscoverEvent(makVre::DtVreMessage* msg);
 
   //! \brief Handles event removal messages
   //! \param msg Pointer to the removal message
   //! \return Message handling result
   //!
   //! Processes messages about removed scenario events,
   //! removing them from the event registry if they exist.
   virtual makVre::DtVreMessageResult handleRemoveEvent(makVre::DtVreMessage* msg);
 
   //! \brief List of currently available scenario events
   //!
   //! Contains all scenario events that have been discovered and not yet removed.
   std::list<ScenarioEvent> myEvents;
};
} // namespace makVre