Skip to main content

Cluster

The Cluster is the root object of every configuration file. It describes the entire cluster.

Parameters​

versionintegerrequired

The version of this configuration file. The current version number is 1.

masteraddressstringrequired

Contains the address of the node that acts as the server for this cluster. This means that one of the Node elements described in this configuration file has to have an address that corresponds to this masteraddress. This value can be either an IP address or a DNS name, which will be resolved at application startup.

nodesNode[]optional

Each object in this array has to be a valid Node. At least one of the described nodes has to have an address that matches the cluster's masteraddress.

usersUser[]optional

Each object in this array has to be a valid User. The first value in the array is considered to be the default user for the application.

debuglogbooleanoptionaldefault false

Determines whether the logging should include Debug level log messages. By default only Info level log messages or above are added to the console, the file, or the registered callback. Log messages that are not logged are discarded.

firmsyncbooleanoptionaldefault false

Determines whether the server should frame lock and wait for all client nodes or not. It is also possible, and more advisable, to set the frame locking on an individual Node basis for the cases where not all nodes are part of a swap group.

threadaffinityintegeroptional

Forces the thread affinity for the main thread of the application. On Windows this is achieved using the SetThreadAffinityMask function, but it might not be implemented on other operating systems. By default no thread affinity is set for the application.

sceneObjectoptional

Determines an overall orientation of the scene. All of its values are included in the projection matrix that is passed to the rendering function of the application.

offsetvec3optionaldefault 0, 0, 0

A linear offset of the scene center.

orientationObjectoptional

Describes a fixed orientation of the global scene.

scalenumberoptionaldefault 1.0

A scaling factor for the entire scene.

captureCaptureoptional

Provides attributes that describe how the application will treat screen captures.

settingsSettingsoptional

Describes general settings for the application. The scene-specific settings can be found under the scene entry instead.

trackersTracker[]optional

Each object in this array describes a VRPN tracker.

generatorObjectoptional

Information about the generator application that was used to create this configuration file.

namestringrequired
A human-friendly name for the generator that created this configuration file.
majorintegerrequired
The major version of the generator that created this configuration file.
minorintegerrequired
The minor version of the generator that created this configuration file.
metaObjectoptional

Information and description of the configuration file.

namestringrequired
Name of the window configuration.
descriptionstringrequired
Description of the window configuration.
authorstringoptional
Author's name.
licensestringoptional
Details of the software license.
versionstringoptional
Version number of the configuration meta.