Schemas / Other

rig.vr.tracker

v1.0.0 · stable maturity: draft 4 fields 1 required

Fields

FieldTypeMeaning
player int optional Optional. Player index (0-based); absent = 0
role enumhead · gaze · left-hand · right-hand · left-shoulder · right-shoulder · left-elbow · right-elbow · chest · waist · left-knee · right-knee · left-foot · right-foot · gamepad · tracker required Which body or device this pose is
index int optional Optional. Disambiguates a repeated role; absent = 0
device entity optional Optional. rig.vr.headset or rig.vr.controller this pose belongs to

One tracked pose. Format when present.

The pose at save is rig.spatial.transform. Parent is rig.spatial.relationship. A label is rig.meta.named.

role is head, gaze, left-hand, right-hand, left-shoulder, right-shoulder, left-elbow, right-elbow, chest, waist, left-knee, right-knee, left-foot, right-foot, gamepad, or tracker.

gaze index 0 is the left eye and index 1 is the right eye. tracker index distinguishes extra pucks. Other roles ignore index.

Grip and aim are child entities with rig.vr.pose, not extra roles. A tracked hand skeleton is rig.vr.hand.

Lost tracking, pose velocity, and prediction stay in the host. A host that saves a running session writes the current pose into the transform, the same way rig.sensor.imu writes its sample.

JSON Schema

Resolves at https://rig.works/schemas/rig.vr.tracker.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.vr.tracker.schema.json",
  "title": "rig.vr.tracker",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "player": {
      "$ref": "./_defs.schema.json#/$defs/int"
    },
    "role": {
      "type": "string",
      "enum": [
        "head",
        "gaze",
        "left-hand",
        "right-hand",
        "left-shoulder",
        "right-shoulder",
        "left-elbow",
        "right-elbow",
        "chest",
        "waist",
        "left-knee",
        "right-knee",
        "left-foot",
        "right-foot",
        "gamepad",
        "tracker"
      ]
    },
    "index": {
      "$ref": "./_defs.schema.json#/$defs/int"
    },
    "device": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    }
  },
  "required": [
    "role"
  ],
  "x-rig-maturity": "draft"
}

Seen in

vr-room.json