ddf.minim

Class UGen.UGenInput

java.lang.Object

ddf.minim.UGen.UGenInput

Enclosing class:

UGen

public final class UGen.UGenInput
extends java.lang.Object

A UGenInput represents parameter of the UGen that can be controlled by other UGens by patching to it. When not patched, a UGenInput produces a constant value, which can be changed at any time by calling setLastValue.

A UGenInput will have an InputType of either AUDIO or CONTROL. An AUDIO input will always have the same number of channels as the owning UGen, in other words the length of the array returned by getLastValues will have a length equal to channel count. A CONTROL input will always have one channel and its value can be conveniently queried by calling getLastValue().

Author:

Anderson Mills

Constructor Summary

Constructors

Constructor and Description
UGenInput(UGen.InputType type) Create a UGenInput with a particular type.
UGenInput(UGen.InputType type, float value) Create a UGenInput of the specified type with an initial value.

Method Summary

Modifier and Type	Method and Description
int	channelCount() Returns how many channels this UGenInput generates.
UGen	getIncomingUGen() The incoming UGen is the UGen that is patched to this UGenInput.
UGen.InputType	getInputType() Returns the InputType of this UGenInput.
java.lang.String	getInputTypeAsString()
float	getLastValue() Returns the first value in the array of last values.
float[]	getLastValues() Access the last values generated by this input.
UGen	getOuterUGen() The outer UGen is the UGen that owns this input.
boolean	isPatched() Returns true if a UGen is patched to this UGenInput.
void	printInput() Print information about this UGenInput (for debugging)
void	setChannelCount(int numberOfChannels) Set the number of channels this input should generate.
void	setIncomingUGen(UGen in) This method is called when a UGen is patched to this input.
void	setLastValue(float value) Sets all values in the last values array to the provided value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UGenInput

public UGenInput(UGen.InputType type)

Create a UGenInput with a particular type.

Parameters:

type - the InputType of this UGenInput

UGenInput

public UGenInput(UGen.InputType type,
                 float value)

Create a UGenInput of the specified type with an initial value.

Parameters:

type - the InputType of this UGenInput

value - the initial float value used for all last values

Method Detail

setChannelCount

public void setChannelCount(int numberOfChannels)

Set the number of channels this input should generate. This will be called by the owning UGen if this input is an AUDIO input.

Parameters:

numberOfChannels - how many channels this input should generate

channelCount

public int channelCount()

Returns how many channels this UGenInput generates.

Returns:

int: how many channels this input generates

getInputType

public UGen.InputType getInputType()

Returns the InputType of this UGenInput.

Returns:

InputType: either AUDIO or CONTROL

getOuterUGen

public UGen getOuterUGen()

The outer UGen is the UGen that owns this input. For instance, calling this on the frequency UGenInput member of an Oscil will return the Oscil.

Returns:

the UGen that owns this UGenInput

getIncomingUGen

public UGen getIncomingUGen()

The incoming UGen is the UGen that is patched to this UGenInput. When this input is ticked, it will tick the incoming UGen and store the result in its last values.

Returns:

the UGen that is patched to this UGenInput

setIncomingUGen

public void setIncomingUGen(UGen in)

This method is called when a UGen is patched to this input. Typically you will not call this method directly, use UGen's patch method instead.

Parameters:

in - the UGen being patched to this input

isPatched

public boolean isPatched()

Returns true if a UGen is patched to this UGenInput.

Returns:

true if a UGen is patched to this UGenInput

getLastValues

public float[] getLastValues()

Access the last values generated by this input.

Returns:

float[]: the last values generated by this input

getLastValue

public float getLastValue()

Returns the first value in the array of last values. This is meant to make code that gets values from CONTROL inputs easier to read.

Returns:

float: the last value generated by this input

setLastValue

public void setLastValue(float value)

Sets all values in the last values array to the provided value. If you want to set last values in the different channels of this input to different values, you should use getLastValues to do so. For example:

 ugen.anInput.getLastValues()[0] = 1.f;
 ugen.anInput.getLastValues()[1] = 0.f;
 

Parameters:

value - float: the value to set all last values to

getInputTypeAsString

public java.lang.String getInputTypeAsString()

Returns:

the InputType as a string (for debugging)

printInput

public void printInput()

Print information about this UGenInput (for debugging)