vreRotaryWingActuator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreRotaryWingActuator.h
//! \ingroup vreVrfmodel
//! \brief Actuator for rotary-wing aircraft simulation
//!
//! This file defines the DtVreRotaryWingActuatorComponent class which provides
//! a kinematics-based model for rotary-wing aircraft. It extends the base actuator
//! with VR-Engage specific functionality including improved collision detection
//! and crash handling.
#pragma once
 
#include "export.h"
 
#include <vrfmodel/rotaryWingActuatorComponent.h>
#include "vreVrfmodel/vreSimComponent.h"
 
namespace makVre
{
//! \brief Type identifier for the VRE rotary wing actuator component
const char DtVreRotaryWingActuatorType[] = "vre-rotary-wing-actuator";
 
//! \brief Rotary-wing aircraft actuator with enhanced collision and crash handling
//!
//! DtVreRotaryWingActuatorComponent extends the base rotary wing actuator to provide
//! VR-Engage specific functionality, particularly for collision detection and crash
//! handling. It includes improved logic for determining landing versus crash states
//! and configurable options for generating detonation events on crash.
class VREVRFMODEL_DLL DtVreRotaryWingActuatorComponent : public DtVreSimComponent<DtRotaryWingActuatorComponent>
{
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 rotary wing actuator component with the specified parameters.
   DtVreRotaryWingActuatorComponent(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the rotary wing actuator component,
   //! removing process state from the process state manager before deleting it.
   virtual ~DtVreRotaryWingActuatorComponent() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreRotaryWingActuatorType)
   //!
   //! Implements the DtSimComponent::type() method to return the
   //! type identifier for this component.
   virtual const char* type() const override;
 
   //! \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 = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
protected:
   //! \brief Sends a detonation event at the crash location if configured
   //! \param geocentricLocation The geocentric coordinates of the crash location
   //!
   //! Checks the component descriptor to determine whether a detonation event
   //! should be generated when the aircraft crashes. If enabled, creates and
   //! sends a detonation event at the specified location, which can generate
   //! visual effects and damage to nearby entities.
   virtual void sendDetonation(const DtVector& geocentricLocation) override;
 
   //! \brief Determines if the aircraft has landed or crashed
   //!
   //! Overridden to perform the landed check before determining if a crash
   //! has occurred. This prevents false positives where normal landings are
   //! incorrectly classified as crashes, fixing an issue with frequent
   //! crash events occurring during standard landing procedures.
   virtual void checkLandedOrCrashed() override;
};
} // namespace makVre