Files
modeling-app/docs/kcl-std/angledLine.md
Nick Cameron 574d6dae7f Add modules to docs (#6699)
* Support modules in docs

Signed-off-by: Nick Cameron <nrc@ncameron.org>

* shuffle around directories

Signed-off-by: Nick Cameron <nrc@ncameron.org>

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-06 11:02:55 +12:00

88 KiB

title, excerpt, layout
title excerpt layout
angledLine Draw a line segment relative to the current origin using the polar measure of some angle and distance. manual

Draw a line segment relative to the current origin using the polar measure of some angle and distance.

angledLine(
  sketch: Sketch,
  angle: number,
  length?: number,
  lengthX?: number,
  lengthY?: number,
  endAbsoluteX?: number,
  endAbsoluteY?: number,
  tag?: TagDeclarator,
): 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
length number Draw the line this distance along the given angle. Only one of length, lengthX, lengthY, endAbsoluteX, endAbsoluteY can be given. No
lengthX number Draw the line this distance along the X axis. Only one of length, lengthX, lengthY, endAbsoluteX, endAbsoluteY can be given. No
lengthY number Draw the line this distance along the Y axis. Only one of length, lengthX, lengthY, endAbsoluteX, endAbsoluteY can be given. No
endAbsoluteX number Draw the line along the given angle until it reaches this point along the X axis. Only one of length, lengthX, lengthY, endAbsoluteX, endAbsoluteY can be given. No
endAbsoluteY number Draw the line along the given angle until it reaches this point along the Y axis. Only one of length, lengthX, lengthY, endAbsoluteX, endAbsoluteY can be given. No
tag TagDeclarator Create a new tag which refers to this line No

Returns

Sketch

Examples

exampleSketch = startSketchOn(XZ)
  |> startProfile(at = [0, 0])
  |> yLine(endAbsolute = 15)
  |> angledLine(angle = 30, length = 15)
  |> line(end = [8, -10])
  |> yLine(endAbsolute = 0)
  |> close()

example = extrude(exampleSketch, length = 10)

Rendered example of angledLine 0