Schemas / Meta / render
rig.render.visibility
v0.31.0 · draft 1 field 1 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
visible |
bool | required | False hides this entity |
Per-entity show/hide. Format when present.
Absent means visible, so a document only pays for the entities that are hidden.
This is the only portable hide bit for scene / document entities. Do not put visible on rig.spatial.layer or geometry schemas.
Hiding is not inherited by this component alone. Whether a hidden parent hides its children is the host's scene-graph behaviour; if you need the children hidden in every reader, mark them too.
Draw order is not here. Sibling sequence lives in order on rig.spatial.relationship; layer-list stacking in order on rig.spatial.layer.
Hiding an entity says nothing about whether it still runs - a hidden emitter keeps emitting. Use the host's own enable flag for that.
JSON Schema
Resolves at https://rig.works/schemas/rig.render.visibility.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.render.visibility.schema.json",
"title": "rig.render.visibility",
"type": "object",
"additionalProperties": false,
"properties": {
"visible": {
"$ref": "./_defs.schema.json#/$defs/bool"
}
},
"required": [
"visible"
]
}