c050739f41
* 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>
323 KiB
323 KiB
title, excerpt, layout
| title | excerpt | layout |
|---|---|---|
| startProfile | Start a new profile at a given point. | manual |
Start a new profile at a given point.
startProfile(
sketchSurface: [[Sketch](/docs/kcl/types/Sketch)Surface](/docs/kcl/types/[Sketch](/docs/kcl/types/Sketch)Surface),
at: [[[number](/docs/kcl/types/number)]](/docs/kcl/types/[number](/docs/kcl/types/number)),
tag?: [TagDeclarator](/docs/kcl/types#tag-declaration),
): [Sketch](/docs/kcl/types/Sketch)
Arguments
| Name | Type | Description | Required |
|---|---|---|---|
sketchSurface |
SketchSurface |
What to start the profile on | Yes |
at |
[number] |
Where to start the profile. An absolute point. | Yes |
tag |
TagDeclarator |
Tag this first starting point | No |
Returns
Examples
exampleSketch = startSketchOn(XZ)
|> startProfile(at = [0, 0])
|> line(end = [10, 0])
|> line(end = [0, 10])
|> line(end = [-10, 0])
|> close()
example = extrude(exampleSketch, length = 5)
exampleSketch = startSketchOn(-XZ)
|> startProfile(at = [10, 10])
|> line(end = [10, 0])
|> line(end = [0, 10])
|> line(end = [-10, 0])
|> close()
example = extrude(exampleSketch, length = 5)
exampleSketch = startSketchOn(-XZ)
|> startProfile(at = [-10, 23])
|> line(end = [10, 0])
|> line(end = [0, 10])
|> line(end = [-10, 0])
|> close()
example = extrude(exampleSketch, length = 5)