Skip to main content

CompoundBlueprint

Implements​

Constructors​

constructor​

• new CompoundBlueprint(blueprints)

Parameters​

NameType
blueprintsBlueprint[]

Defined in​

blueprints/CompoundBlueprint.ts:17

Properties​

blueprints​

• blueprints: Blueprint[]

Defined in​

blueprints/CompoundBlueprint.ts:14

Accessors​

boundingBox​

• get boundingBox(): BoundingBox2d

Returns​

BoundingBox2d

Implementation of​

DrawingInterface.boundingBox

Defined in​

blueprints/CompoundBlueprint.ts:26


repr​

• get repr(): string

Returns​

string

Defined in​

blueprints/CompoundBlueprint.ts:35

Methods​

clone​

▸ clone(): CompoundBlueprint

Returns​

CompoundBlueprint

Implementation of​

DrawingInterface.clone

Defined in​

blueprints/CompoundBlueprint.ts:22


mirror​

▸ mirror(centerOrDirection, origin?, mode?): CompoundBlueprint

Returns the mirror image of this drawing made with a single point (in center mode, the default, or a plane, (plane mode, with both direction and origin of the plane).

Parameters​

NameType
centerOrDirectionPoint2D
origin?Point2D
mode?"center" | "plane"

Returns​

CompoundBlueprint

Implementation of​

DrawingInterface.mirror

Defined in​

blueprints/CompoundBlueprint.ts:76


rotate​

▸ rotate(angle, center?): CompoundBlueprint

Parameters​

NameType
anglenumber
center?Point2D

Returns​

CompoundBlueprint

Implementation of​

DrawingInterface.rotate

Defined in​

blueprints/CompoundBlueprint.ts:55


scale​

▸ scale(scaleFactor, center?): CompoundBlueprint

Parameters​

NameType
scaleFactornumber
center?Point2D

Returns​

CompoundBlueprint

Defined in​

blueprints/CompoundBlueprint.ts:61


sketchOnFace​

▸ sketchOnFace(face, scaleMode?): CompoundSketch

Returns the sketched version of the drawing, on a face.

The scale mode corresponds to the way the coordinates of the drawing are interpreted match with the face:

  • original uses global coordinates (1mm in the drawing is 1mm on the face). This is the default, but currently supported only for planar and circular faces
  • bounds normalises the UV parameters on the face to [0,1] intervals.
  • native uses the default UV parameters of opencascade

Parameters​

NameType
faceFace
scaleMode?ScaleMode

Returns​

CompoundSketch

Implementation of​

DrawingInterface.sketchOnFace

Defined in​

blueprints/CompoundBlueprint.ts:97


sketchOnPlane​

▸ sketchOnPlane(plane?, origin?): CompoundSketch

Returns the sketched version of the drawing, on a plane

Parameters​

NameType
plane?Plane | PlaneName
origin?number | Point

Returns​

CompoundSketch

Implementation of​

DrawingInterface.sketchOnPlane

Defined in​

blueprints/CompoundBlueprint.ts:86


stretch​

▸ stretch(ratio, direction, origin): CompoundBlueprint

Parameters​

NameType
rationumber
directionPoint2D
originPoint2D

Returns​

CompoundBlueprint

Implementation of​

DrawingInterface.stretch

Defined in​

blueprints/CompoundBlueprint.ts:45


toSVG​

▸ toSVG(margin?): string

Formats the drawing as an SVG image

Parameters​

NameTypeDefault value
marginnumber1

Returns​

string

Implementation of​

DrawingInterface.toSVG

Defined in​

blueprints/CompoundBlueprint.ts:117


toSVGGroup​

▸ toSVGGroup(): string

Returns​

string

Defined in​

blueprints/CompoundBlueprint.ts:113


toSVGPaths​

▸ toSVGPaths(): string[]

Formats the drawing as a list of SVG paths

Returns​

string[]

Implementation of​

DrawingInterface.toSVGPaths

Defined in​

blueprints/CompoundBlueprint.ts:109


toSVGViewBox​

▸ toSVGViewBox(margin?): string

Returns the SVG viewbox that corresponds to this drawing

Parameters​

NameTypeDefault value
marginnumber1

Returns​

string

Implementation of​

DrawingInterface.toSVGViewBox

Defined in​

blueprints/CompoundBlueprint.ts:105


translate​

▸ translate(xDist, yDist): CompoundBlueprint

Parameters​

NameType
xDistnumber
yDistnumber

Returns​

CompoundBlueprint

Implementation of​

DrawingInterface.translate

Defined in​

blueprints/CompoundBlueprint.ts:68

▸ translate(translationVector): CompoundBlueprint

Parameters​

NameType
translationVectorPoint2D

Returns​

CompoundBlueprint

Implementation of​

DrawingInterface.translate

Defined in​

blueprints/CompoundBlueprint.ts:69