Class Bounce

Fires

bounce-start-x

Fires

bounce.end-x

Fires

bounce-start-y

Fires

bounce-end-y

Hierarchy (View Summary)

Plugin
- Bounce

Index

Constructors

constructor

new Bounce(parent: Viewport, options?: IBounceOptions): Bounce
This is called by Viewport.bounce.
Parameters
- parent: Viewport
- options: IBounceOptions = {}
Returns Bounce
Overrides Plugin.constructor
- Defined in src/plugins/Bounce.ts:113

Properties

`Readonly`bottom

bottom: boolean

Holds whether to bounce from bottom side.

`Protected`ease

ease: any

Easing

`Readonly`left

left: boolean

Holds whether to bounce from left side.

`Readonly`options

options: Readonly<Required<IBounceOptions>>

The options passed to initialize this plugin, cannot be modified again.

`Readonly`parent

parent: Viewport

The viewport to which this plugin is attached.

paused

paused: boolean

Flags whether this plugin has been "paused".

See

Plugin#pause
Plugin#resume

`Readonly`right

right: boolean

Holds whether to bounce from right side.

`Readonly`top

top: boolean

Holds whether to bounce from top side.

`Protected`toX

toX: IBounceState | null

Bounce state along x-axis

`Protected`toY

toY: IBounceState | null

Bounce state along y-axis

`Readonly`underflowX

underflowX: -1 | 0 | 1

Direction of underflow along x-axis.

`Readonly`underflowY

underflowY: -1 | 0 | 1

Direction of underflow along y-axis.

Methods

bounce

bounce(): void
Returns void
- Defined in src/plugins/Bounce.ts:314

destroy

destroy(): void
Called when plugin is removed

Returns void
Inherited from Plugin.destroy
- Defined in src/plugins/Plugin.ts:64

down

down(): boolean
Handler for pointerdown PIXI event

Returns boolean
Overrides Plugin.down
- Defined in src/plugins/Bounce.ts:172

`Protected`globalToParent

globalToParent<P extends PointData>(point: PointData, out: P): P
Converts a global point to the space the viewport moves in: its parent's, or global if it has no parent. A viewport can't measure in its own space, because that space changes as the viewport moves.
Type Parameters
- P extends PointData
Parameters
- point: PointData
- out: P
Returns P
Inherited from Plugin.globalToParent
- Defined in src/plugins/Plugin.ts:35

isActive

isActive(): boolean
Returns boolean
- Defined in src/plugins/Bounce.ts:167

move

move(_e: FederatedEvent): boolean
Handler for pointermove PIXI event
Parameters
- _e: FederatedEvent
Returns boolean
Inherited from Plugin.move
- Defined in src/plugins/Plugin.ts:76

`Protected`parentToViewport

parentToViewport<P extends PointData>(point: PointData, out: P): P
Converts a point in the viewport's parent space (see globalToParent) to the viewport's local space
Type Parameters
- P extends PointData
Parameters
- point: PointData
- out: P
Returns P
Inherited from Plugin.parentToViewport
- Defined in src/plugins/Plugin.ts:50

pause

pause(): void
Pause the plugin

Returns void
Inherited from Plugin.pause
- Defined in src/plugins/Plugin.ts:115

reset

reset(): void
Called when the viewport is manually moved

Returns void
Overrides Plugin.reset
- Defined in src/plugins/Bounce.ts:396

resize

resize(): void
Called when the viewport is resized

Returns void
Inherited from Plugin.resize
- Defined in src/plugins/Plugin.ts:103

resume

resume(): void
Un-pause the plugin

Returns void
Inherited from Plugin.resume
- Defined in src/plugins/Plugin.ts:121

up

up(): boolean
Handler for pointerup PIXI event

Returns boolean
Overrides Plugin.up
- Defined in src/plugins/Bounce.ts:179

update

update(elapsed: number): void
Called on each tick
Parameters
- elapsed: number
Returns void
Overrides Plugin.update
- Defined in src/plugins/Bounce.ts:186

`Protected`viewportToParent

viewportToParent<P extends PointData>(point: PointData, out: P): P
Converts a point in the viewport's local space to its parent space (see globalToParent)
Type Parameters
- P extends PointData
Parameters
- point: PointData
- out: P
Returns P
Inherited from Plugin.viewportToParent
- Defined in src/plugins/Plugin.ts:56

wheel

wheel(_e: WheelEvent): boolean | undefined
Handler for wheel event on div
Parameters
- _e: WheelEvent
Returns boolean | undefined
Inherited from Plugin.wheel
- Defined in src/plugins/Plugin.ts:88

Class Bounce

Fires

Fires

Fires

Fires

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Bounce

Properties

Readonlybottom

Protectedease

Readonlyleft

Readonlyoptions

Readonlyparent

paused

See

Readonlyright

Readonlytop

ProtectedtoX

ProtectedtoY

ReadonlyunderflowX

ReadonlyunderflowY

Methods

bounce

Returns void

destroy

Returns void

down

Returns boolean

ProtectedglobalToParent

Type Parameters

Parameters

Returns P

isActive

Returns boolean

move

Parameters

Returns boolean

ProtectedparentToViewport

Type Parameters

Parameters

Returns P

pause

Returns void

reset

Returns void

resize

Returns void

resume

Returns void

up

Returns boolean

update

Parameters

Returns void

ProtectedviewportToParent

Type Parameters

Parameters

Returns P

wheel

Parameters

Returns boolean | undefined

Settings

On This Page

`Readonly`bottom

`Protected`ease

`Readonly`left

`Readonly`options

`Readonly`parent

`Readonly`right

`Readonly`top

`Protected`toX

`Protected`toY

`Readonly`underflowX

`Readonly`underflowY

`Protected`globalToParent

`Protected`parentToViewport

`Protected`viewportToParent