kcl-stdfunctionsxLine

xLineFunction in std::sketch

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(Length),
  endAbsolute?: number(Length),
  tag?: tag,
): Sketch

Arguments

NameTypeDescriptionRequired
sketchSketchWhich sketch should this path be added to?Yes
lengthnumber(Length)How far away along the X axis should this line go? Incompatible with endAbsolute.No
endAbsolutenumber(Length)Which absolute X value should this line go to? Incompatible with length.No
tagtagCreate 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])
  |> xLine(length = 15)
  |> angledLine(angle = 80deg, length = 15)
  |> line(end = [8, -10])
  |> xLine(length = 10)
  |> angledLine(angle = 120deg, length = 30)
  |> xLine(length = -15)
  |> close()

example = extrude(exampleSketch, length = 10)

Rendered example of xLine 0

Found a typo?