Files
modeling-app/docs/kcl/xLine.md
Nick Cameron df278c7e6a Various hover improvements (#5617)
* Show more info on hover for variables

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

* Move hover impls to lsp module

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

* Make hover work on names inside calls, fix doc line breaking, trim docs in tool tips

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

* Test the new hovers; fix signature syntax

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

* Hover tips for kwargs

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-03-04 09:53:31 +00:00

89 KiB

title, excerpt, layout
title excerpt layout
xLine Draw a line relative to the current origin to a specified distance away from the current position along the 'x' axis. manual

Draw a line relative to the current origin to a specified distance away from the current position along the 'x' axis.

xLine(
  length: number,
  sketch: Sketch,
  tag?: TagDeclarator,
): Sketch

Arguments

Name Type Description Required
length number Yes
sketch Sketch A sketch is a collection of paths. Yes
tag TagDeclarator No

Returns

Sketch - A sketch is a collection of paths.

Examples

exampleSketch = startSketchOn(XZ)
  |> startProfileAt([0, 0], %)
  |> xLine(15, %)
  |> angledLine({ angle = 80, length = 15 }, %)
  |> line(end = [8, -10])
  |> xLine(10, %)
  |> angledLine({ angle = 120, length = 30 }, %)
  |> xLine(-15, %)
  |> close()

example = extrude(exampleSketch, length = 10)

Rendered example of xLine 0