Files
modeling-app/docs/kcl-std/startProfile.md
Nick Cameron 1841e63021 Misc docs polishing (#6712)
* Fake modules for Rust std lib functions

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

* Include the missing @ in Rust std lib fns

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

* Move revolve and mirror2d to better modules

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

* Use docs from KCL mods for type summaries

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

* Use type docs to describe types from KCL std lib

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

---------

Signed-off-by: Nick Cameron <nrc@ncameron.org>
2025-05-06 16:09:59 +12:00

323 KiB

title, excerpt, layout
title excerpt layout
std::sketch::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 - A sketch is a collection of paths.

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 std::sketch::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 std::sketch::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 std::sketch::startProfile 2