Class: _3DShape<Type>

Defined in: shapes.ts:1021

Extends

• Shape<Type>

Extended by

• Shell
• Solid
• CompSolid
• Compound

Type Parameters

Type

Type extends TopoDS_Shape

Constructors

Constructor

new _3DShape<Type>(ocShape): _3DShape<Type>;

Defined in: shapes.ts:207

Parameters

ocShape

Type

Returns

_3DShape<Type>

Inherited from

Shape.constructor

Other

boundingBox

Get Signature

get boundingBox(): BoundingBox;

Defined in: shapes.ts:375

Returns

BoundingBox

Inherited from

Shape.boundingBox

---

edges

Get Signature

get edges(): Edge[];

Defined in: shapes.ts:363

Returns

Edge[]

Inherited from

Shape.edges

---

faces

Get Signature

get faces(): Face[];

Defined in: shapes.ts:367

Returns

Face[]

Inherited from

Shape.faces

---

hashCode

Get Signature

get hashCode(): number;

Defined in: shapes.ts:215

Returns

number

Inherited from

Shape.hashCode

---

isNull

Get Signature

get isNull(): boolean;

Defined in: shapes.ts:219

Returns

boolean

Inherited from

Shape.isNull

---

wires

Get Signature

get wires(): Wire[];

Defined in: shapes.ts:371

Returns

Wire[]

Inherited from

Shape.wires

---

wrapped

Get Signature

get wrapped(): Type;

Defined in: register.ts:39

Returns

Type

Set Signature

set wrapped(newWrapped): void;

Defined in: register.ts:44

Parameters

newWrapped

Type

Returns

void

Inherited from

Shape.wrapped

---

clone()

clone(): this;

Defined in: shapes.ts:211

Returns

this

Inherited from

Shape.clone

---

delete()

delete(): void;

Defined in: register.ts:54

Returns

void

Inherited from

Shape.delete

---

isEqual()

isEqual(other): boolean;

Defined in: shapes.ts:227

Parameters

other

AnyShape

Returns

boolean

Inherited from

Shape.isEqual

---

isSame()

isSame(other): boolean;

Defined in: shapes.ts:223

Parameters

other

AnyShape

Returns

boolean

Inherited from

Shape.isSame

---

simplify()

simplify(): this;

Defined in: shapes.ts:234

Simplifies the shape by removing unnecessary edges and faces

Returns

this

Inherited from

Shape.simplify

Shape Export

blobSTEP()

blobSTEP(): Blob;

Defined in: shapes.ts:551

Exports the current shape as a STEP file as a Blob

Returns

Blob

Inherited from

Shape.blobSTEP

---

blobSTL()

blobSTL(__namedParameters): Blob;

Defined in: shapes.ts:593

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

__namedParameters

angularTolerance?

number = 0.1

binary?

boolean = false

tolerance?

number = 1e-3

Returns

Blob

Inherited from

Shape.blobSTL

---

mesh()

mesh(__namedParameters): ShapeMesh;

Defined in: shapes.ts:397

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

Parameters

__namedParameters

angularTolerance?

number = 0.1

tolerance?

number = 1e-3

Returns

ShapeMesh

Inherited from

Shape.mesh

---

meshEdges()

meshEdges(__namedParameters): object;

Defined in: shapes.ts:434

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

__namedParameters

angularTolerance?

number = 0.1

tolerance?

number = 1e-3

Returns

object

edgeGroups

edgeGroups: object[];

lines

lines: number[];

Inherited from

Shape.meshEdges

Shape Modifications

chamfer()

chamfer(radiusConfig, filter?): Shape3D;

Defined in: shapes.ts:1289

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

radiusConfig

RadiusConfig<ChamferRadius>

filter?

(e) => EdgeFinder

Returns

Shape3D

---

cut()

cut(tool, __namedParameters): Shape3D;

Defined in: shapes.ts:1058

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

Parameters

tool

Shape3D

__namedParameters

optimisation?

"none" | "commonFace" | "sameFace" = "none"

Returns

Shape3D

---

fillet()

fillet(radiusConfig, filter?): Shape3D;

Defined in: shapes.ts:1236

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

radiusConfig

RadiusConfig<FilletRadius>

filter?

(e) => EdgeFinder

Returns

Shape3D

---

fuse()

fuse(other, __namedParameters): Shape3D;

Defined in: shapes.ts:1027

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

Parameters

other

Shape3D

__namedParameters

optimisation?

"none" | "commonFace" | "sameFace" = "none"

Returns

Shape3D

---

intersect()

intersect(tool): AnyShape;

Defined in: shapes.ts:1088

Builds a new shape by intersecting this shape and another

Parameters

tool

AnyShape

Returns

AnyShape

---

shell()

Call Signature

shell(config, tolerance?): Shape3D;

Defined in: shapes.ts:1109

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

Parameters

config

filter

FaceFinder

thickness

number

tolerance?

number

Returns

Shape3D

Call Signature

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

Defined in: shapes.ts:1113

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

Parameters

thickness

number

finderFcn

(f) => FaceFinder

tolerance?

number

Returns

Shape3D

Shape Transformations

mirror()

mirror(inputPlane?, origin?): this;

Defined in: shapes.ts:326

Mirrors the shape through a plane

Parameters

inputPlane?

Point | Plane | PlaneName

origin?

Point

Returns

this

Inherited from

Shape.mirror

---

rotate()

rotate(
   angle, 
   position, 
   direction): this;

Defined in: shapes.ts:307

Rotates the shape

Parameters

angle

number

position

Point = ...

direction

Point = ...

Returns

this

Inherited from

Shape.rotate

---

scale()

scale(scale, center): this;

Defined in: shapes.ts:342

Returns a scaled version of the shape

Parameters

scale

number

center

Point = ...

Returns

this

Inherited from

Shape.scale

---

translate()

Call Signature

translate(
   xDist, 
   yDist, 
   zDist): this;

Defined in: shapes.ts:258

Translates the shape of an arbitrary vector

Parameters

xDist

number

yDist

number

zDist

number

Returns

this

Inherited from

Shape.translate

Call Signature

translate(vector): this;

Defined in: shapes.ts:259

Translates the shape of an arbitrary vector

Parameters

vector

Point

Returns

this

Inherited from

Shape.translate

---

translateX()

translateX(distance): this;

Defined in: shapes.ts:280

Translates the shape on the X axis

Parameters

distance

number

Returns

this

Inherited from

Shape.translateX

---

translateY()

translateY(distance): this;

Defined in: shapes.ts:289

Translates the shape on the Y axis

Parameters

distance

number

Returns

this

Inherited from

Shape.translateY

---

translateZ()

translateZ(distance): this;

Defined in: shapes.ts:298

Translates the shape on the Z axis

Parameters

distance

number

Returns

this

Inherited from

Shape.translateZ