Class OCCTSolid

Solids in OpenCascade: closed shapes that enclose a volume. Build one from a primitive (createBox, createSphere, createCylinder, createCone, createTorus), from a flat profile extruded front and back (the star, n-gon, heart, beam and other profile solids), or from a closed shell with fromClosedShell; then measure it with the volume, surface area and center of mass getters, and filter points by whether they lie inside it. Vertices, edges, wires, faces, shells and compounds have their own classes beside this one under shapes.

Constructors

constructor

new OCCTSolid(): OCCTSolid
Returns OCCTSolid

beam

createIBeamProfileSolid

createIBeamProfileSolid(
inputs: IBeamProfileSolidDto,
): Promise<TopoDSSolidPointer>
Creates an I-beam by extruding its flat profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown.
Parameters
- inputs: IBeamProfileSolidDto
  The I-beam profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const beam = await bitbybit.occt.shapes.solid.createIBeamProfileSolid({
    width: 10,
    height: 20,
    flangeThickness: 1,
    webThickness: 1,
    alignment: Bit.Inputs.Base.basicAlignmentEnum.midMid,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 0, 1],
    extrusionLengthFront: 100,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44885

createHBeamProfileSolid

createHBeamProfileSolid(
inputs: HBeamProfileSolidDto,
): Promise<TopoDSSolidPointer>
Creates an H-beam by extruding its flat profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown.
Parameters
- inputs: HBeamProfileSolidDto
  The H-beam profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const beam = await bitbybit.occt.shapes.solid.createHBeamProfileSolid({
    width: 20,
    height: 20,
    flangeThickness: 1,
    webThickness: 1,
    alignment: Bit.Inputs.Base.basicAlignmentEnum.midMid,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 0, 1],
    extrusionLengthFront: 100,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44912

createTBeamProfileSolid

createTBeamProfileSolid(
inputs: TBeamProfileSolidDto,
): Promise<TopoDSSolidPointer>
Creates a T-beam by extruding its flat profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown.
Parameters
- inputs: TBeamProfileSolidDto
  The T-beam profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const beam = await bitbybit.occt.shapes.solid.createTBeamProfileSolid({
    width: 10,
    height: 20,
    flangeThickness: 1,
    webThickness: 1,
    alignment: Bit.Inputs.Base.basicAlignmentEnum.midMid,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 0, 1],
    extrusionLengthFront: 100,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44939

createUBeamProfileSolid

createUBeamProfileSolid(
inputs: UBeamProfileSolidDto,
): Promise<TopoDSSolidPointer>
Creates a U-beam by extruding its flat profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown.
Parameters
- inputs: UBeamProfileSolidDto
  The U-beam profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const beam = await bitbybit.occt.shapes.solid.createUBeamProfileSolid({
    width: 10,
    height: 20,
    flangeThickness: 1,
    webThickness: 1,
    flangeWidth: 3,
    alignment: Bit.Inputs.Base.basicAlignmentEnum.midMid,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 0, 1],
    extrusionLengthFront: 100,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44967

debug

debugInfo

debugInfo(inputs: ShapeDto<TopoDSSolidPointer>): Promise<SolidDebugInfo>
Collects diagnostic facts about a solid: whether it is valid, how many faces and edges it has, its surface area and volume, and for every face the surface type, degrees, control point counts, bounds and area.

An empty or null shape gives a report marked invalid with zero counts.
Parameters
- inputs: ShapeDto<TopoDSSolidPointer>
  The solid to inspect
Returns Promise<SolidDebugInfo>
The report with counts, area, volume and one entry per face
Example
```
const info = await bitbybit.occt.shapes.solid.debugInfo({ shape: box });
console.log(info.nbFaces, info.volume);
```
- Defined in bitbybit-docs.d.ts:44551

filter

filterSolidPoints

filterSolidPoints(
inputs: FilterSolidPointsDto<TopoDSSolidPointer>,
): Promise<Point3[]>
Keeps the points that lie inside, on the surface of, or outside a solid, as chosen by the keepIn, keepOn and keepOut flags.

A point counts as on the surface when it is within tolerance of it. Points the kernel cannot classify are kept only with keepUnknown.
Parameters
- inputs: FilterSolidPointsDto<TopoDSSolidPointer>
  The solid, the points, the tolerance and which classes of point to keep
Returns Promise<Point3[]>
The points that passed the filter, in their original order
Example
```
const inside = await bitbybit.occt.shapes.solid.filterSolidPoints({
    shape: box,
    points: [[0, 0, 0], [100, 0, 0]],
    tolerance: 1e-7,
    keepIn: true,
    keepOn: false,
    keepOut: false,
    keepUnknown: false,
});
```
- Defined in bitbybit-docs.d.ts:45074

from

fromClosedShell

fromClosedShell(
inputs: ShapeDto<TopoDSShellPointer>,
): Promise<TopoDSSolidPointer>
Turns a closed shell into a solid, so the volume it encloses becomes a body that can be measured, booleaned and meshed.

The shell must be watertight; a shell with gaps produces a solid the kernel cannot use.
Parameters
- inputs: ShapeDto<TopoDSShellPointer>
  The closed shell
Returns Promise<TopoDSSolidPointer>
The solid bounded by the shell
Example
```
const solid = await bitbybit.occt.shapes.solid.fromClosedShell({ shape: closedShell });
```
- Defined in bitbybit-docs.d.ts:44567

get

getSolidSurfaceArea

getSolidSurfaceArea(inputs: ShapeDto<TopoDSSolidPointer>): Promise<number>
Measures the total area of all the faces of a solid.
Parameters
- inputs: ShapeDto<TopoDSSolidPointer>
  The solid
Returns Promise<number>
The surface area in square model units
Example
```
const area = await bitbybit.occt.shapes.solid.getSolidSurfaceArea({ shape: box });
```
- Defined in bitbybit-docs.d.ts:44980

getSolidVolume

getSolidVolume(inputs: ShapeDto<TopoDSSolidPointer>): Promise<number>
Measures the volume a solid encloses, in cubic model units.
Parameters
- inputs: ShapeDto<TopoDSSolidPointer>
  The solid
Returns Promise<number>
The volume in cubic model units
Example
```
const volume = await bitbybit.occt.shapes.solid.getSolidVolume({ shape: box });
```
- Defined in bitbybit-docs.d.ts:44993

getSolidsVolumes

getSolidsVolumes(inputs: ShapesDto<TopoDSSolidPointer>): Promise<number[]>
Measures the volume of each solid in a list.
Parameters
- inputs: ShapesDto<TopoDSSolidPointer>
  The solids
Returns Promise<number[]>
One volume per solid, in the same order
Example
```
const volumes = await bitbybit.occt.shapes.solid.getSolidsVolumes({ shapes: [box, sphere] });
```
- Defined in bitbybit-docs.d.ts:45006

getSolidCenterOfMass

getSolidCenterOfMass(inputs: ShapeDto<TopoDSSolidPointer>): Promise<Point3>
Finds the center of mass of a solid, treating it as filled with material of uniform density.
Parameters
- inputs: ShapeDto<TopoDSSolidPointer>
  The solid
Returns Promise<Point3>
The center of mass point
Example
```
const center = await bitbybit.occt.shapes.solid.getSolidCenterOfMass({ shape: box });
```
- Defined in bitbybit-docs.d.ts:45019

getSolidsCentersOfMass

getSolidsCentersOfMass(inputs: ShapesDto<TopoDSSolidPointer>): Promise<Point3[]>
Finds the center of mass of each solid in a list, treating each as filled with material of uniform density.
Parameters
- inputs: ShapesDto<TopoDSSolidPointer>
  The solids
Returns Promise<Point3[]>
One point per solid, in the same order
Example
```
const centers = await bitbybit.occt.shapes.solid.getSolidsCentersOfMass({ shapes: [box, sphere] });
```
- Defined in bitbybit-docs.d.ts:45033

getSolids

getSolids(inputs: ShapeDto<TopoDSShapePointer>): Promise<TopoDSSolidPointer[]>
Lists the solids inside any shape, such as the bodies of a compound or the result of a boolean.

A shape that is itself a solid gives a list with that one solid.
Parameters
- inputs: ShapeDto<TopoDSShapePointer>
  The shape to take the solids from
Returns Promise<TopoDSSolidPointer[]>
The solids found in the shape
Example
```
const solids = await bitbybit.occt.shapes.solid.getSolids({ shape: compound });
```
- Defined in bitbybit-docs.d.ts:45049

primitives

createBox

createBox(inputs: BoxDto): Promise<TopoDSSolidPointer>
Creates a box solid with its sides parallel to the axes.

width runs along X, height along Y (up) and length along Z, all in model units. By default the box is centered on center; with originOnCenter set to false it stands on that point instead, so center becomes the middle of the bottom face.
Parameters
- inputs: BoxDto
  Box size, the point it is placed on, and whether it is centered on or stands on it
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const box = await bitbybit.occt.shapes.solid.createBox({ width: 10, length: 20, height: 5, center: [0, 0, 0], originOnCenter: true });
```
- Defined in bitbybit-docs.d.ts:44584

createCube

createCube(inputs: Bit.Inputs.OCCT.CubeDto): Promise<TopoDSSolidPointer>
Creates a cube solid, a box with all three sides the same size, parallel to the axes.

By default the cube is centered on center; with originOnCenter set to false it stands on that point instead, so center becomes the middle of the bottom face.
Parameters
- inputs: Bit.Inputs.OCCT.CubeDto
  Cube size, the point it is placed on, and whether it is centered on or stands on it
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const cube = await bitbybit.occt.shapes.solid.createCube({ size: 10, center: [0, 0, 0], originOnCenter: true });
```
- Defined in bitbybit-docs.d.ts:44600

createBoxFromCorner

createBoxFromCorner(inputs: BoxFromCornerDto): Promise<TopoDSSolidPointer>
Creates a box solid that starts at a corner point and extends along the positive axes.

The corner with the smallest x, y and z sits at corner; the box reaches width along X, height along Y and length along Z from there, all in model units.
Parameters
- inputs: BoxFromCornerDto
  Box size and the corner it grows from
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const box = await bitbybit.occt.shapes.solid.createBoxFromCorner({ width: 10, length: 20, height: 5, corner: [0, 0, 0] });
```
- Defined in bitbybit-docs.d.ts:44616

createCylinder

createCylinder(inputs: Bit.Inputs.OCCT.CylinderDto): Promise<TopoDSSolidPointer>
Creates a cylinder solid with a round base at center, growing height along direction.

With originOnCenter on, the cylinder is shifted back by half its height so center sits in its middle. angle, in degrees, cuts a wedge out of the full 360 degree round, like a slice of cake.
Parameters
- inputs: Bit.Inputs.OCCT.CylinderDto
  Radius, height, base center, direction, an optional partial angle and whether to center on the point
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const cylinder = await bitbybit.occt.shapes.solid.createCylinder({ radius: 5, height: 20, center: [0, 0, 0], direction: [0, 1, 0], angle: 360, originOnCenter: false });
```
- Defined in bitbybit-docs.d.ts:44633

createCylindersOnLines

createCylindersOnLines(
inputs: CylindersOnLinesDto,
): Promise<TopoDSSolidPointer[]>
Creates one cylinder solid along each line, from its start to its end, all with the same radius.

The height of each cylinder is the length of its line.
Parameters
- inputs: CylindersOnLinesDto
  The lines and the radius
Returns Promise<TopoDSSolidPointer[]>
One solid per line, in the same order
Example
```
const rods = await bitbybit.occt.shapes.solid.createCylindersOnLines({
    lines: [{ start: [0, 0, 0], end: [0, 10, 0] }, { start: [5, 0, 0], end: [5, 10, 0] }],
    radius: 0.5,
});
```
- Defined in bitbybit-docs.d.ts:44652

createSphere

createSphere(inputs: Bit.Inputs.OCCT.SphereDto): Promise<TopoDSSolidPointer>
Creates a sphere solid of the given radius around a center point.
Parameters
- inputs: Bit.Inputs.OCCT.SphereDto
  Radius and center
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const sphere = await bitbybit.occt.shapes.solid.createSphere({ radius: 5, center: [0, 0, 0] });
```
- Defined in bitbybit-docs.d.ts:44665

createCone

createCone(inputs: Bit.Inputs.OCCT.ConeDto): Promise<TopoDSSolidPointer>
Creates a cone solid, or a truncated cone when both radii are above 0, standing on a round base at center and growing height along direction.

radius1 is the base and radius2 the top; a top radius of 0 makes a pointed cone. angle, in degrees, cuts a wedge out of the full 360 degree round.
Parameters
- inputs: Bit.Inputs.OCCT.ConeDto
  Base and top radius, height, base center, direction and an optional partial angle
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const cone = await bitbybit.occt.shapes.solid.createCone({ radius1: 5, radius2: 0, height: 10, center: [0, 0, 0], direction: [0, 1, 0], angle: 360 });
```
- Defined in bitbybit-docs.d.ts:44682

createTorus

createTorus(inputs: Bit.Inputs.OCCT.TorusDto): Promise<TopoDSSolidPointer>
Creates a torus solid, a ring with a round cross-section, centered on center with its axis along direction.

majorRadius is the distance from the center to the middle of the tube and minorRadius the tube's own radius. angle, in degrees, makes a partial ring instead of the full 360 degrees.
Parameters
- inputs: Bit.Inputs.OCCT.TorusDto
  Major and minor radius, center, direction and an optional partial angle
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const ring = await bitbybit.occt.shapes.solid.createTorus({ majorRadius: 10, minorRadius: 2, center: [0, 0, 0], direction: [0, 1, 0], angle: 360 });
```
- Defined in bitbybit-docs.d.ts:44699

createStarSolid

createStarSolid(inputs: StarSolidDto): Promise<TopoDSSolidPointer>
Creates a star-shaped solid by extruding a flat star profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown. The star itself is built as shapes.wire.createStarWire builds it.
Parameters
- inputs: StarSolidDto
  The star profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const star = await bitbybit.occt.shapes.solid.createStarSolid({
    numRays: 5,
    outerRadius: 10,
    innerRadius: 5,
    half: false,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44726

createNGonSolid

createNGonSolid(inputs: NGonSolidDto): Promise<TopoDSSolidPointer>
Creates a solid with a regular polygon cross-section by extruding a flat n-gon profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown.
Parameters
- inputs: NGonSolidDto
  The polygon profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const hexPrism = await bitbybit.occt.shapes.solid.createNGonSolid({
    nrCorners: 6,
    radius: 5,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 10,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44750

createParallelogramSolid

createParallelogramSolid(
inputs: ParallelogramSolidDto,
): Promise<TopoDSSolidPointer>
Creates a solid with a parallelogram cross-section by extruding a flat parallelogram profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown.
Parameters
- inputs: ParallelogramSolidDto
  The parallelogram profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const slab = await bitbybit.occt.shapes.solid.createParallelogramSolid({
    width: 10,
    height: 5,
    angle: 15,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    aroundCenter: true,
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44776

createHeartSolid

createHeartSolid(inputs: HeartSolidDto): Promise<TopoDSSolidPointer>
Creates a heart-shaped solid by extruding a flat heart profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown.
Parameters
- inputs: HeartSolidDto
  The heart profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const heart = await bitbybit.occt.shapes.solid.createHeartSolid({
    sizeApprox: 10,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44800

createChristmasTreeSolid

createChristmasTreeSolid(
inputs: ChristmasTreeSolidDto,
): Promise<TopoDSSolidPointer>
Creates a Christmas tree-shaped solid by extruding a flat tree profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown.
Parameters
- inputs: ChristmasTreeSolidDto
  The tree profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const tree = await bitbybit.occt.shapes.solid.createChristmasTreeSolid({
    height: 10,
    innerDist: 1.5,
    outerDist: 3,
    nrSkirts: 5,
    trunkHeight: 1,
    trunkWidth: 1,
    half: false,
    rotation: 0,
    origin: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44830

createLPolygonSolid

createLPolygonSolid(inputs: LPolygonSolidDto): Promise<TopoDSSolidPointer>
Creates an L-shaped solid by extruding a flat L profile forward and backward along its own normal.

extrusionLengthFront and extrusionLengthBack say how far it grows each way, in model units; at least one must be above 0 or an error is thrown.
Parameters
- inputs: LPolygonSolidDto
  The L profile and the two extrusion lengths
Returns Promise<TopoDSSolidPointer>
A new solid
Example
```
const bracket = await bitbybit.occt.shapes.solid.createLPolygonSolid({
    widthFirst: 10,
    lengthFirst: 20,
    widthSecond: 10,
    lengthSecond: 15,
    align: Bit.Inputs.OCCT.directionEnum.outside,
    rotation: 0,
    center: [0, 0, 0],
    direction: [0, 1, 0],
    extrusionLengthFront: 2,
    extrusionLengthBack: 0,
});
```
- Defined in bitbybit-docs.d.ts:44858

Class OCCTSolid

Index

Constructors

beam

debug

filter

from

get

primitives

Constructors

constructor

Returns OCCTSolid

beam

createIBeamProfileSolid

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createHBeamProfileSolid

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createTBeamProfileSolid

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createUBeamProfileSolid

Parameters

Returns Promise<TopoDSSolidPointer>

Example

debug

debugInfo

Parameters

Returns Promise<SolidDebugInfo>

Example

filter

filterSolidPoints

Parameters

Returns Promise<Point3[]>

Example

from

fromClosedShell

Parameters

Returns Promise<TopoDSSolidPointer>

Example

get

getSolidSurfaceArea

Parameters

Returns Promise<number>

Example

getSolidVolume

Parameters

Returns Promise<number>

Example

getSolidsVolumes

Parameters

Returns Promise<number[]>

Example

getSolidCenterOfMass

Parameters

Returns Promise<Point3>

Example

getSolidsCentersOfMass

Parameters

Returns Promise<Point3[]>

Example

getSolids

Parameters

Returns Promise<TopoDSSolidPointer[]>

Example

primitives

createBox

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createCube

Parameters

Returns Promise<TopoDSSolidPointer>

Example

createBoxFromCorner

Parameters