Class: Wire

Defined in: shapes.ts:777

Extends

• _1DShape<TopoDS_Wire>

Constructors

Constructor

new Wire(ocShape): Wire;

Defined in: shapes.ts:248

Parameters

ocShape

TopoDS_Wire

Returns

Wire

Inherited from

_1DShape.constructor

Other

boundingBox

Get Signature

get boundingBox(): BoundingBox;

Defined in: shapes.ts:435

Returns

BoundingBox

Inherited from

_1DShape.boundingBox

---

curve

Get Signature

get curve(): Curve;

Defined in: shapes.ts:648

Returns

Curve

Inherited from

_1DShape.curve

---

edges

Get Signature

get edges(): Edge[];

Defined in: shapes.ts:423

Returns

Edge[]

Inherited from

_1DShape.edges

---

endPoint

Get Signature

get endPoint(): Vector;

Defined in: shapes.ts:656

Returns

Vector

Inherited from

_1DShape.endPoint

---

faces

Get Signature

get faces(): Face[];

Defined in: shapes.ts:427

Returns

Face[]

Inherited from

_1DShape.faces

---

geomType

Get Signature

get geomType(): CurveType;

Defined in: shapes.ts:680

Returns

CurveType

Inherited from

_1DShape.geomType

---

hashCode

Get Signature

get hashCode(): number;

Defined in: shapes.ts:261

Returns

number

Inherited from

_1DShape.hashCode

---

isClosed

Get Signature

get isClosed(): boolean;

Defined in: shapes.ts:668

Returns

boolean

Inherited from

_1DShape.isClosed

---

isNull

Get Signature

get isNull(): boolean;

Defined in: shapes.ts:265

Returns

boolean

Inherited from

_1DShape.isNull

---

isPeriodic

Get Signature

get isPeriodic(): boolean;

Defined in: shapes.ts:672

Returns

boolean

Inherited from

_1DShape.isPeriodic

---

length

Get Signature

get length(): number;

Defined in: shapes.ts:684

Returns

number

Inherited from

_1DShape.length

---

orientation

Get Signature

get orientation(): "forward" | "backward";

Defined in: shapes.ts:693

Returns

"forward" | "backward"

Inherited from

_1DShape.orientation

---

period

Get Signature

get period(): number;

Defined in: shapes.ts:676

Returns

number

Inherited from

_1DShape.period

---

repr

Get Signature

get repr(): string;

Defined in: shapes.ts:640

Returns

string

Inherited from

_1DShape.repr

---

startPoint

Get Signature

get startPoint(): Vector;

Defined in: shapes.ts:652

Returns

Vector

Inherited from

_1DShape.startPoint

---

wires

Get Signature

get wires(): Wire[];

Defined in: shapes.ts:431

Returns

Wire[]

Inherited from

_1DShape.wires

---

wrapped

Get Signature

get wrapped(): Type;

Defined in: register.ts:41

Returns

Type

Set Signature

set wrapped(newWrapped): void;

Defined in: register.ts:46

Parameters

newWrapped

Type

Returns

void

Inherited from

_1DShape.wrapped

---

asShape3D()

asShape3D(): Shape3D;

Defined in: shapes.ts:284

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

Inherited from

_1DShape.asShape3D

---

clone()

clone(): this;

Defined in: shapes.ts:252

Returns

this

Inherited from

_1DShape.clone

---

delete()

delete(): void;

Defined in: register.ts:58

Returns

void

Inherited from

_1DShape.delete

---

flipOrientation()

flipOrientation(): TopoDS_Wire;

Defined in: shapes.ts:699

Returns

TopoDS_Wire

Inherited from

_1DShape.flipOrientation

---

isEqual()

isEqual(other): boolean;

Defined in: shapes.ts:273

Parameters

other

AnyShape

Returns

boolean

Inherited from

_1DShape.isEqual

---

isSame()

isSame(other): boolean;

Defined in: shapes.ts:269

Parameters

other

AnyShape

Returns

boolean

Inherited from

_1DShape.isSame

---

offset2D()

offset2D(offset, kind?): Wire;

Defined in: shapes.ts:782

Parameters

offset

number

kind?

"arc" | "intersection" | "tangent"

Returns

Wire

---

pointAt()

pointAt(position?): Vector;

Defined in: shapes.ts:664

Parameters

position?

number = 0

Returns

Vector

Inherited from

_1DShape.pointAt

---

serialize()

serialize(): string;

Defined in: shapes.ts:256

Returns

string

Inherited from

_1DShape.serialize

---

simplify()

simplify(): this;

Defined in: shapes.ts:294

Simplifies the shape by removing unnecessary edges and faces

Returns

this

Inherited from

_1DShape.simplify

---

tangentAt()

tangentAt(position?): Vector;

Defined in: shapes.ts:660

Parameters

position?

number = 0

Returns

Vector

Inherited from

_1DShape.tangentAt

Shape Export

blobSTEP()

blobSTEP(): Blob;

Defined in: shapes.ts:565

Exports the current shape as a STEP file as a Blob

Returns

Blob

Inherited from

_1DShape.blobSTEP

---

blobSTL()

blobSTL(__namedParameters?): Blob;

Defined in: shapes.ts:606

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

_1DShape.blobSTL

---

mesh()

mesh(__namedParameters?): ShapeMesh;

Defined in: shapes.ts:456

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

_1DShape.mesh

---

meshEdges()

meshEdges(__namedParameters?): object;

Defined in: shapes.ts:519

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

_1DShape.meshEdges

Shape Transformations

mirror()

mirror(inputPlane?, origin?): this;

Defined in: shapes.ts:386

Mirrors the shape through a plane

Parameters

inputPlane?

| Point | Plane | PlaneName

origin?

Point

Returns

this

Inherited from

_1DShape.mirror

---

rotate()

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

Defined in: shapes.ts:367

Rotates the shape

Parameters

angle

number

position?

Point = ...

direction?

Direction = ...

Returns

this

Inherited from

_1DShape.rotate

---

scale()

scale(scale, center?): this;

Defined in: shapes.ts:402

Returns a scaled version of the shape

Parameters

scale

number

center?

Point = ...

Returns

this

Inherited from

_1DShape.scale

---

translate()

Call Signature

translate(
   xDist, 
   yDist, 
   zDist): this;

Defined in: shapes.ts:318

Translates the shape of an arbitrary vector

Parameters

xDist

number

yDist

number

zDist

number

Returns

this

Inherited from

_1DShape.translate

Call Signature

translate(vector): this;

Defined in: shapes.ts:319

Translates the shape of an arbitrary vector

Parameters

vector

Point

Returns

this

Inherited from

_1DShape.translate

---

translateX()

translateX(distance): this;

Defined in: shapes.ts:340

Translates the shape on the X axis

Parameters

distance

number

Returns

this

Inherited from

_1DShape.translateX

---

translateY()

translateY(distance): this;

Defined in: shapes.ts:349

Translates the shape on the Y axis

Parameters

distance

number

Returns

this

Inherited from

_1DShape.translateY

---

translateZ()

translateZ(distance): this;

Defined in: shapes.ts:358

Translates the shape on the Z axis

Parameters

distance

number

Returns

this

Inherited from

_1DShape.translateZ