DtFpsFirstPersonUpdater.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file DtFpsFirstPersonUpdater.h
//! \brief Defines DtFpsFirstPersonUpdater for managing first-person model view in FPS mode
//! \ingroup vreHumanFrontend
 
#pragma once
 
#include "vreHumanFrontend/export.h"
#include "vreCommonComponents/DtSceneObjectMimicUpdater.h"
 
#include <string>
 
using namespace makVrv;
 
namespace makVre
{
//! \brief Updater for first-person model control in FPS mode
//!
//! DtFpsFirstPersonUpdater extends the scene object mimic updater to provide
//! specific control over a first-person model. It manages pitch and heading
//! rotations of the model relative to the parent entity, with configurable
//! pivot joints and rotation axes. This class is used primarily for the
//! first-person view in the human role to control model orientation.
class HUMAN_DLL DtFpsFirstPersonUpdater : public DtSceneObjectMimicUpdater
{
public:
   //! \brief Constructor
   //! \param de Reference to the display element
   //! \param id Unique identifier for this updater
   DtFpsFirstPersonUpdater(DtDe& de, DtUniqueID id);
 
   //! \brief Virtual destructor
   virtual ~DtFpsFirstPersonUpdater() override;
 
   //! \brief Sets the pitch of the first-person model
   //! \param pitch Pitch angle in degrees
   //!
   //! Controls the pitch rotation of the first-person model, relative to the
   //! parent entity's SceneObject orientation.
   virtual void setModelPitch(float pitch);
 
   //! \brief Sets the heading of the first-person model
   //! \param heading Heading angle in degrees
   //!
   //! Controls the heading rotation of the first-person model, relative to the
   //! parent entity's SceneObject orientation.
   virtual void setModelHeading(float heading);
 
   //! \brief Sets the axis used for pitch rotation
   //! \param axis Character representing the axis ('X', 'Y', or 'Z')
   //!
   //! Configuration parameter that controls which axis is used by setModelPitch.
   //! Default is 'Y'.
   virtual void setPitchAxis(char axis);
 
   //! \brief Sets the base rotation for the first-person model
   //! \param yawPitchRoll Vector containing yaw, pitch, and roll values in degrees
   //!
   //! Configuration parameter that sets a base rotation for the first-person model.
   //! Values from setModelPitch and setModelHeading are added to this base rotation.
   //! Value is relative to the parent entity's SceneObject. Default is (0,0,0).
   virtual void setBaseRotation(DtVector yawPitchRoll);
 
   //! \brief Sets the pivot joint for model rotation
   //! \param jointName Name of the skeletal joint to use as pivot
   //!
   //! Configuration parameter that specifies the name of the skeletal joint in the
   //! first-person model around which the model should be rotated. Default is "cervical".
   virtual void setPivotJoint(std::string jointName);
 
protected:
   //! \brief Initializes the model instance
   //! \param modelInstance Pointer to the model instance to initialize
   virtual void initModel(DtModelInstance* modelInstance) override;
 
   //! \brief Sets up the OSG node
   //! \param node Pointer to the OSG node to set up
   virtual void setupOsgNode(osg::Node* node) override;
 
   //! \brief Updates the position and orientation for the current frame
   //! \param tNow Current simulation time
   virtual void updatePosition(DtTime tNow) override;
 
   //! \brief Name of the DIGuy character model
   std::string myDIGuyCharacterName;
 
   //! \brief Current pitch angle of the model in degrees
   float myModelPitch;
 
   //! \brief Current heading angle of the model in degrees
   float myModelHeading;
 
   //! \brief Flag indicating if the model is in aiming pose
   bool myModelAiming;
 
   //! \brief Enumeration of possible rotation axes
   enum Axis
   {
      X,
      Y,
      Z
   };
 
   //! \brief Current axis used for pitch rotation
   Axis myPitchAxis;
 
   //! \brief Name of the base joint for the model
   std::string myBaseJoint;
 
   //! \brief Name of the pivot joint for model rotation
   std::string myPivotJoint;
 
   //! \brief Base rotation of the model in degrees using Tait-Bryan angles
   DtTaitBryan myModelRotationDegrees;
};
} // namespace makVre