Skip to main content

CompoundSketch

A group of sketches that should correspond to a unique face (i.e. an outer sketch, and multiple holes within this sketch.

All the sketches should share the same base face (or surface)

Ideally generated from a CompoundBlueprint

Implements​

Constructors​

constructor​

• new CompoundSketch(sketches)

Parameters​

NameType
sketchesSketch[]

Defined in​

sketches/CompoundSketch.ts:119

Properties​

sketches​

• sketches: Sketch[]

Defined in​

sketches/CompoundSketch.ts:118

Accessors​

innerSketches​

• get innerSketches(): Sketch[]

Returns​

Sketch[]

Defined in​

sketches/CompoundSketch.ts:131


outerSketch​

• get outerSketch(): Sketch

Returns​

Sketch

Defined in​

sketches/CompoundSketch.ts:127


wires​

• get wires(): AnyShape

Returns​

AnyShape

Defined in​

sketches/CompoundSketch.ts:135

Methods​

delete​

▸ delete(): void

Returns​

void

Defined in​

sketches/CompoundSketch.ts:123


extrude​

▸ extrude(extrusionDistance, «destructured»?): Shape3D

Extrudes the sketch to a certain distance.(along the default direction and origin of the sketch).

You can define another extrusion direction or origin,

It is also possible to twist extrude with an angle (in degrees), or to give a profile to the extrusion (the endFactor will scale the face, and the profile will define how the scale is applied (either linarly or with a s-shape).

Parameters​

NameType
extrusionDistancenumber
«destructured»Object
› extrusionDirection?Point
› extrusionProfile?ExtrusionProfile
› origin?Point
› twistAngle?number

Returns​

Shape3D

Implementation of​

SketchInterface.extrude

Defined in​

sketches/CompoundSketch.ts:150


face​

▸ face(): Face

Transforms the lines into a face. The lines should be closed.

Returns​

Face

Implementation of​

SketchInterface.face

Defined in​

sketches/CompoundSketch.ts:140


loftWith​

▸ loftWith(otherCompound, loftConfig): Shape3D

Loft between this sketch and another sketch (or an array of them)

You can also define a startPoint for the loft (that will be placed before this sketch) and an endPoint after the last one.

You can also define if you want the loft to result in a ruled surface.

Note that all sketches will be deleted by this operation

Parameters​

NameType
otherCompoundCompoundSketch
loftConfigLoftConfig

Returns​

Shape3D

Implementation of​

SketchInterface.loftWith

Defined in​

sketches/CompoundSketch.ts:218


revolve​

▸ revolve(revolutionAxis?, «destructured»?): Shape3D

Revolves the drawing on an axis (defined by its direction and an origin (defaults to the sketch origin)

Parameters​

NameType
revolutionAxis?Point
«destructured»Object
› origin?Point

Returns​

Shape3D

Implementation of​

SketchInterface.revolve

Defined in​

sketches/CompoundSketch.ts:206