* Show a more reasonable name in function docs Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix buggy docs for union types Signed-off-by: Nick Cameron <nrc@ncameron.org> * Make types in the docs signatures into links Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
54 lines
66 KiB
Markdown
54 lines
66 KiB
Markdown
---
|
|
title: "angledLineThatIntersects"
|
|
excerpt: "Draw an angled line from the current origin, constructing a line segment such that the newly created line intersects the desired target line segment."
|
|
layout: manual
|
|
---
|
|
|
|
Draw an angled line from the current origin, constructing a line segment such that the newly created line intersects the desired target line segment.
|
|
|
|
|
|
|
|
```kcl
|
|
angledLineThatIntersects(
|
|
sketch: [Sketch](/docs/kcl/types/Sketch),
|
|
angle: [number](/docs/kcl/types/number),
|
|
intersectTag: [TagIdentifier](/docs/kcl/types#tag-identifier),
|
|
offset?: [number](/docs/kcl/types/number),
|
|
tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
|
|
): [Sketch](/docs/kcl/types/Sketch)
|
|
```
|
|
|
|
|
|
### Arguments
|
|
|
|
| Name | Type | Description | Required |
|
|
|----------|------|-------------|----------|
|
|
| `sketch` | [`Sketch`](/docs/kcl/types/Sketch) | Which sketch should this path be added to? | Yes |
|
|
| `angle` | [`number`](/docs/kcl/types/number) | Which angle should the line be drawn at? | Yes |
|
|
| `intersectTag` | [`TagIdentifier`](/docs/kcl/types#tag-identifier) | The tag of the line to intersect with | Yes |
|
|
| `offset` | [`number`](/docs/kcl/types/number) | The offset from the intersecting line. Defaults to 0. | No |
|
|
| `tag` | [`TagDeclarator`](/docs/kcl/types#tag-declaration) | Create a new tag which refers to this line | No |
|
|
|
|
### Returns
|
|
|
|
[`Sketch`](/docs/kcl/types/Sketch)
|
|
|
|
|
|
### Examples
|
|
|
|
```kcl
|
|
exampleSketch = startSketchOn(XZ)
|
|
|> startProfile(at = [0, 0])
|
|
|> line(endAbsolute = [5, 10])
|
|
|> line(endAbsolute = [-10, 10], tag = $lineToIntersect)
|
|
|> line(endAbsolute = [0, 20])
|
|
|> angledLineThatIntersects(angle = 80, intersectTag = lineToIntersect, offset = 10)
|
|
|> close()
|
|
|
|
example = extrude(exampleSketch, length = 10)
|
|
```
|
|
|
|

|
|
|
|
|