modeling-app/docs/kcl/shell.md

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, solid_set: SolidSet) -> SolidSet

Arguments

Name	Type	Description	Required
data	ShellData	Data for shells.	Yes
solid_set	SolidSet	A solid or a group of solids.	Yes

Returns

SolidSet - A solid or a group of solids.

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)

// 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)

// 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)

// 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)

// 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)

// 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)

// 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])