DtFpsOrientationUpdaterClasses.hpp

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file DtFpsOrientationUpdaterClasses.hpp
//! \brief Defines implementation classes for the orientation updater in FPS mode
//! \ingroup vreHumanFrontend
 
#pragma once
 
#include "export.h"
 
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
 
#include <vrvCore/DtSceneObjectUpdaterClasses.hpp>
#include "DtFpsOrientationUpdaterAgent.hpp"
 
namespace makVre 
{
 
//! \brief Implementation of the agent class for DtFpsOrientationUpdater
//!
//! DtFpsOrientationUpdaterAgentImplementation provides the concrete implementation
//! of the DtFpsOrientationUpdaterAgent interface. It forwards method calls to the
//! actual DtFpsOrientationUpdater object and handles distributed operation.
class HUMAN_DLL DtFpsOrientationUpdaterAgentImplementation : public virtual DtFpsOrientationUpdaterAgent , public makVrv::DtSceneObjectUpdaterAgentImplementation
{
public:
   //! \brief Default constructor
   DtFpsOrientationUpdaterAgentImplementation();
 
   //! \brief Virtual destructor
   virtual ~DtFpsOrientationUpdaterAgentImplementation() 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) override;
 
 
protected:
   //! \brief Finds the controlled object as DtSceneObjectUpdater
   //! \return Pointer to the controlled updater object as DtSceneObjectUpdater
   virtual makVrv::DtSceneObjectUpdater* findObjectAsDtSceneObjectUpdater() override;
 
   //! \brief Implementation of the abstract method to find the controlled object
   //! \return Pointer to the controlled DtFpsOrientationUpdater object
   virtual DtFpsOrientationUpdater* findObjectAsDtFpsOrientationUpdater() override;
 
};
 
}
 
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
 
#include "DtFpsOrientationUpdater.h"
 
namespace makVre 
{
 
//! \brief Class definition for the DtFpsOrientationUpdater
//!
//! DtFpsOrientationUpdaterClassDefinition defines the function IDs and agent
//! interactions for the DtFpsOrientationUpdater class. It establishes the
//! interface between the agent system and the actual updater object.
class HUMAN_DLL DtFpsOrientationUpdaterClassDefinition : public makVrv::DtInheritedAgentDefinition<makVrv::DtSceneObjectUpdaterClassDefinition,DtFpsOrientationUpdater>
{
public:
   //! \brief Constructor
   //! \param className Name of the class being defined, defaults to "DtFpsOrientationUpdater"
   //!
   //! All function pointers are bound in the constructor.
   DtFpsOrientationUpdaterClassDefinition(const std::string& className = "DtFpsOrientationUpdater");
 
   //! \brief Virtual destructor
   virtual ~DtFpsOrientationUpdaterClassDefinition() 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 setModelHeading function
      function_setModelHeading = makVrv::DtSceneObjectUpdaterClassDefinition::end_FunctionIds,
      
      //! \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 
{
 
//! \brief Forward declaration of the orientation updater class definition
class DtFpsOrientationUpdaterClassDefinition;
 
//! \brief Creator class for DtFpsOrientationUpdater agents
//!
//! DtFpsOrientationUpdaterClassesCreator handles the creation of agents and
//! resolvers for DtFpsOrientationUpdater objects. It registers itself with
//! the agent factory system to enable dynamic creation of these objects.
class HUMAN_DLL DtFpsOrientationUpdaterClassesCreator : public makVrv::DtAgentCreator
{
public:
   //! \brief Default constructor
   DtFpsOrientationUpdaterClassesCreator();
 
   //! \brief Virtual destructor
   virtual ~DtFpsOrientationUpdaterClassesCreator() 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 DtFpsOrientationUpdater 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 DtFpsOrientationUpdater 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 DtFpsOrientationUpdater
   DtFpsOrientationUpdaterClassDefinition* 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;
};
 
}