weaponsStatusControllerDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file weaponsStatusControllerDescriptor.h
//! \ingroup vreVrfobjparam
//! \brief Weapons status controller descriptor for VREngage
//!
//! This file defines the DtWeaponsStatusControllerDescriptor class, which configures
//! weapon management and cycling behavior in VREngage simulations. It provides parameters
//! for defining weapon cycling order and range ring update behavior.
 
#pragma once
 
#include <vreVrfobjparam/export.h>
 
#include <vrfobjparam/joyDeviceControllerDescriptor.h>
 
namespace makVre
{
//! \brief Type identifier string for the weapons status controller descriptor
const char DtWeaponsStatusControllerDescriptorType[] = "weapons-status-controller-descriptor";
 
//! \brief Weapons status controller descriptor for VREngage
//!
//! This class defines a descriptor for the weapons status controller component,
//! which manages weapon selection and cycling behavior in VREngage. It extends
//! the joystick device controller descriptor to add configuration for weapon cycling
//! order and range ring update behavior.
class VREVRFOBJPARAM_DLL DtWeaponsStatusControllerDescriptor : public DtJoyDeviceControllerDescriptor
{
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 weapons status controller descriptor with the specified name.
   DtWeaponsStatusControllerDescriptor(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source descriptor to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new weapons status controller descriptor as a copy of the provided original.
   DtWeaponsStatusControllerDescriptor(
      const DtWeaponsStatusControllerDescriptor& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The source descriptor to copy from
   //! \return Reference to this descriptor after assignment
   //!
   //! Assigns the contents of the provided descriptor to this one.
   DtWeaponsStatusControllerDescriptor& operator=(const DtWeaponsStatusControllerDescriptor& orig);
 
   //! \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 weapons status controller descriptor as a deep copy of this one.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtWeaponsStatusControllerDescriptor() override;
 
   //! \brief Gets the type identifier for this descriptor
   //! \return String identifying this descriptor type
   //!
   //! Returns a unique type identifier string for this descriptor type.
   //! Will return DtWeaponsStatusControllerDescriptorType.
   virtual DtString type() const override;
 
   //! \brief Gets the weapon cycle order
   //! \return Vector of weapon category names in cycling order
   //!
   //! Returns the ordered list of weapon categories that defines the sequence
   //! in which weapons will be cycled through when using the weapon selection controls.
   virtual std::vector<std::string> weaponCycleOrder() const;
 
   //! \brief Checks if range rings should be updated
   //! \return True if range rings should be updated when weapons change, false otherwise
   //!
   //! Returns whether the controller should modify the entity's range rings
   //! based on which weapon is currently selected.
   virtual bool updateRangeRings() const;
 
   //! \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();
 
protected:
   //! \brief Weapon categories in cycling order
   //!
   //! Semicolon-separated string of weapon categories, defining the order in which
   //! weapons will be cycled through when using the weapon selection controls.
   //! This allows the weapon cycle order to be specifically configured.
   DtRwString myWeaponCycleOrder;
 
   //! \brief Flag for updating range rings
   //!
   //! When true, this controller will modify the entity's range rings based on which
   //! weapon is currently selected, providing visual feedback of the selected weapon's range.
   DtRwBoolean myUpdateRangeRings;
};
} // namespace makVre