Home Manual Reference Source Repository
import CenteredZoomState from 'waves-ui-piper/src/states/centered-zoom-state.js'
public class | source

CenteredZoomState

Extends:

BaseState → CenteredZoomState

CenteredZoomState is a timeline state mimicing the Live zoom interaction. It allows the user to browse the timeline by clicking on a track, and then

  • moving down to zoom in
  • moving up to zoom out
  • moving left to move in time, after
  • moving right to move in time, before

example usage

Constructor Summary

Public Constructor
public

constructor(timeline: *)

Member Summary

Public Members
public
public
public
public
public
public
public
public

maxZoom: *

public

minZoom: *

Method Summary

Public Methods
public

handleEvent(e: *)

public

onMouseDown(e: *)

public

onMouseMove(e: *)

public

onMouseUp(e: *)

public

Inherited Summary

From class BaseState
public get

Returns all registered layers.

public get

Returns timeline tracks collection.

public

A reference to the timeline on which the state should be installed.

public

enter()

Called when the timeline is entering the state.

public

exit()

Called when the timeline is leaving the state.

public

handleEvent(e: WaveEvent, hitLayers: Array)

Main interface method to override when creating a new State.

Public Constructors

public constructor(timeline: *) source

Returns timeline tracks collection.

Override:

BaseState#constructor

Params:

NameTypeAttributeDescription
timeline *

Public Members

public currentLayer: * source

public dragMode: string source

public initialCenterTime: * source

public initialOffset: * source

public initialX: * source

public initialY: * source

public initialZoom: * source

public maxZoom: * source

public minZoom: * source

Public Methods

public handleEvent(e: *) source

Main interface method to override when creating a new State. Handle event from mouse or keyboard, should define behavior according to the event (aka. mousedown, mouseup, ...).

Override:

BaseState#handleEvent

Params:

NameTypeAttributeDescription
e *

public onMouseDown(e: *) source

Params:

NameTypeAttributeDescription
e *

public onMouseMove(e: *) source

Params:

NameTypeAttributeDescription
e *

public onMouseUp(e: *) source

Params:

NameTypeAttributeDescription
e *

public updateDragMode(e: *) source

Params:

NameTypeAttributeDescription
e *