aea82e004a
Previously, `xLine`, `xLineTo`, `yLine` and `yLineTo` used positional arguments. Now: - `xLineTo` and `yLineTo` have been removed - `xLine` and `yLine` both use keyword arguments: - `length`, optional (i.e. a relative distance along the X or Y axis) - `endAbsolute` optional (i.e. an absolute point along the X or Y axis) - `tag` optional - Exactly one of `length` or `endAbsolute` must be given. Not both, not neither. For example: ``` // Old way |> xLine(6.04, %) |> yLineTo(20, %, $base) // New way |> xLine(length = 6.04) |> yLine(endAbsolute = 20, tag = $base) ``` This also improves some of the general-purpose keyword arguments code in modeling app's TS codebase.
50 lines
86 KiB
Markdown
50 lines
86 KiB
Markdown
---
|
|
title: "angledLine"
|
|
excerpt: "Draw a line segment relative to the current origin using the polar measure of some angle and distance."
|
|
layout: manual
|
|
---
|
|
|
|
Draw a line segment relative to the current origin using the polar measure of some angle and distance.
|
|
|
|
|
|
|
|
```js
|
|
angledLine(
|
|
data: AngledLineData,
|
|
sketch: Sketch,
|
|
tag?: TagDeclarator,
|
|
): Sketch
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `data` | [`AngledLineData`](/docs/kcl/types/AngledLineData) | Data to draw an angled line. | Yes |
|
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | | Yes |
|
|
| [`tag`](/docs/kcl/types/tag) | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl/types/Sketch)
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
exampleSketch = startSketchOn(XZ)
|
|
|> startProfileAt([0, 0], %)
|
|
|> yLine(endAbsolute = 15)
|
|
|> angledLine({ angle = 30, length = 15 }, %)
|
|
|> line(end = [8, -10])
|
|
|> yLine(endAbsolute = 0)
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 10)
|
|
```
|
|
|
|
|
|
|
|
|