vreAmmunitionManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreAmmunitionManager.h
//! \ingroup vreVrfobjparam
//! \brief Ammunition manager for VREngage
//!
//! This file defines the DtVreAmmunitionManager class, which manages ammunition
//! (such as bullets in a gun) for VREngage simulations. It handles ammunition types,
//! targeting capabilities, and ammunition parameters for weapons.
 
#pragma once
 
#include <vreVrfobjparam/export.h>
#include <vrfobjparam/ammunitionManager.h>
 
namespace makVre
{
class DtVreAmmunitionParams;
 
//! \brief Ammunition manager for VREngage weapon systems
//!
//! The DtVreAmmunitionManager maintains ammunition that is not published to the
//! network (such as bullets in a gun), their munition types, and the targets they
//! can currently engage. This class extends the base ammunition manager to create
//! VREngage-specific ammunition parameter objects that support the extended data
//! found in ammunitionParams.mtl configuration files.
class VREVRFOBJPARAM_DLL DtVreAmmunitionManager : public DtAmmunitionManager
{
public:
   //! \brief Default constructor
   //!
   //! Creates a new ammunition manager with default values.
   DtVreAmmunitionManager();
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the ammunition manager.
   virtual ~DtVreAmmunitionManager() override;
 
   //! \brief Factory function to create a new ammunition manager
   //! \return Pointer to a newly created ammunition manager
   //!
   //! Static factory function used to instantiate new instances of the
   //! ammunition manager.
   static DtAmmunitionManager* create();
 
protected:
   //! \brief Creates a new ammunition parameters object
   //! \return Pointer to a newly created ammunition parameters object
   //!
   //! Creates a new instance of DtVreAmmunitionParams. If new parameters are
   //! used in a derived version of this class, override this method to return
   //! a derived version of DtVreAmmunitionParams.
   //!
   //! This factory method enables the ammunition manager to create appropriate
   //! parameter objects specific to VREngage.
   virtual DtAmmunitionParams* createParameters() override;
 
private:
   //! \brief Copy constructor (not implemented)
   //! \param orig The source manager to copy from
   //!
   //! Copy constructor is private and not implemented to prevent copying.
   DtVreAmmunitionManager(const DtVreAmmunitionManager& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \param other The source manager to copy from
   //! \return Reference to this manager after assignment
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   DtVreAmmunitionManager& operator=(const DtVreAmmunitionManager& other);
};
} // namespace makVre