makVre::DtEntityRoleDescriptor Struct Reference

Detailed Description

Contains comprehensive information about an entity role, including its visibility settings, configuration path, parameters, and associated display configurations.

#include <entityRoleDescriptorStructs.h>

Public Attributes
bool	unlisted
std::string	slotName
std::string	path
std::map< std::string, std::string >	parameters
std::string	defaultDisplayLayout
std::map< std::string, DtDisplayConfigDescriptor >	displayConfigDescriptors

Member Data Documentation

unlisted

bool makVre::DtEntityRoleDescriptor::unlisted

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

slotName

std::string makVre::DtEntityRoleDescriptor::slotName

Name of the role as it appears in the Choose Role panel.

path

std::string makVre::DtEntityRoleDescriptor::path

Location of the role configuration file.

parameters

std::map<std::string, std::string> makVre::DtEntityRoleDescriptor::parameters

Map of parameter override names to values.

Used for overriding portions of the role configuration file with data specific to a given entity

defaultDisplayLayout

std::string makVre::DtEntityRoleDescriptor::defaultDisplayLayout

Default display layout to use if none is specified.

Example: "1 Screen Horizontal"

displayConfigDescriptors

std::map<std::string, DtDisplayConfigDescriptor> makVre::DtEntityRoleDescriptor::displayConfigDescriptors

Map of display configuration names to their descriptors.

---

The documentation for this struct was generated from the following file:

• include/utilities/vreUtil/entityRoleDescriptorStructs.h