Class Follow

Plugin to follow a display-object.

See

Viewport.follow

Hierarchy (View Summary)

Plugin
- Follow

Index

Constructors

Properties

options parent paused target velocity

Methods

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

Constructors

constructor

new Follow(
    parent: Viewport,
    target: Container,
    options?: IFollowOptions,
): Follow
This is called by Viewport.follow.
Parameters
- parent: Viewport
- target: Container
  target to follow
- options: IFollowOptions = {}
Returns Follow
Overrides Plugin.constructor
- Defined in src/plugins/Follow.ts:67

Properties

`Readonly`options

options: Required<IFollowOptions>

The 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

target

target: Container

The target this plugin will make the viewport follow.

`Protected`velocity

velocity: PointData

The velocity provided the viewport by following, at the current time.

Methods

destroy

destroy(): void
Called when plugin is removed

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

down

down(_e: FederatedEvent): boolean
Handler for pointerdown PIXI event
Parameters
- _e: FederatedEvent
Returns boolean
Inherited from Plugin.down
- Defined in src/plugins/Plugin.ts:70

`Protected`getTargetPosition

getTargetPosition(): PointData
Target's position in world coordinates (handles targets nested inside other containers)

Returns PointData
- Defined in src/plugins/Follow.ts:77

`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

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
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(_e: FederatedEvent): boolean
Handler for pointerup PIXI event
Parameters
- _e: FederatedEvent
Returns boolean
Inherited from Plugin.up
- Defined in src/plugins/Plugin.ts:82

update

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

`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