Class: abstract _1DShape<Type>

Defined in: shapes.ts:667

Extends

• Shape<Type>

Extended by

• Edge
• Wire

Type Parameters

Type

Type extends TopoDS_Shape

Constructors

Constructor

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

Defined in: shapes.ts:230

Parameters

ocShape

Type

Returns

_1DShape<Type>

Inherited from

Shape.constructor

Other

boundingBox

Get Signature

get boundingBox(): BoundingBox;

Defined in: shapes.ts:417

Returns

BoundingBox

Inherited from

Shape.boundingBox

---

curve

Get Signature

get curve(): Curve;

Defined in: shapes.ts:677

Returns

Curve

---

edges

Get Signature

get edges(): Edge[];

Defined in: shapes.ts:405

Returns

Edge[]

Inherited from

Shape.edges

---

endPoint

Get Signature

get endPoint(): Vector;

Defined in: shapes.ts:685

Returns

Vector

---

faces

Get Signature

get faces(): Face[];

Defined in: shapes.ts:409

Returns

Face[]

Inherited from

Shape.faces

---

geomType

Get Signature

get geomType(): CurveType;

Defined in: shapes.ts:709

Returns

CurveType

---

hashCode

Get Signature

get hashCode(): number;

Defined in: shapes.ts:243

Returns

number

Inherited from

Shape.hashCode

---

isClosed

Get Signature

get isClosed(): boolean;

Defined in: shapes.ts:697

Returns

boolean

---

isNull

Get Signature

get isNull(): boolean;

Defined in: shapes.ts:247

Returns

boolean

Inherited from

Shape.isNull

---

isPeriodic

Get Signature

get isPeriodic(): boolean;

Defined in: shapes.ts:701

Returns

boolean

---

length

Get Signature

get length(): number;

Defined in: shapes.ts:713

Returns

number

---

orientation

Get Signature

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

Defined in: shapes.ts:722

Returns

"forward" | "backward"

---

period

Get Signature

get period(): number;

Defined in: shapes.ts:705

Returns

number

---

repr

Get Signature

get repr(): string;

Defined in: shapes.ts:669

Returns

string

---

startPoint

Get Signature

get startPoint(): Vector;

Defined in: shapes.ts:681

Returns

Vector

---

wires

Get Signature

get wires(): Wire[];

Defined in: shapes.ts:413

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

---

asShape3D()

asShape3D(): Shape3D;

Defined in: shapes.ts:266

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

Shape.asShape3D

---

clone()

clone(): this;

Defined in: shapes.ts:234

Returns

this

Inherited from

Shape.clone

---

delete()

delete(): void;

Defined in: register.ts:54

Returns

void

Inherited from

Shape.delete

---

flipOrientation()

flipOrientation(): Type;

Defined in: shapes.ts:728

Returns

Type

---

isEqual()

isEqual(other): boolean;

Defined in: shapes.ts:255

Parameters

other

AnyShape

Returns

boolean

Inherited from

Shape.isEqual

---

isSame()

isSame(other): boolean;

Defined in: shapes.ts:251

Parameters

other

AnyShape

Returns

boolean

Inherited from

Shape.isSame

---

pointAt()

pointAt(position): Vector;

Defined in: shapes.ts:693

Parameters

position

number = 0

Returns

Vector

---

serialize()

serialize(): string;

Defined in: shapes.ts:238

Returns

string

Inherited from

Shape.serialize

---

simplify()

simplify(): this;

Defined in: shapes.ts:276

Simplifies the shape by removing unnecessary edges and faces

Returns

this

Inherited from

Shape.simplify

---

tangentAt()

tangentAt(position): Vector;

Defined in: shapes.ts:689

Parameters

position

number = 0

Returns

Vector

Shape Export

blobSTEP()

blobSTEP(): Blob;

Defined in: shapes.ts:593

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:635

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:439

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:476

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 Transformations

mirror()

mirror(inputPlane?, origin?): this;

Defined in: shapes.ts:368

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:349

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:384

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:300

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:301

Translates the shape of an arbitrary vector

Parameters

vector

Point

Returns

this

Inherited from

Shape.translate

---

translateX()

translateX(distance): this;

Defined in: shapes.ts:322

Translates the shape on the X axis

Parameters

distance

number

Returns

this

Inherited from

Shape.translateX

---

translateY()

translateY(distance): this;

Defined in: shapes.ts:331

Translates the shape on the Y axis

Parameters

distance

number

Returns

this

Inherited from

Shape.translateY

---

translateZ()

translateZ(distance): this;

Defined in: shapes.ts:340

Translates the shape on the Z axis

Parameters

distance

number

Returns

this

Inherited from

Shape.translateZ