weaponPoseUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file weaponPoseUpdater.h
//! \brief Component that updates weapon position and orientation based on observer position
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
 
#include "vrePlayerStation/playerComponent.h"
 
namespace makVrv
{
class DtObserver;
}
 
namespace makVre
{
//! \brief Type identifier for DtWeaponPoseUpdater component
constexpr const char* DtWeaponPoseUpdaterType = "DtWeaponPoseUpdater";
 
//! \brief Component that updates weapon position and orientation based on observer view
//!
//! DtWeaponPoseUpdater tracks the observer's position and orientation and updates
//! corresponding weapon pose attributes. It maintains the weapon's geocentric position
//! and orientation for use by other components, performing coordinate transformations
//! from local to network coordinates. The component also validates whether the pose
//! is currently valid based on scene visibility status.
class VRECOMMONCOMPONENTS_DLL DtWeaponPoseUpdater : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtWeaponPoseUpdater
   //!
   //! Initializes the component with default values
   DtWeaponPoseUpdater();
 
   //! \brief Virtual destructor for DtWeaponPoseUpdater
   virtual ~DtWeaponPoseUpdater() override;
 
   //! \brief Initializes the weapon pose updater component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing component settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Connects to the renderer's post-update signal, finds the observer, and initializes
   //! weapon pose state attributes with default values
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
   //! \brief Called every frame to update component state
   //! \param dt Delta time since the last frame in seconds
   //!
   //! This implementation is currently empty as the actual updates
   //! occur in the updateWeaponPosition method connected to the renderer's post-update signal
   virtual void tick(double dt) override;
   //! \brief Shuts down the weapon pose updater component
   //!
   //! Disconnects from the renderer's post-update signal
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtWeaponPoseUpdater
   virtual const char* type() const override;
 
protected:
   //! \brief Updates the weapon position and orientation based on observer state
   //!
   //! Gets the current observer position and orientation, transforms them from local
   //! to geocentric coordinates, and updates the weaponLocation and weaponOrientation
   //! attributes. Also updates the weaponPoseValid flag based on scene visibility.
   void updateWeaponPosition();
 
   //! \brief Pointer to the observer being used to determine weapon pose
   makVrv::DtObserver* myObserver;
};
} // namespace makVre