sublayer [building profile]

May 26, 2021 ยท View on GitHub

Sublayer of a building scene layer. A building scene layer is composed of an overview and the full model containing the discipline and category layers. These layer types are represented as sublayers. A sublayer may contain other layers or sublayers (i.e. group) to form a nested structure. The order of the layers is inverted, meaning the first layer is on the bottom and the last layer is on the top.

bld::layer, bld::sublayer

Properties

PropertyTypeDescription
idintegerIdentifier for this sublayer. If layerType != 'group', resources will be at /layers/{bim_layer_id}/sublayers/{this.id}/...
namestringLayer name. Must be unique per building scene layer.
aliasstringAlias of the layer name. Can be empty if alias and name are identical.
disciplinestringSemantics for work discipline groups which can be used to refine the user experience.
Possible values are:
  • Mechanical
  • Architectural
  • Piping
  • Electrical
  • Structural
modelNamestringA fixed string of sublayer information. Used by client applications to define specific behavior for the modelName. See list of defined modelNames for sublayers.
layerTypestring
Possible values are:
  • group
  • 3DObject
  • Point
visibilitybooleanVisibility of the sublayer. Default is true.
sublayerssublayer[]Sublayers contained in this layer.
isEmptybooleanReturns true if the layer has no features.

Note: properties in bold are required

Examples

Example: Building Scene Layer simple group

 {
  "id": 100,
  "layerType": "group",
  "name": "architectural",
  "alias": "Architecture",
  "modelName": "Architectural",
  "visibility": true,
  "sublayers": [
    {
      "id": 0,
      "layerType": "3DObject",
      "name": "stairs",
      "alias": "Escaliers",
      "visibility": true,
      "isEmpty": false
    },
    {
      "id": 1,
      "layerType": "3DObject",
      "name": "roof",
      "alias": "Toitures",
      "visibility": true,
      "isEmpty": false
    }
  ]
} 

Example: Building Scene Layer simple group with Point sublayer

 {
  "id": 100,
  "layerType": "group",
  "name": "architectural",
  "alias": "Architecture",
  "modelName": "Architectural",
  "visibility": true,
  "sublayers": [
    {
      "id": 1,
      "layerType": "3DObject",
      "name": "Casework",
      "alias": "Casework",
      "modelName": "Casework",
      "discipline": "Architectural",
      "visibility": true,
      "isEmpty": false
    },
    {
      "id": 2,
      "layerType": "Point",
      "name": "LocationPoints",
      "alias": "LocationPoints",
      "modelName": "LocationPoints",
      "discipline": "Architectural",
      "visibility": true,
      "isEmpty": false
    }
  ]
}