roleTemplateUtilities.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file roleTemplateUtilities.h
//! \ingroup vreUtil
//! \brief Utility functions for working with role configuration files
//!
//! This file provides utility functions for loading and managing role definition files,
//! display configurations, and other role-related settings. It includes functions for
//! loading table files, retrieving role templates, and managing display layouts.
 
#pragma once
 
#include "vreUtil/export.h"
#include "vreUtil/entityRoleDescriptorStructs.h"
#include "vreUtil/initializer.h"
 
#include <set>
#include <string>
 
namespace makVre
{
//! \brief Loads a table file from the specified path
//! \param path The file path to the table file (e.g., a display configuration file)
//! \param initializer Pointer to the initializer used to load the file
//! \return DtInitTable containing the loaded table data
//!
//! This function loads a table file (typically a display configuration or other
//! configuration file) from the specified path using the provided initializer.
UTIL_DLL DtInitTable loadTableFile(const std::string& path, DtInitializer* initializer);
 
//! \brief Loads a role definition file from the specified path
//! \param path The file path to the role definition file
//! \param initializer Pointer to the initializer used to load the file
//! \return DtInitTable containing the loaded role template data
//!
//! This function loads a role definition file from the specified path and
//! returns it as a DtInitTable structure for further processing.
UTIL_DLL DtInitTable getRoleTemplateFromPath(const std::string& path, DtInitializer* initializer);
 
//! \brief Retrieves a display configuration by name for a given role descriptor
//! \param roleDescriptor The role descriptor containing display configurations
//! \param name The name of the display configuration to retrieve
//! \param initializer Pointer to the initializer used for loading
//! \return DtInitTable containing the requested display layout configuration
//!
//! This function looks up and loads a display configuration by name. It first checks
//! for the display configuration in the additional display configurations list,
//! which contains any new configurations or overrides to what's in the role template file.
//! If not found there, it then checks the role file itself.
UTIL_DLL DtInitTable getDisplayLayout(
   DtEntityRoleDescriptor& roleDescriptor, const std::string& name, DtInitializer* initializer);
 
//! \brief Retrieves the default display configuration for a role
//! \param roleDescriptorPath The path to the role descriptor file
//! \param initializer Pointer to the initializer used for loading
//! \return DtInitTable containing the default display layout configuration
//!
//! This function loads the role descriptor from the specified path and then
//! retrieves the default display configuration defined for that role.
UTIL_DLL DtInitTable getDefaultDisplayLayout(const std::string& roleDescriptorPath, DtInitializer* initializer);
 
//! \brief Retrieves all available display configuration names for a role
//! \param roleDescriptor The role descriptor to get display configurations from
//! \param initializer Pointer to the initializer used for loading
//! \param displayConfigNames Output parameter to store the configuration names
//!
//! This function populates the provided set with the names of all display configurations
//! available for the specified role descriptor. It includes configurations from
//! both the role template file and any additional display configurations.
UTIL_DLL void getDisplayConfigNames(
   DtEntityRoleDescriptor& roleDescriptor, DtInitializer* initializer, std::set<std::string>& displayConfigNames);
 
//! \brief Clears the role template cache
//! \param initializer Pointer to the initializer whose cache should be cleared
//!
//! This function clears the entire role template cache in the provided initializer,
//! forcing fresh loading of role templates on subsequent requests.
UTIL_DLL void clearRoleCache(DtInitializer* initializer);
} // namespace makVre