Files
modeling-app/docs/kcl/xLine.md
Adam Chalmers aa6dd18f93 Redo docs
2025-02-25 15:48:28 -06:00

158 KiB

title, excerpt, layout
title excerpt layout
xLine Draw a line from current point, along the X axis. You can either specify manual

Draw a line from current point, along the X axis. You can either specify

this line's length, or which X it should end at.

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 - A sketch is a collection of paths.

Examples

exampleSketch = startSketchOn('XZ')
  |> startProfileAt([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

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

example = extrude(exampleSketch, length = 10)

Rendered example of xLine 1