de.sciss.synth.proc.AuralView.scala Maven / Gradle / Ivy

Go to download
/*
 *  AuralView.scala
 *  (SoundProcesses)
 *
 *  Copyright (c) 2010-2016 Hanns Holger Rutz. All rights reserved.
 *
 *	This software is published under the GNU General Public License v2+
 *
 *
 *  For further information, please contact Hanns Holger Rutz at
 *  [email protected]
 */

package de.sciss.synth.proc

import de.sciss.lucre.event.Observable
import de.sciss.lucre.stm
import de.sciss.lucre.stm.{Obj, Disposable, Sys}

object AuralView {
  /* The current state a view is in. */
  sealed trait State
  case object Stopped   extends State
  case object Preparing extends State
  case object Prepared  extends State
  case object Playing   extends State
}
/** A trait that provides a shared structure for `AuralObj` and `AuralAttribute`,
  * the only difference being the `Target` context type needed for issuing a play.
  */
trait AuralView[S <: Sys[S], Target] extends Observable[S#Tx, AuralView.State] with Disposable[S#Tx] {
  def typeID: Int

  /** The view must store a handle to its underlying model. */
  def obj: stm.Source[S#Tx, Obj[S]]

  def state(implicit tx: S#Tx): AuralView.State

  def prepare(timeRef: TimeRef.Option                )(implicit tx: S#Tx): Unit
  def play   (timeRef: TimeRef.Option, target: Target)(implicit tx: S#Tx): Unit

  def stop()(implicit tx: S#Tx): Unit
}