DtFpsFirstPersonUpdaterClasses.hpp

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file DtFpsFirstPersonUpdaterClasses.hpp
//! \brief Defines implementation classes for the first-person model updater in FPS mode
//! \ingroup vreHumanFrontend
 
#pragma once
 
#include "export.h"
 
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
 
#include <vreCommonComponents/DtSceneObjectMimicUpdaterClasses.hpp>
#include "DtFpsFirstPersonUpdaterAgent.hpp"
 
namespace makVre 
{
 
//! \brief Implementation of the agent class for DtFpsFirstPersonUpdater
//!
//! DtFpsFirstPersonUpdaterAgentImplementation provides the concrete implementation
//! of the DtFpsFirstPersonUpdaterAgent interface. It forwards method calls to the
//! actual DtFpsFirstPersonUpdater object and handles distributed operation.
class HUMAN_DLL DtFpsFirstPersonUpdaterAgentImplementation : public virtual DtFpsFirstPersonUpdaterAgent , public DtSceneObjectMimicUpdaterAgentImplementation
{
public:
   //! \brief Default constructor
   DtFpsFirstPersonUpdaterAgentImplementation();
 
   //! \brief Virtual destructor
   virtual ~DtFpsFirstPersonUpdaterAgentImplementation() 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) override;
 
   //! \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) override;
 
   //! \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) override;
 
   //! \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) override;
 
   //! \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) override;
 
 
protected:
   //! \brief Finds the controlled object as DtSceneObjectMimicUpdater
   //! \return Pointer to the controlled updater object as DtSceneObjectMimicUpdater
   virtual DtSceneObjectMimicUpdater* findObjectAsDtSceneObjectMimicUpdater() override;
 
   //! \brief Implementation of the abstract method to find the controlled object
   //! \return Pointer to the controlled DtFpsFirstPersonUpdater object
   virtual DtFpsFirstPersonUpdater* findObjectAsDtFpsFirstPersonUpdater() override;
 
};
 
}
 
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
 
#include "DtFpsFirstPersonUpdater.h"
 
namespace makVre 
{
 
//! \brief Class definition for the DtFpsFirstPersonUpdater
//!
//! DtFpsFirstPersonUpdaterClassDefinition defines the function IDs and agent
//! interactions for the DtFpsFirstPersonUpdater class. It establishes the
//! interface between the agent system and the actual updater object.
class HUMAN_DLL DtFpsFirstPersonUpdaterClassDefinition : public makVrv::DtInheritedAgentDefinition<DtSceneObjectMimicUpdaterClassDefinition,DtFpsFirstPersonUpdater>
{
public:
   //! \brief Constructor
   //! \param className Name of the class being defined, defaults to "DtFpsFirstPersonUpdater"
   //!
   //! All function pointers are bound in the constructor.
   DtFpsFirstPersonUpdaterClassDefinition(const std::string& className = "DtFpsFirstPersonUpdater");
 
   //! \brief Virtual destructor
   virtual ~DtFpsFirstPersonUpdaterClassDefinition() override;
 
   //! \brief Unique function IDs used to store the state functions in a message
   //!
   //! These IDs identify the different functions that can be invoked on this class
   //! through the agent system. They are used for message serialization and routing.
   enum FunctionIds
   {
      //! \brief ID for the setModelPitch function
      function_setModelPitch = DtSceneObjectMimicUpdaterClassDefinition::end_FunctionIds,
      
      //! \brief ID for the setModelHeading function
      function_setModelHeading,
      
      //! \brief ID for the setPitchAxis function
      function_setPitchAxis,
      
      //! \brief ID for the setBaseRotation function
      function_setBaseRotation,
      
      //! \brief ID for the setPivotJoint function
      function_setPivotJoint,
      
      //! \brief Marks the end of the function IDs for this class
      end_FunctionIds
   };
 
};
 
}
 
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
#include <vrvCore/DtAgentCreator.h>
#include <vrvCore/DtAgentFactory.h>
 
namespace makVre 
{
 
class DtFpsFirstPersonUpdaterClassDefinition;
 
//! \brief Creator class for DtFpsFirstPersonUpdater agents
//!
//! DtFpsFirstPersonUpdaterClassesCreator handles the creation of agents and
//! resolvers for DtFpsFirstPersonUpdater objects. It registers itself with
//! the agent factory system to enable dynamic creation of these objects.
class HUMAN_DLL DtFpsFirstPersonUpdaterClassesCreator : public makVrv::DtAgentCreator
{
public:
   //! \brief Default constructor
   DtFpsFirstPersonUpdaterClassesCreator();
 
   //! \brief Virtual destructor
   virtual ~DtFpsFirstPersonUpdaterClassesCreator() override;
 
   //! \brief Static factory method to create a new creator instance
   //! \return Pointer to a newly created DtAgentCreator instance
   static makVrv::DtAgentCreator* create();
 
   //! \brief Creates an agent object for the DtFpsFirstPersonUpdater class
   //! \param sceneInterface Reference to the agent manager interface
   //! \return Pointer to the newly created agent
   virtual makVrv::DtAgent* createAgent(makVrv::DtAgentManagerInterface& sceneInterface) override;
 
   //! \brief Creates an updater resolver for the DtFpsFirstPersonUpdater class
   //! \param de Reference to the display element
   //! \param id Unique identifier for the new resolver
   //! \return Pointer to the newly created agent update resolver interface
   virtual makVrv::DtAgentUpdateResolverInterface* createResolver(makVrv::DtDe& de, makVrv::DtUniqueID id) override;
 
protected:
   //! \brief Pointer to the class definition for DtFpsFirstPersonUpdater
   DtFpsFirstPersonUpdaterClassDefinition* myDefinition;
 
   //! \brief Static flag indicating if this creator is registered with the factory
   static bool theRegisteredFlag;
   
   //! \brief Static auto-unregistrar to handle cleanup when the module is unloaded
   static makVrv::DtAgentFactory::DtAutoUnregistrar theAutoUnregistrar;
};
 
}