Wire

Hierarchy

• _1DShape<TopoDS_Wire>

  ↳ Wire

Constructors

constructor

• new Wire(ocShape)

Parameters

Name	Type
ocShape	TopoDS_Wire

Inherited from

_1DShape.constructor

Defined in

shapes.ts:151

Accessors

boundingBox

• get boundingBox(): BoundingBox

Returns

BoundingBox

Inherited from

_1DShape.boundingBox

Defined in

shapes.ts:309

---

curve

• get curve(): Curve

Returns

Curve

Inherited from

_1DShape.curve

Defined in

shapes.ts:562

---

edges

• get edges(): Edge[]

Returns

Edge[]

Inherited from

_1DShape.edges

Defined in

shapes.ts:297

---

endPoint

• get endPoint(): Vector

Returns

Vector

Inherited from

_1DShape.endPoint

Defined in

shapes.ts:573

---

faces

• get faces(): Face[]

Returns

Face[]

Inherited from

_1DShape.faces

Defined in

shapes.ts:301

---

geomType

• get geomType(): CurveType

Returns

CurveType

Inherited from

_1DShape.geomType

Defined in

shapes.ts:609

---

hashCode

• get hashCode(): number

Returns

number

Inherited from

_1DShape.hashCode

Defined in

shapes.ts:159

---

isClosed

• get isClosed(): boolean

Returns

boolean

Inherited from

_1DShape.isClosed

Defined in

shapes.ts:587

---

isNull

• get isNull(): boolean

Returns

boolean

Inherited from

_1DShape.isNull

Defined in

shapes.ts:163

---

isPeriodic

• get isPeriodic(): boolean

Returns

boolean

Inherited from

_1DShape.isPeriodic

Defined in

shapes.ts:595

---

length

• get length(): number

Returns

number

Inherited from

_1DShape.length

Defined in

shapes.ts:616

---

orientation

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

Returns

"forward" | "backward"

Inherited from

_1DShape.orientation

Defined in

shapes.ts:625

---

period

• get period(): number

Returns

number

Inherited from

_1DShape.period

Defined in

shapes.ts:602

---

repr

• get repr(): string

Returns

string

Inherited from

_1DShape.repr

Defined in

shapes.ts:554

---

startPoint

• get startPoint(): Vector

Returns

Vector

Inherited from

_1DShape.startPoint

Defined in

shapes.ts:566

---

wires

• get wires(): Wire[]

Returns

Wire[]

Inherited from

_1DShape.wires

Defined in

shapes.ts:305

---

wrapped

• get wrapped(): Type

Returns

Type

Inherited from

_1DShape.wrapped

Defined in

register.ts:39

• set wrapped(newWrapped): void

Parameters

Name	Type
newWrapped	Type

Returns

void

Inherited from

_1DShape.wrapped

Defined in

register.ts:44

Other Methods

clone

▸ clone(): Wire

Returns

Wire

Inherited from

_1DShape.clone

Defined in

shapes.ts:155

---

delete

▸ delete(): void

Returns

void

Inherited from

_1DShape.delete

Defined in

register.ts:54

---

isEqual

▸ isEqual(other): boolean

Parameters

Name	Type
other	AnyShape

Returns

boolean

Inherited from

_1DShape.isEqual

Defined in

shapes.ts:171

---

isSame

▸ isSame(other): boolean

Parameters

Name	Type
other	AnyShape

Returns

boolean

Inherited from

_1DShape.isSame

Defined in

shapes.ts:167

---

offset2D

▸ offset2D(offset, kind?): Wire

Parameters

Name	Type	Default value
offset	number	undefined
kind	"arc" | "intersection" | "tangent"	"arc"

Returns

Wire

Defined in

shapes.ts:701

---

simplify

▸ simplify(): Wire

Simplifies the shape by removing unnecessary edges and faces

Returns

Wire

Inherited from

_1DShape.simplify

Defined in

shapes.ts:178

---

tangentAt

▸ tangentAt(position?): Vector

Parameters

Name	Type	Default value
position	number	0

Returns

Vector

Inherited from

_1DShape.tangentAt

Defined in

shapes.ts:580

---

Shape Export Methods

blobSTEP

▸ blobSTEP(): Blob

Exports the current shape as a STEP file as a Blob

Returns

Blob

Inherited from

_1DShape.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
› tolerance	undefined | number

Returns

Blob

Inherited from

_1DShape.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

_1DShape.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

_1DShape.meshEdges

Defined in

shapes.ts:368

---

Shape Transformations Methods

mirror

▸ mirror(inputPlane, origin): Wire

Mirrors the shape through a plane

Parameters

Name	Type
inputPlane	Point | Plane | PlaneName
origin	Point

Returns

Wire

Inherited from

_1DShape.mirror

Defined in

shapes.ts:264

---

rotate

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

Rotates the shape

Parameters

Name	Type
angle	number
position	Point
direction	Point

Returns

Wire

Inherited from

_1DShape.rotate

Defined in

shapes.ts:247

---

scale

▸ scale(scale, center?): Wire

Returns a scaled version of the shape

Parameters

Name	Type
scale	number
center	Point

Returns

Wire

Inherited from

_1DShape.scale

Defined in

shapes.ts:278

---

translate

▸ translate(xDist, yDist, zDist): Wire

Translates the shape of an arbitrary vector

Parameters

Name	Type
xDist	number
yDist	number
zDist	number

Returns

Wire

Inherited from

_1DShape.translate

Defined in

shapes.ts:200

▸ translate(vector): Wire

Parameters

Name	Type
vector	Point

Returns

Wire

Inherited from

_1DShape.translate

Defined in

shapes.ts:201

---

translateX

▸ translateX(distance): Wire

Translates the shape on the X axis

Parameters

Name	Type
distance	number

Returns

Wire

Inherited from

_1DShape.translateX

Defined in

shapes.ts:220

---

translateY

▸ translateY(distance): Wire

Translates the shape on the Y axis

Parameters

Name	Type
distance	number

Returns

Wire

Inherited from

_1DShape.translateY

Defined in

shapes.ts:229

---

translateZ

▸ translateZ(distance): Wire

Translates the shape on the Z axis

Parameters

Name	Type
distance	number

Returns

Wire

Inherited from

_1DShape.translateZ

Defined in

shapes.ts:238