Skip to main content

Class: KeyPlayHandler

component.KeyPlayHandler

The KeyPlayHandler allows the user to control the play behavior using the following key commands:

Spacebar: Start or stop playing. SHIFT + D: Switch direction. <: Decrease speed. >: Increase speed.

example

var keyboardComponent = viewer.getComponent("keyboard");
keyboardComponent.keyPlay.disable();keyboardComponent.keyPlay.enable();
var isEnabled = keyboardComponent.keyPlay.isEnabled;

Hierarchy#

Accessors#

isEnabled#

• get isEnabled(): boolean

Returns a Boolean indicating whether the interaction is enabled.

Returns#

boolean

true if the interaction is enabled.

Defined in#

component/util/HandlerBase.ts:31

Methods#

disable#

â–¸ disable(): void

Disables the interaction.

example

<component-name>.<handler-name>.disable();

Returns#

void

Inherited from#

HandlerBase.disable

Defined in#

component/util/HandlerBase.ts:60


enable#

â–¸ enable(): void

Enables the interaction.

example

<component-name>.<handler-name>.enable();

Returns#

void

Inherited from#

HandlerBase.enable

Defined in#

component/util/HandlerBase.ts:43