DtSceneObjectMimicUpdaterAgent.hpp

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file DtSceneObjectMimicUpdaterAgent.hpp
//! \brief Agent interface for the DtSceneObjectMimicUpdater that enables one scene object to mimic another
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include <vrvCore/DtUniqueID.h>
// *** Generated Code - Do Not Edit! ***
// *** Created by dcgen              ***
 
 
#include <vrvCore/DtSceneObjectUpdaterAgent.hpp>
 
namespace makVre 
{
 
class DtSceneObjectMimicUpdater;
 
//! \brief Agent class for the scene object class: DtSceneObjectMimicUpdater
//!
//! This agent provides an interface to control a DtSceneObjectMimicUpdater, which allows
//! one scene object to follow another's position and orientation with an optional offset.
//! It is commonly used for attaching objects to others in a scene, such as weapons to characters
//! or interior models to vehicles.
class VRECOMMONCOMPONENTS_DLL DtSceneObjectMimicUpdaterAgent : public virtual makVrv::DtSceneObjectUpdaterAgent
{
public:
    //! \brief Constructor for the DtSceneObjectMimicUpdaterAgent
    DtSceneObjectMimicUpdaterAgent();
 
    //! \brief Static helper method to create an instance of this agent
    //! \param sceneInterface The agent manager interface to register with
    //! \param bDistribute Flag indicating if the agent should be distributed in networked scenarios
    //! \return Pointer to the newly created agent instance
    static DtSceneObjectMimicUpdaterAgent* create(makVrv::DtAgentManagerInterface& sceneInterface, bool bDistribute = true);
 
    //! \brief Destructor for the DtSceneObjectMimicUpdaterAgent
    virtual ~DtSceneObjectMimicUpdaterAgent();
 
    //! \brief Attempt to find the actual object the agent is controlling
    //! \return Pointer to the controlled DtSceneObjectMimicUpdater instance or nullptr if not found
    //! \warning Any modifications to the actual object will NOT work when
    //! using distributed rendering
    DtSceneObjectMimicUpdater* findObject();
    
    //! \brief Const version of findObject()
    //! \return Const pointer to the controlled DtSceneObjectMimicUpdater instance or nullptr if not found
    const DtSceneObjectMimicUpdater* findObject() const;
 
   
    //! \brief Sets the parent scene object that this mimic updater will follow
    //! \param id Unique ID of the parent scene object to mimic
    //!
    //! The mimic updater will track the specified scene object, following its position
    //! and orientation with the configured offset
    virtual void setParentSceneObject(makVrv::DtUniqueID id) = 0;
 
   
    //! \brief Sets the position offset from the parent scene object
    //! \param offset Vector specifying the local-space offset from the parent scene object
    //!
    //! This offset is applied in the parent object's local space, then transformed to world space
    //! when positioning the mimic object
    virtual void setModelOffset(const DtVector& offset) = 0;
 
 
protected:
    //! \brief Internal method to find and cast the object to DtSceneObjectMimicUpdater
    //! \return Pointer to the controlled DtSceneObjectMimicUpdater or nullptr if not found
    //!
    //! This method is implemented by derived agent classes to properly locate and cast
    //! the object being controlled
    virtual DtSceneObjectMimicUpdater* findObjectAsDtSceneObjectMimicUpdater() = 0;
};
 
}