util.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
//! \file util.h
//! \brief Utility functions for VREngage player station connector
//!
//! This file provides utility functions to support the VREngage player station connector,
//! including functions to create and populate simulation state messages from entity data.
 
#pragma once
 
#include "vrePlayerStationConnector/export.h"
 
#include "vreUtil/attribute.h"
 
//! \brief Forward declaration of the reflected entity class
class DtReflectedEntity;
class DtReflectedExtEntityList;
 
namespace makVre
{
//! \brief Forward declaration of the simulation state message class
class SimulationStateMessage;
 
//! \brief Creates and populates a simulation state message from an entity
//! \param entity Pointer to the reflected entity to extract state information from
//! \return Pointer to a newly created simulation state message containing the entity's state
//!
//! This function extracts position, orientation, and other state information from
//! the provided entity and creates a SimulationStateMessage containing this data.
//! The caller is responsible for managing the lifecycle of the returned message.
VRL_DLL SimulationStateMessage* createAndFillSimStateMessage(DtReflectedEntity* entity);
 
VRL_DLL void updateReflectedEntityAttributes(DtReflectedExtEntityList* rel, DtAttributeHandle entityStateStore);
 
} // namespace makVre