vreSpawnController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreSpawnController.h
//! \ingroup vreVrfmodel
//! \brief Controller for optimized entity spawning
//!
//! This file defines the DtVreSpawnController class which extends the base
//! spawn controller to provide performance optimizations for vehicle creation.
//! It modifies the entity creation process to avoid automatically adding spawned
//! vehicles to the Vortex physics world until needed, significantly improving
//! performance when creating vehicles at spawn points.
//!
//! The controller passes context information indicating that a vehicle is being
//! created at a spawn point, ensuring it doesn't incur the performance penalty
//! of Vortex world integration (which can take seconds) unless the vehicle is
//! actually player controlled. When a player does take control of a spawn-point
//! generated vehicle, the Vortex world integration occurs at that time.
 
#pragma once
 
#include "vreVrfmodel/export.h"
 
#include <vrfmodel/spawnController.h>
 
namespace makVre
{
//! \brief Controller for optimized entity spawning
//!
//! DtVreSpawnController extends the base spawn controller to provide
//! performance optimizations for vehicle creation. It modifies the entity
//! creation process to avoid automatically adding spawned vehicles to the
//! Vortex physics world until needed, which significantly improves performance
//! when creating vehicles at spawn points.
class VREVRFMODEL_DLL DtVreSpawnController : public DtSpawnController
{
public:
   //! \brief Constructor
   //! \param name The name of this component
   //! \param owner The local object that owns this component
   //! \param simManager The simulation services manager
   //! \param desc Component descriptor with configuration parameters
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new spawn controller component with the specified parameters.
   DtVreSpawnController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc, DtReaderWriterRegistry* parentRegistry);
 
   //! \brief Factory method to create a new instance of this component
   //! \param name The name for the new component
   //! \param owner The local object that will own this component
   //! \param simManager The simulation services manager
   //! \param desc Optional component descriptor
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to the newly created component
   //!
   //! Static factory method used by the component creation system to instantiate
   //! new instances of this component type.
   static DtSimComponent* creator(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc, DtReaderWriterRegistry* parentRegistry);
 
protected:
   //! \brief Creates an object with spawn point context information
   //! \param spawnObjectUUID UUID of the object to spawn
   //! \param sinkPoint The sink point where the object will be spawned
   //! \param spawnData Spawn configuration data
   //! \param dataAvailable Output parameter indicating if required data was available
   //! \param entityPlan The plan to assign to the spawned entity
   //! \return Handle to the created object
   //!
   //! Overridden to pass context information that the vehicle is being created
   //! at a spawn point. Sets an entry with the keyword "DtSpawnedBy" in the
   //! extended data map, where the value is the UUID of the spawning entity.
   //! The presence of this keyword indicates that the entity was created via
   //! a spawn point, which prevents automatic Vortex world integration until needed.
   virtual DtCreateObjectHandle createObject(const DtUUID& spawnObjectUUID, const DtSimObject* sinkPoint,
      const DtRwSpawnData* spawnData, bool& dataAvailable, const DtPlan& entityPlan) override;
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreSpawnController();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreSpawnController(const DtVreSpawnController& other);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   DtVreSpawnController& operator=(const DtVreSpawnController& other);
};
 
} // namespace makVre