vrfObjectStateRepositoryUtil.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vrfObjectStateRepositoryUtil.h
//! \ingroup vreVrfobjcore
//! \brief Utility functions for VRF object state repositories
//!
//! This file contains utility functions associated with the DtVrfObjectStateRepository class
//! and related functionality. It provides helpers for determining player control status
//! of simulation entities.
 
#include "vreVrfobjcore/export.h"
 
#include <string>
 
class DtSimObject;
class DtLocalObjectManager;
 
namespace makVre
{
//! \brief Component name for the movement chooser
//!
//! Constant string defining the component name for the movement chooser system.
//! Used for component lookups when determining player control status.
const char DtMovementChooserComponentName[] = "base-system.movement.movement-chooser";
 
//! \brief Checks if an entity is under player control
//! \param stateRep Reference to the simulation object to check
//! \return True if the entity is currently under player control in any role, false otherwise
//!
//! This function determines whether a simulation entity is currently being controlled
//! by a player in any role. It checks the entity's components to see if a player has
//! assumed control in roles such as driver, gunner, commander, etc.
VREVRFOBJCORE_DLL bool isPlayerControlled(const DtSimObject& stateRep);
 
//! \brief Checks if an entity is under player control in a specific role
//! \param stateRep Reference to the simulation object to check
//! \param role The specific role to check for (e.g., "Driver", "Gunner", "Commander")
//! \return True if the entity is currently controlled by a player in the specified role, false otherwise
//!
//! This function determines whether a simulation entity is currently being controlled
//! by a player in the specified role. It checks the entity's components to see if
//! a player has assumed control in the given role.
VREVRFOBJCORE_DLL bool isPlayerControlledAs(const DtSimObject& stateRep, std::string role);
 
VREVRFOBJCORE_DLL void setLocalObjectManager(DtLocalObjectManager* mgr);
VREVRFOBJCORE_DLL DtLocalObjectManager* getLocalObjectManager();
} // namespace makVre