Class ManifoldBooleans

Combining Manifold solids: fusing, cutting and intersecting two or many at once, and splitting a solid with another solid or a plane. Because the kernel works on closed triangle meshes, these are fast and always give a watertight result; the two-shape and many-shape forms give the same results and exist for convenience. Every method returns new solids and leaves the inputs as they are.

Index

Constructors

constructor

new ManifoldBooleans(): ManifoldBooleans
Returns ManifoldBooleans

2 manifolds

differenceTwo

differenceTwo(
inputs: TwoManifoldsDto<ManifoldPointer>,
): Promise<ManifoldPointer>
Cuts the second solid out of the first, the same as subtract.
Parameters
- inputs: TwoManifoldsDto<ManifoldPointer>
  The solid to cut from and the solid to cut with
Returns Promise<ManifoldPointer>
The first solid minus the second
Example
```
const holed = await bitbybit.manifold.manifold.booleans.differenceTwo({ manifold1: cube, manifold2: sphere });
```
- Defined in bitbybit-docs.d.ts:38189

unionTwo

unionTwo(inputs: TwoManifoldsDto<ManifoldPointer>): Promise<ManifoldPointer>
Fuses two solids into one, the same as add.
Parameters
- inputs: TwoManifoldsDto<ManifoldPointer>
  The two solids
Returns Promise<ManifoldPointer>
The fused solid
Example
```
const fused = await bitbybit.manifold.manifold.booleans.unionTwo({ manifold1: cube, manifold2: sphere });
```
- Defined in bitbybit-docs.d.ts:38202

intersectionTwo

intersectionTwo(
inputs: TwoManifoldsDto<ManifoldPointer>,
): Promise<ManifoldPointer>
Keeps only the volume two solids share, the same as intersect.
Parameters
- inputs: TwoManifoldsDto<ManifoldPointer>
  The two solids
Returns Promise<ManifoldPointer>
The shared volume
Example
```
const common = await bitbybit.manifold.manifold.booleans.intersectionTwo({ manifold1: cube, manifold2: sphere });
```
- Defined in bitbybit-docs.d.ts:38215

a to b

subtract

subtract(inputs: TwoManifoldsDto<ManifoldPointer>): Promise<ManifoldPointer>
Cuts the second solid out of the first, leaving what remains of the first.
Parameters
- inputs: TwoManifoldsDto<ManifoldPointer>
  The solid to cut from and the solid to cut with
Returns Promise<ManifoldPointer>
The first solid minus the second
Example
```
const holed = await bitbybit.manifold.manifold.booleans.subtract({ manifold1: cube, manifold2: sphere });
```
- Defined in bitbybit-docs.d.ts:38150

add

add(inputs: TwoManifoldsDto<ManifoldPointer>): Promise<ManifoldPointer>
Fuses two solids into one closed, watertight solid.
Parameters
- inputs: TwoManifoldsDto<ManifoldPointer>
  The two solids
Returns Promise<ManifoldPointer>
The fused solid
Example
```
const fused = await bitbybit.manifold.manifold.booleans.add({ manifold1: cube, manifold2: sphere });
```
- Defined in bitbybit-docs.d.ts:38163

intersect

intersect(inputs: TwoManifoldsDto<ManifoldPointer>): Promise<ManifoldPointer>
Keeps only the volume two solids share, dropping everything else.
Parameters
- inputs: TwoManifoldsDto<ManifoldPointer>
  The two solids
Returns Promise<ManifoldPointer>
The shared volume
Example
```
const common = await bitbybit.manifold.manifold.booleans.intersect({ manifold1: cube, manifold2: sphere });
```
- Defined in bitbybit-docs.d.ts:38176

minkowski

minkowskiSum

minkowskiSum(inputs: TwoManifoldsDto<ManifoldPointer>): Promise<ManifoldPointer>
Sweeps the second solid over the whole surface of the first and fuses everything it passes through, growing the first solid by the shape of the second - the Minkowski sum, which is how a solid is rounded or padded by a sphere.
Parameters
- inputs: TwoManifoldsDto<ManifoldPointer>
  The solid to grow and the solid to sweep
Returns Promise<ManifoldPointer>
The grown solid
Example
```
const padded = await bitbybit.manifold.manifold.booleans.minkowskiSum({ manifold1: cube, manifold2: sphere });
```
- Defined in bitbybit-docs.d.ts:38122

minkowskiDifference

minkowskiDifference(
inputs: TwoManifoldsDto<ManifoldPointer>,
): Promise<ManifoldPointer>
Sweeps the second solid over the whole surface of the first and cuts away everything it passes through, shrinking the first solid by the shape of the second - the Minkowski difference, the erosion that undoes a Minkowski sum.
Parameters
- inputs: TwoManifoldsDto<ManifoldPointer>
  The solid to shrink and the solid to sweep
Returns Promise<ManifoldPointer>
The shrunken solid
Example
```
const eroded = await bitbybit.manifold.manifold.booleans.minkowskiDifference({ manifold1: cube, manifold2: sphere });
```
- Defined in bitbybit-docs.d.ts:38137

multiple

difference

difference(inputs: ManifoldsDto<ManifoldPointer>): Promise<ManifoldPointer>
Cuts every further solid in the list out of the first one.
Parameters
- inputs: ManifoldsDto<ManifoldPointer>
  The solids, the first being the one cut from
Returns Promise<ManifoldPointer>
The first solid minus all the others
Example
```
const holed = await bitbybit.manifold.manifold.booleans.difference({ manifolds: [cube, sphere, cylinder] });
```
- Defined in bitbybit-docs.d.ts:38228

union

union(inputs: ManifoldsDto<ManifoldPointer>): Promise<ManifoldPointer>
Fuses all the solids in a list into one.
Parameters
- inputs: ManifoldsDto<ManifoldPointer>
  The solids
Returns Promise<ManifoldPointer>
The fused solid
Example
```
const fused = await bitbybit.manifold.manifold.booleans.union({ manifolds: [cube, sphere, cylinder] });
```
- Defined in bitbybit-docs.d.ts:38241

intersection

intersection(inputs: ManifoldsDto<ManifoldPointer>): Promise<ManifoldPointer>
Keeps only the volume all the solids in a list share.
Parameters
- inputs: ManifoldsDto<ManifoldPointer>
  The solids
Returns Promise<ManifoldPointer>
The volume common to all of them
Example
```
const common = await bitbybit.manifold.manifold.booleans.intersection({ manifolds: [cube, sphere] });
```
- Defined in bitbybit-docs.d.ts:38254

split

split(inputs: SplitManifoldsDto<ManifoldPointer>): Promise<ManifoldPointer[]>
Cuts a solid with another solid and keeps both pieces: the part inside the cutter and the part outside it.

Cheaper than an intersection followed by a subtraction when both are needed.
Parameters
- inputs: SplitManifoldsDto<ManifoldPointer>
  The solid to split and the solid to cut with
Returns Promise<ManifoldPointer[]>
Two solids: the part inside the cutter, then the part outside it
Example
```
const [inside, outside] = await bitbybit.manifold.manifold.booleans.split({ manifoldToSplit: cube, manifoldCutter: sphere });
```
- Defined in bitbybit-docs.d.ts:38270

splitByPlane

splitByPlane(
inputs: SplitByPlaneDto<ManifoldPointer>,
): Promise<ManifoldPointer[]>
Cuts a solid with a plane and keeps both pieces.

The plane is given by its normal and its distance from the origin along that normal; the first piece lies on the side the normal points to, the second on the other side.
Parameters
- inputs: SplitByPlaneDto<ManifoldPointer>
  The solid, the plane normal and the plane's distance from the origin
Returns Promise<ManifoldPointer[]>
Two solids: the part on the normal's side, then the rest
Example
```
const [top, bottom] = await bitbybit.manifold.manifold.booleans.splitByPlane({ manifold: cube, normal: [0, 0, 1], originOffset: 0.5 });
```
- Defined in bitbybit-docs.d.ts:38286

splitByPlaneOnOffsets

splitByPlaneOnOffsets(
inputs: SplitByPlaneOnOffsetsDto<ManifoldPointer>,
): Promise<ManifoldPointer[]>
Cuts a solid into slabs with several parallel planes, all with the same normal, at the given distances from the origin.

Each cut keeps the part on the far side of the normal as a finished piece and carries the rest to the next distance, so the offsets should increase; n offsets give n + 1 pieces, empty ones dropped.
Parameters
- inputs: SplitByPlaneOnOffsetsDto<ManifoldPointer>
  The solid, the plane normal and the distances of the planes from the origin
Returns Promise<ManifoldPointer[]>
The slabs, one more than the offsets given
Example
```
const slabs = await bitbybit.manifold.manifold.booleans.splitByPlaneOnOffsets({ manifold: cube, normal: [0, 0, 1], originOffsets: [0.25, 0.5, 0.75] });
```
- Defined in bitbybit-docs.d.ts:38304

trim

trimByPlane

trimByPlane(inputs: TrimByPlaneDto<ManifoldPointer>): Promise<ManifoldPointer>
Cuts a solid with a plane and keeps only the part on the side the normal points to.

The plane is given by its normal and its distance from the origin along that normal.
Parameters
- inputs: TrimByPlaneDto<ManifoldPointer>
  The solid, the plane normal and the plane's distance from the origin
Returns Promise<ManifoldPointer>
The part of the solid on the normal's side
Example
```
const half = await bitbybit.manifold.manifold.booleans.trimByPlane({ manifold: sphere, normal: [0, 0, 1], originOffset: 0 });
```
- Defined in bitbybit-docs.d.ts:38319

Class ManifoldBooleans

Index

Constructors

2 manifolds

a to b

minkowski

multiple

split

trim

Constructors

constructor

Returns ManifoldBooleans

2 manifolds

differenceTwo

Parameters

Returns Promise<ManifoldPointer>

Example

unionTwo

Parameters

Returns Promise<ManifoldPointer>

Example

intersectionTwo

Parameters

Returns Promise<ManifoldPointer>

Example

a to b

subtract

Parameters

Returns Promise<ManifoldPointer>

Example

add

Parameters

Returns Promise<ManifoldPointer>

Example

intersect

Parameters

Returns Promise<ManifoldPointer>

Example

minkowski

minkowskiSum

Parameters

Returns Promise<ManifoldPointer>

Example

minkowskiDifference

Parameters

Returns Promise<ManifoldPointer>

Example

multiple

difference

Parameters

Returns Promise<ManifoldPointer>

Example

union

Parameters

Returns Promise<ManifoldPointer>

Example

intersection

Parameters

Returns Promise<ManifoldPointer>

Example

split

split

Parameters

Returns Promise<ManifoldPointer[]>

Example

splitByPlane

Parameters

Returns Promise<ManifoldPointer[]>

Example

splitByPlaneOnOffsets

Parameters

Returns Promise<ManifoldPointer[]>

Example

trim

trimByPlane

Parameters

Returns Promise<ManifoldPointer>

Example

Settings

On This Page