Interface Blueprints

Hold a collection of disjoint 2D profiles (simple or compound).

Unlike CompoundBlueprint, the child blueprints here are independent shapes -- none is treated as a hole in another. Blueprints is the typical result of boolean operations that produce multiple disconnected regions.

See

Blueprint for a single contiguous profile.
CompoundBlueprint for a profile with holes.

interface Blueprints {
    _boundingBox: BoundingBox2d | null;
    blueprints: (Blueprint | CompoundBlueprint)[];
    get boundingBox(): BoundingBox2d;
    get repr(): string;
    clone(): Blueprints;
    mirror(
        centerOrDirection: Point2D,
        origin?: Point2D,
        mode?: "plane" | "center",
    ): Blueprints;
    punchHole(
        shape: AnyShape<Dimension>,
        face: SingleFace,
        options?: { draftAngle?: number; height?: number; origin?: PointInput },
    ): AnyShape<Dimension>;
    rotate(angle: number, center?: Point2D): Blueprints;
    scale(scaleFactor: number, center?: Point2D): Blueprints;
    sketchOnFace(
        face: Face,
        scaleMode?: ScaleMode,
    ): (SketchData | SketchData[])[];
    sketchOnPlane(
        plane?: Plane | PlaneName,
        origin?: number | PointInput,
    ): (SketchData | SketchData[])[];
    stretch(ratio: number, direction: Point2D, origin: Point2D): Blueprints;
    toSVG(margin?: number): string;
    toSVGPaths(): string[][];
    toSVGViewBox(margin?: number): string;
    translate(xDist: number, yDist: number): Blueprints;
    translate(translationVector: Point2D): Blueprints;
}

Implements

DrawingInterface

Index

Properties

`Protected`_boundingBox

_boundingBox: BoundingBox2d | null

blueprints

blueprints: (Blueprint | CompoundBlueprint)[]

The independent profiles in this collection.

Accessors

boundingBox

get boundingBox(): BoundingBox2d
Compute (and cache) the combined bounding box of all child blueprints.

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

repr

get repr(): string
Return a multi-line debug representation of every child blueprint.

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

Methods

clone

clone(): Blueprints
Return a deep copy of this collection and all its children.

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

mirror

mirror(
    centerOrDirection: Point2D,
    origin?: Point2D,
    mode?: "plane" | "center",
): Blueprints
Mirror all child blueprints across a point or plane.
Parameters
- centerOrDirection: Point2D
- Optionalorigin: Point2D
- Optionalmode: "plane" | "center"
Returns Blueprints
Implementation of DrawingInterface.mirror
- Defined in src/2d/blueprints/blueprints.ts:89

punchHole

punchHole(
    shape: AnyShape<Dimension>,
    face: SingleFace,
    options?: { draftAngle?: number; height?: number; origin?: PointInput },
): AnyShape<Dimension>
Punch holes through a solid for each child blueprint in sequence.
Parameters
- shape: AnyShape<Dimension>
- face: SingleFace
- options: { draftAngle?: number; height?: number; origin?: PointInput } = {}
Returns AnyShape<Dimension>
The shape with all holes applied.
- Defined in src/2d/blueprints/blueprints.ts:111

rotate

rotate(angle: number, center?: Point2D): Blueprints
Rotate all child blueprints by an angle in degrees.
Parameters
- angle: number
- Optionalcenter: Point2D
Returns Blueprints
Implementation of DrawingInterface.rotate
- Defined in src/2d/blueprints/blueprints.ts:65

scale

scale(scaleFactor: number, center?: Point2D): Blueprints
Uniformly scale all child blueprints around a center point.
Parameters
- scaleFactor: number
- Optionalcenter: Point2D
Returns Blueprints
- Defined in src/2d/blueprints/blueprints.ts:70

sketchOnFace

sketchOnFace(face: Face, scaleMode?: ScaleMode): (SketchData | SketchData[])[]
Map all child blueprints onto a 3D face's UV surface.
Parameters
- face: Face
- OptionalscaleMode: ScaleMode
Returns (SketchData | SketchData[])[]
Implementation of DrawingInterface.sketchOnFace
- Defined in src/2d/blueprints/blueprints.ts:102

sketchOnPlane

sketchOnPlane(
plane?: Plane | PlaneName,
origin?: number | PointInput,
): (SketchData | SketchData[])[]
Project all child blueprints onto a 3D plane.
Parameters
- Optionalplane: Plane | PlaneName
- Optionalorigin: number | PointInput
Returns (SketchData | SketchData[])[]
Implementation of DrawingInterface.sketchOnPlane
- Defined in src/2d/blueprints/blueprints.ts:94

stretch

stretch(ratio: number, direction: Point2D, origin: Point2D): Blueprints
Stretch all child blueprints along a direction by a given ratio.
Parameters
- ratio: number
- direction: Point2D
- origin: Point2D
Returns Blueprints
Implementation of DrawingInterface.stretch
- Defined in src/2d/blueprints/blueprints.ts:60

toSVG

toSVG(margin?: number): string
Render a complete SVG document string for all child blueprints.
Parameters
- margin: number = 1
Returns string
Implementation of DrawingInterface.toSVG
- Defined in src/2d/blueprints/blueprints.ts:138

toSVGPaths

toSVGPaths(): string[][]
Return nested SVG path d string arrays -- one sub-array per child.

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

toSVGViewBox

toSVGViewBox(margin?: number): string
Compute the SVG viewBox attribute for this collection.
Parameters
- margin: number = 1
Returns string
Implementation of DrawingInterface.toSVGViewBox
- Defined in src/2d/blueprints/blueprints.ts:128

translate

translate(xDist: number, yDist: number): Blueprints
Translate all child blueprints by separate x/y distances or a vector.
Parameters
- xDist: number
- yDist: number
Returns Blueprints
Implementation of DrawingInterface.translate
- Defined in src/2d/blueprints/blueprints.ts:76
translate(translationVector: Point2D): Blueprints
Translate all child blueprints by separate x/y distances or a vector.
Parameters
- translationVector: Point2D
Returns Blueprints
Implementation of DrawingInterface.translate
- Defined in src/2d/blueprints/blueprints.ts:77

Interface Blueprints

See

Implements

Index

Properties

Accessors

Methods

Properties

Protected_boundingBox

blueprints

Accessors

boundingBox

Returns BoundingBox2d

repr

Returns string

Methods

clone

Returns Blueprints

mirror

Parameters

Returns Blueprints

punchHole

Parameters

Returns AnyShape<Dimension>

rotate

Parameters

Returns Blueprints

scale

Parameters

Returns Blueprints

sketchOnFace

Parameters

Returns (SketchData | SketchData[])[]

sketchOnPlane

Parameters

Returns (SketchData | SketchData[])[]

stretch

Parameters

Returns Blueprints

toSVG

Parameters

Returns string

toSVGPaths

Returns string[][]

toSVGViewBox

Parameters

Returns string

translate

Parameters

Returns Blueprints

Parameters

Returns Blueprints

Settings

On This Page

`Protected`_boundingBox