Box

Public class

class Box {}

packages/editor/src/lib/primitives/Box.ts

Constructor

Public constructor

Constructs a new instance of the Box class

number

number

number

number

Properties

aspectRatio

Public readonly property

get aspectRatio(): number

center

Public property

get center(): Vec

set center(v: Vec)

Vec

Collides

Public static property

static Collides: (A: Box, B: Box) => boolean

Box

Common

Public static property

static Common: (boxes: Box[]) => Box

Box

Contains

Public static property

static Contains: (A: Box, B: Box) => boolean

Box

ContainsPoint

Public static property

static ContainsPoint: (A: Box, B: VecLike, margin?: number) => boolean

Box, VecLike

corners

Public readonly property

get corners(): Vec[]

Vec

h

Public property

h: number

height

Public property

get height(): number

set height(n: number)

Includes

Public static property

static Includes: (A: Box, B: Box) => boolean

Box

maxX

Public readonly property

get maxX(): number

maxY

Public readonly property

get maxY(): number

midX

Public readonly property

get midX(): number

midY

Public readonly property

get midY(): number

minX

Public property

get minX(): number

set minX(n: number)

minY

Public property

get minY(): number

set minY(n: number)

point

Public property

get point(): Vec

set point(val: Vec)

Vec

sides

Public readonly property

get sides(): Array<[Vec, Vec]>

Vec

Sides

Public static property

static Sides: (A: Box, inset?: number) => Vec[][]

Box, Vec

size

Public readonly property

get size(): Vec

Vec

snapPoints

Public readonly property

get snapPoints(): Vec[]

Vec

w

Public property

w: number

width

Public property

get width(): number

set width(n: number)

x

Public property

x: number

y

Public property

y: number

Methods

clone()

Public method

clone(): Box

Box

collides()

Public method

collides(B: Box): boolean

Box

boolean

Box

contains()

Public method

contains(B: Box): boolean

Box

boolean

Box

containsPoint()

Public method

containsPoint(V: VecLike, margin?: number): boolean

VecLike

number

boolean

VecLike

equals()

Public method

equals(other: Box | BoxModel): boolean

Box | BoxModel

boolean

Box, BoxModel

Equals()

Public static method

static Equals(a: Box | BoxModel, b: Box | BoxModel): boolean

Box | BoxModel

Box | BoxModel

boolean

Box, BoxModel

expand()

Public method

expand(A: Box): this

Box

this

Box

Expand()

Public static method

static Expand(A: Box, B: Box): Box

Box

Box

Box

Box

expandBy()

Public method

expandBy(n: number): this

number

this

ExpandBy()

Public static method

static ExpandBy(A: Box, n: number): Box

Box

number

Box

Box

From()

Public static method

static From(box: BoxModel): Box

BoxModel

Box

BoxModel, Box

FromCenter()

Public static method

static FromCenter(center: VecLike, size: VecLike): Box

VecLike

VecLike

Box

VecLike, Box

FromPoints()

Public static method

static FromPoints(points: VecLike[]): Box

VecLike[]

Box

VecLike, Box

getHandlePoint()

Public method

getHandlePoint(handle: SelectionCorner | SelectionEdge): Vec

SelectionCorner | SelectionEdge

Vec

SelectionCorner, SelectionEdge, Vec

includes()

Public method

includes(B: Box): boolean

Box

boolean

Box

resize()

Public method

resize(
  handle: SelectionCorner | SelectionEdge | string,
  dx: number,
  dy: number
): void

SelectionCorner | SelectionEdge | string

number

number

void

SelectionCorner, SelectionEdge

Resize()

Public static method

static Resize(
  box: Box,
  handle: SelectionCorner | SelectionEdge | string,
  dx: number,
  dy: number,
  isAspectRatioLocked?: boolean
): {
  box: Box
  scaleX: number
  scaleY: number
}

Box

SelectionCorner | SelectionEdge | string

number

number

boolean

{
  box: Box
  scaleX: number
  scaleY: number
}

Box, SelectionCorner, SelectionEdge

scale()

Public method

scale(n: number): this

number

this

set()

Public method

set(x?: number, y?: number, w?: number, h?: number): this

number

number

number

number

this

setTo()

Public method

setTo(B: Box): this

Box

this

Box

snapToGrid()

Public method

snapToGrid(size: number): void

number

void

toFixed()

Public method

toFixed(): this

toJson()

Public method

toJson(): BoxModel

BoxModel

translate()

Public method

translate(delta: VecLike): this

VecLike

this

VecLike

union()

Public method

union(box: BoxModel): this

BoxModel

this

BoxModel

zeroFix()

Public method

zeroFix(): this

ZeroFix()

Public static method

static ZeroFix(other: Box | BoxModel): Box

Box | BoxModel

Box

Box, BoxModel