Class: Drawing
Defined in: draw.ts:50
Implements
Constructors
Constructor
new Drawing(innerShape): Drawing;
Defined in: draw.ts:53
Parameters
innerShape
Shape2D
= null
Returns
Drawing
Drawing Modifications
chamfer()
chamfer(radius, filter?): Drawing;
Defined in: draw.ts:171
Creates a new drawing with some corners filletted, as specified by the radius and the corner finder function
Parameters
radius
number
filter?
(c
) => CornerFinder
Returns
Drawing
cut()
cut(other): Drawing;
Defined in: draw.ts:132
Builds a new drawing by cuting another drawing into this one
Parameters
other
Drawing
Returns
Drawing
fillet()
fillet(radius, filter?): Drawing;
Defined in: draw.ts:160
Creates a new drawing with some corners filletted, as specified by the radius and the corner finder function
Parameters
radius
number
filter?
(c
) => CornerFinder
Returns
Drawing
fuse()
fuse(other): Drawing;
Defined in: draw.ts:141
Builds a new drawing by merging another drawing into this one
Parameters
other
Drawing
Returns
Drawing
intersect()
intersect(other): Drawing;
Defined in: draw.ts:150
Builds a new drawing by intersection this drawing with another
Parameters
other
Drawing
Returns
Drawing
Other
blueprint
Get Signature
get blueprint(): Blueprint;
Defined in: draw.ts:220
Returns
boundingBox
Get Signature
get boundingBox(): BoundingBox2d;
Defined in: draw.ts:87
Returns
Implementation of
repr
Get Signature
get repr(): string;
Defined in: draw.ts:96
Returns
string
approximate()
approximate(target, options): Drawing;
Defined in: draw.ts:210
Parameters
target
"svg"
| "arcs"
options
ApproximationOptions
= {}
Returns
Drawing
clone()
clone(): Drawing;
Defined in: draw.ts:57
Returns
Drawing
Implementation of
mirror()
mirror(
centerOrDirection,
origin?,
mode?): Drawing;
Defined in: draw.ts:118
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
centerOrDirection
origin?
mode?
"center"
| "plane"
Returns
Drawing
Implementation of
offset()
offset(distance, offsetConfig): Drawing;
Defined in: draw.ts:206
Parameters
distance
number
offsetConfig
Offset2DConfig
= {}
Returns
Drawing
rotate()
rotate(angle, center?): Drawing;
Defined in: draw.ts:101
Parameters
angle
number
center?
Returns
Drawing
Implementation of
scale()
scale(scaleFactor, center?): Drawing;
Defined in: draw.ts:113
Parameters
scaleFactor
number
center?
Returns
Drawing
serialize()
serialize(): string;
Defined in: draw.ts:61
Returns
string
sketchOnFace()
sketchOnFace(face, scaleMode):
| SketchInterface
| Sketches;
Defined in: draw.ts:189
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 facesbounds
normalises the UV parameters on the face to [0,1] intervals.native
uses the default UV parameters of opencascade
Parameters
face
scaleMode
Returns
Implementation of
sketchOnPlane()
Call Signature
sketchOnPlane(inputPlane):
| SketchInterface
| Sketches;
Defined in: draw.ts:176
Returns the sketched version of the drawing, on a plane
Parameters
inputPlane
Returns
Implementation of
DrawingInterface
.sketchOnPlane
Call Signature
sketchOnPlane(inputPlane?, origin?):
| SketchInterface
| Sketches;
Defined in: draw.ts:177
Parameters
inputPlane?
origin?
number
| Point
Returns
Implementation of
DrawingInterface
.sketchOnPlane
stretch()
stretch(
ratio,
direction,
origin): Drawing;
Defined in: draw.ts:91
Parameters
ratio
number
direction
origin
Returns
Drawing
Implementation of
toSVG()
toSVG(margin?): string;
Defined in: draw.ts:194
Formats the drawing as an SVG image
Parameters
margin?
number
Returns
string
Implementation of
toSVGPaths()
toSVGPaths(): string[] | string[][];
Defined in: draw.ts:202
Formats the drawing as a list of SVG paths
Returns
string
[] | string
[][]
Implementation of
toSVGViewBox()
toSVGViewBox(margin): string;
Defined in: draw.ts:198
Returns the SVG viewbox that corresponds to this drawing
Parameters
margin
number
= 1
Returns
string
Implementation of
translate()
Call Signature
translate(xDist, yDist): Drawing;
Defined in: draw.ts:106
Parameters
xDist
number
yDist
number
Returns
Drawing
Implementation of
Call Signature
translate(translationVector): Drawing;
Defined in: draw.ts:107
Parameters
translationVector
Returns
Drawing