ballisticGunJoyControllerDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file ballisticGunJoyControllerDescriptor.h
//! \ingroup vreVrfobjparam
//! \brief Ballistic gun joystick controller descriptor for VREngage
//!
//! This file defines the DtBallisticGunJoyControllerDescriptor class, which configures
//! joystick-controlled ballistic gun components in VREngage. It combines joystick device
//! controls with ballistic gun functionality, enabling joystick-based weapon aiming and firing.
 
#pragma once
 
#include "vreVrfobjparam/export.h"
 
#include <vrfobjparam/joyDeviceControllerDescriptor.h>
#include <vrfobjparam/ballisticGunControllerDescriptor.h>
 
//! \brief Type identifier string for the ballistic gun joystick controller descriptor
const char DtBallisticGunJoyControllerDescriptorType[] = "ballistic-gun-joy-ctrl-descriptor";
 
namespace makVre
{
//! \brief Ballistic gun joystick controller descriptor for VREngage
//!
//! This class defines a descriptor for the ballistic gun joystick controller component,
//! which allows ballistic guns to be controlled via joystick input devices. It combines
//! joystick device controller functionality with ballistic gun controller capabilities,
//! enabling game controller-based weapon aiming and firing in VREngage simulations.
//!
//! This descriptor template combines joystick device controller capabilities with
//! ballistic gun controller configuration options.
class VREVRFOBJPARAM_DLL DtBallisticGunJoyControllerDescriptor
   : public DtJoyDeviceControllerDescriptorTemplate<DtBallisticGunControllerDescriptor>
{
public:
   //! \brief Constructor with component name
   //! \param name The name of this component
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new ballistic gun joystick controller descriptor with the specified name.
   DtBallisticGunJoyControllerDescriptor(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Constructor with component name as symbol string
   //! \param name The name of this component as a symbol string
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new ballistic gun joystick controller descriptor with the specified name.
   DtBallisticGunJoyControllerDescriptor(const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Copy constructor
   //! \param orig The source descriptor to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new ballistic gun joystick controller descriptor as a copy of the provided original.
   DtBallisticGunJoyControllerDescriptor(
      const DtBallisticGunJoyControllerDescriptor& orig, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtBallisticGunJoyControllerDescriptor() override;
 
   //! \brief Creates a clone of this descriptor
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //! \return Pointer to a new descriptor that is a clone of this one
   //!
   //! Creates a new ballistic gun joystick controller descriptor as a deep copy of this one.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = NULL) const override;
 
   //! \brief Factory function to create a new instance of this descriptor
   //! \return Pointer to a newly created descriptor
   //!
   //! Static factory function used by the descriptor creation system to instantiate
   //! new instances of this descriptor type.
   static DtComponentDescriptor* creator();
 
   //! \brief Gets the type identifier for this descriptor
   //! \return String identifying this descriptor type
   //!
   //! Returns a unique type identifier string for this descriptor type.
   //! Used for creating descriptors from MTL files.
   virtual DtString type() const override;
};
} // namespace makVre