`location`#

object

The location object defines where the head is located in the scene.

Location is defined using x, y, and z global coordinates, measured in meters. Each value is a floating-point variable that can range from -5 to 5 meters.

Important

The location of the head may be the most critical setting in your data request. If the head is in the wrong place, it might not be in the camera frame and you will render nothing but the background.

Tip

Use this visualization tool to experiment with positioning the actor’s head in the frame.

The location object contains the following fields:

"location": {
  "x": //The x coordinate, which moves the head from side to side
  "y": //The y coordinate, which moves the head from front to back
  "z": //The z coordinate, which moves the head down and up
},

For an in-depth look at these axes, as well as which part of the head is actually located at the coordinates you set, see About our coordinate systems.

Sample usage

Location in the data request

In the JSON hierarchy of the data request, the location field is found here:
{
  "datapoints": [
    {
      "human": {
        "location": {

        }
      }
    }
  ]
}

A sample complete location object

"location": {
  "x": 0.0,
  "y": 1.38,
  "z": 1.1
},
The above values place the head 1.38 meters behind and 1.1 meters above the origin.

location#

`location`#