Schemas / CAD / solids

rig.cad.cylinder

v0.31.0 · draft 4 fields 2 required

Fields

FieldTypeMeaning
radius float required Radius in the local XZ plane
height float required Length along local +Y
circularSegments integer3 – * optional Optional. Tessellation hint for mesh CSG kernels (≥ 3). Absent = host default
center bool optional Optional. Absent = true: the cylinder is centred on the local origin along Y. False: the origin is the base, height runs +Y

Circular cylinder. Format when present.

This is a CSG primitive, not a triangle mesh. Pose lives on rig.spatial.transform. When this component is present it is the solid source of truth; rig.geometry.mesh on the same entity is an optional bake.

A 2D ellipse / circle stays on rig.geometry.ellipse.

JSON Schema

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.cad.cylinder.schema.json",
  "title": "rig.cad.cylinder",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "radius": {
      "$ref": "./_defs.schema.json#/$defs/float"
    },
    "height": {
      "$ref": "./_defs.schema.json#/$defs/float"
    },
    "circularSegments": {
      "type": "integer",
      "minimum": 3
    },
    "center": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    }
  },
  "required": [
    "radius",
    "height"
  ]
}

Seen in

cad-boolean.json