Class Pinch

Plugin for enabling two-finger pinching (or dragging).

Hierarchy (View Summary)

Plugin
- Pinch

Index

Constructors

Properties

active lastCenter? moved options parent paused pinching

Methods

destroy down globalToParent isAxisX isAxisY move parentToViewport pause reset resize resume up update viewportToParent wheel

Constructors

constructor

new Pinch(parent: Viewport, options?: IPinchOptions): Pinch
This is called by Viewport.pinch.
Parameters
- parent: Viewport
- options: IPinchOptions = {}
Returns Pinch
Overrides Plugin.constructor
- Defined in src/plugins/Pinch.ts:73

Properties

active

active: boolean = false

Flags whether this plugin is active, i.e. a pointer is down on the viewport.

`Protected` `Optional`lastCenter

lastCenter?: PointData | null

`Protected`moved

moved: boolean = false

`Readonly`options

options: Required<IPinchOptions>

Options used to initialize this plugin.

`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

pinching

pinching: boolean = false

Flags whether the viewport is being pinched.

Methods

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/Pinch.ts:79

`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

isAxisX

isAxisX(): boolean
Returns boolean
- Defined in src/plugins/Pinch.ts:91

isAxisY

isAxisY(): boolean
Returns boolean
- Defined in src/plugins/Pinch.ts:96

move

move(e: FederatedPointerEvent): boolean
Handler for pointermove PIXI event
Parameters
- e: FederatedPointerEvent
Returns boolean
Overrides Plugin.move
- Defined in src/plugins/Pinch.ts:101

`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
Inherited from Plugin.reset
- Defined in src/plugins/Plugin.ts:109

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/Pinch.ts:220

update

update(_elapsed: number): void
Called on each tick
Parameters
- _elapsed: number
  time in milliseconds since last update
Returns void
Inherited from Plugin.update
- Defined in src/plugins/Plugin.ts:97

`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