kcl → types →

KclValue

Any KCL value.

This schema accepts exactly one of the following:

Type: object

Properties

Property	Type	Required
`type`	enum: `UserVal`	No
`value`	``	No
`__meta`	`[` `Metadata` `]`	No

Type: object

Property	Type	Required
`type`	enum: `TagIdentifier`	No
`value`	`string`	No
`info`	`TagEngineInfo`	No
`__meta`	`[` `Metadata` `]`	No

Type: object

Property	Type	Required
`type`	enum: `TagDeclarator`	No
`start`	`EnvironmentRef`	No
`end`	`EnvironmentRef`	No
`value`	`string`	No
`digest`	`[,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`,` integer`]`	No

A plane.

Type: object

Property	Type	Description	Required
`type`	enum: `Plane`		No
`id`	`string`	The id of the plane.	No
`value`	`PlaneType`	Any KCL value.	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

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

An solid is a collection of extrude surfaces.

Type: object

Property	Type	Description	Required
`type`	enum: `Solid`		No
`id`	`string`	The id of the solid.	No
`value`	`[` `ExtrudeSurface` `]`	The extrude surfaces.	No
`sketch`	`Sketch`	The sketch.	No
`height`	`number`	The height of the solid.	No
`startCapId`	`string`	The id of the extrusion start cap	No
`endCapId`	`string`	The id of the extrusion end cap	No
`edgeCuts`	`[` `EdgeCut` `]`	Chamfers or fillets on this solid.	No
`__meta`	`[` `Metadata` `]`	Metadata.	No

Type: object

Property	Type	Description	Required
`type`	enum: `Solids`		No
`value`	`[` `Solid` `]`		No

Data for an imported geometry.

Type: object

Property	Type	Description	Required
`type`	enum: `ImportedGeometry`		No
`id`	`string`	The ID of the imported geometry.	No
`value`	`[` `string` `]`	The original file paths.	No
`__meta`	`[` `Metadata` `]`		No

Type: object

Property	Type	Description	Required
`type`	enum: `Function`		No
`expression`	`FunctionExpression`	Any KCL value.	No
`memory`	`ProgramMemory`	Any KCL value.	No
`__meta`	`[` `Metadata` `]`		No