DtFpsFirstPersonUpdaterAgent.hpp

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file DtFpsFirstPersonUpdaterAgent.hpp
//! \brief Defines DtFpsFirstPersonUpdaterAgent for remote control of first-person model updaters
//! \ingroup vreHumanFrontend
 
#pragma once
 
#include "export.h"
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
 
#include <vreCommonComponents/DtSceneObjectMimicUpdaterAgent.hpp>
 
namespace makVre 
{
//! \brief Forward declaration of the first-person updater class
class DtFpsFirstPersonUpdater;
 
//! \brief Agent class for remote control of DtFpsFirstPersonUpdater objects
//!
//! DtFpsFirstPersonUpdaterAgent provides a distributed interface for controlling
//! DtFpsFirstPersonUpdater objects. It enables remote control of first-person model
//! orientation and configuration across distributed rendering systems. This agent
//! forwards calls to the actual updater object, handling distribution when needed.
class HUMAN_DLL DtFpsFirstPersonUpdaterAgent : public virtual DtSceneObjectMimicUpdaterAgent
{
public:
   //! \brief Default constructor
   DtFpsFirstPersonUpdaterAgent();
 
   //! \brief Static helper method to create an instance of this agent
   //! \param sceneInterface Reference to the agent manager interface
   //! \param bDistribute Flag indicating whether to distribute this agent
   //! \return Pointer to a newly created agent instance
   static DtFpsFirstPersonUpdaterAgent* create(makVrv::DtAgentManagerInterface& sceneInterface, bool bDistribute = true);
 
   //! \brief Virtual destructor
   virtual ~DtFpsFirstPersonUpdaterAgent() override;
 
   //! \brief Finds the actual updater object this agent is controlling
   //! \return Pointer to the controlled DtFpsFirstPersonUpdater object
   //! \warning Any direct modifications to the actual object will NOT work when
   //! using distributed rendering
   DtFpsFirstPersonUpdater* findObject();
   
   //! \brief Finds the actual updater object this agent is controlling (const version)
   //! \return Const pointer to the controlled DtFpsFirstPersonUpdater object
   //! \warning Any direct modifications to the actual object will NOT work when
   //! using distributed rendering
   const DtFpsFirstPersonUpdater* findObject() const;
 
   //! \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) = 0;
 
   //! \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) = 0;
 
   //! \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) = 0;
 
   //! \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) = 0;
 
   //! \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) = 0;
 
 
protected:
   //! \brief Implementation method to find the controlled object as DtFpsFirstPersonUpdater
   //! \return Pointer to the controlled DtFpsFirstPersonUpdater object
   virtual DtFpsFirstPersonUpdater* findObjectAsDtFpsFirstPersonUpdater() = 0;
};
 
}