de.sciss.lucre.synth.NodeRef.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of lucresynth_2.11 Show documentation

Transactional extension for ScalaCollider

There is a newer version: 3.30.0

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

package de.sciss.lucre.synth

import de.sciss.lucre.stm
import de.sciss.lucre.stm.Disposable
import de.sciss.synth.ControlSet
import de.sciss.topology

object NodeRef {
  trait Full[S <: stm.Sys[S]] extends NodeRef with Disposable[S#Tx] {

    /** Adds a user to the node-ref. If it is already playing,
      * it successively calls `user.add()`.
      */
    def addUser(user: DynamicUser)(implicit tx: Txn): Unit

    /** Removes a user from the node-ref. __Note:__ If the node-ref
      * is already playing, it currently does not call `user.remove()`,
      * but this must be done by the caller.
      * XXX TODO -- perhaps we should change that?
      */
    def removeUser(user: DynamicUser)(implicit tx: Txn): Unit

    def addResource   (resource: Resource)(implicit tx: Txn): Unit
    def removeResource(resource: Resource)(implicit tx: Txn): Unit

    def addControl(pair: ControlSet)(implicit tx: S#Tx): Unit
  }

  final case class Edge(source: NodeRef, sink: NodeRef)
    extends topology.Edge[NodeRef] {

    def sourceVertex: NodeRef = source
    def targetVertex: NodeRef = sink
  }
}
trait NodeRef {
  def server: Server
  def node(implicit tx: Txn): Node
}