Interface BoundingBox2d

Axis-aligned 2D bounding box backed by an kernel Bnd_Box2d.

Provides bounds queries, containment tests, and union operations for spatial indexing of 2D geometry.

interface BoundingBox2d {
    get bounds(): [Point2D, Point2D];
    get center(): Point2D;
    get height(): number;
    get repr(): string;
    get width(): number;
    get wrapped(): any;
    "[dispose]"(): void;
    add(other: BoundingBox2d): void;
    containsPoint(other: Point2D): boolean;
    delete(): void;
    isOut(other: BoundingBox2d): boolean;
    outsidePoint(paddingPercent?: number): Point2D;
}

Index

Accessors

bounds center height repr width wrapped

Methods

[dispose] add containsPoint delete isOut outsidePoint

Accessors

bounds

get bounds(): [Point2D, Point2D]
Return the [min, max] corner points of the bounding box.

Returns [Point2D, Point2D]
- Defined in src/2d/lib/boundingBox2d.ts:47

center

get center(): Point2D
Return the center point of the bounding box.

Returns Point2D
- Defined in src/2d/lib/boundingBox2d.ts:56

height

get height(): number
Return the height (y-extent) of the bounding box.

Returns number
- Defined in src/2d/lib/boundingBox2d.ts:68

repr

get repr(): string
Return a human-readable string of the form (xMin,yMin) - (xMax,yMax).

Returns string
- Defined in src/2d/lib/boundingBox2d.ts:41

width

get width(): number
Return the width (x-extent) of the bounding box.

Returns number
- Defined in src/2d/lib/boundingBox2d.ts:62

wrapped

get wrapped(): any
Returns any
- Defined in src/2d/lib/boundingBox2d.ts:23

Methods

[dispose]

"[dispose]"(): void
Returns void
- Defined in src/2d/lib/boundingBox2d.ts:36

add

add(other: BoundingBox2d): void
Expand this bounding box to include other.
Parameters
- other: BoundingBox2d
Returns void
- Defined in src/2d/lib/boundingBox2d.ts:90

containsPoint

containsPoint(other: Point2D): boolean
Test whether the given point lies inside (or on the boundary of) this box.
Parameters
- other: Point2D
Returns boolean
- Defined in src/2d/lib/boundingBox2d.ts:100

delete

delete(): void
Returns void
- Defined in src/2d/lib/boundingBox2d.ts:28

isOut

isOut(other: BoundingBox2d): boolean
Test whether this bounding box and other are completely disjoint.
Parameters
- other: BoundingBox2d
Returns boolean
- Defined in src/2d/lib/boundingBox2d.ts:95

outsidePoint

outsidePoint(paddingPercent?: number): Point2D
Return a point guaranteed to lie outside the bounding box.
Parameters
- paddingPercent: number = 1
  Extra padding as a percentage of the box dimensions.
Returns Point2D
- Defined in src/2d/lib/boundingBox2d.ts:78