Schemas / CAD / solids

rig.cad.extrude

v0.31.0 · draft 5 fields 2 required

Fields

FieldTypeMeaning
profile entity required Contour entity: rig.geometry.polygon, rig.geometry.path, or rig.geometry.spline
height float required Sweep length along local +Z
nDivisions integer1 – * optional Optional. Steps along the sweep (≥ 1). Absent = host default (often 1)
twistDegrees float optional Optional. Rotation about +Z from base to top. Absent = 0
scaleTop float optional Optional. Uniform scale of the top cap relative to the profile. Absent = 1

Solid from a 2D profile swept along local +Z. Format when present.

The profile is read in that entity's local XY. This entity's rig.spatial.transform places the solid.

When this component is present it is the solid source of truth; rig.geometry.mesh on the same entity is an optional bake.

JSON Schema

Resolves at https://rig.works/schemas/rig.cad.extrude.schema.jsonraw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.cad.extrude.schema.json",
  "title": "rig.cad.extrude",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "profile": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "height": {
      "$ref": "./_defs.schema.json#/$defs/float"
    },
    "nDivisions": {
      "type": "integer",
      "minimum": 1
    },
    "twistDegrees": {
      "$ref": "./_defs.schema.json#/$defs/float"
    },
    "scaleTop": {
      "$ref": "./_defs.schema.json#/$defs/float"
    }
  },
  "required": [
    "profile",
    "height"
  ]
}

Seen in

bim-model.json