projectileDetonationResult.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file projectileDetonationResult.h
//! \ingroup vreVrfobjcore
//! \brief Projectile detonation result class for VREngage
//!
//! This file defines the DtProjectileDetonationResult class, which represents the result
//! of a projectile detonation in VREngage simulations. It contains information about
//! what happened when a projectile reached its target or termination point.
 
#pragma once
#include "vreVrfobjcore/export.h"
 
#include <vrfobjcore/simObjectReference.h>
 
#include <matrix/vlVector.h>
 
#include <vlpi/disEnums.h>
 
 
namespace makVre
{
//! \brief Class representing the result of a projectile detonation
//!
//! This class contains information about what happened when a projectile reached its
//! target or termination point. It includes details about the collision result,
//! distance to the target, the entity that was hit (if any), and the position
//! where the detonation occurred.
class VREVRFOBJCORE_DLL DtProjectileDetonationResult
{
public:
   //! \brief The collision result
   //!
   //! Enumeration indicating what happened when the projectile terminated
   //! (e.g., entity hit, terrain hit, max range reached, etc.).
   DtDetonationResult result;
 
   //! \brief The distance to the target in meters
   //!
   //! The distance from the projectile's origin to the target that was hit.
   //! Only meaningful when a target was actually hit.
   double rangeToTarget;
 
   //! \brief Reference to the entity that was hit
   //!
   //! Contains a reference to the entity that was hit by the projectile,
   //! or an invalid reference if no entity was hit (e.g., terrain hit
   //! or max range reached).
   DtSimObjectReference targetEntity;
 
   //! \brief The position where the detonation occurred
   //!
   //! The 3D position in local coordinates where the projectile terminated,
   //! whether by hitting something or reaching its maximum range.
   DtVector detonationPosition;
};
} // namespace makVre