Query Geometry
queryUse this when you need to resolve or inspect topology against a script's lowered geometry. Selected by mode (default 'evaluate'):
'evaluate' — inspect a Query (@kc[...] ref, @kcq[...] DSL, or { ast }); returns matched entities. Pass expect:'unique' to assert exactly-one.
'resolve' — resolve a single @kc[...] / @kcq[...] ref to one entity ({ ref }).
'lineage' — walk the HistoryMap for a named face ref ({ feature_id, ref }). All params except
modeare forwarded verbatim.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ref | No | mode:'resolve'|'lineage' — topology ref string. | |
| code | No | Inline kernelCAD script source. | |
| file | No | Path to a .kcad.ts script file. | |
| mode | No | Resolution mode (default 'evaluate'). | |
| query | No | mode:'evaluate' — Query input: @kc[...] / @kcq[...] string or { ast } object. | |
| expect | No | mode:'evaluate' — 'unique' asserts exactly-one. | |
| feature_id | No | Optional FeatureId; defaults to the last lowered shape (use "auto" for lineage). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| ref | No | mode:'resolve' — the resolved ref string. | |
| chain | No | mode:'lineage' — HistoryMap walk. | |
| error | No | ||
| query | No | mode:'evaluate' — the resolved Query ({ ast }). | |
| entity | No | mode:'resolve' — the single matched entity. | |
| entities | No | mode:'evaluate' — matched entities. | |
| warnings | No | ||
| errorCode | No | ||
| candidates | No | mode:'resolve' — near-miss candidates (failure). |