vehicleBlinkerControlLogic.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
// Class DtVehicleBlinkerControlLogic is a VR-Engage front-end component that
// handles gamepad/joystick, and/or keyboard/mouse inputs for left and right vehicle
// blinkers.  When the user activates a blinker via a gamepad button press or
// keypress, that input is received by this class. It fills out and sends a
// corresponding joystick message to the sim engine.
 
#pragma once
 
#include "vrePlayerStation/playerStation.h"
#include "vrePlayerStation/entityControlLogic.h"
#include "vrePlayerStation/inputLogic.h"
 
constexpr auto DtVehicleBlinkerControlLogicType = "DtVehicleBlinkerControlLogic";
 
//! \brief VR-Engage frontend component that handles input for vehicle turn signals.
//!
//! This component captures gamepad/joystick and keyboard/mouse inputs for left and right
//! vehicle blinkers. When the user activates a blinker via a button press or keypress,
//! this class receives the input and sends a corresponding joystick message to the
//! simulation engine backend where the blinker state is updated.
class DtVehicleBlinkerControlLogic : virtual public makVre::DtEntityControlLogic
{
public:
   DtVehicleBlinkerControlLogic();
   virtual ~DtVehicleBlinkerControlLogic() override;
 
   // Returns the component type identifier
   virtual const char* type() const override;
 
   // Overriding initialize() to configure the handlers for player input.
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   // Handler for the "left-blinker" player input action.
   virtual void setLeftBlinker(double val);
 
   // Handler for the "right-blinker" player input action.
   virtual void setRightBlinker(double val);
 
protected:
   // Called by the above handler functions.  Sends a JoystickMessage to the sim
   // engine, where the action will ultimately be handled.
   virtual void sendJoystickMessage(const std::string& function, double val, double delay = 0);
 
 
   //
   makVre::DtInputLogic myInputLogic;
 
   // Convenience variable for caching the name of our joystick group.  A joystick group
   // is a named collection of joystick functions.  A joystick function is a string that
   // gets mapped to a particular handler function.  This class derives from DtEntityControlLogic,
   // which has a list of joystick groups.  In the case of this particular derived class
   // there is one joystick group, so we're caching the name of that first and only joystick
   // group in this member variable.
   std::string myMainJoystickGroup;
};