6303130e08
* updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * start of types docs Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest) * add types files Signed-off-by: Jess Frazelle <github@jessfraz.com> * add links Signed-off-by: Jess Frazelle <github@jessfraz.com> * better Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * uodates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> * A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest) * updates Signed-off-by: Jess Frazelle <github@jessfraz.com> --------- Signed-off-by: Jess Frazelle <github@jessfraz.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
48 lines
71 KiB
Markdown
48 lines
71 KiB
Markdown
---
|
|
title: "xLineTo"
|
|
excerpt: "Draw a line parallel to the X axis, that ends at the given X."
|
|
layout: manual
|
|
---
|
|
|
|
Draw a line parallel to the X axis, that ends at the given X.
|
|
|
|
E.g. if the previous line ended at (1, 1), then xLineTo(4) draws a line from (1, 1) to (4, 1)
|
|
|
|
```js
|
|
xLineTo(to: number, sketch_group: SketchGroup, tag?: TagDeclarator) -> SketchGroup
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `to` | `number` | | Yes |
|
|
| `sketch_group` | [`SketchGroup`](kcl/types/SketchGroup) | A sketch group is a collection of paths. | Yes |
|
|
| `tag` | [`TagDeclarator`](kcl/types#tag-declaration) | | No |
|
|
|
|
### Returns
|
|
|
|
[`SketchGroup`](kcl/types/SketchGroup) - A sketch group is a collection of paths.
|
|
|
|
|
|
### Examples
|
|
|
|
```js
|
|
const exampleSketch = startSketchOn('XZ')
|
|
|> startProfileAt([0, 0], %)
|
|
|> xLineTo(15, %)
|
|
|> angledLine({ angle: 80, length: 15 }, %)
|
|
|> line([8, -10], %)
|
|
|> xLineTo(40, %)
|
|
|> angledLine({ angle: 135, length: 30 }, %)
|
|
|> xLineTo(10, %)
|
|
|> close(%)
|
|
|
|
const example = extrude(10, exampleSketch)
|
|
```
|
|
|
|
|
|
|
|
|