Files
modeling-app/docs/kcl/shell.md
Jess Frazelle 6303130e08 kcl std lib docs use handlebars now so making changes should be better (1st pass) (#4007)
* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* start of types docs

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest)

* add types files

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* add links

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* better

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* uodates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu-latest)

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2024-09-27 10:37:46 -04:00

690 KiB

title, excerpt, layout
title excerpt layout
shell Remove volume from a 3-dimensional shape such that a wall of the manual

Remove volume from a 3-dimensional shape such that a wall of the

provided thickness remains, taking volume starting at the provided face, leaving it open in that direction.

shell(data: ShellData, extrude_group_set: ExtrudeGroupSet) -> ExtrudeGroupSet

Arguments

Name Type Description Required
data ShellData Data for shells. Yes
extrude_group_set ExtrudeGroupSet A extrude group or a group of extrude groups. Yes

Returns

ExtrudeGroupSet - A extrude group or a group of extrude groups.

Examples

// Remove the end face for the extrusion.
const firstSketch = startSketchOn('XY')
  |> startProfileAt([-12, 12], %)
  |> line([24, 0], %)
  |> line([0, -24], %)
  |> line([-24, 0], %)
  |> close(%)
  |> extrude(6, %)

// Remove the end face for the extrusion.
shell({ faces: ['end'], thickness: 0.25 }, firstSketch)

Rendered example of shell 0

// Remove the start face for the extrusion.
const firstSketch = startSketchOn('-XZ')
  |> startProfileAt([-12, 12], %)
  |> line([24, 0], %)
  |> line([0, -24], %)
  |> line([-24, 0], %)
  |> close(%)
  |> extrude(6, %)

// Remove the start face for the extrusion.
shell({ faces: ['start'], thickness: 0.25 }, firstSketch)

Rendered example of shell 1

// Remove a tagged face and the end face for the extrusion.
const firstSketch = startSketchOn('XY')
  |> startProfileAt([-12, 12], %)
  |> line([24, 0], %)
  |> line([0, -24], %)
  |> line([-24, 0], %, $myTag)
  |> close(%)
  |> extrude(6, %)

// Remove a tagged face for the extrusion.
shell({ faces: [myTag], thickness: 0.25 }, firstSketch)

Rendered example of shell 2

// Remove multiple faces at once.
const firstSketch = startSketchOn('XY')
  |> startProfileAt([-12, 12], %)
  |> line([24, 0], %)
  |> line([0, -24], %)
  |> line([-24, 0], %, $myTag)
  |> close(%)
  |> extrude(6, %)

// Remove a tagged face and the end face for the extrusion.
shell({
  faces: [myTag, 'end'],
  thickness: 0.25
}, firstSketch)

Rendered example of shell 3

// Shell a sketch on face.
let size = 100
const case = startSketchOn('-XZ')
  |> startProfileAt([-size, -size], %)
  |> line([2 * size, 0], %)
  |> line([0, 2 * size], %)
  |> tangentialArcTo([-size, size], %)
  |> close(%)
  |> extrude(65, %)

const thing1 = startSketchOn(case, 'end')
  |> circle({
       center: [-size / 2, -size / 2],
       radius: 25
     }, %)
  |> extrude(50, %)

const thing2 = startSketchOn(case, 'end')
  |> circle({
       center: [size / 2, -size / 2],
       radius: 25
     }, %)
  |> extrude(50, %)

// We put "case" in the shell function to shell the entire object.
shell({ faces: ['start'], thickness: 5 }, case)

Rendered example of shell 4

// Shell a sketch on face object on the end face.
let size = 100
const case = startSketchOn('XY')
  |> startProfileAt([-size, -size], %)
  |> line([2 * size, 0], %)
  |> line([0, 2 * size], %)
  |> tangentialArcTo([-size, size], %)
  |> close(%)
  |> extrude(65, %)

const thing1 = startSketchOn(case, 'end')
  |> circle({
       center: [-size / 2, -size / 2],
       radius: 25
     }, %)
  |> extrude(50, %)

const thing2 = startSketchOn(case, 'end')
  |> circle({
       center: [size / 2, -size / 2],
       radius: 25
     }, %)
  |> extrude(50, %)

// We put "thing1" in the shell function to shell the end face of the object.
shell({ faces: ['end'], thickness: 5 }, thing1)

Rendered example of shell 5

// Shell sketched on face objects on the end face, include all sketches to shell
// the entire object.


let size = 100
const case = startSketchOn('XY')
  |> startProfileAt([-size, -size], %)
  |> line([2 * size, 0], %)
  |> line([0, 2 * size], %)
  |> tangentialArcTo([-size, size], %)
  |> close(%)
  |> extrude(65, %)

const thing1 = startSketchOn(case, 'end')
  |> circle({
       center: [-size / 2, -size / 2],
       radius: 25
     }, %)
  |> extrude(50, %)

const thing2 = startSketchOn(case, 'end')
  |> circle({
       center: [size / 2, -size / 2],
       radius: 25
     }, %)
  |> extrude(50, %)

// We put "thing1" and "thing2" in the shell function to shell the end face of the object.
shell({ faces: ['end'], thickness: 5 }, [thing1, thing2])

Rendered example of shell 6