Class: Compound

Hierarchy

• _3DShape<TopoDS_Compound>

  ↳ Compound

Constructors

constructor

• new Compound(ocShape)

Parameters

Name	Type
ocShape	TopoDS_Compound

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

register.ts:39

• set wrapped(newWrapped): void

Parameters

Name	Type
newWrapped	Type

Returns

void

Inherited from

_3DShape.wrapped

Defined in

register.ts:44

Other Methods

clone

▸ clone(): Compound

Returns

Compound

Inherited from

_3DShape.clone

Defined in

shapes.ts:155

---

delete

▸ delete(): void

Returns

void

Inherited from

_3DShape.delete

Defined in

register.ts:54

---

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(): Compound

Returns

Compound

Inherited from

_3DShape.simplify

Defined in

shapes.ts:178

---

Shape Export Methods

blobSTEP

▸ blobSTEP(): Blob

Returns

Blob

Inherited from

_3DShape.blobSTEP

Defined in

shapes.ts:485

---

blobSTL

▸ blobSTL(__namedParameters?): Blob

Parameters

Name	Type
__namedParameters	Object
__namedParameters.angularTolerance	undefined | number
__namedParameters.tolerance	undefined | number

Returns

Blob

Inherited from

_3DShape.blobSTL

Defined in

shapes.ts:524

---

mesh

▸ mesh(__namedParameters?): ShapeMesh

Parameters

Name	Type
__namedParameters	Object
__namedParameters.angularTolerance	undefined | number
__namedParameters.tolerance	undefined | number

Returns

ShapeMesh

Inherited from

_3DShape.mesh

Defined in

shapes.ts:331

---

meshEdges

▸ meshEdges(__namedParameters?): Object

Parameters

Name	Type
__namedParameters	Object
__namedParameters.angularTolerance	undefined | number
__namedParameters.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

Parameters

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

Returns

Shape3D

Inherited from

_3DShape.chamfer

Defined in

shapes.ts:1210

---

cut

▸ cut(tool, __namedParameters?): Shape3D

Parameters

Name	Type
tool	Shape3D
__namedParameters	Object
__namedParameters.optimisation?	"none" | "commonFace" | "sameFace"

Returns

Shape3D

Inherited from

_3DShape.cut

Defined in

shapes.ts:986

---

fillet

▸ fillet(radiusConfig, filter?): Shape3D

Parameters

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

Returns

Shape3D

Inherited from

_3DShape.fillet

Defined in

shapes.ts:1163

---

fuse

▸ fuse(other, __namedParameters?): Shape3D

Parameters

Name	Type
other	Shape3D
__namedParameters	Object
__namedParameters.optimisation?	"none" | "commonFace" | "sameFace"

Returns

Shape3D

Inherited from

_3DShape.fuse

Defined in

shapes.ts:955

---

intersect

▸ intersect(tool): AnyShape

Parameters

Name	Type
tool	AnyShape

Returns

AnyShape

Inherited from

_3DShape.intersect

Defined in

shapes.ts:1016

---

shell

▸ shell(config, tolerance?): Shape3D

Parameters

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

Returns

Shape3D

Inherited from

_3DShape.shell

Defined in

shapes.ts:1037

▸ 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:1041

---

Shape Transformations Methods

mirror

▸ mirror(inputPlane, origin): Compound

Parameters

Name	Type
inputPlane	Plane | PlaneName | Point
origin	Point

Returns

Compound

Inherited from

_3DShape.mirror

Defined in

shapes.ts:264

---

rotate

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

Parameters

Name	Type
angle	number
position	Point
direction	Point

Returns

Compound

Inherited from

_3DShape.rotate

Defined in

shapes.ts:247

---

scale

▸ scale(scale, center?): Compound

Parameters

Name	Type
scale	number
center	Point

Returns

Compound

Inherited from

_3DShape.scale

Defined in

shapes.ts:278

---

translate

▸ translate(xDist, yDist, zDist): Compound

Parameters

Name	Type
xDist	number
yDist	number
zDist	number

Returns

Compound

Inherited from

_3DShape.translate

Defined in

shapes.ts:200

▸ translate(vector): Compound

Parameters

Name	Type
vector	Point

Returns

Compound

Inherited from

_3DShape.translate

Defined in

shapes.ts:201

---

translateX

▸ translateX(distance): Compound

Parameters

Name	Type
distance	number

Returns

Compound

Inherited from

_3DShape.translateX

Defined in

shapes.ts:220

---

translateY

▸ translateY(distance): Compound

Parameters

Name	Type
distance	number

Returns

Compound

Inherited from

_3DShape.translateY

Defined in

shapes.ts:229

---

translateZ

▸ translateZ(distance): Compound

Parameters

Name	Type
distance	number

Returns

Compound

Inherited from

_3DShape.translateZ

Defined in

shapes.ts:238