entityRoleDescriptorStructs.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file entityRoleDescriptorStructs.h
//! \ingroup vreUtil
//! \brief Defines data structures for entity role configurations
//!
//! This file contains the data structures used to describe entity roles,
//! display configurations, and parameter mappings in the VREngage system.
//! These structures support the management of role-based entity capabilities.
 
#pragma once
 
#include "vreUtil/export.h"
#include "vreUtil/initializer.h"
 
#include <string>
 
namespace makVre
{
//! \brief Descriptor for a display configuration
//!
//! Contains information about a display configuration, including its file path
//! and parameter overrides that modify the configuration for specific entities.
struct UTIL_DLL DtDisplayConfigDescriptor
{
   //! \brief Location of the display configuration file
   std::string path;
 
   //! \brief Map of parameter override names to values
   //!
   //! The key is the name of a Lua table member in the display configuration, e.g.,
   //! "savedViewUpdater.savedViews", and the value is the Lua code fragment
   //! to replace in the given display configuration, e.g., "boxerApcViews.osrx".
   std::map<std::string, std::string> parameters;
};
 
//! \brief Descriptor for an entity role
//!
//! Contains comprehensive information about an entity role, including its
//! visibility settings, configuration path, parameters, and associated
//! display configurations.
struct UTIL_DLL DtEntityRoleDescriptor
{
   //! \brief Flag indicating if this role should be hidden in the GUI
   //!
   //! When true, the role will not be listed explicitly in the Choose Role panel
   bool unlisted;
 
   //! \brief Name of the role as it appears in the Choose Role panel
   std::string slotName;
 
   //! \brief Location of the role configuration file
   std::string path;
 
   //! \brief Map of parameter override names to values
   //!
   //! Used for overriding portions of the role configuration file with data
   //! specific to a given entity
   std::map<std::string, std::string> parameters;
 
   //! \brief Default display layout to use if none is specified
   //!
   //! Example: "1 Screen Horizontal"
   std::string defaultDisplayLayout;
 
   //! \brief Map of display configuration names to their descriptors
   std::map<std::string, DtDisplayConfigDescriptor> displayConfigDescriptors;
};
 
//! \brief Map of parameter names to values for entity configuration
//!
//! Used to store parameter overrides for entities
using DtEntityParameterMap = std::map<std::string, std::string>;
 
//! \brief Map of role names to role descriptor objects
//!
//! Used to store all roles associated with an entity
using DtEntityRoleMap = std::map<std::string, std::shared_ptr<DtEntityRoleDescriptor>>;
} // namespace makVre