Camera
ecs.Camera
Description
The Camera component defines the camera behavior.
Functions
See component schema.
Schema
World Effects
| Property | Type | Default | Description |
|---|---|---|---|
scale | string | responsive | Either responsive or absolute. responsive will return values so that the camera on frame 1 is at the origin defined via XR8.XrController.updateCameraProjectionMatrix(). absolute will return the camera, image targets, etc in meters. When using absolute the x-position, z-position, and rotation of the starting pose will respect the parameters set in XR8.XrController.updateCameraProjectionMatrix() once scale has been estimated. The y-position will depend on the camera's physical height from the ground plane. |
Face Effects
| Property | Type | Default | Description |
|---|---|---|---|
| nearClip | Number | 0.1 | The distance from the camera of the near clip plane, i.e. the closest distance to the camera at which scene objects are visible. |
| farClip | Number | 1000 | The distance from the camera of the far clip plane, i.e. the farthest distance to the camera at which scene objects are visible |
| Face | boolean | true | Whether to show face mesh geometry. |
| Eyes | boolean | false | Whether to show eye mesh geometry. |
| Iris | boolean | false | Whether to show iris mesh geometry. |
| Mouth | boolean | false | Whether to show mouth mesh geometry. |
| maxDetections | Number | 1 | The maximum number of faces to detect. The available choices are 1, 2, or 3. |
| enableEars | boolean | false | If true, runs ear detection simultaneously with Face Effects and returns ear attachment points. |