kcl → types →

SketchSurface

A sketch type.

This schema accepts exactly one of the following:

A plane.

Type: object

Properties

Property	Type	Description	Required
`type`	enum: `plane`		No
`id`	`string`	The id of the plane.	No
`value`	`PlaneType`	A sketch type.	No
`origin`	`Point3d`	Origin of the plane.	No
`xAxis`	`Point3d`	What should the plane’s X axis be?	No
`yAxis`	`Point3d`	What should the plane’s Y axis be?	No
`zAxis`	`Point3d`	The z-axis (normal).	No
`__meta`	`[` `Metadata` `]`		No

A face.

Type: object

Properties

Property	Type	Description	Required
`type`	enum: `face`		No
`id`	`string`	The id of the face.	No
`value`	`string`	The tag of the face.	No
`xAxis`	`Point3d`	What should the face’s X axis be?	No
`yAxis`	`Point3d`	What should the face’s Y axis be?	No
`zAxis`	`Point3d`	The z-axis (normal).	No
`solid`	`Solid`	The solid the face is on.	No
`__meta`	`[` `Metadata` `]`		No