Files
modeling-app/docs/kcl/angleToMatchLengthY.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

76 KiB

title, excerpt, layout
title excerpt layout
angleToMatchLengthY Returns the angle to match the given length for y. manual

Returns the angle to match the given length for y.

angleToMatchLengthY(
  tag: TagIdentifier,
  to: number,
  sketch: Sketch,
): number

Arguments

Name Type Description Required
tag TagIdentifier Yes
to number Yes
sketch Sketch Yes

Returns

number

Examples

sketch001 = startSketchOn('XZ')
  |> startProfileAt([0, 0], %)
  |> line(end = [1, 2], tag = $seg01)
  |> angledLine({
       angle = angleToMatchLengthY(seg01, 15, %),
       length = 5
     }, %)
  |> yLine(endAbsolute = 0)
  |> close()

extrusion = extrude(sketch001, length = 5)

Rendered example of angleToMatchLengthY 0