vreSimulationModelSetLoader.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreSimulationModelSetLoader.h
//! \ingroup vreSimulationObjectEditor
//! \brief Extended simulation model set loader for VREngage
//!
//! This file defines the DtVreSimulationModelSetLoader class, which extends
//! the base simulation model set loader with VREngage-specific functionality.
//! It provides enhanced capabilities for loading and saving ammunition tables
//! with VREngage-specific extensions.
 
#pragma once
 
#include "vreSimulationObjectEditor/export.h"
 
#include <simulationObjectEditorImpl/simulationModelSetLoader.h>
 
namespace makVre
{
//! \brief Extended simulation model set loader for VREngage
//!
//! This class extends the base simulation model set loader with the ability
//! to load and save VREngage-specific extensions to the ammunition table in
//! a Simulation Model Set (SMS). It handles the creation of VREngage-specific
//! ammunition parameters and ensures proper serialization of extended data.
class VRESIMULATIONOBJECTEDITOR_DLL DtVreSimulationModelSetLoader : public DtSimulationModelSetLoader
{
public:
   //! \brief Constructor
   //! \param de The document environment providing access to application resources
   //!
   //! Creates a new simulation model set loader for VREngage with the specified
   //! document environment.
   DtVreSimulationModelSetLoader(makVrv::DtDe& de);
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the simulation model set loader.
   virtual ~DtVreSimulationModelSetLoader() override;
 
   //! \brief Saves the ammunition table with VREngage-specific extensions
   //! \return True if the save operation was successful, false otherwise
   //!
   //! Overrides the base implementation to use VREngage-specific ammunition parameters.
   //! This corrects the issue with the standard VR-Forces implementation using
   //! DtAmmunitionParams on the stack instead of the derived DtVreAmmunitionParams,
   //! which has VREngage-specific extensions. This override replaces the stack
   //! variable with a call to createAmmunitionParameters(), which creates the
   //! correct derived type.
   //!
   //! \note This function should be removed once VREngage builds against a version
   //! of VR-Forces that has resolved defect Jira VRF-2152.
   virtual bool saveAmmunitionTable() override;
 
protected:
   //! \brief Creates VREngage-specific ammunition parameters
   //! \return Pointer to the created ammunition parameters object
   //!
   //! Overrides the base implementation to create the derived DtVreAmmunitionParameters,
   //! which is the extended type used by VREngage. This enables support for
   //! VREngage-specific extensions to ammunition parameters.
   virtual DtAmmunitionParams* createAmmunitionParameters() const override;
 
private:
   //! \brief Copy constructor (not implemented)
   //! \param other The source object
   //!
   //! Copy constructor is private and not implemented to prevent copying.
   DtVreSimulationModelSetLoader(const DtVreSimulationModelSetLoader& other);
 
   //! \brief Assignment operator (not implemented)
   //! \param other The source object
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   DtVreSimulationModelSetLoader& operator=(const DtVreSimulationModelSetLoader& other);
};
} // namespace makVre