Files
modeling-app/docs/kcl-std/xLine.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

90 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(
  sketch: Sketch,
  length?: number,
  endAbsolute?: number,
  tag?: TagDeclarator,
): Sketch

Arguments

Name Type Description Required
sketch Sketch Which sketch should this path be added to? Yes
length number How far away along the X axis should this line go? Incompatible with endAbsolute. No
endAbsolute number Which absolute X value should this line go to? Incompatible with length. No
tag TagDeclarator Create a new tag which refers to this line No

Returns

Sketch

Examples

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

example = extrude(exampleSketch, length = 10)

Rendered example of xLine 0