* 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>
90 KiB
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](/docs/kcl/types/Sketch),
length?: [number](/docs/kcl/types/number),
endAbsolute?: [number](/docs/kcl/types/number),
tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
): [Sketch](/docs/kcl/types/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
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)