projectileList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file projectileList.h
//! \ingroup vreVrfobjcore
//! \brief Projectile list class for VREngage
//!
//! This file defines the DtProjectileList class, which provides a readable/writable list
//! of DtProjectile objects in VREngage simulations. DtProjectileList items include the type of
//! DtProjectile class, so it can read/write DtProjectile objects of any type registered
//! in the DtProjectileFactory.
 
#pragma once
 
#include <readerWriter/rwList.h>
 
class DtProjectile;
 
#include "vreVrfobjcore/export.h"
 
namespace makVre
{
//! \brief Type identifier string for the projectile list class
const char DtProjectileListType[] = "DtProjectileList";
 
class DtProjectile;
 
//! \brief Class representing a list of projectiles
//!
//! This class provides a readable/writable list of DtProjectile objects.
//! It handles reading and writing projectile objects of various types to/from
//! files or streams, and provides methods for adding and managing projectiles
//! in the list. The list is used to track and manage multiple projectiles in
//! the simulation.
class VREVRFOBJCORE_DLL DtProjectileList : public DtRwList
{
protected:
   //! \brief Default constructor (protected)
   //!
   //! Default constructor is protected to prevent creation of unnamed instances.
   //! Use the public constructor with a name instead.
   DtProjectileList();
 
public:
   //! \brief Constructor with name
   //! \param name The name of this projectile list
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new projectile list with the specified name.
   DtProjectileList(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source projectile list to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new projectile list as a copy of the provided original.
   DtProjectileList(const DtProjectileList& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The source projectile list to copy from
   //! \return Reference to this projectile list after assignment
   //!
   //! Assigns the contents of the provided list to this one.
   //! Removes and deletes all entries on the left hand side, then
   //! clones all entries on the right side list and adds them to
   //! the left side list.
   DtProjectileList& operator=(const DtProjectileList& orig);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the projectile list, including all
   //! contained projectile objects.
   virtual ~DtProjectileList() override;
 
   //! \brief Creates a clone of this projectile list
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //! \return Pointer to a new projectile list that is a clone of this one
   //!
   //! Creates a new projectile list as a deep copy of this one, including
   //! all contained projectile objects.
   virtual DtProjectileList* clone(DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Removes and destroys all projectiles from the list
   //!
   //! Clears the list by removing and destroying all contained projectile objects.
   virtual void emptyList();
 
   //! \brief Copies all projectiles from another list
   //! \param orig The source projectile list to copy from
   //!
   //! Copies all projectiles from the provided list to this one.
   //! Any existing projectiles in this list are preserved.
   virtual void copyList(const DtProjectileList& orig);
 
   //! \brief Adds a projectile to the list by copying
   //! \param projectile The projectile to add
   //! \return Pointer to the newly added projectile
   //!
   //! Makes a clone of the provided projectile and adds it to the list.
   //! The returned pointer is owned by this list and should not be deleted
   //! by the caller.
   virtual DtProjectile* addProjectile(const DtProjectile& projectile);
 
   //! \brief Gets the reader/writer type identifier
   //! \return String identifying this list type
   //!
   //! Returns a unique type identifier string for this list type.
   //! Will return DtProjectileListType.
   virtual const char* readerWriterType() const override;
 
   //! \brief Equality operator
   //! \param other The projectile list to compare with (unnamed parameter)
   //! \return True if the projectile lists are equal, false otherwise
   //!
   //! Compares this projectile list with another to determine if they are equal.
   //! Lists are equal if they contain the same number of items and each item
   //! is equal to the corresponding item in the other list.
   bool operator==(const DtProjectileList&) const;
 
protected:
   //! \brief Adds a pre-created projectile to the list
   //! \param projectile Pointer to the projectile to add
   //!
   //! Adds the provided projectile to the list. The projectile will be owned
   //! by this list and destroyed when the list is emptied or destroyed.
   //! This protected method is used internally when loading projectiles from
   //! a file or stream.
   virtual void addProjectile(DtProjectile* projectile);
 
   //! \brief Handles reading projectiles from an MTL stream
   //! \param args Input stream from an MTL file
   //! \param searchPaths Search paths for resolving references
   //! \param variableBindings Variable bindings for resolving references
   //! \return Processed MTL stream after reading
   //!
   //! Overrides the base class getData method to handle reading projectiles from
   //! an MTL stream. Constructs a projectile object, retrieves it from the MTL stream,
   //! and then adds it to the list.
   virtual DtlObjPtr getData(DtlObjPtr args,
      const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) override;
};
} // namespace makVre