Interface CompoundBlueprint

Represent a 2D profile with holes (an outer boundary minus inner cutouts).

The first element of blueprints is the outer boundary; all subsequent elements are holes subtracted from it. CompoundBlueprint implements the same DrawingInterface as Blueprint, so it can be transformed, sketched, and serialized to SVG in the same way.

See

Blueprint for simple profiles without holes.
Blueprints for collections of disjoint profiles.

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

Implements

DrawingInterface

Index

Properties

`Protected`_boundingBox

_boundingBox: BoundingBox2d | null

blueprints

blueprints: Blueprint[]

Ordered array where blueprints[0] is the outer boundary and the remaining entries are inner holes.

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/compoundBlueprint.ts:60

repr

get repr(): string
Return a multi-line debug representation showing outline and holes.

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

Methods

clone

clone(): CompoundBlueprint
Return a deep copy of this compound blueprint and all its children.

Returns CompoundBlueprint
Implementation of DrawingInterface.clone
- Defined in src/2d/blueprints/compoundBlueprint.ts:55

mirror

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

punchHole

punchHole(
    shape: AnyShape<Dimension>,
    face: SingleFace,
    options?: { draftAngle?: number; height?: number; origin?: PointInput },
): AnyShape<Dimension>
Punch a hole through a solid using the outer boundary of this compound.
Parameters
- shape: AnyShape<Dimension>
- face: SingleFace
- options: { draftAngle?: number; height?: number; origin?: PointInput } = {}
Returns AnyShape<Dimension>
Remarks
Only the outer boundary (blueprints[0]) is used for the hole.
- Defined in src/2d/blueprints/compoundBlueprint.ts:143

rotate

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

scale

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

sketchOnFace

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

sketchOnPlane

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

stretch

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

toSVG

toSVG(margin?: number): string
Render a complete SVG document string for this compound blueprint.
Parameters
- margin: number = 1
Returns string
Implementation of DrawingInterface.toSVG
- Defined in src/2d/blueprints/compoundBlueprint.ts:171

toSVGGroup

toSVGGroup(): string
Wrap all child SVG paths in a <g> group element string.

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

toSVGPaths

toSVGPaths(): string[]
Return SVG path d strings for every child blueprint.

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

toSVGViewBox

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

translate

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

Interface CompoundBlueprint

See

Implements

Index

Properties

Accessors

Methods

Properties

Protected_boundingBox

blueprints

Accessors

boundingBox

Returns BoundingBox2d

repr

Returns string

Methods

clone

Returns CompoundBlueprint

mirror

Parameters

Returns CompoundBlueprint

punchHole

Parameters

Returns AnyShape<Dimension>

Remarks

rotate

Parameters

Returns CompoundBlueprint

scale

Parameters

Returns CompoundBlueprint

sketchOnFace

Parameters

Returns SketchData[]

sketchOnPlane

Parameters

Returns SketchData[]

stretch

Parameters

Returns CompoundBlueprint

toSVG

Parameters

Returns string

toSVGGroup

Returns string

toSVGPaths

Returns string[]

toSVGViewBox

Parameters

Returns string

translate

Parameters

Returns CompoundBlueprint

Parameters

Returns CompoundBlueprint

Settings

On This Page

`Protected`_boundingBox