Files
modeling-app/docs/kcl/angledLineThatIntersects.md
Nick Cameron c050739f41 Some improvements to the boxed signatures in the docs (#6593)
* 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>
2025-04-30 16:03:22 +00:00

66 KiB

title, excerpt, layout
title excerpt layout
angledLineThatIntersects Draw an angled line from the current origin, constructing a line segment such that the newly created line intersects the desired target line segment. 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.

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 Which sketch should this path be added to? Yes
angle number Which angle should the line be drawn at? Yes
intersectTag TagIdentifier The tag of the line to intersect with Yes
offset number The offset from the intersecting line. Defaults to 0. No
tag TagDeclarator Create a new tag which refers to this line No

Returns

Sketch

Examples

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)

Rendered example of angledLineThatIntersects 0