DtFpsOrientationUpdater.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file DtFpsOrientationUpdater.h
//! \brief Defines DtFpsOrientationUpdater for managing orientation in FPS mode
//! \ingroup vreHumanFrontend
 
#pragma once
 
 
#include "vreHumanFrontend/export.h"
 
#include <vrvCore/DtSceneObjectUpdater.h>
 
namespace makVrv
{
//! \brief Forward declaration of the model instance class
class DtModelInstance;
 
//! \brief Forward declaration of the OSG model instance class
class DtOsgModelInstance;
} // namespace makVrv
 
namespace osg
{
//! \brief Forward declaration of the OSG node class
class Node;
} // namespace osg
 
using namespace makVrv;
 
namespace makVre
{
//! \brief Forward declaration of the player station class
class DtPlayerStation;
 
//! \brief Updater for controlling orientation in first-person shooter mode
//!
//! DtFpsOrientationUpdater controls the orientation of scene objects
//! in first-person shooter mode. It allows setting the heading of the model
//! and updates the object's orientation accordingly each frame.
class HUMAN_DLL DtFpsOrientationUpdater : public DtSceneObjectUpdater
{
public:
   //! \brief Constructor
   //! \param de Reference to the display element
   //! \param id Unique identifier for this updater
   DtFpsOrientationUpdater(DtDe& de, DtUniqueID id);
 
   //! \brief Virtual destructor
   virtual ~DtFpsOrientationUpdater() override;
 
   //! \brief Updates the orientation for the current frame
   //! \param tNow Current simulation time
   //!
   //! Updates the scene object's orientation based on the current model heading
   //! and yaw configuration.
   virtual void update(DtTime tNow) override;
 
   //! \brief Sets the heading of the model
   //! \param heading Heading angle in degrees
   //! \param useYaw Flag indicating whether to use yaw rotation or direct orientation
   //!
   //! Controls the heading rotation of the model. When useYaw is true, the heading is
   //! applied as a yaw rotation. Otherwise, it's applied as a direct orientation change.
   virtual void setModelHeading(double heading, bool useYaw);
 
protected:
   //! \brief Current heading angle of the model in degrees
   double myModelHeading;
 
   //! \brief Flag indicating whether to use yaw rotation or direct orientation
   bool myUseYaw;
};
} // namespace makVre