de.sciss.fscape.graph.Progress.scala Maven / Gradle / Ivy

Go to download
/*
 *  Progress.scala
 *  (FScape)
 *
 *  Copyright (c) 2001-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.fscape
package graph

import de.sciss.fscape.stream.StreamIn

import scala.collection.immutable.{IndexedSeq => Vec}

/** A UGen that contributes to the progress monitoring of a graph.
  * It is possible to instantiate multiple instances of this UGen,
  * in which cases their individual progress reports will simply
  * be added up (and clipped to the range from zero to one).
  *
  * @param in     progress fraction from zero to one
  * @param trig   trigger that causes the UGen to submit a snapshot
  *               of the progress to the control instance.
  * @param label  the label can be used to distinguish the
  *               contributions of different progress UGens
  */
final case class Progress(in: GE, trig: GE, label: String = "render")
  extends UGenSource.ZeroOut {

  protected def makeUGens(implicit b: UGenGraph.Builder): Unit =
  unwrap(Vector(in.expand, trig.expand))

  protected def makeUGen(args: Vec[UGenIn])(implicit b: UGenGraph.Builder): Unit =
  UGen.ZeroOut(this, inputs = args, rest = label)

  private[fscape] def makeStream(args: Vec[StreamIn])(implicit b: stream.Builder): Unit = {
    val Vec(in, trig) = args
    stream.Progress(in = in.toDouble, trig = trig.toInt, label = label)
  }
}