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<V>): this
Parameters
- b: Val<V>
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<V>
Parameters
- p: P
Returns P extends WritableBrand ? Writable<Bool> : Bool
- Defined in src/core/values/box.ts:162

derive

derive(this: Cell<V>, fn: (v: V) => V): 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<V>
- fn: (v: V) => V
Returns this
Inherited from Cell.derive
- Defined in src/core/cell.ts:885

expand

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

lens

lens(this: Cell<V>, fwd: (v: V) => V, bwd: (target: V, current: V) => V): this
Endomorphic lens. A 2-arg bwd(view, current) consults the current source; a 1-arg bwd(view) reconstructs it from the view alone.
Parameters
- this: Cell<V>
- fwd: (v: V) => V
- bwd: (target: V, current: V) => V
Returns this
Inherited from Cell.lens
- Defined in src/core/cell.ts:879

lerp

lerp(b: Val<V>, t: Val<number>): Box
Parameters
- b: Val<V>
- t: Val<number>
Returns Box
- Defined in src/core/values/box.ts:156

merge

merge(this: Cell<V>, fold?: MergeFold<V>): Cell<V>
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<V>
- Optionalfold: MergeFold<V>
Returns Cell<V>
Inherited from Cell.merge
- Defined in src/core/cell.ts:914

peek

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

scale

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

sub

sub(b: Val<V>): this
Parameters
- b: Val<V>
Returns this
- Defined in src/core/values/box.ts:134

through

through(this: Cell<V>, o: Optic<V, B>): Writable<Cell>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
Parameters
- this: Cell<V>
- o: Optic<V, B>
Returns Writable<Cell>
Inherited from Cell.through
- Defined in src/core/cell.ts:892
through<B, C>(
 this: Cell<V>,
 o1: Optic<V, B>,
 o2: Optic<B, C>,
): Writable<Cell<C>>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
- C
Parameters
- this: Cell<V>
- o1: Optic<V, B>
- o2: Optic<B, C>
Returns Writable<Cell<C>>
Inherited from Cell.through
- Defined in src/core/cell.ts:893
through<B, C, D>(
 this: Cell<V>,
 o1: Optic<V, B>,
 o2: Optic<B, C>,
 o3: Optic<C, D>,
): Writable<Cell<D>>
Apply optic value(s) as a writable lens: c.through(o) ≡ lens(c, o.get, o.put); multiple optics compose left-to-right (c.through(a, b) = a then b). Cross-type, unlike the endomorphic instance .lens.
Type Parameters
- B
- C
- D
Parameters
- this: Cell<V>
- o1: Optic<V, B>
- o2: Optic<B, C>
- o3: Optic<C, D>
Returns Writable<Cell<D>>
Inherited from Cell.through
- Defined in src/core/cell.ts:894

to

to(this: Writable<Box>, target: V, dur: Val<number>, ease?: Easing): Tween<V>
Tween-builder.
Parameters
- this: Writable<Box>
- target: V
- dur: Val<number>
- Optionalease: Easing
Returns Tween<V>
- 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:987

`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:932
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:937
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:942

`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:981

`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. 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), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
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:952
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. 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), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
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:958
lens<C extends AnyCellCtor, P, Cm>(
 this: C,
 parent: Read,
 spec: StatefulLensSpec1<P, Inner<InstanceType<C>>, Cm>,
): Writable<InstanceType<C>>
Writable lens. 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), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P
- Cm
Parameters
- this: C
- parent: Read
- spec: StatefulLensSpec1<P, Inner<InstanceType<C>>, Cm>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:964
lens<C extends AnyCellCtor, P extends readonly Read<unknown>[], Cm>(
 this: C,
 parents: P,
 spec: StatefulLensSpec<ReadValues, Inner<InstanceType<C>>, Cm>,
): Writable<InstanceType<C>>
Writable lens. 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), spec) builds a complement-carrying lens from { init, step, fwd, bwd }.
Type Parameters
- C extends AnyCellCtor
- P extends readonly Read<unknown>[]
- Cm
Parameters
- this: C
- parents: P
- spec: StatefulLensSpec<ReadValues, Inner<InstanceType<C>>, Cm>
Returns Writable<InstanceType<C>>
Inherited from Cell.lens
- Defined in src/core/cell.ts:969

`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:1000

Properties

`Readonly`_t

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

Type Declaration

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

name

name: string | undefined

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

`Readonly`value

value: V

`Static`traits

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

Type Declaration

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

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

lerp

Parameters

Returns Box

merge

Parameters

Returns Cell<V>

peek

Returns V

scale

Parameters

Returns this

sub

Parameters

Returns this

through

Type Parameters

Parameters

Returns Writable<Cell<B>>

Type Parameters

Parameters

Returns Writable<Cell<C>>

Type Parameters

Parameters

Returns Writable<Cell<D>>

to

Parameters

Returns Tween<V>

Staticcoerce

`Static`coerce

`Static`derive

`Static`is

`Static`lens

`Static`pin

`Readonly`_t

`Readonly`value

`Static`traits