lightsSirensControlLogic.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file lightsSirensControlLogic.h
//! \brief Component for controlling vehicle emergency lights and sirens
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
 
#include "vrePlayerStation/playerComponent.h"
 
#include "vreMessageManager/vreMessage.h"
 
namespace makVre
{
class DtInitTable;
 
namespace LightsSirensControlLogicConfig
{
//! \ingroup RoleConfigParams
//! \defgroup LightsSirensControlLogicRoleParams Lights Sirens Control Logic Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for lights and sirens control logic role.
//! @{
 
//! \vreRoleParam{lights,table,{},lightsSirensControlLogic,Table of light configuration entries defining available emergency lights and their properties.}
constexpr const char* lights = "lights";
 
//! \vreRoleParam{sirens,table,{},lightsSirensControlLogic,Table of siren names for creating siren control state attributes.}
constexpr const char* sirens = "sirens";
 
//! @}
} // namespace LightsSirensControlLogicConfig
}
 
//! \brief Type identifier for DtLightsSirensControlLogic component
constexpr const char* DtLightsSirensControlLogicType = "DtLightsSirensControlLogic";
 
//! \brief Component that provides control of vehicle emergency lights and sirens
//!
//! DtLightsSirensControlLogic allows toggling of emergency lights and sirens
//! on vehicles. It maintains the state of various light types and sirens,
//! handles menu actions for toggling them, and updates their states based on
//! player inputs.
class VRECOMMONCOMPONENTS_DLL DtLightsSirensControlLogic : public makVre::DtPlayerComponent
{
public:
   //! \brief Constructor for DtLightsSirensControlLogic
   //!
   //! Initializes the component with default values
   DtLightsSirensControlLogic();
 
   //! \brief Virtual destructor for DtLightsSirensControlLogic
   virtual ~DtLightsSirensControlLogic() override;
 
   //! \brief Initializes the lights and sirens control component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing lights and sirens settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Configures the available lights and sirens from the configuration table,
   //! initializes state attributes, and sets up message handlers for menu actions
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Called every frame to update lights and sirens states
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Updates player attributes for all configured lights based on the entity's
   //! current appearance and light states
   virtual void tick(double dt) override;
 
   //! \brief Shuts down the lights and sirens control component
   //!
   //! Removes message handlers and performs cleanup operations
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
   //! \brief Toggles the state of a specific siren
   //! \param sirenName Name of the siren to toggle
   //!
   //! Inverts the current state of the specified siren and updates
   //! the corresponding player attribute
   virtual void toggleSiren(const std::string& sirenName);
 
   //! \brief Toggles the state of a specific light
   //! \param lightName Name of the light to toggle
   //!
   //! Inverts the current state of the specified light, updates the
   //! corresponding player attribute, and sends a VrfSetLightStateMessage
   //! to update the visual appearance of the vehicle
   virtual void toggleLight(const std::string& lightName);
 
protected:
   //! \brief Type definition for mapping light names to their light type IDs
   using LightMap = std::map<std::string, int>;
 
   //! \brief Map associating light names with their corresponding light type IDs
   //!
   //! Maps configuration-defined light names (e.g., "headlights", "brake_lights")
   //! to their corresponding DtLightType enumeration values
   LightMap myLightMap;
 
   //! \brief Handles menu action messages for lights and sirens
   //! \param msg The message to handle
   //! \return Message handling result indicating if the message was handled
   //!
   //! Processes "toggleSiren" and "toggleLights" menu actions with a parameter
   //! indicating which specific light or siren to toggle
   virtual makVre::DtVreMessageResult handleMenuMessage(makVre::DtVreMessage* msg);
};