Files
modeling-app/docs/kcl/startProfileAt.md
Nick Cameron 1104d908c0 Improve hover tool tips and function docs (#5538)
* Improve hover tool tips and function docs

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

* A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores)

* A snapshot a day keeps the bugs away! 📷🐛 (OS: namespace-profile-ubuntu-8-cores)

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2025-02-27 22:03:37 +13:00

322 KiB

title, excerpt, layout
title excerpt layout
startProfileAt Start a new profile at a given point. manual

Start a new profile at a given point.

startProfileAt(
  to: [number],
  sketchSurface: SketchSurface,
  tag?: TagDeclarator,
) -> Sketch

Arguments

Name Type Description Required
to [number] Yes
sketchSurface SketchSurface A sketch type. Yes
tag TagDeclarator No

Returns

Sketch - A sketch is a collection of paths.

Examples

exampleSketch = startSketchOn(XZ)
  |> startProfileAt([0, 0], %)
  |> line(end = [10, 0])
  |> line(end = [0, 10])
  |> line(end = [-10, 0])
  |> close()

example = extrude(exampleSketch, length = 5)

Rendered example of startProfileAt 0

exampleSketch = startSketchOn(-XZ)
  |> startProfileAt([10, 10], %)
  |> line(end = [10, 0])
  |> line(end = [0, 10])
  |> line(end = [-10, 0])
  |> close()

example = extrude(exampleSketch, length = 5)

Rendered example of startProfileAt 1

exampleSketch = startSketchOn(-XZ)
  |> startProfileAt([-10, 23], %)
  |> line(end = [10, 0])
  |> line(end = [0, 10])
  |> line(end = [-10, 0])
  |> close()

example = extrude(exampleSketch, length = 5)

Rendered example of startProfileAt 2