Class Drawing

Immutable wrapper around a 2D shape (Blueprint, CompoundBlueprint, or Blueprints).

A Drawing can be transformed (translate, rotate, scale, mirror), combined with Boolean operations (cut, fuse, intersect), filleted/chamfered, serialized, and ultimately projected onto a 3D plane via sketchOnPlane.

Example

const profile = drawRectangle(40, 20)
  .fillet(3)
  .cut(drawCircle(5).translate(10, 0));
const sketch = profile.sketchOnPlane("XY");

Index

Drawing Modifications

chamfer cut fillet fuse intersect

Other

constructor blueprint boundingBox repr approximate clone mirror offset punchHole rotate scale serialize sketchOnFace sketchOnPlane stretch toSVG toSVGPaths toSVGViewBox translate

Drawing Modifications

chamfer

chamfer(radius: number, filter?: (c: CornerFinderFn) => CornerFinderFn): Drawing
Creates a new drawing with some corners chamfered, as specified by the radius and the corner finder function
Parameters
- radius: number
- Optionalfilter: (c: CornerFinderFn) => CornerFinderFn
Returns Drawing
- Defined in src/sketching/draw.ts:229

cut

cut(other: Drawing): Drawing
Builds a new drawing by cutting another drawing into this one
Parameters
- other: Drawing
Returns Drawing
- Defined in src/sketching/draw.ts:190

fillet

fillet(radius: number, filter?: (c: CornerFinderFn) => CornerFinderFn): Drawing
Creates a new drawing with some corners filleted, as specified by the radius and the corner finder function
Parameters
- radius: number
- Optionalfilter: (c: CornerFinderFn) => CornerFinderFn
Returns Drawing
- Defined in src/sketching/draw.ts:218

fuse

fuse(other: Drawing): Drawing
Builds a new drawing by merging another drawing into this one
Parameters
- other: Drawing
Returns Drawing
- Defined in src/sketching/draw.ts:199

intersect

intersect(other: Drawing): Drawing
Builds a new drawing by intersection this drawing with another
Parameters
- other: Drawing
Returns Drawing
- Defined in src/sketching/draw.ts:208

Other

constructor

new Drawing(innerShape?: Shape2D): Drawing
Parameters
- innerShape: Shape2D = null
Returns Drawing
- Defined in src/sketching/draw.ts:98

blueprint

get blueprint(): Blueprint
Access the underlying Blueprint, throwing if the drawing is compound.

Returns Blueprint
- Defined in src/sketching/draw.ts:297

boundingBox

get boundingBox(): BoundingBox2d
Get the axis-aligned 2D bounding box of this drawing.

Returns BoundingBox2d
- Defined in src/sketching/draw.ts:140

repr

get repr(): string
Return a human-readable string representation of the drawing.

Returns string
- Defined in src/sketching/draw.ts:152

approximate

approximate(target: "svg" | "arcs", options?: ApproximationOptions): Drawing
Approximate the drawing curves for a target format (currently only 'svg').
Parameters
- target: "svg" | "arcs"
- options: ApproximationOptions = {}
Returns Drawing
- Defined in src/sketching/draw.ts:289

clone

clone(): Drawing
Create an independent deep copy of this drawing.

Returns Drawing
- Defined in src/sketching/draw.ts:103

mirror

mirror(
    centerOrDirection: Point2D,
    origin?: Point2D,
    mode?: "center" | "plane",
): Drawing
Mirror the drawing about a point or a line defined by direction and origin.
Parameters
- centerOrDirection: Point2D
- Optionalorigin: Point2D
- Optionalmode: "center" | "plane"
Returns Drawing
- Defined in src/sketching/draw.ts:180

offset

offset(distance: number, offsetConfig?: Offset2DConfig): Drawing
Offset the drawing contour by a signed distance (positive = outward).
Parameters
- distance: number
- offsetConfig: Offset2DConfig = {}
Returns Drawing
- Defined in src/sketching/draw.ts:284

punchHole

punchHole(
    shape: AnyShape,
    faceFinder: SingleFace,
    options?: { draftAngle?: number; height?: number; origin?: PointInput },
): AnyShape
Punch the drawing's profile as a hole through a 3D shape on the given face.
Parameters
- shape: AnyShape
- faceFinder: SingleFace
- options: { draftAngle?: number; height?: number; origin?: PointInput } = {}
Returns AnyShape
- Defined in src/sketching/draw.ts:255

rotate

rotate(angle: number, center?: Point2D): Drawing
Rotate the drawing by an angle (in degrees) around an optional center point.
Parameters
- angle: number
- Optionalcenter: Point2D
Returns Drawing
- Defined in src/sketching/draw.ts:158

scale

scale(scaleFactor: number, center?: Point2D): Drawing
Uniformly scale the drawing by a factor around an optional center point.
Parameters
- scaleFactor: number
- Optionalcenter: Point2D
Returns Drawing
- Defined in src/sketching/draw.ts:174

serialize

serialize(): string
Serialize the drawing to a JSON string for persistence or transfer.

Returns string
- Defined in src/sketching/draw.ts:108

sketchOnFace

sketchOnFace(face: Face, scaleMode: ScaleMode): SketchInterface | Sketches
Project this drawing onto a 3D face surface with the given scale mode.
Parameters
- face: Face
- scaleMode: ScaleMode
Returns SketchInterface | Sketches
- Defined in src/sketching/draw.ts:248

sketchOnPlane

sketchOnPlane(inputPlane: Plane): SketchInterface | Sketches
Project this drawing onto a 3D plane, producing a Sketch or Sketches.
Parameters
- inputPlane: Plane
Returns SketchInterface | Sketches
- Defined in src/sketching/draw.ts:235
sketchOnPlane(
inputPlane?: PlaneName,
origin?: number | PointInput,
): SketchInterface | Sketches
Project this drawing onto a named plane at an optional origin.
Parameters
- OptionalinputPlane: PlaneName
- Optionalorigin: number | PointInput
Returns SketchInterface | Sketches
- Defined in src/sketching/draw.ts:237

stretch

stretch(ratio: number, direction: Point2D, origin: Point2D): Drawing
Stretch the drawing by a ratio along a direction from an origin point.
Parameters
- ratio: number
- direction: Point2D
- origin: Point2D
Returns Drawing
- Defined in src/sketching/draw.ts:146

toSVG

toSVG(margin?: number): string
Export the drawing as a complete SVG string.
Parameters
- Optionalmargin: number
Returns string
- Defined in src/sketching/draw.ts:269

toSVGPaths

toSVGPaths(): string[] | string[][]
Return the SVG <path> d attribute strings for this drawing.

Returns string[] | string[][]
- Defined in src/sketching/draw.ts:279

toSVGViewBox

toSVGViewBox(margin?: number): string
Return the SVG viewBox attribute string for this drawing.
Parameters
- margin: number = 1
Returns string
- Defined in src/sketching/draw.ts:274

translate

translate(xDist: number, yDist: number): Drawing
Translate the drawing by horizontal and vertical distances.
Parameters
- xDist: number
- yDist: number
Returns Drawing
- Defined in src/sketching/draw.ts:164
translate(translationVector: Point2D): Drawing
Translate the drawing by a 2D vector.
Parameters
- translationVector: Point2D
Returns Drawing
- Defined in src/sketching/draw.ts:166

Class Drawing

Example

Index

Drawing Modifications

Other

Drawing Modifications

chamfer

Parameters

Returns Drawing

cut

Parameters

Returns Drawing

fillet

Parameters

Returns Drawing

fuse

Parameters

Returns Drawing

intersect

Parameters

Returns Drawing

Other

constructor

Parameters

Returns Drawing

blueprint

Returns Blueprint

boundingBox

Returns BoundingBox2d

repr

Returns string

approximate

Parameters

Returns Drawing

clone

Returns Drawing

mirror

Parameters

Returns Drawing

offset

Parameters

Returns Drawing

punchHole

Parameters

Returns AnyShape

rotate

Parameters

Returns Drawing

scale

Parameters

Returns Drawing

serialize

Returns string

sketchOnFace

Parameters

Returns SketchInterface | Sketches

sketchOnPlane

Parameters

Returns SketchInterface | Sketches

Parameters

Returns SketchInterface | Sketches

stretch

Parameters

Returns Drawing

toSVG

Parameters

Returns string

toSVGPaths

Returns string[] | string[][]

toSVGViewBox

Parameters

Returns string

translate

Parameters

Returns Drawing

Parameters

Returns Drawing

Settings

On This Page