Files
modeling-app/docs/kcl-std/functions/std-sketch-yLine.md
Nick Cameron 3936017f10 Tag types (#7458)
* Replace tag type with tagIdent and tagDecl

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

* Replace tagIdent with TaggedEdge and TaggedFace

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

---------

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

89 KiB

title, subtitle, excerpt, layout
title subtitle excerpt layout
yLine Function in std::sketch Draw a line relative to the current origin to a specified distance away from the current position along the 'y' axis. manual

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

yLine(
  @sketch: Sketch,
  length?: number(Length),
  endAbsolute?: number(Length),
  tag?: TagDecl,
): Sketch

Arguments

Name Type Description Required
sketch Sketch Which sketch should this path be added to? Yes
length number(Length) How far away along the Y axis should this line go? Incompatible with endAbsolute. No
endAbsolute number(Length) Which absolute Y value should this line go to? Incompatible with length. No
tag TagDecl 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(length = 15)
  |> angledLine(angle = 30deg, length = 15)
  |> line(end = [8, -10])
  |> yLine(length = -5)
  |> close()

example = extrude(exampleSketch, length = 10)

Rendered example of yLine 0