vreDiGuyController.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreDiGuyController.h
//! \ingroup vreVrfmodel
//! \brief Controller for DiGuy animation and behavior
//!
//! This file defines the DtVreDiGuyController class which extends the base DiGuy
//! controller with VRE-specific functionality. It provides overrides for certain
//! behaviors to better support player control and animation states. This extension
//! corrects some logic errors in the base implementation.
 
#pragma once
 
#include "vreVrfmodel/export.h"
#include "vreVrfModel/vreSimComponent.h"
#include <vrfobjcore/humanLocalObjectFacade.h>
#include <vrfmodel/diGuyController.h>
 
namespace makVre
{
//! \brief Type identifier for the VRE DiGuy controller component
const char DtVreDIGuyControllerType[] = "vre-di-guy-controller";
 
//! \brief Controller for managing DiGuy human animation and behavior
//!
//! DtVreDiGuyController extends the base DiGuy controller with VRE-specific logic
//! to better support player control and animation states. It provides overrides
//! for certain behaviors to fix logic errors in the base implementation and to
//! ensure proper animation selection based on various entity states.
class VREVRFMODEL_DLL DtVreDiGuyController : public DtVreSimComponent<DtDiGuyController>
{
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 DiGuy controller component with the specified parameters.
   DtVreDiGuyController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the DiGuy controller component.
   virtual ~DtVreDiGuyController() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreDIGuyControllerType)
   //!
   //! 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);
 
   //! \brief Updates the controller state each simulation frame
   //!
   //! Overridden to give up animation control when the entity is player-controlled.
   //! This allows player inputs to directly control animation states rather than
   //! having the AI controller determine animations.
   virtual void tick() override;
 
   void DtDiGuyController_tick();
 
   //! \brief Performs initialization before the first simulation tick
   //!
   //! Sets up initial states and configurations before the simulation begins.
   //! This initialization is performed once before the first tick of the simulation.
   virtual void preFirstTickInit() override;
 
   //! \brief VRE override to handle ordered animations (currently commented out)
   //!
   //! This would override the base class method to obey ordered animation regardless
   //! of posture, fixing issue VRE-3299. However, it's currently disabled because it
   //! would prevent injured animations from showing when embarked in vehicles.
   //! Future improvement needed: posture should not override ordered animation,
   //! but injured or dead state should still take precedence.
   //
   // const DtDiGuyAnimation* chooseAnimation(DtWeaponState weaponState, DtDamageState damageState,
   //   DtLifeformStaticPosture post, const DtString& demeanor, double speed, double heading, bool debug = true) const
   //   override;
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreDiGuyController();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreDiGuyController(const DtVreDiGuyController& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   const DtVreDiGuyController& operator=(const DtVreDiGuyController& orig);
};
 
} // namespace makVre