Schemas / Spatial / scene

rig.spatial.relationship

v0.31.0 · draft 2 fields 1 required

Fields

FieldTypeMeaning
parent entity required Parent entity; none = root
order int optional Optional. Sibling position under parent, ascending. Ties and gaps are allowed; a host sorts by it and breaks ties by document order.

Scene-graph parent. Format when present.

Emit order when sibling sequence carries meaning - draw order, z-order, stacking inside a group. Omit it when children are an unordered set. Without it, sibling sequence is not portable and a reader may present children in any order.

Compositor grouping uses groupParent on rig.pixel.layer - different graph, different field.

Scene group folders compose rig.spatial.group on the parent entity - still use this parent field for children. A scene is an unparented rig.spatial.vertex; locators and groups parent to it.

JSON Schema

Resolves at https://rig.works/schemas/rig.spatial.relationship.schema.json — raw file. 

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.spatial.relationship.schema.json",
  "title": "rig.spatial.relationship",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "parent": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "order": {
      "$ref": "./_defs.schema.json#/$defs/int"
    }
  },
  "required": [
    "parent"
  ]
}

Seen in

bim-model.json · font-ufo.json · font-var.json · minimal-scene.json · page-anchor.json · place-address.json · story-frames.json