The selection context this session publishes its note selection in; hand it to ProjectSelectionService.snapshot and friends. null when the session has none.

Functions

beginDrag

open override fun beginDrag()

A move drag works from the notes as they were when it began, so each update re-applies one delta rather than accumulating rounding. The session holds that snapshot: say when the drag starts, how far it has moved, and whether it ended or was cancelled.

cancelDrag

open override fun cancelDrag()

commit

open override fun commit(app: AppModel): Boolean

Writes the session back to the clip, through the undo history.

createNote

open override fun createNote(startSeconds: Double, durationSeconds: Double, note: Int, velocity: Float)

deleteNote

open override fun deleteNote(index: Int)

finishDrag

open override fun finishDrag(index: Int, originalStart: Double, originalEnd: Double, originalNote: Int)

isNoteSelected

open override fun isNoteSelected(index: Int): Boolean

isObjectSelected

open override fun isObjectSelected(referenceId: String): Boolean

loadNotes

open override fun loadNotes(snapshot: PianoRollSnapshot?)

matchesSource

open override fun matchesSource(snapshot: PianoRollSnapshot): Boolean

Whether this session was built from that snapshot's UMP stream. False means the clip changed underneath and the session must be reloaded — which is what stops an edit being applied to a clip it was not made against.

moveSelection

open override fun moveSelection(timeDeltaSeconds: Double, pitchDelta: Int)

noteReferenceId

open override fun noteReferenceId(index: Int): String?

The document reference id of the note at index, or null for an unknown index.

performAction

open override fun performAction(action: PianoRollAction, pasteSeconds: Double = 0.0)

resizeNote

open override fun resizeNote(index: Int, startSeconds: Double, durationSeconds: Double, note: Int)

selectNote

open override fun selectNote(index: Int, additive: Boolean = false, toggle: Boolean = false)

index -1 clears the selection.

selectObject

open override fun selectObject(referenceId: String, additive: Boolean = false, toggle: Boolean = false)

Selects (or, with toggle, flips) a note or automation point by reference id, then makes this session's context the active one. additive keeps the rest of the selection.

syncSelection

open override fun syncSelection()

Re-reads the session's selection from the selection service, for when it changed elsewhere.