pixi-reels

ReelAxis

pixi-reels


pixi-reels / index / ReelAxis

Interface: ReelAxis

Defined in: core/ReelAxis.ts:29

Immutable projection between screen space and a reel’s travel/cross axes.

One per reel, built by the builder and injected into ReelMotion, Reel, and every phase. It carries no per-frame allocation on the hot path - addMain is one property lookup and one +=. See ADR 016 sections 3.1-3.2.

The point is to keep direction (“which way is backwards for this reel”) out of the sign of a raw delta, and orientation (“which screen axis”) out of a hardcoded .y. Public geometry stays screen-space (see toLocal/toScreen), so third-party ReelSymbol subclasses are unaffected.

Properties#

PropertyModifierTypeDescriptionDefined in
crossPropreadonly"x" | "y"Pixi / GSAP property key for the reel-marching axis.core/ReelAxis.ts:37
directionreadonlyDirection-core/ReelAxis.ts:31
feedEdgereadonly"start" | "end"Which strip edge new symbols enter from: ‘start’ when polarity > 0.core/ReelAxis.ts:39
mainPropreadonly"x" | "y"Pixi / GSAP property key for the travel axis.core/ReelAxis.ts:35
orientationreadonlyOrientation-core/ReelAxis.ts:30
polarityreadonly-1 | 1+1 for ‘forward’, -1 for ‘reverse’.core/ReelAxis.ts:33

Methods#

addMain()#

addMain(view: Container, d: number): void;

Defined in: core/ReelAxis.ts:43

Parameters#

ParameterType
viewContainer
dnumber

Returns#

void


getCross()#

getCross(view: Container): number;

Defined in: core/ReelAxis.ts:44

Parameters#

ParameterType
viewContainer

Returns#

number


getMain()#

getMain(view: Container): number;

Defined in: core/ReelAxis.ts:41

Parameters#

ParameterType
viewContainer

Returns#

number


setCross()#

setCross(view: Container, v: number): void;

Defined in: core/ReelAxis.ts:45

Parameters#

ParameterType
viewContainer
vnumber

Returns#

void


setMain()#

setMain(view: Container, v: number): void;

Defined in: core/ReelAxis.ts:42

Parameters#

ParameterType
viewContainer
vnumber

Returns#

void


toLocal()#

toLocal(width: number, height: number): {
  cross: number;
  main: number;
};

Defined in: core/ReelAxis.ts:47

Screen-space (width, height) to (cross size, main size).

Parameters#

ParameterType
widthnumber
heightnumber

Returns#

{
  cross: number;
  main: number;
}
NameTypeDefined in
crossnumbercore/ReelAxis.ts:47
mainnumbercore/ReelAxis.ts:47

toScreen()#

toScreen(cross: number, main: number): {
  x: number;
  y: number;
};

Defined in: core/ReelAxis.ts:49

(cross, main) to screen-space (x, y).

Parameters#

ParameterType
crossnumber
mainnumber

Returns#

{
  x: number;
  y: number;
}
NameTypeDefined in
xnumbercore/ReelAxis.ts:49
ynumbercore/ReelAxis.ts:49