kcl → types

SketchSet

A sketch or a group of sketches.

This schema accepts exactly one of the following:

A sketch is a collection of paths.

Type: object

Properties

PropertyTypeDescriptionRequired
typeenum: sketchNo
idstringThe id of the sketch (this will change when the engine's reference to it changes).No
paths[ Path ]The paths in the sketch.No
onSketchSurfaceWhat the sketch is on (can be a plane or a face).No
startBasePathThe starting path.No
tagsobjectTag identifiers that have been declared in this sketch.No
artifactIdArtifactIdThe original id of the sketch. This stays the same even if the sketch is is sketched on face etc.No
originalIdstringNo
unitsUnitLenA sketch or a group of sketches.No
__meta[ Metadata ]Metadata.No

Type: [object, array]

[ Sketch ]

Properties

PropertyTypeDescriptionRequired
typeenum: sketchesNo