vreWeaponControllerDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreWeaponControllerDescriptor.h
//! \ingroup vreVrfobjparam
//! \brief Weapon controller descriptor for VREngage
//!
//! This file defines the DtVreWeaponControllerDescriptor class, which configures
//! weapon controller components in VREngage. It extends the base weapon controller
//! descriptor to add equipment resource type configuration and ammunition selection
//! capabilities.
 
#pragma once
 
#include <vreVrfobjparam/export.h>
 
#include <vrfobjparam/weaponControllerDescriptor.h>
#include <vrfutil/rwResource.h>
 
namespace makVre
{
//! \brief Type identifier string for the weapon controller descriptor
const char DtVreWeaponControllerDescriptorType[] = "vre-weapon-controller-descriptor";
 
//! \brief Weapon controller descriptor for VREngage
//!
//! This class extends the base weapon controller descriptor to add configuration for
//! equipment resource types and ammunition selection capabilities. It provides parameters
//! for direct fire weapon controllers, allowing them to choose appropriate ammunition
//! based on target types and maintain resource tracking.
class VREVRFOBJPARAM_DLL DtVreWeaponControllerDescriptor : public DtWeaponControllerDescriptor
{
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 weapon controller descriptor with the specified name.
   DtVreWeaponControllerDescriptor(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 weapon controller descriptor as a copy of the provided original.
   DtVreWeaponControllerDescriptor(
      const DtVreWeaponControllerDescriptor& 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.
   DtVreWeaponControllerDescriptor& operator=(const DtVreWeaponControllerDescriptor& orig);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtVreWeaponControllerDescriptor() override;
 
   //! \brief Default constructor (deleted)
   //!
   //! Default constructor is explicitly deleted to prevent
   //! creation of instances without proper initialization.
   DtVreWeaponControllerDescriptor() = delete;
 
   //! \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 DtVreWeaponControllerDescriptorType.
   virtual DtString type() const 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 weapon controller descriptor as a deep copy of this one.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets the equipment resource type
   //! \return Reference to the equipment resource entity type
   //!
   //! Returns the type of equipment resource used by this weapon controller.
   //! This is used for resource tracking and management in the simulation.
   virtual const DtEntityType& equipmentResourceType() const;
 
   //! \brief Sets the equipment resource type
   //! \param equipmentResourceType The equipment resource entity type
   //!
   //! Sets the type of equipment resource used by this weapon controller.
   //! This is used for resource tracking and management in the simulation.
   virtual void setEquipmentResourceType(const DtEntityType& equipmentResourceType);
 
   //! \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 Equipment resource entity type
   //!
   //! The type of equipment resource used by this weapon controller.
   //! This is used for resource tracking and management in the simulation.
   //! Parameter name: "equipment-resource"
   DtRwResource myEquipmentResourceType;
};
} // namespace makVre