humanWeaponPoseLogic.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file humanWeaponPoseLogic.h
//! \brief Defines DtHumanWeaponPoseLogic for managing human weapon positioning and orientation
//! \ingroup vreHumanFrontend
 
#pragma once
 
#include "vreHumanFrontend/export.h"
 
#include "vrePlayerStation/playerComponent.h"
 
namespace makVrv
{
//! \brief Forward declaration of the display element class
class DtDe;
 
//! \brief Forward declaration of the observer class
class DtObserver;
} // namespace makVrv
 
//! \brief Type identifier constant for DtHumanWeaponPoseLogic components
//!
//! This constant defines the string identifier used to identify DtHumanWeaponPoseLogic
//! component types within the VR-Engage framework. It is used for component
//! registration, type checking, and serialization operations.
constexpr const char* DtHumanWeaponPoseLogicType = "DtHumanWeaponPoseLogic";
 
//! \brief Weapon pose logic component for the human role
//!
//! DtHumanWeaponPoseLogic manages the positioning and orientation of weapons
//! for the human entity, handling weapon alignment with observer view and
//! adjustments for different postures and aiming states. This component ensures
//! weapons appear correctly positioned relative to the player's view.
class HUMAN_DLL DtHumanWeaponPoseLogic : public makVre::DtPlayerComponent
{
public:
   //! \brief Default constructor
   DtHumanWeaponPoseLogic();
 
   //! \brief Virtual destructor
   virtual ~DtHumanWeaponPoseLogic() override;
 
   //! \brief Initializes the weapon pose logic component
   //! \param player Pointer to the player station
   //! \param config Configuration settings for initialization
   //! \return True if initialization was successful, false otherwise
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates weapon positioning for the current frame
   //! \param dt Delta time since the last frame in seconds
   virtual void tick(double dt) override;
 
   //! \brief Cleans up resources when the component is being shut down
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return String identifier for this component type
   //!
   //! Returns the type identifier string for this component, which is used
   //! by the VR-Engage framework for component identification and management.
   //! The returned value matches DtHumanWeaponPoseLogicType.
   virtual const char* type() const override;
 
protected:
   //! \brief Updates the weapon position and orientation
   //!
   //! Calculates and applies the appropriate weapon position based on the current
   //! player state, view orientation, and VR mode settings
   void updateWeaponPosition();
 
   //! \brief Pointer to the observer used for view orientation
   makVrv::DtObserver* myObserver;
 
   //! \brief Flag indicating if VR mode is active
   bool myUsingVr;
};