Schemas / BIM / OpenBIM

rig.bim.viewpoint

v0.31.0 · draft 4 fields 1 required

Fields

FieldTypeMeaning
topic entity required Parent rig.bim.topic
selected array<entity> optional Optional. Highlighted / selected elements; absent = none
hidden array<entity> optional Optional. Hidden elements; absent = none
clipPlanes array<object> optional Optional. Clip planes; each has origin (vec3) and normal (vec3)

BCF viewpoint on a topic. Format when present.

Compose rig.spatial.transform and rig.spatial.camera on the same entity for camera pose and projection. Snapshot image is rig.media.asset_ref kind: image on the same entity - do not invent a parallel path field.

JSON Schema

Resolves at https://rig.works/schemas/rig.bim.viewpoint.schema.jsonraw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.bim.viewpoint.schema.json",
  "title": "rig.bim.viewpoint",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "topic": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "selected": {
      "type": "array",
      "items": {
        "$ref": "./_defs.schema.json#/$defs/entity"
      }
    },
    "hidden": {
      "type": "array",
      "items": {
        "$ref": "./_defs.schema.json#/$defs/entity"
      }
    },
    "clipPlanes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "origin",
          "normal"
        ],
        "properties": {
          "origin": {
            "$ref": "./_defs.schema.json#/$defs/vec3"
          },
          "normal": {
            "$ref": "./_defs.schema.json#/$defs/vec3"
          }
        }
      }
    }
  },
  "required": [
    "topic"
  ]
}

Seen in

bim-bcf.json