Shell

Hierarchy

_3DShape<TopoDS_Shell>
↳ Shell

Constructors

constructor

• new Shell(ocShape)

Parameters

Name	Type
`ocShape`	`TopoDS_Shell`

Inherited from

_3DShape.constructor

Defined in

shapes.ts:151

Accessors

boundingBox

• get boundingBox(): BoundingBox

Returns

BoundingBox

Inherited from

_3DShape.boundingBox

Defined in

shapes.ts:309

edges

• get edges(): Edge[]

Returns

Edge[]

Inherited from

_3DShape.edges

Defined in

shapes.ts:297

faces

• get faces(): Face[]

Returns

Face[]

Inherited from

_3DShape.faces

Defined in

shapes.ts:301

hashCode

• get hashCode(): number

Returns

number

Inherited from

_3DShape.hashCode

Defined in

shapes.ts:159

isNull

• get isNull(): boolean

Returns

boolean

Inherited from

_3DShape.isNull

Defined in

shapes.ts:163

wires

• get wires(): Wire[]

Returns

Wire[]

Inherited from

_3DShape.wires

Defined in

shapes.ts:305

wrapped

• get wrapped(): Type

Returns

Type

Inherited from

_3DShape.wrapped

Defined in

• set wrapped(newWrapped): void

Parameters

Name	Type
`newWrapped`	`Type`

Returns

void

Inherited from

_3DShape.wrapped

Defined in

Other Methods

clone

▸ clone(): Shell

delete

▸ delete(): void

Returns

void

Inherited from

_3DShape.delete

Defined in

isEqual

▸ isEqual(other): boolean

Parameters

Name	Type
`other`	`AnyShape`

Returns

boolean

Inherited from

_3DShape.isEqual

Defined in

shapes.ts:171

isSame

▸ isSame(other): boolean

Parameters

Name	Type
`other`	`AnyShape`

Returns

boolean

Inherited from

_3DShape.isSame

Defined in

shapes.ts:167

simplify

▸ simplify(): Shell

Simplifies the shape by removing unnecessary edges and faces

Returns

Shell

Inherited from

_3DShape.simplify

Defined in

shapes.ts:178

Shape Export Methods

blobSTEP

▸ blobSTEP(): Blob

Exports the current shape as a STEP file as a Blob

Returns

Blob

Inherited from

_3DShape.blobSTEP

Defined in

shapes.ts:485

blobSTL

▸ blobSTL(«destructured»?): Blob

Exports the current shape as a STL file as a Blob

In order to create a STL file, the shape needs to be meshed. The tolerances correspond to the values used to mesh the shape.

Parameters

Name	Type
`«destructured»`	`Object`
› `angularTolerance`	`undefined` \| `number`
› `binary`	`undefined` \| `boolean`
› `tolerance`	`undefined` \| `number`

Returns

Blob

Inherited from

_3DShape.blobSTL

Defined in

shapes.ts:527

mesh

▸ mesh(«destructured»?): ShapeMesh

Exports the current shape as a set of triangle. These can be used by threejs for instance to represent the the shape

Parameters

Name	Type
`«destructured»`	`Object`
› `angularTolerance`	`undefined` \| `number`
› `tolerance`	`undefined` \| `number`

Returns

ShapeMesh

Inherited from

_3DShape.mesh

Defined in

shapes.ts:331

meshEdges

▸ meshEdges(«destructured»?): Object

Exports the current shape as a set of lines. These can be used by threejs for instance to represent the edges of the shape

Parameters

Name	Type
`«destructured»`	`Object`
› `angularTolerance`	`undefined` \| `number`
› `tolerance`	`undefined` \| `number`

Returns

Object

Name	Type
`edgeGroups`	{ `count`: `number` ; `edgeId`: `number` ; `start`: `number` }[]
`lines`	`number`[]

Inherited from

_3DShape.meshEdges

Defined in

shapes.ts:368

Shape Modifications Methods

chamfer

▸ chamfer(radiusConfig, filter?): Shape3D

Creates a new shapes with some edges chamfered, as specified in the radius config.

If the radius is a filter finder object (with an EdgeFinder as filter, and a radius to specifiy the chamfer radius), the fillet will only be applied to the edges as selected by the finder. The finder will be deleted unless it is explicitly specified to keep it.

If the radius is a number all the edges will be chamfered.

If the radius is a function edges will be chamfered according to the value returned by the function (0 or null will not add any chamfer).

Parameters

Name	Type
`radiusConfig`	`RadiusConfig`
`filter?`	(`e`: `EdgeFinder`) => `EdgeFinder`

Returns

Shape3D

Inherited from

_3DShape.chamfer

Defined in

shapes.ts:1208

cut

▸ cut(tool, «destructured»?): Shape3D

Builds a new shape by removing the tool tape from this shape

Parameters

Name	Type
`tool`	`Shape3D`
`«destructured»`	`Object`
› `optimisation?`	`"none"` \| `"commonFace"` \| `"sameFace"`

Returns

Shape3D

Inherited from

_3DShape.cut

Defined in

shapes.ts:984

fillet

▸ fillet(radiusConfig, filter?): Shape3D

Creates a new shapes with some edges filletted, as specified in the radius config.

If the radius is a filter finder object (with an EdgeFinder as filter, and a radius to specifiy the fillet radius), the fillet will only be applied to the edges as selected by the finder. The finder will be deleted unless it is explicitly specified to keep it.

If the radius is a number all the edges will be filletted.

If the radius is a function edges will be filletted according to the value returned by the function (0 or null will not add any fillet).

Parameters

Name	Type
`radiusConfig`	`RadiusConfig`
`filter?`	(`e`: `EdgeFinder`) => `EdgeFinder`

Returns

Shape3D

Inherited from

_3DShape.fillet

Defined in

shapes.ts:1161

fuse

▸ fuse(other, «destructured»?): Shape3D

Builds a new shape out of the two, fused, shapes

Parameters

Name	Type
`other`	`Shape3D`
`«destructured»`	`Object`
› `optimisation?`	`"none"` \| `"commonFace"` \| `"sameFace"`

Returns

Shape3D

Inherited from

_3DShape.fuse

Defined in

shapes.ts:953

intersect

▸ intersect(tool): AnyShape

Builds a new shape by intersecting this shape and another

Parameters

Name	Type
`tool`	`AnyShape`

Returns

AnyShape

Inherited from

_3DShape.intersect

Defined in

shapes.ts:1014

shell

▸ shell(config, tolerance?): Shape3D

Hollows out the current shape, removing the faces found by the filter and keeping a border of thickness

Parameters

Name	Type
`config`	`Object`
`config.filter`	`FaceFinder`
`config.thickness`	`number`
`tolerance?`	`number`

Returns

Shape3D

Inherited from

_3DShape.shell

Defined in

shapes.ts:1035

▸ shell(thickness, finderFcn, tolerance?): Shape3D

Parameters

Name	Type
`thickness`	`number`
`finderFcn`	(`f`: `FaceFinder`) => `FaceFinder`
`tolerance?`	`number`

Returns

Shape3D

Inherited from

_3DShape.shell

Defined in

shapes.ts:1039

Shape Transformations Methods

mirror

▸ mirror(inputPlane?, origin?): Shell

Mirrors the shape through a plane

Parameters

Name	Type
`inputPlane?`	`Point` \| `Plane` \| `PlaneName`
`origin?`	`Point`

Returns

Shell

Inherited from

_3DShape.mirror

Defined in

shapes.ts:264

rotate

▸ rotate(angle, position?, direction?): Shell

Rotates the shape

Parameters

Name	Type
`angle`	`number`
`position`	`Point`
`direction`	`Point`

Returns

Shell

Inherited from

_3DShape.rotate

Defined in

shapes.ts:247

scale

▸ scale(scale, center?): Shell

Returns a scaled version of the shape

Parameters

Name	Type
`scale`	`number`
`center`	`Point`

Returns

Shell

Inherited from

_3DShape.scale

Defined in

shapes.ts:278

translate

▸ translate(xDist, yDist, zDist): Shell

Translates the shape of an arbitrary vector

Parameters

Name	Type
`xDist`	`number`
`yDist`	`number`
`zDist`	`number`

Returns

Shell

Inherited from

_3DShape.translate

Defined in

shapes.ts:200

▸ translate(vector): Shell

Parameters

Name	Type
`vector`	`Point`

Returns

Shell

Inherited from

_3DShape.translate

Defined in

shapes.ts:201

translateX

▸ translateX(distance): Shell

Translates the shape on the X axis

Parameters

Name	Type
`distance`	`number`

Returns

Shell

Inherited from

_3DShape.translateX

Defined in

shapes.ts:220

translateY

▸ translateY(distance): Shell

Translates the shape on the Y axis

Parameters

Name	Type
`distance`	`number`

Returns

Shell

Inherited from

_3DShape.translateY

Defined in

shapes.ts:229

translateZ

▸ translateZ(distance): Shell

Translates the shape on the Z axis

Parameters

Name	Type
`distance`	`number`

Returns

Shell

Inherited from

_3DShape.translateZ

Defined in

shapes.ts:238

Hierarchy​

Constructors​

constructor​

Parameters​

Inherited from​

Defined in​

Accessors​

boundingBox​

Returns​

Inherited from​

Defined in​

edges​

Returns​

Inherited from​

Defined in​

faces​

Returns​

Inherited from​

Defined in​

hashCode​

Returns​

Inherited from​

Defined in​

isNull​

Returns​

Inherited from​

Defined in​

wires​

Returns​

Inherited from​

Defined in​

wrapped​

Returns​

Inherited from​

Defined in​

Parameters​

Returns​

Inherited from​

Defined in​

Other Methods​

clone​

Returns​

Inherited from​

Defined in​

delete​

Returns​

Inherited from​

Defined in​

isEqual​

Parameters​

Returns​

Inherited from​

Defined in​

isSame​

Parameters​

Returns​

Inherited from​

Defined in​

simplify​

Returns​

Inherited from​

Defined in​

Shape Export Methods​

blobSTEP​

Returns​

Inherited from​

Defined in​

blobSTL​

Parameters​

Returns​

Inherited from​

Defined in​

mesh​

Parameters​

Returns​

Inherited from​

Defined in​

meshEdges​

Parameters​

Returns​

Hierarchy

Constructors

constructor

Parameters

Inherited from

Defined in

Accessors

boundingBox

Returns

Inherited from

Defined in

edges

Returns

Inherited from

Defined in

faces

Returns

Inherited from

Defined in

hashCode

Returns

Inherited from

Defined in

isNull

Returns

Inherited from

Defined in

wires

Returns

Inherited from

Defined in

wrapped

Returns

Inherited from

Defined in

Parameters

Returns

Inherited from

Defined in

Other Methods

clone

Returns

Inherited from

Defined in

delete

Returns

Inherited from

Defined in

isEqual

Parameters

Returns

Inherited from

Defined in

isSame

Parameters

Returns

Inherited from

Defined in

simplify

Returns

Inherited from

Defined in

Shape Export Methods

blobSTEP

Returns

Inherited from

Defined in

blobSTL

Parameters

Returns

Inherited from

Defined in

mesh

Parameters

Returns

Inherited from

Defined in

meshEdges

Parameters

Returns