Files
modeling-app/docs/kcl-std/angledLine.md
Nick Cameron 1841e63021 Misc docs polishing (#6712)
* Fake modules for Rust std lib functions

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

* Include the missing @ in Rust std lib fns

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

* Move revolve and mirror2d to better modules

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

* Use docs from KCL mods for type summaries

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

* Use type docs to describe types from KCL std lib

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-06 16:09:59 +12:00

88 KiB

title, excerpt, layout
title excerpt layout
std::sketch::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 - A sketch is a collection of paths.

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 std::sketch::angledLine 0