Files
modeling-app/docs/kcl/segStartX.md
Nick Cameron c050739f41 Some improvements to the boxed signatures in the docs (#6593)
* Show a more reasonable name in function docs

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

* Fix buggy docs for union types

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

* Make types in the docs signatures into links

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-04-30 16:03:22 +00:00

69 KiB

title, excerpt, layout
title excerpt layout
segStartX Compute the starting point of the provided line segment along the 'x' axis. manual

Compute the starting point of the provided line segment along the 'x' axis.

segStartX(tag: [TagIdentifier](/docs/kcl/types#tag-identifier)): [number](/docs/kcl/types/number)

Arguments

Name Type Description Required
tag TagIdentifier The line segment being queried by its tag Yes

Returns

number

Examples

exampleSketch = startSketchOn(XZ)
  |> startProfile(at = [0, 0])
  |> line(end = [20, 0], tag = $thing)
  |> line(end = [0, 5])
  |> line(end = [20 - segStartX(thing), 0])
  |> line(end = [-20, 10])
  |> close()

example = extrude(exampleSketch, length = 5)

Rendered example of segStartX 0