net.beadsproject.beads.ugens

Class Mult

java.lang.Object

net.beadsproject.beads.core.Bead

net.beadsproject.beads.core.UGen

net.beadsproject.beads.ugens.Mult

public class Mult
extends UGen

Takes an incoming signal (or signals in the multi-channel case) and multiplies it with something (another signal or a float value).

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

Constructors

Constructor and Description
Mult(AudioContext context, int channels, float multiplier) Constructor for a Mult object with a static multiplier value.
Mult(AudioContext context, int channels, UGen multiplierUGen) Constructor for a Mult object with a UGen controlling the multiplier value.
Mult(AudioContext context, UGen input, UGen multiplierUGen) Constructor for a Mult object with a given UGen as input and another as multiplier.

Method Summary

Modifier and Type	Method and Description
void	calculateBuffer() Called by the signal chain to update this UGen's ouput data.
float	getMultiplier() Gets the current multiplier value.
UGen	getMultiplierUGen() Gets the multiplier UGen controller.
Mult	setMultiplier(float multiplier) Sets the multiplier to a static float value.
Mult	setMultiplier(UGen multiplierUGen) Sets a UGen to control the multiplier 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

Mult

public Mult(AudioContext context,
            int channels,
            float multiplier)

Constructor for a Mult object with a static multiplier value.

Parameters:

context - The audio context.

channels - The number of channels.

multiplier - The multiplier value.

Mult

public Mult(AudioContext context,
            int channels,
            UGen multiplierUGen)

Constructor for a Mult object with a UGen controlling the multiplier value.

Parameters:

context - The audio context.

channels - The number of channels.

multiplierUGen - The UGen controlling the multiplier value.

Mult

public Mult(AudioContext context,
            UGen input,
            UGen multiplierUGen)

Constructor for a Mult object with a given UGen as input and another as multiplier. i.e., use this as quickest way to multiply two UGens together.

Parameters:

context - the AudioContext.

input - the input UGen.

multiplierUGen - the multiplier UGen.

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

getMultiplier

public float getMultiplier()

Gets the current multiplier value.

Returns:

The multiplier.

setMultiplier

public Mult setMultiplier(float multiplier)

Sets the multiplier to a static float value.

Parameters:

multiplier - The new multiplier value.

Returns:

This Mult instance.

setMultiplier

public Mult setMultiplier(UGen multiplierUGen)

Sets a UGen to control the multiplier value.

Parameters:

multiplierUGen - The multiplier UGen.

Returns:

This Mult instance.

getMultiplierUGen

public UGen getMultiplierUGen()

Gets the multiplier UGen controller.

Returns:

The multipler UGen controller.