Autoplay

Since version 4.0.0

source

A manager class for autoplay feature.

class Autoplay

Properties

canInterrupt

Whether user can interrupt the rotation with click/wheel input

delay

Reactivation delay after mouse input in milisecond.

delayOnMouseLeave

Reactivation delay after mouse leave when using pauseOnHover

disableOnInterrupt

Whether to disable autoplay on user interrupt

enabled

Whether autoplay is enabled or not

pauseOnHover

Whether to pause rotation on mouse hover

playing

Whether autoplay is updating the camera at the moment

speed

Y-axis(yaw) rotation speed

Methods

destroy

Destroy the instance and remove all event listeners attached

disable

Disable autoplay and remove all event handlers.

enable

Enable autoplay and add event listeners.

enableAfterDelay

Enable autoplay after current delay value.

update

Rotate camera by given deltaTime

Constructor

Create new AutoPlayer instance

new Autoplay(viewer: View360, element: HTMLElement, options: boolean | Partial<AutoplayOptions>): Autoplay

Parameters

viewer

View360

element

HTMLElement

Canvas element

options

boolean | Partial<AutoplayOptions>

Autoplay options

Properties

canInterrupt

>=4.0.0

canInterrupt

boolean

true

Whether user can interrupt the rotation with click/wheel input

source

delay

>=4.0.0

delay

number

2000

Reactivation delay after mouse input in milisecond.

source

delayOnMouseLeave

>=4.0.0

delayOnMouseLeave

number

0

Reactivation delay after mouse leave when using pauseOnHover

source

disableOnInterrupt

>=4.0.0

disableOnInterrupt

boolean

false

Whether to disable autoplay on user interrupt

source

enabled

>=4.0.0

readonly

enabled

boolean

Whether autoplay is enabled or not

source

pauseOnHover

>=4.0.0

pauseOnHover

boolean

false

Whether to pause rotation on mouse hover

source

playing

>=4.0.0

readonly

playing

boolean

Whether autoplay is updating the camera at the moment

source

speed

>=4.0.0

speed

number

1

Y-axis(yaw) rotation speed

source

Methods

destroy

>=4.0.0

destroy

void

destroy(): void

Destroy the instance and remove all event listeners attached

source

disable

>=4.0.0

disable

void

disable(): void

Disable autoplay and remove all event handlers.

source

enable

>=4.0.0

enable

void

enable(): void

Enable autoplay and add event listeners.

source

enableAfterDelay

>=4.0.0

enableAfterDelay

void

enableAfterDelay(): void

Enable autoplay after current delay value.

source

update

>=4.0.0

update

void

update(deltaTime: number): void

Rotate camera by given deltaTime

Parameters

deltaTime

number

Number of milisec to update

source