deadReckonOverrider.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file deadReckonOverrider.h
//! \brief Defines the DtDeadReckonOverrider component that modifies dead reckoning settings for controlled entities.
//!
//! This component manages dead reckoning settings for an engaged entity, specifically
//! disabling acceleration-based prediction and smoothing to provide better direct control.
//!
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
 
#include "vrePlayerStation/playerComponent.h"
 
#include <vrvCore/DtUniqueID.h>
 
namespace makVrv
{
//! \brief Forward declaration of the VR-Vantage scene object class
class DtSceneObject;
 
//! \brief Forward declaration of the VR-Vantage dead reckoning updater class
class DtDeadReckonUpdater;
} // namespace makVrv
 
namespace makVre
{
//! \brief Forward declaration of the player station class
class DtPlayerStation;
 
namespace DeadReckonOverriderConfig
{
//! \ingroup RoleConfigParams
//! \defgroup DeadReckonOverriderRoleParams Dead Reckon Overrider Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for dead reckon overrider role.
//! @{
 
// (No specific configuration parameters are currently used by DtDeadReckonOverrider.)
 
//! @}
} // namespace DeadReckonOverriderConfig
 
//! \brief Type identifier for DtDeadReckonOverrider component
constexpr const char* DtDeadReckonOverriderType = "DtDeadReckonOverrider";
 
//! \brief Component that overrides dead reckoning settings for controlled entities
//!
//! The DtDeadReckonOverrider modifies dead reckoning settings for the ownship entity
//! when it is engaged. Specifically, it disables acceleration-based prediction and
//! smoothing to provide more responsive and accurate control when a player is
//! directly controlling the entity.
//!
//! This component automatically locates the scene object and its dead reckoning updater,
//! then modifies the settings. When the component is shut down or the scene object is
//! deleted, the original settings are restored.
class VRECOMMONCOMPONENTS_DLL DtDeadReckonOverrider : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtDeadReckonOverrider
   //!
   //! Initializes the component with null pointers for scene object and dead reckoning updater.
   DtDeadReckonOverrider();
 
   //! \brief Virtual destructor for DtDeadReckonOverrider
   virtual ~DtDeadReckonOverrider() override;
 
   //! \brief Initializes the component with configuration from Lua
   //!
   //! Performs basic initialization using the parent class implementation.
   //!
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing initialization parameters
   //! \return True if initialization succeeds, false otherwise
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
 
   //! \brief Performs post-initialization setup
   //!
   //! Called after all components have been initialized.
   //!
   //! \return True if post-initialization succeeds, false otherwise
   virtual bool postInitialize() override;
 
   //! \brief Updates the component state
   //!
   //! Attempts to find the scene object and dead reckoning updater if not already found,
   //! then modifies the dead reckoning settings to disable acceleration-based prediction
   //! and smoothing.
   //!
   //! \param dt Delta time in seconds since the last tick
   virtual void tick(double dt) override;
 
   //! \brief Shuts down the component
   //!
   //! Disconnects from the scene object's deletion signal and restores original
   //! dead reckoning settings if the engine is not being destroyed.
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
protected:
   //! \brief Locates the scene object for the player's entity
   //!
   //! Attempts to find the scene object corresponding to the player's element ID.
   //! If found, connects to the scene object's deletion signal to handle cleanup.
   //!
   //! \return True if the scene object was found or previously found, false otherwise
   bool findSceneObject();
 
   //! \brief Locates the dead reckoning updater for the scene object
   //!
   //! Searches through the scene object's updater chain to find a dead reckoning updater.
   //!
   //! \return True if the dead reckoning updater was found or previously found, false otherwise
   bool findDeadReckonUpdater();
 
   //! \brief Signal handler for scene object deletion
   //!
   //! Called when the connected scene object is about to be deleted.
   //! Performs cleanup by disconnecting signals and clearing pointers.
   //!
   //! \param id The unique ID of the scene object being deleted
   void slot_sceneObjectToBeDeleted(const makVrv::DtUniqueID& id);
 
   //! \brief Pointer to the scene object for the player's entity
   makVrv::DtSceneObject* mySceneObject;
 
   //! \brief Pointer to the dead reckoning updater for the scene object
   makVrv::DtDeadReckonUpdater* myDeadReckonUpdater;
};
 
} // namespace makVre