Commons configuration file (cfg_commons)
- Last UpdatedDec 04, 2023
- 4 minute read
The cfg_commons.xml file contains configuration settings that relate to virtual reality settings.
For more information, see Main logic files and Avatar customization.
Understanding VR settings
This section describes the settings when using a HMD Visor, such as Oculus Rift or HTC Vive.
|
VR setting |
Description |
|---|---|
|
vr.enabled |
Keep this setting False. It is managed by modules. Do not change it unless explicitly requested. |
|
vr.moveUsingTrackerDirection |
Keep this setting True to avoid motion sickness. |
|
vr.handLeftModel |
Specifies which model to show for left hand. Use off/ to remove visualization when not required, such as having the Oculus Rift without Touch devices. Use Auto to automatically detect the correct device model to show. |
|
vr.handRightModel |
Specifies which model to show for right hand. Use off/ to remove visualization when not required, such as having the Oculus Rift without touch devices. Use Auto to automatically detect the correct device model to show. |
|
vr.viewfinder |
Specifies which selection mode to be used by the InteractionSelector node. The modes are: 2D pointer, 3D solid pointer, and Selection stick attached to selected hand device. |
|
vr.interactionpanel |
Specifies how to display item-related information. Hand uses ItemViewer2D node while HUD keeps using InteractionViewer and InteractionActionMenu nodes. |
Parameters
main
The main parameters of the configuration file.
|
Name |
Type |
Description |
|---|---|---|
|
main |
Group |
These parameters are used to define the application type and is high level functionalities. |
|
type |
SSTRING |
Application type. The options are: Simulation, Viewer. |
|
simsetup |
SBOOL |
Enables simsetup. |
|
scenario |
SBOOL |
Enable scenario. |
|
graphicContext |
SSTRING |
Application user starting point file. Can be either a graphic context or a script file. |
|
initialConditions |
SSTRING |
Initial conditions file to load. Used only in simulation projects. |
customBanner
The custom banner parameters of the configuration file.
|
Name |
Type |
Description |
|---|---|---|
|
customBanner |
Group |
Allows to add a banner image to the application for customization reasons. |
|
enable |
SBOOL |
Enables custom banner. |
|
position |
SVEC2 |
The custom banner position. |
|
size |
SVEC2 |
The custom banner size. |
|
image |
SSTRING |
The custom banner image. |
commons
The common parameters of the configuration file.
|
Name |
Type |
Description |
|---|---|---|
|
commons |
Group |
Despite of the name this section is designed to manage SHADERGEN avatar PPE and tools selection |
|
dpi |
Group |
The DPI list includes both PPE and tools. |
|
items |
Group |
List of DPI and tools. |
|
normal_hardhead |
Group |
Standard hardhead. |
|
initialState |
SBOOL |
The initial state for item. |
|
visor_protection |
Group |
Face protection that can be mounted on the normal_hardhead. |
|
initialState |
SBOOL |
The initial state for item. |
|
hearing_protection |
Group |
Hearing protection that can be mounted on the normal_hardhead. |
|
initialState |
SBOOL |
The initial state for item. |
|
faceshield_hardhead |
Group |
Hardhead provided faceshield. |
|
initialState |
SBOOL |
The initial state for item. |
|
gallet_hardhead |
Group |
Fire protection hardhead. |
|
initialState |
SBOOL |
The initial state for item. |
|
gloves |
Group |
Protection gloves. |
|
initialState |
SBOOL |
The initial state for item. |
|
safety_glasses |
Group |
Safety glasses. |
|
initialState |
SBOOL |
The initial state for item. |
|
splash_goggle |
Group |
Welding type glasses. |
|
initialState |
SBOOL |
The initial state for item. |
|
radio |
Group |
Radio for communication. |
|
initialState |
SBOOL |
The initial state for item. |
|
torch |
Group |
Torch/flashlight to light dark areas or during night conditions. |
|
initialState |
SBOOL |
The initial state for item. |
|
piezo_lighter |
Group |
Fire that can be used to start flames. |
|
initialState |
SBOOL |
The initial state for item. |
|
h2s_detector |
Group |
H2S sensor tool. |
|
initialState |
SBOOL |
The initial state for item. |
|
explosive_meter |
Group |
Explosive sensor tool. |
|
initialState |
SBOOL |
The initial state for item. |
|
radiation_meter |
Group |
Radiation sensor tool. |
|
initialState |
SBOOL |
The initial state for item. |
|
airline_mask |
Group |
Face mask and cylinder. |
|
initialState |
SBOOL |
The initial state for item. |
|
vapor_respirator |
Group |
Protection mask with air filters. |
|
initialState |
SBOOL |
The initial state for item. |
deploy
The deploy parameters of the configuration file.
|
Name |
Type |
Description |
|---|---|---|
|
deploy |
Group |
Version of the library. |
|
version |
SSTRING |
The deployment version number. |
vr
The virtual reality parameters of the configuration file.
|
Name |
Type |
Description |
|---|---|---|
|
vr |
Group |
The parameters in this section are designed to define the behavior when using a VR device such as Oculus or OpenVR. |
|
enabled |
SBOOL |
If set to true, other users are represented as floating avatars instead of field operators. |
|
moveUsingTrackerDirection |
SBOOL |
When set to true, the movements are based on the visor direction. |
|
handLeftModel |
SSTRING |
Defines which geometry to use to represent left hand in VR. The options are: Hand, Vive, Oculus, Auto, Off. |
|
handRightModel |
SSTRING |
Defines which geometry to use to represent right hand in VR.The options are: Hand, Vive, Oculus, Auto, Off. |
|
viewfinder |
SSTRING |
Defines which tool to use to select items in VR. The options are: Solid, 2D, Hand. |
|
interactionpanel |
SSTRING |
Defines how to represent item information in VR.The options are: Hud, Hand. |
|
grip |
SBOOL |
Enables grip fly mode. |
|
teleport |
SBOOL |
Enable teleport mode. |
|
handsCollisionVibration |
SBOOL |
Hands vibrate when collision. |
|
model |
SSTRING |
Placeholder for remote players. |