DtFpsOrientationUpdaterAgent.hpp

Go to the documentation of this file.

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