vreIndLocalNetIfWithProperties.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreIndLocalNetIfWithProperties.h
//! \ingroup vreVrfVrlinkNetworkInterface
//! \brief Enhanced local entity network interface for VREngage
//!
//! This file defines the DtVreIndividualLocalEntityNetInterface class, which extends
//! the standard network interface with VREngage-specific functionality, particularly
//! for player-controlled entities to improve network update fidelity.
 
#pragma once
 
#include "vreVrfVrlinkNetworkInterface/export.h"
 
#include <vrlinkNetworkInterface/simIndividualLocalEntityWithPropertiesNetInterface.h>
 
//! \brief Enhanced local entity network interface for VREngage
//!
//! This class replaces the default local entity network interface, which is responsible
//! for copying internal entity state to the VR-Link publisher which outputs that data to
//! the network. It forces an update each frame when the entity is player-controlled
//! to improve fidelity for that particular entity, ensuring smoother player movement
//! and interactions in networked simulations.
 
namespace makVre
{
//! \brief Enhanced local entity network interface for VREngage
//!
//! This class implements a specialized network interface for local entities in VREngage.
//! It extends the standard interface with VREngage-specific functionality, particularly
//! for improving the network update rates of player-controlled entities to ensure
//! smoother movement and interactions in networked simulations.
class VREVRFVRLINKNETWORKINTERFACE_DLL DtVreIndividualLocalEntityNetInterface
   : public makVrf::DtSimIndividualLocalEntityWithPropertiesNetInterface
{
public:
   //! \brief Constructor
   //! \param vrfObject The state data object for the entity
   //! \param mgr The VRLink network interface manager
   //! \param publishObject Flag indicating whether this object should be published (default: true)
   //!
   //! Initializes a new network interface for the specified entity with VREngage-specific
   //! enhancements for network publication.
   DtVreIndividualLocalEntityNetInterface(
      makVrf::DtStateData* vrfObject, makVrf::DtVrlinkNetworkInterface* mgr, bool publishObject = true);
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the network interface.
   virtual ~DtVreIndividualLocalEntityNetInterface();
 
   //! \brief Updates the VR-Link publisher with current entity state
   //!
   //! Copies entity state data from the VR-Forces state components into the
   //! VR-Link state repository for publication to the network. This implementation
   //! enhances the update behavior for player-controlled entities to improve network
   //! fidelity of movement and other state changes.
   //!
   //! \note For player-controlled entities, this function forces an update on every frame
   //! regardless of internal change detection, ensuring smoother network representation.
   virtual void updatePublisher();
 
   //! \brief Gets the type identifier for this network interface
   //! \return String identifying this network interface type
   //!
   //! Returns a unique type identifier string for this custom network interface.
   //! This is overridden to completely replace the default VR-Forces interface in
   //! the interface factory system.
   virtual DtString type() const;
 
   //! \brief Factory function to create a new instance of this interface
   //! \param vrfObject The state data object for the entity
   //! \param mgr The VRLink network interface manager
   //! \param publishObject Flag indicating whether this object should be published
   //! \return Pointer to the newly created network interface
   //!
   //! Static factory function used by the interface creation system to instantiate
   //! new instances of this network interface type.
   static DtSimObjectNetInterface* creator(
      makVrf::DtStateData* vrfObject, makVrf::DtVrlinkNetworkInterface* mgr, bool publishObject);
 
protected:
   //! \brief Determines if the entity is currently player-controlled
   //! \return True if the entity is player-controlled, false otherwise
   //!
   //! Checks if the entity is currently being controlled by a player in any role.
   //! This is determined by examining the extended data map for an entry starting
   //! with the string "role-" and having a non-empty string value, which indicates
   //! that a player is assigned to the entity in some capacity.
   virtual bool isPlayerControlled();
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreIndividualLocalEntityNetInterface();
 
   //! \brief Copy constructor (not implemented)
   //! \param orig The source object
   //!
   //! Copy constructor is private and not implemented to prevent copying.
   DtVreIndividualLocalEntityNetInterface(const DtVreIndividualLocalEntityNetInterface& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \param orig The source object
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   const DtVreIndividualLocalEntityNetInterface& operator=(const DtVreIndividualLocalEntityNetInterface& orig);
};
} // namespace makVre