import ContextEditionState from 'waves-ui-piper/src/states/context-edition-state.js'

public class | source

ContextEditionState

Extends:

BaseState → ContextEditionState

A state to interact directly with layers time contexts.

example usage, see. advanced usage

Constructor Summary

Public Constructor
public	constructor(timeline: *)

Member Summary

Public Members
public	currentLayer: *
public	currentTarget: *
public	mouseDown: boolean

Method Summary

Public Methods
public	handleEvent(e: *)
public	onMouseDown(e: *)
public	onMouseMove(e: *)
public	onMouseUp(e: *)

Inherited Summary

From class BaseState
public get	layers: Array<Layer> Returns all registered layers.
public get	tracks: TrackCollection<Track> Returns timeline tracks collection.
public	timeline: Timeline 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:

Name	Type	Attribute	Description
timeline	*

Public Members

public currentLayer: * source

public currentTarget: * source

public mouseDown: boolean 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:

Name	Type	Attribute	Description
e	*

public onMouseDown(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public onMouseMove(e: *) source

Params:

Name	Type	Attribute	Description
e	*

public onMouseUp(e: *) source

Params:

Name	Type	Attribute	Description
e	*