Files
modeling-app/docs/kcl/mirror2d.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

286 KiB

title, excerpt, layout
title excerpt layout
mirror2d Mirror a sketch. manual

Mirror a sketch.

Only works on unclosed sketches for now.

Mirror occurs around a local sketch axis rather than a global axis.

mirror2d(
  data: Mirror2dData,
  sketchSet: SketchSet,
) -> [Sketch]

Arguments

Name Type Description Required
data Mirror2dData Data for a mirror. Yes
sketchSet SketchSet A sketch or a group of sketches. Yes

Returns

[Sketch]

Examples

// Mirror an un-closed sketch across the Y axis.
sketch001 = startSketchOn('XZ')
  |> startProfileAt([0, 10], %)
  |> line(end = [15, 0])
  |> line(end = [-7, -3])
  |> line(end = [9, -1])
  |> line(end = [-8, -5])
  |> line(end = [9, -3])
  |> line(end = [-8, -3])
  |> line(end = [9, -1])
  |> line(end = [-19, -0])
  |> mirror2d({ axis = 'Y' }, %)

example = extrude(sketch001, length = 10)

Rendered example of mirror2d 0

// Mirror a un-closed sketch across the Y axis.
sketch001 = startSketchOn('XZ')
  |> startProfileAt([0, 8.5], %)
  |> line(end = [20, -8.5])
  |> line(end = [-20, -8.5])
  |> mirror2d({ axis = 'Y' }, %)

example = extrude(sketch001, length = 10)

Rendered example of mirror2d 1

// Mirror a un-closed sketch across an edge.
helper001 = startSketchOn('XZ')
  |> startProfileAt([0, 0], %)
  |> line(end = [0, 10], tag = $edge001)

sketch001 = startSketchOn('XZ')
  |> startProfileAt([0, 8.5], %)
  |> line(end = [20, -8.5])
  |> line(end = [-20, -8.5])
  |> mirror2d({ axis = edge001 }, %)

// example = extrude(sketch001, length = 10)

Rendered example of mirror2d 2

// Mirror an un-closed sketch across a custom axis.
sketch001 = startSketchOn('XZ')
  |> startProfileAt([0, 8.5], %)
  |> line(end = [20, -8.5])
  |> line(end = [-20, -8.5])
  |> mirror2d({
       axis = {
         custom = {
           axis = [0.0, 1.0],
           origin = [0.0, 0.0]
         }
       }
     }, %)

example = extrude(sketch001, length = 10)

Rendered example of mirror2d 3