Files
modeling-app/docs/kcl/xLine.md
Adam Chalmers aea82e004a KCL: Convert x/y lines to use keyword arguments (#5615)
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.
2025-03-07 22:07:16 -06:00

90 KiB

title, excerpt, layout
title excerpt layout
xLine Draw a line relative to the current origin to a specified distance away from the current position along the 'x' axis. manual

Draw a line relative to the current origin to a specified distance away from the current position along the 'x' axis.

xLine(
  sketch: Sketch,
  length?: number,
  endAbsolute?: number,
  tag?: TagDeclarator,
): Sketch

Arguments

Name Type Description Required
sketch Sketch Which sketch should this path be added to? Yes
length number How far away along the X axis should this line go? Incompatible with endAbsolute. No
endAbsolute number Which absolute X value should this line go to? Incompatible with length. No
tag TagDeclarator Create a new tag which refers to this line No

Returns

Sketch

Examples

exampleSketch = startSketchOn(XZ)
  |> startProfileAt([0, 0], %)
  |> xLine(length = 15)
  |> angledLine({ angle = 80, length = 15 }, %)
  |> line(end = [8, -10])
  |> xLine(length = 10)
  |> angledLine({ angle = 120, length = 30 }, %)
  |> xLine(length = -15)
  |> close()

example = extrude(exampleSketch, length = 10)

Rendered example of xLine 0