Files
modeling-app/docs/kcl-std/startProfile.md
Nick Cameron 574d6dae7f Add modules to docs (#6699)
* Support modules in docs

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

* shuffle around directories

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-06 11:02:55 +12:00

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: Plane | Face,
  at: Point2d,
  tag?: TagDeclarator,
): Sketch

Arguments

Name Type Description Required
sketchSurface Plane or Face What to start the profile on Yes
at Point2d Where to start the profile. An absolute point. Yes
tag TagDeclarator Tag this first starting point No

Returns

Sketch

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)

Rendered example of startProfile 0

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)

Rendered example of startProfile 1

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)

Rendered example of startProfile 2