DtSceneObjectMimicUpdaterClasses.hpp

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file DtSceneObjectMimicUpdaterClasses.hpp
//! \brief Implementations of agent and factory classes for the DtSceneObjectMimicUpdater
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
 
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
 
#include <vrvCore/DtSceneObjectUpdaterClasses.hpp>
#include "vreCommonComponents/DtSceneObjectMimicUpdaterAgent.hpp"
 
namespace makVre 
{
 
//! \brief Implementation of the agent class for the DtSceneObjectMimicUpdater
//!
//! This class provides the concrete implementation of the DtSceneObjectMimicUpdaterAgent interface.
//! It handles communication with the actual DtSceneObjectMimicUpdater instance and implements
//! the required virtual functions for setting parent scene objects and model offsets.
class VRECOMMONCOMPONENTS_DLL DtSceneObjectMimicUpdaterAgentImplementation : public virtual DtSceneObjectMimicUpdaterAgent , public makVrv::DtSceneObjectUpdaterAgentImplementation
{
public:
   //! \brief Constructor for the DtSceneObjectMimicUpdaterAgentImplementation
   DtSceneObjectMimicUpdaterAgentImplementation();
 
   //! \brief Destructor for the DtSceneObjectMimicUpdaterAgentImplementation
   virtual ~DtSceneObjectMimicUpdaterAgentImplementation();
   
   //! \brief Sets the parent scene object that this mimic updater will follow
   //! \param id Unique ID of the parent scene object to mimic
   //!
   //! Implementation of the abstract method from DtSceneObjectMimicUpdaterAgent
   virtual void setParentSceneObject(makVrv::DtUniqueID id);
 
   
   //! \brief Sets the position offset from the parent scene object
   //! \param offset Vector specifying the local-space offset from the parent scene object
   //!
   //! Implementation of the abstract method from DtSceneObjectMimicUpdaterAgent
   virtual void setModelOffset(const DtVector& offset);
 
 
protected:
   //! \brief Finds and casts the object to DtSceneObjectUpdater
   //! \return Pointer to the controlled DtSceneObjectUpdater or nullptr if not found
   //!
   //! Implementation of the abstract method from DtSceneObjectUpdaterAgentImplementation
   virtual makVrv::DtSceneObjectUpdater* findObjectAsDtSceneObjectUpdater();
 
   //! \brief Finds and casts the object to DtSceneObjectMimicUpdater
   //! \return Pointer to the controlled DtSceneObjectMimicUpdater or nullptr if not found
   //!
   //! Implementation of the abstract method from DtSceneObjectMimicUpdaterAgent
   virtual DtSceneObjectMimicUpdater* findObjectAsDtSceneObjectMimicUpdater();
 
};
 
}
 
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
 
#include <vrvCore/DtSceneObjectUpdaterClasses.hpp>
#include "vreCommonComponents/DtSceneObjectMimicUpdater.h"
 
namespace makVre 
{
 
//! \brief Definition class for the DtSceneObjectMimicUpdater
//!
//! This class defines the agent interfaces and functionality for the DtSceneObjectMimicUpdater.
//! It registers function IDs for the various operations that can be performed on the updater,
//! such as setting the parent scene object and model offset.
class VRECOMMONCOMPONENTS_DLL DtSceneObjectMimicUpdaterClassDefinition : public makVrv::DtInheritedAgentDefinition<makVrv::DtSceneObjectUpdaterClassDefinition,DtSceneObjectMimicUpdater>
{
public:
   //! \brief Constructor for DtSceneObjectMimicUpdaterClassDefinition
   //! \param className The class name to register (defaults to "DtSceneObjectMimicUpdater")
   //!
   //! All function pointers are bound in the constructor to establish the interface
   DtSceneObjectMimicUpdaterClassDefinition(const std::string& className = "DtSceneObjectMimicUpdater");
 
   //! \brief Destructor for DtSceneObjectMimicUpdaterClassDefinition
   virtual ~DtSceneObjectMimicUpdaterClassDefinition();
 
   //! \brief Unique Function IDs used to store the state functions in a message
   //!
   //! These IDs identify the specific functions that can be called on a DtSceneObjectMimicUpdater
   //! when communicating over a network or between processes
   enum FunctionIds
   {
      //! \brief ID for the setParentSceneObject function
      function_setParentSceneObject = makVrv::DtSceneObjectUpdaterClassDefinition::end_FunctionIds,
      
      //! \brief ID for the setModelOffset function
      function_setModelOffset,
      
      //! \brief Marker for the end of the function ID enumeration
      end_FunctionIds
   };
 
};
 
}
 
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
#include <vrvCore/DtAgentCreator.h>
#include <vrvCore/DtAgentFactory.h>
 
namespace makVre 
{
 
class DtSceneObjectMimicUpdaterClassDefinition;
 
//! \brief Creator class for the DtSceneObjectMimicUpdater
//!
//! This class is responsible for creating DtSceneObjectMimicUpdater instances and their
//! corresponding agents. It registers with the agent factory system to allow creation
//! of these objects through the standard factory mechanism.
class VRECOMMONCOMPONENTS_DLL DtSceneObjectMimicUpdaterClassesCreator : public makVrv::DtAgentCreator
{
public:
 
   //! \brief Constructor for DtSceneObjectMimicUpdaterClassesCreator
   //!
   //! Initializes the creator and registers the class definition
   DtSceneObjectMimicUpdaterClassesCreator();
 
   //! \brief Destructor for DtSceneObjectMimicUpdaterClassesCreator
   virtual ~DtSceneObjectMimicUpdaterClassesCreator();
 
   //! \brief Static factory method to create an instance of this creator
   //! \return Pointer to a new DtAgentCreator instance
   //!
   //! Used by the agent factory system to create instances of this creator
   static makVrv::DtAgentCreator* create();
 
   //! \brief Creates an agent object for the DtSceneObjectMimicUpdater class
   //! \param sceneInterface The agent manager interface to register with
   //! \return Pointer to the newly created agent
   //!
   //! Implementation of the abstract method from DtAgentCreator
   virtual makVrv::DtAgent* createAgent(makVrv::DtAgentManagerInterface& sceneInterface);
 
   //! \brief Creates an updater object for the DtSceneObjectMimicUpdater class
   //! \param de The distributed environment in which to create the updater
   //! \param id The unique ID to assign to the new updater
   //! \return Pointer to the newly created updater resolver interface
   //!
   //! Implementation of the abstract method from DtAgentCreator
   virtual makVrv::DtAgentUpdateResolverInterface* createResolver(makVrv::DtDe& de, makVrv::DtUniqueID id);
 
protected:
   //! \brief Pointer to the class definition used by this creator
   DtSceneObjectMimicUpdaterClassDefinition* myDefinition;
 
   //! \brief Flag indicating if this class has been registered with the factory
   static bool theRegisteredFlag;
   
   //! \brief Auto-unregistrar to clean up factory registration when the application exits
   static makVrv::DtAgentFactory::DtAutoUnregistrar theAutoUnregistrar;
};
 
}