Class Blueprint

Represent a closed or open 2D profile as an ordered list of curves.

A Blueprint is the fundamental 2D drawing primitive: it stores an ordered sequence of Curve2D segments that together describe a planar profile. Blueprints can be transformed (translate, rotate, scale, mirror, stretch), projected onto 3D planes or faces, combined with boolean operations, and serialized to SVG.

Create instances via BlueprintSketcher rather than calling the constructor directly.

Example

const bp = new BlueprintSketcher()
  .movePointerTo([0, 0])
  .lineTo([10, 0])
  .lineTo([10, 10])
  .lineTo([0, 10])
  .close();

// sketchOnPlane returns SketchData (wire + metadata), not a Face
const sketch = bp.sketchOnPlane("XY");

See

CompoundBlueprint for blueprints with holes.
Blueprints for collections of disjoint blueprints.
createBlueprint for the functional API equivalent.

Implements

DrawingInterface

Index

Constructors

constructor

new Blueprint(curves: Curve2D[]): Blueprint
Create a blueprint from an ordered array of 2D curves.
Parameters
- curves: Curve2D[]
Returns Blueprint
Throws
Error if the curves array is empty.
- Defined in src/2d/blueprints/Blueprint.ts:93

Properties

`Protected`_boundingBox

_boundingBox: BoundingBox2d | null

curves

curves: Curve2D[]

Ordered 2D curve segments that compose this blueprint.

Accessors

boundingBox

get boundingBox(): BoundingBox2d
Compute (and cache) the axis-aligned bounding box of all curves.

Returns BoundingBox2d
Implementation of DrawingInterface.boundingBox
- Defined in src/2d/blueprints/Blueprint.ts:123

firstPoint

get firstPoint(): Point2D
Get the start point of the first curve.

Returns Point2D
- Defined in src/2d/blueprints/Blueprint.ts:382

lastPoint

get lastPoint(): Point2D
Get the end point of the last curve.

Returns Point2D
- Defined in src/2d/blueprints/Blueprint.ts:388

orientation

get orientation(): "clockwise" | "counterClockwise"
Determine the winding direction of the blueprint via the shoelace formula.

Returns "clockwise" | "counterClockwise"
Remarks
Uses an approximation based on curve midpoints for non-linear segments. The result is cached after the first call.
- Defined in src/2d/blueprints/Blueprint.ts:135

repr

get repr(): string
Return a multi-line string representation for debugging.

Returns string
- Defined in src/2d/blueprints/Blueprint.ts:118

Methods

clone

clone(): Blueprint
Return a deep copy of this blueprint.

Returns Blueprint
Implementation of DrawingInterface.clone
- Defined in src/2d/blueprints/Blueprint.ts:113

delete

delete(): void
Release WASM resources held by the underlying curves and bounding box.

Returns void
- Defined in src/2d/blueprints/Blueprint.ts:105

intersects

intersects(other: Blueprint): boolean
Test whether this blueprint's curves intersect with another blueprint's curves.
Parameters
- other: Blueprint
Returns boolean
Remarks
Uses bounding-box pre-filtering for early rejection.
- Defined in src/2d/blueprints/Blueprint.ts:437

isClosed

isClosed(): boolean
Check whether the first and last points coincide (the profile is closed).

Returns boolean
- Defined in src/2d/blueprints/Blueprint.ts:428

isInside

isInside(point: Point2D): boolean
Test whether a 2D point lies inside this closed blueprint.

Uses ray-casting (intersection counting) against a segment from the point to a location guaranteed to be outside the bounding box.
Parameters
- point: Point2D
Returns boolean
true if the point is strictly inside the blueprint.

Remarks
Returns false for points on the boundary.
- Defined in src/2d/blueprints/Blueprint.ts:402

mirror

mirror(
    centerOrDirection: Point2D,
    origin?: Point2D,
    mode?: "center" | "plane",
): Blueprint
Mirror the blueprint across a point or plane.
Parameters
- centerOrDirection: Point2D
  Mirror center (center mode) or plane normal (plane mode).
- origin: Point2D = ...
  Origin for plane-mode mirroring.
- mode: "center" | "plane" = 'center'
  'center' for point symmetry, 'plane' for reflection across an axis.
Returns Blueprint
A new mirrored Blueprint.
Implementation of DrawingInterface.mirror
- Defined in src/2d/blueprints/Blueprint.ts:221

punchHole

punchHole(
    shape: AnyShape,
    face: SingleFace,
    options?: {
        draftAngle?: number;
        height?: number | null;
        origin?: PointInput | null;
    },
): AnyShape
Cut a prism-shaped hole through a solid along a face using this blueprint.
Parameters
- shape: AnyShape
  The solid to punch through.
- face: SingleFace
  The face on which the hole profile is placed.
- options: { draftAngle?: number; height?: number | null; origin?: PointInput | null } = {}
  Optional hole parameters.
  - OptionaldraftAngle?: number
    Taper angle in degrees (0 = straight hole).
  - Optionalheight?: number | null
    Hole depth; null (default) cuts through the entire solid.
  - Optionalorigin?: PointInput | null
    UV origin on the face for the blueprint placement.
Returns AnyShape
The modified shape with the hole removed.
- Defined in src/2d/blueprints/Blueprint.ts:300

rotate

rotate(angle: number, center?: Point2D): Blueprint
Rotate the blueprint by an angle in degrees.
Parameters
- angle: number
  Rotation angle in degrees (positive = counter-clockwise).
- Optionalcenter: Point2D
  Center of rotation (defaults to the origin).
Returns Blueprint
A new rotated Blueprint.
Implementation of DrawingInterface.rotate
- Defined in src/2d/blueprints/Blueprint.ts:193

scale

scale(scaleFactor: number, center?: Point2D): Blueprint
Uniformly scale the blueprint around a center point.
Parameters
- scaleFactor: number
  Scale multiplier (>1 enlarges, <1 shrinks).
- Optionalcenter: Point2D
  Center of scaling (defaults to the bounding box center).
Returns Blueprint
A new scaled Blueprint.
- Defined in src/2d/blueprints/Blueprint.ts:180

sketchOnFace

sketchOnFace(face: Face, scaleMode?: ScaleMode): SketchData
Map this 2D blueprint onto a 3D face's UV surface.
Parameters
- face: Face
  Target face to project onto.
- OptionalscaleMode: ScaleMode
  How UV coordinates are interpreted ('original', 'bounds', or 'native').
Returns SketchData
Sketch data containing the wire mapped onto the face.
Implementation of DrawingInterface.sketchOnFace
- Defined in src/2d/blueprints/Blueprint.ts:260

sketchOnPlane

sketchOnPlane(
inputPlane?: Plane | PlaneName,
origin?: number | PointInput,
): SketchData
Project this 2D blueprint onto a 3D plane, producing a wire and metadata.
Parameters
- OptionalinputPlane: Plane | PlaneName
  Named plane ("XY", "XZ", etc.) or a custom Plane.
- Optionalorigin: number | PointInput
  Origin offset; a number sets the offset along the plane normal.
Returns SketchData
Sketch data containing the projected wire and default orientation.
Implementation of DrawingInterface.sketchOnPlane
- Defined in src/2d/blueprints/Blueprint.ts:237

stretch

stretch(ratio: number, direction: Point2D, origin?: Point2D): Blueprint
Stretch the blueprint along a direction by a given ratio.
Parameters
- ratio: number
  Stretch factor (1 = unchanged).
- direction: Point2D
  Unit direction vector to stretch along.
- origin: Point2D = ...
  Fixed point of the stretch (defaults to the origin).
Returns Blueprint
A new stretched Blueprint.
Implementation of DrawingInterface.stretch
- Defined in src/2d/blueprints/Blueprint.ts:168

subFace

subFace(face: Face, origin?: PointInput | null): Face
Create a face on a target face's surface defined by this blueprint's profile.
Parameters
- face: Face
  The face whose surface the sub-face lies on.
- Optionalorigin: PointInput | null
  Optional UV origin offset (defaults to the face center).
Returns Face
A new Face bounded by the blueprint's profile.
- Defined in src/2d/blueprints/Blueprint.ts:282

toSVG

toSVG(margin?: number): string
Render a complete SVG document string for this blueprint.
Parameters
- margin: number = 1
  Extra padding around the bounding box in drawing units.
Returns string
Implementation of DrawingInterface.toSVG
- Defined in src/2d/blueprints/Blueprint.ts:377

toSVGPath

toSVGPath(): string
Wrap the SVG path data in a <path> element string.

Returns string
- Defined in src/2d/blueprints/Blueprint.ts:354

toSVGPathD

toSVGPathD(): string
Convert the blueprint to an SVG path d attribute string.

Returns string
- Defined in src/2d/blueprints/Blueprint.ts:338

toSVGPaths

toSVGPaths(): string[]
Return the SVG path d strings for this blueprint as an array.

Returns string[]
Implementation of DrawingInterface.toSVGPaths
- Defined in src/2d/blueprints/Blueprint.ts:368

toSVGViewBox

toSVGViewBox(margin?: number): string
Compute the SVG viewBox attribute for this blueprint.
Parameters
- margin: number = 1
  Extra padding around the bounding box in drawing units.
Returns string
Implementation of DrawingInterface.toSVGViewBox
- Defined in src/2d/blueprints/Blueprint.ts:363

translate

translate(xDist: number, yDist: number): Blueprint
Translate the blueprint by separate x/y distances or a vector.
Parameters
- xDist: number
- yDist: number
Returns Blueprint
A new translated Blueprint.
Implementation of DrawingInterface.translate
- Defined in src/2d/blueprints/Blueprint.ts:203
translate(translationVector: Point2D): Blueprint
Translate the blueprint by separate x/y distances or a vector.
Parameters
- translationVector: Point2D
Returns Blueprint
A new translated Blueprint.
Implementation of DrawingInterface.translate
- Defined in src/2d/blueprints/Blueprint.ts:204

Class Blueprint

Example

See

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Blueprint

Throws

Properties

Protected_boundingBox

curves

Accessors

boundingBox

Returns BoundingBox2d

firstPoint

Returns Point2D

lastPoint

Returns Point2D

orientation

Returns "clockwise" | "counterClockwise"

Remarks

repr

Returns string

Methods

clone

Returns Blueprint

delete

Returns void

intersects

Parameters

Returns boolean

Remarks

isClosed

Returns boolean

isInside

Parameters

Returns boolean

Remarks

mirror

Parameters

Returns Blueprint

punchHole

Parameters

OptionaldraftAngle?: number

Optionalheight?: number | null

Optionalorigin?: PointInput | null

Returns AnyShape

rotate

Parameters

Returns Blueprint

scale

Parameters

Returns Blueprint

sketchOnFace

Parameters

Returns SketchData

sketchOnPlane

Parameters

Returns SketchData

stretch

Parameters

Returns Blueprint

subFace

Parameters

Returns Face

toSVG

Parameters

Returns string

toSVGPath

Returns string

toSVGPathD

Returns string

toSVGPaths

Returns string[]

`Protected`_boundingBox

`Optional`draftAngle?: number

`Optional`height?: number | null

`Optional`origin?: PointInput | null