vreBallisticGunJoyController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreBallisticGunJoyController.h
//! \ingroup vreVrfmodel
//! \brief Controller for ballistic guns with joystick input support
//!
//! This file defines the DtVreBallisticGunJoyController class which extends the base
//! ballistic gun controller with the ability to be controlled from a joystick.
//! It provides mechanisms for handling joystick input to control gun aiming and firing.
 
#pragma once
 
#include "vreVrfmodel/export.h"
#include "vreVrfmodel/vreSimComponent.h"
 
#include "vreVrfmodel/ballisticGunJoyController.h"
 
namespace makVre
{
 
//! \brief Type identifier for the VRE ballistic gun joy controller component
const char DtVreBallisticGunJoyControllerType[] = "vre-ballistic-gun-joy-controller";
 
//! \brief Controller for ballistic guns with joystick support
//!
//! DtVreBallisticGunJoyController extends the DtBallisticGunController class
//! with the ability to be controlled from a joystick. It processes joystick
//! inputs to control gun aiming, elevation adjustment, and firing operations.
//! The controller responds to joystick events by updating the appropriate
//! control parameters for the underlying ballistic gun.
//!
//! Uses Descriptor Type: DtBallisticGunJoyControllerDescriptor
class VREVRFMODEL_DLL DtVreBallisticGunJoyController : public DtVreSimComponent<DtBallisticGunJoyController>
{
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 ballistic gun joy controller component with the specified parameters.
   DtVreBallisticGunJoyController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc, DtReaderWriterRegistry* const parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the ballistic gun joy controller component.
   virtual ~DtVreBallisticGunJoyController() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreBallisticGunJoyControllerType)
   //!
   //! Implements the DtSimComponent::type() method to return the
   //! type identifier for this component.
   virtual const char* type() const override { return DtVreBallisticGunJoyControllerType; }
 
   //! \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);
 
protected:
   //! \brief Updates the controller state each simulation frame
   //!
   //! Processes joystick input and updates the gun's aiming and firing state.
   //! This method is called each simulation frame to maintain continuous control
   //! of the gun based on current joystick inputs.
   virtual void tick() override;
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreBallisticGunJoyController();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreBallisticGunJoyController(const DtVreBallisticGunJoyController& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   const DtVreBallisticGunJoyController& operator=(const DtVreBallisticGunJoyController& orig);
};
 
} // namespace makVre