Skip to main content

Shape<Type>

Type parameters

NameType
Typeextends TopoDS_Shape

Hierarchy

Constructors

constructor

new Shape<Type>(ocShape)

Type parameters

NameType
Typeextends TopoDS_Shape

Parameters

NameType
ocShapeType

Overrides

WrappingObj.constructor

Defined in

shapes.ts:151

Accessors

boundingBox

get boundingBox(): BoundingBox

Returns

BoundingBox

Defined in

shapes.ts:309


edges

get edges(): Edge[]

Returns

Edge[]

Defined in

shapes.ts:297


faces

get faces(): Face[]

Returns

Face[]

Defined in

shapes.ts:301


hashCode

get hashCode(): number

Returns

number

Defined in

shapes.ts:159


isNull

get isNull(): boolean

Returns

boolean

Defined in

shapes.ts:163


wires

get wires(): Wire[]

Returns

Wire[]

Defined in

shapes.ts:305


wrapped

get wrapped(): Type

Returns

Type

Inherited from

WrappingObj.wrapped

Defined in

register.ts:39

set wrapped(newWrapped): void

Parameters

NameType
newWrappedType

Returns

void

Inherited from

WrappingObj.wrapped

Defined in

register.ts:44

Other Methods

clone

clone(): Shape<Type>

Returns

Shape<Type>

Defined in

shapes.ts:155


delete

delete(): void

Returns

void

Inherited from

WrappingObj.delete

Defined in

register.ts:54


isEqual

isEqual(other): boolean

Parameters

NameType
otherAnyShape

Returns

boolean

Defined in

shapes.ts:171


isSame

isSame(other): boolean

Parameters

NameType
otherAnyShape

Returns

boolean

Defined in

shapes.ts:167


simplify

simplify(): Shape<Type>

Simplifies the shape by removing unnecessary edges and faces

Returns

Shape<Type>

Defined in

shapes.ts:178


Shape Export Methods

blobSTEP

blobSTEP(): Blob

Exports the current shape as a STEP file as a Blob

Returns

Blob

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

NameType
«destructured»Object
› angularToleranceundefined | number
› toleranceundefined | number

Returns

Blob

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

NameType
«destructured»Object
› angularToleranceundefined | number
› toleranceundefined | number

Returns

ShapeMesh

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

NameType
«destructured»Object
› angularToleranceundefined | number
› toleranceundefined | number

Returns

Object

NameType
edgeGroups{ count: number ; edgeId: number ; start: number }[]
linesnumber[]

Defined in

shapes.ts:368


Shape Transformations Methods

mirror

mirror(inputPlane, origin): Shape<Type>

Mirrors the shape through a plane

Parameters

NameType
inputPlanePoint | Plane | PlaneName
originPoint

Returns

Shape<Type>

Defined in

shapes.ts:264


rotate

rotate(angle, position?, direction?): Shape<Type>

Rotates the shape

Parameters

NameType
anglenumber
positionPoint
directionPoint

Returns

Shape<Type>

Defined in

shapes.ts:247


scale

scale(scale, center?): Shape<Type>

Returns a scaled version of the shape

Parameters

NameType
scalenumber
centerPoint

Returns

Shape<Type>

Defined in

shapes.ts:278


translate

translate(xDist, yDist, zDist): Shape<Type>

Translates the shape of an arbitrary vector

Parameters

NameType
xDistnumber
yDistnumber
zDistnumber

Returns

Shape<Type>

Defined in

shapes.ts:200

translate(vector): Shape<Type>

Parameters

NameType
vectorPoint

Returns

Shape<Type>

Defined in

shapes.ts:201


translateX

translateX(distance): Shape<Type>

Translates the shape on the X axis

Parameters

NameType
distancenumber

Returns

Shape<Type>

Defined in

shapes.ts:220


translateY

translateY(distance): Shape<Type>

Translates the shape on the Y axis

Parameters

NameType
distancenumber

Returns

Shape<Type>

Defined in

shapes.ts:229


translateZ

translateZ(distance): Shape<Type>

Translates the shape on the Z axis

Parameters

NameType
distancenumber

Returns

Shape<Type>

Defined in

shapes.ts:238