driverMenuLogic.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file driverMenuLogic.h
//! \brief Defines the DtDriverMenuLogic component for handling menu interactions for vehicle drivers.
//!
//! This component processes menu actions related to vehicle control and forwards them to the
//! DtDriverControlLogic component to execute the appropriate controls.
//!
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
 
#include "vrePlayerStation/playerComponent.h"
 
#include "vreMessageManager/vreMessage.h"
 
namespace makVre
{
//! \brief Forward declaration of the driver control logic class
class DtDriverControlLogic;
 
namespace DriverMenuLogicConfig
{
//! \ingroup RoleConfigParams
//! \defgroup DriverMenuLogicRoleParams Driver Menu Logic Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for driver menu logic role.
//! @{
 
// (No specific configuration parameters are currently used by DtDriverMenuLogic.)
 
//! @}
} // namespace DriverMenuLogicConfig
 
//! \brief Type identifier for DtDriverMenuLogic component
constexpr const char* DtDriverMenuLogicType = "DtDriverMenuLogic";
 
//! \brief Component for handling menu interactions for vehicle drivers
//!
//! The DtDriverMenuLogic processes menu actions related to vehicle control and forwards
//! them to the DtDriverControlLogic component. It specifically handles the "DriverMovementGroup"
//! menu action, sending appropriate joystick messages with timing to simulate button presses.
//!
//! This component works in conjunction with the DtDriverControlLogic component, which it
//! locates during post-initialization.
class VRECOMMONCOMPONENTS_DLL DtDriverMenuLogic : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtDriverMenuLogic
   //!
   //! Initializes the component with the name "DtDriverMenuLogic".
   DtDriverMenuLogic();
 
   //! \brief Virtual destructor for DtDriverMenuLogic
   virtual ~DtDriverMenuLogic() override;
 
   //! \brief Initializes the component with configuration from Lua
   //!
   //! Sets up a message handler for the MenuActionMessage type.
   //!
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing initialization parameters
   //! \return True if initialization succeeds, false otherwise
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
 
   //! \brief Performs post-initialization setup
   //!
   //! Locates the DtDriverControlLogic component that will be used to execute
   //! vehicle control actions triggered through the menu system.
   //!
   //! \return True if post-initialization succeeds (DtDriverControlLogic was found),
   //!         false otherwise
   virtual bool postInitialize() override;
 
   //! \brief Updates the component state (empty implementation)
   //!
   //! This method is called each frame but currently has no implementation.
   //!
   //! \param dt Delta time in seconds since the last tick
   virtual void tick(double dt) override;
 
   //! \brief Shuts down the component
   //!
   //! Removes the MenuActionMessage handler.
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
   //! \brief Handles menu action messages
   //!
   //! Processes the "DriverMovementGroup" menu action by forwarding the action's
   //! parameter to the DtDriverControlLogic as a joystick message. It sends two
   //! messages: one with value 1 immediately, and another with value 0 after a
   //! short delay (0.1 seconds), simulating a button press and release.
   //!
   //! \param msg The message to process
   //! \return HANDLED if the message was processed, IGNORED otherwise
   virtual DtVreMessageResult handleMenuMessage(makVre::DtVreMessage* msg);
 
protected:
   //! \brief Pointer to the driver control logic component
   //!
   //! This component is located during post-initialization and is used to
   //! execute vehicle control actions triggered through the menu system.
   DtDriverControlLogic* myCarControlLogic;
};
 
} // namespace makVre