net.beadsproject.beads.ugens
Class Add

java.lang.Object
  extended by net.beadsproject.beads.core.Bead
      extended by net.beadsproject.beads.core.UGen
          extended by net.beadsproject.beads.ugens.Add

public class Add
extends UGen

Takes an incoming signal (or signals in the multi-channel case) and adds something (either a float value or another signal) to it (them).

Version:
0.9.5
Author:
ollie, Benito Crawford

Nested Class Summary
 
Nested classes/interfaces inherited from class net.beadsproject.beads.core.UGen
UGen.OutputInitializationRegime, UGen.OutputPauseRegime
 
Field Summary
 
Fields inherited from class net.beadsproject.beads.core.UGen
bufferSize, bufIn, bufOut, context, ins, outputInitializationRegime, outputPauseRegime, outs
 
Constructor Summary
Add(AudioContext context, int channels, float adder)
          Constructor for an Add object that sets a static adder value.
Add(AudioContext context, int channels, UGen adderUGen)
          Constructor for an Add object that sets a UGen to control the value to add.
Add(AudioContext context, UGen input, UGen adderUGen)
          Constructor for an Add object with a given UGen as input and another as adder.
 
Method Summary
 void calculateBuffer()
          Called by the signal chain to update this UGen's ouput data.
 float getAdder()
          Gets the current adder value.
 UGen getAdderUGen()
          Gets the adder UGen controller.
 Add setAdder(float adder)
          Sets the adder to a static float value.
 Add setAdder(UGen adderUGen)
          Sets a UGen to control the adder value.
 
Methods inherited from class net.beadsproject.beads.core.UGen
addDependent, addInput, addInput, clearDependents, clearInputConnections, containsInput, crossfadeInput, getConnectedInputs, getContext, getEnvelopes, getIns, getNumberOfConnectedUGens, getNumberOfDependents, getOutBuffer, getOuts, getTimeTakenLastUpdate, getValue, getValue, getValueDouble, getValueDouble, initializeOuts, isTimerMode, isUpdated, noInputs, pause, printInBuffers, printInputList, printOutBuffers, removeAllConnections, removeConnection, removeDependent, setOutsToPause, setTimerMode, setValue, update, zeroIns, zeroOuts
 
Methods inherited from class net.beadsproject.beads.core.Bead
getKillListener, getName, isDeleted, isPaused, kill, message, messageReceived, setKillListener, setName, start, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Add

public Add(AudioContext context,
           int channels,
           UGen adderUGen)
Constructor for an Add object that sets a UGen to control the value to add.

Parameters:
context - The audio context.
channels - The number of channels.
adderUGen - The adder UGen controller.

Add

public Add(AudioContext context,
           UGen input,
           UGen adderUGen)
Constructor for an Add object with a given UGen as input and another as adder. i.e., use this as quickest way to add two UGens together.

Parameters:
context - the AudioContext.
input - the input UGen.
adderUGen - the adder UGen.

Add

public Add(AudioContext context,
           int channels,
           float adder)
Constructor for an Add object that sets a static adder value.

Parameters:
context - The audio context.
channels - The number of channels.
adder - The value to add.
Method Detail

calculateBuffer

public void calculateBuffer()
Description copied from class: UGen
Called by the signal chain to update this UGen's ouput data. Subclassses of UGen should implement the UGen's DSP perform routine here. In general this involves grabbing data from UGen.bufIn and putting data into UGen.bufOut in some way. UGen.bufIn and UGen.bufOut are 2D arrays of floats of the form float[numChannels][bufferSize]. The length of the buffers is given by UGen.bufferSize, and the number of channels of the input and output buffers are given by UGen.ins and UGen.outs respectively.

Specified by:
calculateBuffer in class UGen

getAdder

public float getAdder()
Gets the current adder value.

Returns:
The adder value.

setAdder

public Add setAdder(float adder)
Sets the adder to a static float value.

Parameters:
adder - The new adder value.
Returns:
This Add instance.

setAdder

public Add setAdder(UGen adderUGen)
Sets a UGen to control the adder value.

Parameters:
adderUGen - The adder UGen controller.
Returns:
This Add instance.

getAdderUGen

public UGen getAdderUGen()
Gets the adder UGen controller.

Returns:
The adder UGen controller.