vreDieWhenHitActuator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreDieWhenHitActuator.h
//! \ingroup vreVrfmodel
//! \brief Actuator for making entities die when hit or run over
//!
//! This file defines the DtVreDieWhenHitActuator class which causes entities
//! to be marked as destroyed when they are hit by weapons or run over by vehicles.
//! It extends the base die-when-hit functionality with VRE-specific behaviors.
 
#pragma once
 
#include "vreVrfmodel/export.h"
#include <vrfmodel/dieWhenHitActuator.h>
#include "vreVrfModel/vreSimComponent.h"
 
namespace makVre
{
//! \brief Type identifier for the VRE die-when-hit actuator component
const char DtVreDieWhenHitActuatorType[] = "vre-die-when-hit-actuator";
 
//! \brief Actuator that causes entities to die when hit or run over
//!
//! DtVreDieWhenHitActuator extends the base die-when-hit actuator with VRE-specific
//! functionality. It monitors for collision events and weapon hits, changing the entity
//! to a destroyed state when appropriate. This actuator specifically checks for
//! vehicles running over the entity and handles those collisions as destruction events.
class VREVRFMODEL_DLL DtVreDieWhenHitActuator : public DtVreSimComponent<DtDieWhenHitActuator>
{
public:
   //! \brief Constructor
   //! \param name The name of this component
   //! \param object The local object that owns this component
   //! \param simManager The simulation services manager
   //! \param compDescriptor Component descriptor with configuration parameters
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new die-when-hit actuator component with the specified parameters.
   DtVreDieWhenHitActuator(const DtString& name, DtLocalObject* object, DtSimulationServices* simManager,
      DtComponentDescriptor* compDescriptor, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the die-when-hit actuator component.
   virtual ~DtVreDieWhenHitActuator() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreDieWhenHitActuatorType)
   //!
   //! Implements the DtSimComponent::type() method to return the
   //! type identifier for this component.
   virtual const char* type() const override;
 
   //! \brief Updates the actuator state each simulation frame
   //!
   //! Checks for collision events with vehicles and other destruction conditions.
   //! If hit by a weapon or run over by a vehicle, changes the entity to the
   //! destroyed state. Updates kinematic state and copies it to the state repository.
   virtual void tick() override;
 
public:
   //! \brief Factory method to create a new instance of this component
   //! \param name The name for the new component
   //! \param object The local object that will own this component
   //! \param simManager The simulation services manager
   //! \param compDescriptor 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* object, DtSimulationServices* simManager,
      DtComponentDescriptor* compDescriptor, DtReaderWriterRegistry* parentRegistry);
};
 
} // namespace makVre