Class BBox

The BBox class

Hierarchy (View Summary)

BBox
- LineBBox

Index

Constructors

Properties

w boxSides fullWidth

Methods

append clean combine copy empty rescale updateFrom empty zero

Constructors

constructor

new BBox(def?: BBoxData): BBox
Parameters
- def: BBoxData = ...
  The data with which to initialize the BBox
Returns BBox
- Defined in ts/util/BBox.ts:91

Properties

w

w: number

These are the data stored for a bounding box

`Static`boxSides

boxSides: [string, number, string][] = ...

The side names, indices, and which dimension they affect

`Static`fullWidth

fullWidth: string = '100%'

Constant for pwidth of full width box

Methods

append

append(cbox: BBox): void
Parameters
- cbox: BBox
  A bounding box to be added to the right of this one
Returns void
- Defined in ts/util/BBox.ts:147

clean

clean(): void
Convert any unspecified values into zeros

Returns void
- Defined in ts/util/BBox.ts:114

combine

combine(cbox: BBox, x?: number, y?: number): void
Parameters
- cbox: BBox
  A bounding to combine with this one
- x: number = 0
  An x-offest for the child bounding box
- y: number = 0
  A y-offset for the child bounding box
Returns void
- Defined in ts/util/BBox.ts:134

copy

copy(): BBox
Returns BBox
A copy of the current BBox
- Defined in ts/util/BBox.ts:173

empty

empty(): BBox
Set up a bbox for append() and combine() operations

Returns BBox
the bbox itself (for chaining calls)
- Defined in ts/util/BBox.ts:105

rescale

rescale(scale: number): void
Parameters
- scale: number
  The scale to use to modify the bounding box size
Returns void
- Defined in ts/util/BBox.ts:123

updateFrom

updateFrom(cbox: BBox): void
Parameters
- cbox: BBox
  The bounding box to use to overwrite this one
Returns void
- Defined in ts/util/BBox.ts:161

`Static`empty

empty(): BBox
Returns BBox
A BBox with height and depth not set
- Defined in ts/util/BBox.ts:82

`Static`zero

zero(): BBox
Returns BBox
A BBox initialized to zeros
- Defined in ts/util/BBox.ts:75