vreTurretJoystickController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreTurretJoystickController.h
//! \ingroup vreVrfmodel
//! \brief Controller for joystick-based turret control
//!
//! This file defines the DtVreTurretJoystickController class which provides
//! joystick control functionality for turrets. It extends the base joystick
//! controller with specific functionality for controlling turret rotation,
//! elevation, and aiming modes.
 
#pragma once
 
#include "vreVrfModel/vreJoystickController.h"
 
class DtStringOutputPort;
 
namespace makVre
{
 
//! \brief Type identifier for the VRE turret joystick controller component
const char DtVreTurretJoystickControllerType[] = "vre-turret-joystick-controller";
 
//! \brief Controller for joystick-based turret control
//!
//! DtVreTurretJoystickController extends the base joystick controller to provide
//! specialized functionality for controlling turrets with joystick inputs. It
//! automatically creates and manages the appropriate output ports for turret
//! azimuth, elevation, and aiming mode controls, and translates joystick inputs
//! into commands that the turret actuator can understand and execute.
 
class VREVRFMODEL_DLL DtVreTurretJoystickController : public DtVreJoystickController
{
public:
   //! \brief Constructor
   //! \param name The name of this component
   //! \param owner The local object that owns this component
   //! \param simManager The simulation services manager
   //! \param desc Component descriptor with configuration parameters
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new turret joystick controller component with the specified parameters.
   //! Initializes the controller and sets up the required output ports for turret control.
   DtVreTurretJoystickController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the turret joystick controller component.
   virtual ~DtVreTurretJoystickController() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreTurretJoystickControllerType)
   //!
   //! Implements the DtSimComponent::type() method to return the
   //! type identifier for this component.
   virtual const char* type() const override;
 
 
   //! \brief Factory method to create a new instance of this component
   //! \param name The name for the new component
   //! \param owner The local object that will own this component
   //! \param simManager The simulation services manager
   //! \param desc Optional component descriptor
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to the newly created component
   //!
   //! Static factory method used by the component creation system to instantiate
   //! new instances of this component type.
   static DtSimComponent* creator(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreTurretJoystickController();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreTurretJoystickController(const DtVreJoystickController& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   DtVreTurretJoystickController& operator=(const DtVreTurretJoystickController& orig);
 
protected:
   //! \brief Processes joystick input and sets corresponding port values
   //! \param functionGroup The function group identifier for the input
   //! \param function The specific function name for the input
   //! \param value The input value (typically in range [-1.0, 1.0])
   //! \param repeat Flag indicating whether the function should repeat
   //!
   //! Handles joystick input by translating joystick function calls into
   //! appropriate turret control values. Maps joystick axes and buttons
   //! to turret azimuth, elevation, and aiming mode controls.
   virtual void calcAndSetPortValues(
      const DtString& functionGroup, const DtString& function, double value, bool repeat) override;
 
   //! \brief Creates input and output ports for the component
   //! \return True if ports are successfully created, false otherwise
   //!
   //! Creates the output ports needed by this component for turret control,
   //! including ports for azimuth, elevation, and aiming mode. These ports
   //! connect to the turret actuator component.
   virtual bool createPorts() override;
 
   //! \brief Output port for the turret aiming mode
   //!
   //! String output port that specifies the current aiming mode for the turret.
   //! This can be used to switch between different aiming behaviors such as
   //! direct aim, lead aim, or other specialized aiming modes.
   DtStringOutputPort* myAimingModePort;
};
 
} // namespace makVre