Class Box

Hierarchy

Cell<V>
- Box (View Summary)

Index

Accessors

area

get area(): Num
Returns Num
- Defined in src/core/values/box.ts:203

bottom

get bottom(): Vec
Returns Vec
- Defined in src/core/values/box.ts:219

center

get center(): Vec
Returns Vec
- Defined in src/core/values/box.ts:213

h

get h(): this extends WritableBrand ? Writable<Num> : Num
Returns this extends WritableBrand ? Writable<Num> : Num
- Defined in src/core/values/box.ts:200

left

get left(): Vec
Returns Vec
- Defined in src/core/values/box.ts:222

right

get right(): Vec
Returns Vec
- Defined in src/core/values/box.ts:225

top

get top(): Vec
Returns Vec
- Defined in src/core/values/box.ts:216

w

get w(): this extends WritableBrand ? Writable<Num> : Num
Returns this extends WritableBrand ? Writable<Num> : Num
- Defined in src/core/values/box.ts:197

x

get x(): this extends WritableBrand ? Writable<Num> : Num
Returns this extends WritableBrand ? Writable<Num> : Num
- Defined in src/core/values/box.ts:191

y

get y(): this extends WritableBrand ? Writable<Num> : Num
Returns this extends WritableBrand ? Writable<Num> : Num
- Defined in src/core/values/box.ts:194

Constructors

constructor

new Box(v?: V): Box
Parameters
- v: V = ...
Returns Box
Overrides Cell.constructor
- Defined in src/core/values/box.ts:123

Methods

add

add(b: Val<Readonly<{ h: number; w: number; x: number; y: number }>>): this
Parameters
- b: Val<Readonly<{ h: number; w: number; x: number; y: number }>>
Returns this
- Defined in src/core/values/box.ts:127

at

at(u: number, v: number): Vec
Vec at parametric (u, v) in [0,1]². Not memoised; use the named edge getters (.center, .top, …) for stable identity.
Parameters
- u: number
- v: number
Returns Vec
- Defined in src/core/values/box.ts:209

contains

contains>>(
p: P,
): P extends WritableBrand ? Writable<Bool> : Bool
True when p is inside the box. A writable Vec yields a Writable<Bool>: flipping it clamps p to the nearest in-box point (true) or ejects it past the nearest edge (false). Literal/RO inputs yield a read-only Bool.
Type Parameters
- P extends Val<Readonly<{ x: number; y: number }>>
Parameters
- p: P
Returns P extends WritableBrand ? Writable<Bool> : Bool
- Defined in src/core/values/box.ts:162

derive

derive(
this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>,
fn: (v: T) => T,
): this
Read-only same-type view: the RO dual of the endo .lens. For a cross-type view use the typed static Target.derive(src, fn).
Parameters
- this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>
- fn: (v: T) => T
Returns this
Inherited from Cell.derive
- Defined in src/core/cell.ts:854

expand

expand(n: Val<number>): this
Parameters
- n: Val<number>
Returns this
- Defined in src/core/values/box.ts:148

lens

lens(
 this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>,
 fwd: (v: T) => T,
 bwd: (target: T, current: T) => T,
): this
Endomorphic lens from a fwd/bwd pair (2-arg bwd reads the source, 1-arg reconstructs it), or apply optic value(s), chaining left-to-right. A chain whose every hop is T → T stays same-type (returns this); a chain that changes the value type yields a plain Cell of the final view.
Parameters
- this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>
- fwd: (v: T) => T
- bwd: (target: T, current: T) => T
Returns this
Inherited from Cell.lens
- Defined in src/core/cell.ts:839
lens(
 this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>,
 ...optics: readonly AppliedOptic<
 Readonly<{ h: number; w: number; x: number; y: number }>,
 Readonly<{ h: number; w: number; x: number; y: number }>,
 >[],
): this
Endomorphic lens from a fwd/bwd pair (2-arg bwd reads the source, 1-arg reconstructs it), or apply optic value(s), chaining left-to-right. A chain whose every hop is T → T stays same-type (returns this); a chain that changes the value type yields a plain Cell of the final view.
Parameters
- this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>
- ...optics: readonly AppliedOptic<
 Readonly<{ h: number; w: number; x: number; y: number }>,
 Readonly<{ h: number; w: number; x: number; y: number }>,
 >[]
Returns this
Inherited from Cell.lens
- Defined in src/core/cell.ts:840
lens<V1>(
 this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>,
 optic: AppliedOptic<
 Readonly<{ h: number; w: number; x: number; y: number }>,
 V1,
 >,
): Writable<Cell<V1>>
Endomorphic lens from a fwd/bwd pair (2-arg bwd reads the source, 1-arg reconstructs it), or apply optic value(s), chaining left-to-right. A chain whose every hop is T → T stays same-type (returns this); a chain that changes the value type yields a plain Cell of the final view.
Type Parameters
- V1
Parameters
- this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>
- optic: AppliedOptic<Readonly<{ h: number; w: number; x: number; y: number }>, V1>
Returns Writable<Cell<V1>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:841
lens<Os extends AnyOptics>(
 this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>,
 ...optics: Os,
): Writable<
 Cell<
 ChainResult<
 Readonly<{ h: number; w: number; x: number; y: number }>,
 Os,
 >,
 >,
>
Endomorphic lens from a fwd/bwd pair (2-arg bwd reads the source, 1-arg reconstructs it), or apply optic value(s), chaining left-to-right. A chain whose every hop is T → T stays same-type (returns this); a chain that changes the value type yields a plain Cell of the final view.
Type Parameters
- Os extends AnyOptics
Parameters
- this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>
- ...optics: Os
Returns Writable<
 Cell<
 ChainResult<
 Readonly<{ h: number; w: number; x: number; y: number }>,
 Os,
 >,
 >,
>
Inherited from Cell.lens
- Defined in src/core/cell.ts:842

lerp

lerp(
b: Val<Readonly<{ h: number; w: number; x: number; y: number }>>,
t: Val<number>,
): Box
Parameters
- b: Val<Readonly<{ h: number; w: number; x: number; y: number }>>
- t: Val<number>
Returns Box
- Defined in src/core/values/box.ts:156

merge

merge(
this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>,
fold?: MergeFold<Readonly<{ h: number; w: number; x: number; y: number }>>,
): Cell<Readonly<{ h: number; w: number; x: number; y: number }>>
Backward fan-in: forwards its parent's value unchanged; on write, folds N contributors into one value. fold defaults to last-writer-wins.
Parameters
- this: Cell<Readonly<{ h: number; w: number; x: number; y: number }>>
- Optionalfold: MergeFold<Readonly<{ h: number; w: number; x: number; y: number }>>
Returns Cell<Readonly<{ h: number; w: number; x: number; y: number }>>
Inherited from Cell.merge
- Defined in src/core/cell.ts:860

peek

peek(): T
Returns T
Inherited from Cell.peek
- Defined in src/core/cell.ts:822

scale

scale(k: Val<number>): this
Parameters
- k: Val<number>
Returns this
- Defined in src/core/values/box.ts:141

sub

sub(b: Val<Readonly<{ h: number; w: number; x: number; y: number }>>): this
Parameters
- b: Val<Readonly<{ h: number; w: number; x: number; y: number }>>
Returns this
- Defined in src/core/values/box.ts:134

to

to(
 this: Writable<Box>,
 target: V,
 dur: Val<number>,
 ease?: Easing,
): Tween<Readonly<{ h: number; w: number; x: number; y: number }>>
Tween-builder.
Parameters
- this: Writable<Box>
- target: V
- dur: Val<number>
- Optionalease: Easing
Returns Tween<Readonly<{ h: number; w: number; x: number; y: number }>>
- Defined in src/core/values/box.ts:230

`Static`coerce

coerce<C extends AnyCellCtor>(
this: C,
v: Val<Inner<InstanceType<C>>>,
): InstanceType<C>
Coerce Val<Inner<Cls>> → Cls: instance → identity, RO cell → tracked derive, literal → fresh seed.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: Val<Inner<InstanceType<C>>>
Returns InstanceType<C>
Inherited from Cell.coerce
- Defined in src/core/cell.ts:945

`Static`derive

derive<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 fn: (v: P) => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- fn: (v: P) => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:878
derive<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 fn: (vals: ReadValues) => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- fn: (vals: ReadValues) => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:883
derive<C extends AnyCellCtor>(
this: C,
fn: () => Inner<InstanceType<C>>,
): InstanceType<C>
Read-only typed view. Cls.derive(parent, fn) (1-input), Cls.derive(parents, fn) (N-input), or Cls.derive(fn) (closure). Polymorphic-this: Vec.derive(...) → Vec.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- fn: () => Inner<InstanceType<C>>
Returns InstanceType<C>
Inherited from Cell.derive
- Defined in src/core/cell.ts:888

`Static`is

is<C extends AnyCellCtor>(this: C, v: unknown): v is InstanceType<C>
Type predicate against this class: Vec.is(x) narrows x to Vec. Inherited static; works for any subclass via polymorphic this.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: unknown
Returns v is InstanceType<C>
Inherited from Cell.is
- Defined in src/core/cell.ts:939

`Static`lens

lens<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 fwd: (v: P) => Inner<InstanceType<C>>,
 bwd: (target: Inner<InstanceType<C>>, v: P) => P,
): Writable<InstanceType<C>>
Writable lens, typed to this class. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N (a 2-arg bwd reads the source, a 1-arg bwd reconstructs it); Cls.lens(parent(s), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- fwd: (v: P) => Inner<InstanceType<C>>
- bwd: (target: Inner<InstanceType<C>>, v: P) => P
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:898
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 fwd: (vals: ReadValues) => Inner<InstanceType<C>>,
 bwd: (
 target: Inner<InstanceType<C>>,
 vals: ReadValues,
 ) => BackUpdates<ReadValuesOrSkip>,
): Writable<InstanceType<C>>
Writable lens, typed to this class. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N (a 2-arg bwd reads the source, a 1-arg bwd reconstructs it); Cls.lens(parent(s), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- fwd: (vals: ReadValues) => Inner<InstanceType<C>>
- bwd: (
 target: Inner<InstanceType<C>>,
 vals: ReadValues,
 ) => BackUpdates<ReadValuesOrSkip>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:904
lens<C extends AnyCellCtor, P>(
 this: C,
 parent: Read,
 optic: AppliedOptic<P, Inner<InstanceType<C>>>,
): Writable<InstanceType<C>>
Writable lens, typed to this class. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N (a 2-arg bwd reads the source, a 1-arg bwd reconstructs it); Cls.lens(parent(s), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P
Parameters
- this: C
- parent: Read
- optic: AppliedOptic<P, Inner<InstanceType<C>>>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:910
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[]>(
 this: C,
 parents: P,
 optic: AppliedOptic<ReadValues, Inner<InstanceType<C>>>,
): Writable<InstanceType<C>>
Writable lens, typed to this class. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N (a 2-arg bwd reads the source, a 1-arg bwd reconstructs it); Cls.lens(parent(s), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
Parameters
- this: C
- parents: P
- optic: AppliedOptic<ReadValues, Inner<InstanceType<C>>>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:915
lens<C extends AnyCellCtor, P, Os extends AnyOptics>(
 this: C,
 parent: Read,
 ...optics: Os,
): ChainResult<P, Os> extends Inner<InstanceType<C>>
 ? Writable<InstanceType<C>>
 : never
Writable lens, typed to this class. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N (a 2-arg bwd reads the source, a 1-arg bwd reconstructs it); Cls.lens(parent(s), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P
- Os extends AnyOptics
Parameters
- this: C
- parent: Read
- ...optics: Os
Returns ChainResult<P, Os> extends Inner<InstanceType<C>>
? Writable<InstanceType<C>>
: never
Inherited from Cell.lens
- Defined in src/core/cell.ts:920
lens<
 C extends AnyCellCtor,
 P extends readonly Read<unknown>[],
 Os extends AnyOptics,
>(
 this: C,
 parents: P,
 ...optics: Os,
): ChainResult<ReadValues, Os> extends Inner<InstanceType<C>>
 ? Writable<InstanceType<C>>
 : never
Writable lens, typed to this class. Cls.lens(parent, fwd, bwd) for one input, Cls.lens(parents, fwd, bwd) for N (a 2-arg bwd reads the source, a 1-arg bwd reconstructs it); Cls.lens(parent(s), optic, …) applies an optic value (pure or complement-carrying), chaining left-to-right onto this class.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
- Os extends AnyOptics
Parameters
- this: C
- parents: P
- ...optics: Os
Returns ChainResult<ReadValues, Os> extends Inner<InstanceType<C>>
? Writable<InstanceType<C>>
: never
Inherited from Cell.lens
- Defined in src/core/cell.ts:925

`Static`pin

pin<C extends AnyCellCtor>(
this: C,
v: Inner<InstanceType<C>>,
): Writable<InstanceType<C>>
Writable-shaped constant: always reads v, absorbs writes (parentless sink lens), for APIs demanding bidirectionality.
Type Parameters
- C extends AnyCellCtor
Parameters
- this: C
- v: Inner<InstanceType<C>>
Returns Writable<InstanceType<C>>
Inherited from Cell.pin
- Defined in src/core/cell.ts:958

Properties

`Readonly`_t

_t: {
 equals: (a: V, b: V) => boolean;
 lerp: (a: V, b: V, t: number) => V;
 linear: Linear<Readonly<{ h: number; w: number; x: number; y: number }>>;
 metric: (a: V, b: V) => number;
 pack: Pack<Readonly<{ h: number; w: number; x: number; y: number }>>;
}

Type Declaration

equals: (a: V, b: V) => boolean
lerp: (a: V, b: V, t: number) => V
linear: Linear<Readonly<{ h: number; w: number; x: number; y: number }>>
metric: (a: V, b: V) => number
Euclidean distance over (x, y, w, h).
pack: Pack<Readonly<{ h: number; w: number; x: number; y: number }>>

name

name: string | undefined

Optional debug label (cell(0, { name })); used by errors and graph dumps.

`Readonly`value

value: T

`Static`traits

traits: {
 equals: (a: V, b: V) => boolean;
 lerp: (a: V, b: V, t: number) => V;
 linear: Linear<Readonly<{ h: number; w: number; x: number; y: number }>>;
 metric: (a: V, b: V) => number;
 pack: Pack<Readonly<{ h: number; w: number; x: number; y: number }>>;
} = ...

Type Declaration

equals: (a: V, b: V) => boolean
lerp: (a: V, b: V, t: number) => V
linear: Linear<Readonly<{ h: number; w: number; x: number; y: number }>>
metric: (a: V, b: V) => number
Euclidean distance over (x, y, w, h).
pack: Pack<Readonly<{ h: number; w: number; x: number; y: number }>>

Class Box

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

area

Returns Num

bottom

Returns Vec

center

Returns Vec

h

Returns this extends WritableBrand ? Writable<Num> : Num

left

Returns Vec

right

Returns Vec

top

Returns Vec

w

Returns this extends WritableBrand ? Writable<Num> : Num

x

Returns this extends WritableBrand ? Writable<Num> : Num

y

Returns this extends WritableBrand ? Writable<Num> : Num

Constructors

constructor

Parameters

Returns Box

Methods

add

Parameters

Returns this

at

Parameters

Returns Vec

contains

Type Parameters

Parameters

Returns P extends WritableBrand ? Writable<Bool> : Bool

derive

Parameters

Returns this

expand

Parameters

Returns this

lens

Parameters

Returns this

Parameters

Returns this

Type Parameters

Parameters

Returns Writable<Cell<V1>>

Type Parameters

Parameters

Returns Writable< Cell< ChainResult< Readonly<{ h: number; w: number; x: number; y: number }>, Os, >, >,>

lerp

Parameters

Returns Box

merge

Parameters

Returns Cell<Readonly<{ h: number; w: number; x: number; y: number }>>

peek

Returns T

scale

Parameters

Returns this

sub

Parameters

Returns this

to

Parameters

Returns Tween<Readonly<{ h: number; w: number; x: number; y: number }>>

Staticcoerce

Type Parameters

Parameters

Returns Writable<
Cell<
ChainResult<
Readonly<{ h: number; w: number; x: number; y: number }>,
Os,
>,
>,
>

`Static`coerce

`Static`derive

`Static`is

`Static`lens

Returns ChainResult<P, Os> extends Inner<InstanceType<C>>
? Writable<InstanceType<C>>
: never

Returns ChainResult<ReadValues<P>, Os> extends Inner<InstanceType<C>>
? Writable<InstanceType<C>>
: never

`Static`pin

`Readonly`_t

`Readonly`value

`Static`traits