592c5259c6
* KCL: Update patternTransform and 2d to use kwargs * Update docs * Convert segment functions to use keyword args * Regenerate docs, change branch of kcl-samples
43 lines
86 KiB
Markdown
43 lines
86 KiB
Markdown
---
|
|
title: "segLen"
|
|
excerpt: "Compute the length of the provided line segment."
|
|
layout: manual
|
|
---
|
|
|
|
Compute the length of the provided line segment.
|
|
|
|
|
|
|
|
```js
|
|
segLen(tag: TagIdentifier) -> number
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `tag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | The line segment being queried by its tag | Yes |
|
|
|
|
### Returns
|
|
|
|
`number`
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
exampleSketch = startSketchOn("XZ")
|
|
|> startProfileAt([0, 0], %)
|
|
|> angledLine({ angle = 60, length = 10 }, %, $thing)
|
|
|> tangentialArc({ offset = -120, radius = 5 }, %)
|
|
|> angledLine({ angle = -60, length = segLen(thing) }, %)
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 5)
|
|
```
|
|
|
|
|
|
|
|
|