@revideo/core / types / BBox

Class: BBox

Defined in: types/BBox.ts:35

Implements

Constructors

Constructor

new BBox(): BBox

Defined in: types/BBox.ts:235

Returns

BBox

Constructor

new BBox(from): BBox

Defined in: types/BBox.ts:236

Parameters

from

PossibleBBox

Returns

BBox

Constructor

new BBox(position, size): BBox

Defined in: types/BBox.ts:237

Parameters

position

Vector2

size

Vector2

Returns

BBox

Constructor

new BBox(x, y?, width?, height?): BBox

Defined in: types/BBox.ts:238

Parameters

x

number

y?

number

width?

number

height?

number

Returns

BBox

Properties

height

height: number = 0

Defined in: types/BBox.ts:41

width

width: number = 0

Defined in: types/BBox.ts:40

x

x: number = 0

Defined in: types/BBox.ts:38

y

y: number = 0

Defined in: types/BBox.ts:39

symbol

readonly static symbol: typeof symbol

Defined in: types/BBox.ts:36

Accessors

bottom

Get Signature

get bottom(): number

Defined in: types/BBox.ts:198

Returns

number

Set Signature

set bottom(value): void

Defined in: types/BBox.ts:202

Parameters

value

number

Returns

void

bottomLeft

Get Signature

get bottomLeft(): Vector2

Defined in: types/BBox.ts:214

Returns

Vector2

bottomRight

Get Signature

get bottomRight(): Vector2

Defined in: types/BBox.ts:218

Returns

Vector2

center

Get Signature

get center(): Vector2

Defined in: types/BBox.ts:168

Returns

Vector2

corners

Get Signature

get corners(): [Vector2, Vector2, Vector2, Vector2]

Defined in: types/BBox.ts:222

Returns

[Vector2, Vector2, Vector2, Vector2]

left

Get Signature

get left(): number

Defined in: types/BBox.ts:172

Returns

number

Set Signature

set left(value): void

Defined in: types/BBox.ts:176

Parameters

value

number

Returns

void

pixelPerfect

Get Signature

get pixelPerfect(): BBox

Defined in: types/BBox.ts:226

Returns

BBox

position

Get Signature

get position(): Vector2

Defined in: types/BBox.ts:155

Returns

Vector2

Set Signature

set position(value): void

Defined in: types/BBox.ts:159

Parameters

value

Vector2

Returns

void

right

Get Signature

get right(): number

Defined in: types/BBox.ts:181

Returns

number

Set Signature

set right(value): void

Defined in: types/BBox.ts:185

Parameters

value

number

Returns

void

size

Get Signature

get size(): Vector2

Defined in: types/BBox.ts:164

Returns

Vector2

top

Get Signature

get top(): number

Defined in: types/BBox.ts:189

Returns

number

Set Signature

set top(value): void

Defined in: types/BBox.ts:193

Parameters

value

number

Returns

void

topLeft

Get Signature

get topLeft(): Vector2

Defined in: types/BBox.ts:206

Returns

Vector2

topRight

Get Signature

get topRight(): Vector2

Defined in: types/BBox.ts:210

Returns

Vector2

Methods

addSpacing()

addSpacing(value): BBox

Defined in: types/BBox.ts:315

Expand the bounding box to accommodate the given spacing.

Parameters

value

PossibleSpacing

The value to expand the bounding box by.

Returns

BBox

Deprecated

Use expand instead.

expand()

expand(value): BBox

Defined in: types/BBox.ts:299

Expand the bounding box to accommodate the given spacing.

Parameters

value

PossibleSpacing

The value to expand the bounding box by.

Returns

BBox

includes()

includes(point): boolean

Defined in: types/BBox.ts:319

Parameters

point

Vector2

Returns

boolean

intersection()

intersection(other): BBox

Defined in: types/BBox.ts:337

Parameters

other

BBox

Returns

BBox

intersects()

intersects(other): boolean

Defined in: types/BBox.ts:328

Parameters

other

BBox

Returns

boolean

lerp()

lerp(to, value): BBox

Defined in: types/BBox.ts:151

Parameters

to

BBox

value

number | Vector2 | BBox

Returns

BBox

serialize()

serialize(): SerializedBBox

Defined in: types/BBox.ts:376

Returns

SerializedBBox

toString()

toString(): string

Defined in: types/BBox.ts:365

Returns a string representation of an object.

Returns

string

toSymbol()

toSymbol(): symbol

Defined in: types/BBox.ts:361

Returns

symbol

Implementation of

Type.toSymbol

toUniform()

toUniform(gl, location): void

Defined in: types/BBox.ts:369

Parameters

gl

WebGL2RenderingContext

location

WebGLUniformLocation

Returns

void

Implementation of

WebGLConvertible.toUniform

transform()

transform(matrix): BBox

Defined in: types/BBox.ts:283

Parameters

matrix

PossibleMatrix2D

Returns

BBox

transformCorners()

transformCorners(matrix): Vector2[]

Defined in: types/BBox.ts:290

Parameters

matrix

PossibleMatrix2D

Returns

Vector2[]

union()

union(other): BBox

Defined in: types/BBox.ts:350

Parameters

other

BBox

Returns

BBox

arcLerp()

static arcLerp(from, to, value, reverse?, ratio?): BBox

Defined in: types/BBox.ts:84

Parameters

from

BBox

to

BBox

value

number

reverse?

boolean = false

ratio?

number

Returns

BBox

createSignal()

static createSignal(initial?, interpolation?): RectSignal<void>

Defined in: types/BBox.ts:43

Parameters

fromBBoxes()

static fromBBoxes(…boxes): BBox

Defined in: types/BBox.ts:125

Parameters

boxes

…BBox[]

Returns

BBox

fromPoints()

static fromPoints(…points): BBox

Defined in: types/BBox.ts:101

Parameters

points

…Vector2[]

Returns

BBox

fromSizeCentered()

static fromSizeCentered(size): BBox

Defined in: types/BBox.ts:97

Parameters

size

Vector2

Returns

BBox

lerp()

static lerp(from, to, value): BBox

Defined in: types/BBox.ts:55

Parameters

from

BBox

to

BBox

value

number | Vector2 | BBox

Returns

BBox