Waves

java.lang.Object
- ddf.minim.ugens.Waves

```
public class Waves
extends java.lang.Object
```
Waves provides some already constructed Wavetables for common waveforms, as well as methods for constructing some basic waveforms with non-standard parameters. For instance, you can use the QUARTERPULSE member if you want a typical "thin" square wave sound, but you might want a square wave with a 60% duty cycle instead, which you can create by passing 0.6f to the square method. Methods exist for generating basic waves with multiple harmonics, basic waves with different duty cycles, and noise.

Author:

Nicolas Brix, Anderson Mills

Field Summary

Fields
Modifier and Type	Field and Description
`static Wavetable`	`PHASOR` A perfect phasor wave going from 0 to 1.
`static Wavetable`	`QUARTERPULSE` A perfect square wave with a 25% duty cycle.
`static Wavetable`	`SAW` A perfect sawtooth wave.
`static Wavetable`	`SINE` A pure sine wave.
`static Wavetable`	`SQUARE` A perfect square wave with a 50% duty cycle.
`static Wavetable`	`TRIANGLE` A perfect triangle wave.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Wavetable`	`add(float[] amps, Waveform... waves)` Generates a Wavetable by adding any number of Waveforms, each scaled by an amplitude.
`static Wavetable`	`pulse(float dutyCycle)` Constructs a perfect square wave with the specified duty cycle.
`static Wavetable`	`randomNHarms(int numberOfHarmonics)` Constructs a waveform by summing together the first numberOfHarmonics in the harmonic series with randomly chosen amplitudes.
`static Wavetable`	`randomNOddHarms(int numberOfHarmonics)` Constructs a waveform by summing together the first odd numberOfHarmonics in the harmonic series (1, 3, 5, etc) with randomly chosen amplitudes.
`static Wavetable`	`randomNoise()` Constructs a Wavetable of randomly generated noise.
`static Wavetable`	`saw(float dutyCycle)` Constructs a perfect sawtooth wave with the specified duty cycle.
`static Wavetable`	`sawh(int numberOfHarmonics)` Builds an approximation of a perfect sawtooth wave by summing together harmonically related sine waves.
`static Wavetable`	`square(float dutyCycle)` Constructs a perfect square wave with the specified duty cycle.
`static Wavetable`	`squareh(int numberOfHarmonics)` Builds an approximation of a perfect square wave by summing together harmonically related sine waves.
`static Wavetable`	`triangle(float dutyCycle)` Constructs a perfect triangle wave with the specified duty cycle.
`static Wavetable`	`triangleh(int numberOfHarmonics)` Builds an approximation of a perfect triangle wave by summing together harmonically related sine waves.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SINE
```
public static final Wavetable SINE
```
    A pure sine wave.
  - SAW
```
public static final Wavetable SAW
```
    A perfect sawtooth wave.
  - PHASOR
```
public static final Wavetable PHASOR
```
    A perfect phasor wave going from 0 to 1.
  - SQUARE
```
public static final Wavetable SQUARE
```
    A perfect square wave with a 50% duty cycle.
  - TRIANGLE
```
public static final Wavetable TRIANGLE
```
    A perfect triangle wave.
  - QUARTERPULSE
```
public static final Wavetable QUARTERPULSE
```
    A perfect square wave with a 25% duty cycle.
- Method Detail
  - sawh
```
public static Wavetable sawh(int numberOfHarmonics)
```
    Builds an approximation of a perfect sawtooth wave by summing together harmonically related sine waves.
    
    Parameters:
    
    numberOfHarmonics - int: the number of harmonics to use in the approximation. 1 harmonic will simply generate a sine wave. The greater the number of harmonics used, the closer to a pure saw wave the approximation will be.
    
    Returns:
    
    a Wavetable
  - saw
```
public static Wavetable saw(float dutyCycle)
```
    Constructs a perfect sawtooth wave with the specified duty cycle.
    
    Parameters:
    
    dutyCycle - float: a sawtooth wave with a duty cycle of 0.5 will be a perfect sawtooth wave that smoothly changes from 1 to -1 with a zero-crossing in the middle. By changing the duty cycle, you change how much of the sawtooth is below zero. So, a duty cycle of 0.2 would result in 20 percent of the sawtooth below zero and the rest above. Duty cycle will be clamped to [0,1].
    
    Returns:
    
    Wavetable
  - squareh
```
public static Wavetable squareh(int numberOfHarmonics)
```
    Builds an approximation of a perfect square wave by summing together harmonically related sine waves.
    
    Parameters:
    
    numberOfHarmonics - int: the number of harmonics to use in the approximation. 1 harmonic will simply generate a sine wave. The greater the number of harmonics used, the closer to a pure saw wave the approximation will be.
    
    Returns:
    
    a Wavetable
  - square
```
public static Wavetable square(float dutyCycle)
```
    Constructs a perfect square wave with the specified duty cycle.
    
    Parameters:
    
    dutyCycle - float: a square wave with a duty cycle of 0.5 will be a perfect square wave that is 1 half the time and -1 the other half. By changing the duty cycle, you change how much of the square is below zero. So, a duty cycle of 0.2 would result in 20 percent of the square below zero and the rest above. Duty cycle will be clamped to [0,1].
    
    Returns:
    
    Wavetable
  - pulse
```
public static Wavetable pulse(float dutyCycle)
```
    Constructs a perfect square wave with the specified duty cycle.
    
    Parameters:
    
    dutyCycle - float: a square wave with a duty cycle of 0.5 will be a perfect square wave that is 1 half the time and -1 the other half. By changing the duty cycle, you change how much of the square is below zero. So, a duty cycle of 0.2 would result in 20 percent of the square below zero and the rest above. Duty cycle will be clamped to [0,1].
    
    Returns:
    
    Wavetable
  - triangleh
```
public static Wavetable triangleh(int numberOfHarmonics)
```
    Builds an approximation of a perfect triangle wave by summing together harmonically related sine waves.
    
    Parameters:
    
    numberOfHarmonics - int: the number of harmonics to use in the approximation. 1 harmonic will simply generate a sine wave. The greater the number of harmonics used, the closer to a pure saw wave the approximation will be.
    
    Returns:
    
    a Wavetable
  - triangle
```
public static Wavetable triangle(float dutyCycle)
```
    Constructs a perfect triangle wave with the specified duty cycle.
    
    Parameters:
    
    dutyCycle - float: a triangle wave with a duty cycle of 0.5 will be a perfect triangle wave that is 1 half the time and -1 the other half. By changing the duty cycle, you change how much of the triangle is below zero. So, a duty cycle of 0.2 would result in 20 percent of the triangle below zero and the rest above. Duty cycle will be clamped to [0,1].
    
    Returns:
    
    Wavetable
  - randomNHarms
```
public static Wavetable randomNHarms(int numberOfHarmonics)
```
    Constructs a waveform by summing together the first numberOfHarmonics in the harmonic series with randomly chosen amplitudes. This often sounds like an organ.
    
    Parameters:
    
    numberOfHarmonics - int: the number of harmonics to use when generating the wave
    
    Returns:
    
    a Wavetable
  - randomNOddHarms
```
public static Wavetable randomNOddHarms(int numberOfHarmonics)
```
    Constructs a waveform by summing together the first odd numberOfHarmonics in the harmonic series (1, 3, 5, etc) with randomly chosen amplitudes. This often sounds like an organ with a band pass filter on it.
    
    Parameters:
    
    numberOfHarmonics - int: the number of odd harmonics to use when generating the wave
    
    Returns:
    
    a Wavetable
  - randomNoise
```
public static Wavetable randomNoise()
```
    Constructs a Wavetable of randomly generated noise.
    
    Returns:
    
    a Wavetable
  - add
```
public static Wavetable add(float[] amps,
                            Waveform... waves)
```
    Generates a Wavetable by adding any number of Waveforms, each scaled by an amplitude. Calling this method might look like: Wavetable wave = Wavetable.add( new float[] { 0.8f, 0.2f }, Waves.SINE, Waves.SAW ); or: Wavetable wave = Wavetable.add( new float[] { 0.2f, 0.3f, 0.5f }, Waves.SINE, Waves.SQUARE, Waves.sawh( 6 ) ); In other words, the number of elements in the amplitude array must match the number of Waveform arguments provided.
    
    Parameters:
    
    amps - float[]: an array of amplitudes used to scale the matching Waveform argument when adding it into the final Wavetable.
    
    waves - Waveform vararg: The Waveforms to be added together. The number of Waveforms passed in as arguments much match the length of the amps array.
    
    Returns:
    
    a Wavetable

Class Waves

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SINE

SAW

PHASOR

SQUARE

TRIANGLE

QUARTERPULSE

Method Detail

sawh

saw

squareh

square

pulse

triangleh

triangle

randomNHarms

randomNOddHarms

randomNoise

add