Class: Shape<Type>

Defined in: packages/replicad/src/shapes.ts:188

Extends

• WrappingObj<Type>

Extended by

• Vertex
• _1DShape
• Face
• _3DShape

Type Parameters

Type

Type extends TopoDS_Shape

Constructors

Constructor

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

Defined in: packages/replicad/src/shapes.ts:189

Parameters

ocShape

Type

Returns

Shape<Type>

Overrides

WrappingObj.constructor

Finders

findEdge()

findEdge(this, finderFcn): Edge;

Defined in: packages/replicad/src/shapes.ts:403

Finds a unique edge using a finder function, which receives a fresh EdgeFinder and this shape. Throws if there is not exactly one match.

Parameters

this

AnyShape

finderFcn

FinderFunction<EdgeFinder, AnyShape>

Returns

Edge

---

findEdges()

findEdges(this, finderFcn): Edge[];

Defined in: packages/replicad/src/shapes.ts:416

Finds all matching edges using a finder function, which receives a fresh EdgeFinder and this shape.

Parameters

this

AnyShape

finderFcn

FinderFunction<EdgeFinder, AnyShape>

Returns

Edge[]

---

findFace()

findFace(this, finderFcn): Face;

Defined in: packages/replicad/src/shapes.ts:429

Finds a unique face using a finder function, which receives a fresh FaceFinder and this shape. Throws if there is not exactly one match.

Parameters

this

AnyShape

finderFcn

FinderFunction<FaceFinder, AnyShape>

Returns

Face

---

findFaces()

findFaces(this, finderFcn): Face[];

Defined in: packages/replicad/src/shapes.ts:442

Finds all matching faces using a finder function, which receives a fresh FaceFinder and this shape.

Parameters

this

AnyShape

finderFcn

FinderFunction<FaceFinder, AnyShape>

Returns

Face[]

Other

boundingBox

Get Signature

get boundingBox(): BoundingBox;

Defined in: packages/replicad/src/shapes.ts:460

Returns

BoundingBox

---

edges

Get Signature

get edges(): Edge[];

Defined in: packages/replicad/src/shapes.ts:389

Returns

Edge[]

---

faces

Get Signature

get faces(): Face[];

Defined in: packages/replicad/src/shapes.ts:393

Returns

Face[]

---

hashCode

Get Signature

get hashCode(): number;

Defined in: packages/replicad/src/shapes.ts:201

Returns

number

---

isNull

Get Signature

get isNull(): boolean;

Defined in: packages/replicad/src/shapes.ts:205

Returns

boolean

---

solids

Get Signature

get solids(): Solid[];

Defined in: packages/replicad/src/shapes.ts:449

Returns

Solid[]

---

wires

Get Signature

get wires(): Wire[];

Defined in: packages/replicad/src/shapes.ts:456

Returns

Wire[]

---

wrapped

Get Signature

get wrapped(): Type;

Defined in: packages/replicad/src/register.ts:41

Returns

Type

Set Signature

set wrapped(newWrapped): void;

Defined in: packages/replicad/src/register.ts:46

Parameters

newWrapped

Type

Returns

void

Inherited from

WrappingObj.wrapped

---

[dispose]()

dispose: void;

Defined in: node_modules/typescript/lib/lib.esnext.disposable.d.ts:36

Returns

void

Inherited from

WrappingObj.[dispose]

---

asShape3D()

asShape3D(): Shape3D;

Defined in: packages/replicad/src/shapes.ts:260

Asserts that this shape is a 3D shape (Shell, Solid, CompSolid, or Compound) and returns it typed as Shape3D. Throws if the shape is not 3D.

Useful for chaining after operations that return a generic shape type.

Returns

Shape3D

---

clone()

clone(): this;

Defined in: packages/replicad/src/shapes.ts:193

Returns

this

---

delete()

delete(): void;

Defined in: packages/replicad/src/register.ts:58

Returns

void

Inherited from

WrappingObj.delete

---

isEqual()

isEqual(other): boolean;

Defined in: packages/replicad/src/shapes.ts:213

Parameters

other

AnyShape

Returns

boolean

---

isSame()

isSame(other): boolean;

Defined in: packages/replicad/src/shapes.ts:209

Parameters

other

AnyShape

Returns

boolean

---

serialize()

serialize(): string;

Defined in: packages/replicad/src/shapes.ts:197

Returns

string

---

simplify()

simplify(): this;

Defined in: packages/replicad/src/shapes.ts:270

Simplifies the shape by removing unnecessary edges and faces

Returns

this

Shape Export

blobSTEP()

blobSTEP(): Blob;

Defined in: packages/replicad/src/shapes.ts:491

Exports the current shape as a STEP file as a Blob

Returns

Blob

---

blobSTL()

blobSTL(options?): Blob;

Defined in: packages/replicad/src/shapes.ts:503

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

options?

STLExportOptions = {}

Returns

Blob

---

mesh()

mesh(options?): ShapeMesh;

Defined in: packages/replicad/src/shapes.ts:472

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

Parameters

options?

MeshOptions = {}

Returns

ShapeMesh

---

meshEdges()

meshEdges(options?): ShapeEdgeMesh;

Defined in: packages/replicad/src/shapes.ts:482

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

options?

MeshOptions = {}

Returns

ShapeEdgeMesh

Shape Modifications

split()

split(
   plane?, 
   offset?, 
tolerance?): PlaneSplitResult<Solid | Compound>;

Defined in: packages/replicad/src/shapes.ts:228

Splits the solid parts of this shape with an oriented plane and groups them by side. Non-solid results are ignored.

offset translates the splitting plane along its normal. Each side is null when empty, the resulting shape when it contains one piece, or a Compound when it contains multiple disconnected pieces. Positive is the direction of the plane's normal.

Parameters

plane?

Plane | PlaneName

offset?

number = 0

tolerance?

number = 1e-7

Returns

PlaneSplitResult<Solid | Compound>

Shape Transformations

mirror()

mirror(inputPlane?, origin?): this;

Defined in: packages/replicad/src/shapes.ts:362

Mirrors the shape through a plane

Parameters

inputPlane?

| Point | Plane | PlaneName

origin?

Point

Returns

this

---

rotate()

rotate(
   angle, 
   position?, 
   direction?): this;

Defined in: packages/replicad/src/shapes.ts:343

Rotates the shape

Parameters

angle

number

position?

Point = ...

direction?

Direction = ...

Returns

this

---

scale()

scale(scale, center?): this;

Defined in: packages/replicad/src/shapes.ts:378

Returns a scaled version of the shape

Parameters

scale

number

center?

Point = ...

Returns

this

---

translate()

Call Signature

translate(
   xDist, 
   yDist, 
   zDist): this;

Defined in: packages/replicad/src/shapes.ts:294

Translates the shape of an arbitrary vector

Parameters

xDist

number

yDist

number

zDist

number

Returns

this

Call Signature

translate(vector): this;

Defined in: packages/replicad/src/shapes.ts:295

Translates the shape of an arbitrary vector

Parameters

vector

Point

Returns

this

---

translateX()

translateX(distance): this;

Defined in: packages/replicad/src/shapes.ts:316

Translates the shape on the X axis

Parameters

distance

number

Returns

this

---

translateY()

translateY(distance): this;

Defined in: packages/replicad/src/shapes.ts:325

Translates the shape on the Y axis

Parameters

distance

number

Returns

this

---

translateZ()

translateZ(distance): this;

Defined in: packages/replicad/src/shapes.ts:334

Translates the shape on the Z axis

Parameters

distance

number

Returns

this