Tracker#

Defines a group of tracking devices or sensors as they are advertised by the VRPN standard. See its documentation for more information on this.

  • name
    string

    The name of the tracker group.

  • devices (optional)
    array of objects

    • name
      string

      Specifies the name of the device so that it can be referenced by a User or can be accessed programmatically by the application.

    • sensors (optional)
      array of objects

      • vrpnaddress
        string

        The VRPN address of this sensor.

      • id
        integer

        The sensor id for this device. This information is not used by SGCT directly but can be used by the application to distinguish different sensors if multiple sensors are specified in the configuration file.

    • buttons (optional)
      array of objects

      • vrpnaddress
        string

        The VRPN address of this button group.

      • count
        integer

        The number of buttons that are advertised and received through the device.

    • axes (optional)
      array of objects

      • vrpnaddress
        string

        The VRPN address of this group of axes.

      • count
        integer

        The number of axes that are advertised by this VRPN device.

    • offset (optional)
      vec3

      A linear offset that is added to the entire device. Must define three float attributes x, y, and z. The default values are x=0, y=0, z=0, leading to no offset being applied.

    • transformation (optional)
      array of numbers

      A generic transformation matrix that is applied to this device. This value will overwrite the value specified in orientation. All 16 of these values have to be present in this attribute and have to be floating point values and are used in this order to initialize the matrix in a column-major order.

  • offset (optional)
    vec3

    A linear offset of the class of trackers. Must define three float attributes x, y, and z. The default values are x=0, y=0, z=0, which means that no linear offset is applied to the tracker.

  • scale (optional)
    number

    A scaling factor for this class of trackers. The default value is 1.0.

  • orientation (optional)
    orientation

    Describes a fixed orientation for the this device. This can be provided either as Euler angles or as a quaternion. This value will overwrite the value specified in matrix.

  • matrix (optional)
    array of numbers

    A generic transformation matrix that is applied to this device. This value will overwrite the value specified in orientation. All 16 of these values have to be present in this attribute and have to be floating point values and are used in this order to initialize the matrix in a column-major order.