vreTurretActuator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreTurretActuator.h
//! \ingroup vreVrfmodel
//! \brief Actuator for turret movement with player control awareness
//!
//! This file defines the DtVreTurretActuator class which extends the base
//! turret actuator component to provide player control awareness. It suppresses
//! normal turret control operations when the entity is under player control,
//! allowing other systems to take over.
#pragma once
 
#include "vreVrfmodel/export.h"
#include "vreVrfmodel/vreSimComponent.h"
// #include <vreMessageManager/vreMessage.h>
 
#include <vrfmodel/turretActuatorComponent.h>
 
// #include <vl/hostStructs.h>
 
namespace makVre
{
 
//! \brief Type identifier for the VRE turret actuator component
const char DtVreTurretActuatorType[] = "vre-turret-actuator";
 
//! \brief Actuator for turret movement with player control awareness
//!
//! DtVreTurretActuator extends the base turret actuator to provide
//! player control awareness. When a player is controlling the entity's turret,
//! this component suppresses its normal tick functionality, allowing the player's
//! inputs to control the turret through other mechanisms (typically a separate
//! player-specific actuator).
//!
//! This component gracefully switches between AI-controlled behavior (using the
//! base turret actuator functionality) and player-controlled behavior (deferring
//! to player input systems) based on the entity's control state.
//!
//! Uses Descriptor Type: DtHumanGunActuatorDescriptor
 
class VREVRFMODEL_DLL DtVreTurretActuator : public DtVreSimComponent<DtTurretActuatorComponent>
{
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 turret actuator component with the specified parameters.
   //! Initializes the component to track player control state and manage turret movements.
   DtVreTurretActuator(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the turret actuator component.
   virtual ~DtVreTurretActuator() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreTurretActuatorType)
   //!
   //! Implements the DtSimComponent::type() method to return the
   //! type identifier for this component.
   virtual const char* type() const override { return DtVreTurretActuatorType; }
 
   //! \brief Updates the turret state each simulation frame
   //!
   //! Checks if a player is acting in the gunner role for this entity. If so,
   //! the method returns immediately without making changes, allowing player
   //! control mechanisms to handle turret movement. Otherwise, it calls the
   //! base class tick method to function normally under CGF (Computer Generated
   //! Forces) control, updating turret position based on AI commands.
   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 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);
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreTurretActuator();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreTurretActuator(const DtVreTurretActuator& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   const DtVreTurretActuator& operator=(const DtVreTurretActuator& orig);
};
 
} // namespace makVre