Tone.js/Tone/effect/AutoPanner.js

define(["Tone/core/Tone", "Tone/effect/Effect", "Tone/component/LFO", "Tone/component/Panner"], function(Tone){

	"use strict";

	/**
	 *  @class AutoPanner is a Tone.Panner with an LFO connected to the pan amount
	 *
	 *  @constructor
	 *  @extends {Tone.Effect}
	 *  @param { number= } frequency (optional) rate in HZ of the left-right pan
	 */
	Tone.AutoPanner = function(){

		var options = this.optionsObject(arguments, ["frequency"], Tone.AutoPanner.defaults);
		Tone.Effect.call(this, options);

		/**
		 *  the lfo which drives the panning
		 *  @type {Tone.LFO}
		 *  @private
		 */
		this._lfo = new Tone.LFO(options.frequency, 0, 1);

		/**
		 *  the panner node which does the panning
		 *  @type {Tone.Panner}
		 *  @private
		 */
		this._panner = new Tone.Panner();

		//connections
		this.connectEffect(this._panner);
		this._lfo.connect(this._panner.pan);
		this.setType(options.type);
	};

	//extend Effect
	Tone.extend(Tone.AutoPanner, Tone.Effect);

	/**
	 *  defaults
	 *  @static
	 *  @type {Object}
	 */
	Tone.AutoPanner.defaults = {
		"frequency" : 1,
		"type" : "sine"
	};
	
	/**
	 * Start the panner
	 * 
	 * @param {Tone.Time} [time=now] the panner begins.
	 */
	Tone.AutoPanner.prototype.start = function(time){
		this._lfo.start(time);
	};

	/**
	 * Stop the panner
	 * 
	 * @param {Tone.Time} [time=now] the panner stops.
	 */
	Tone.AutoPanner.prototype.stop = function(time){
		this._lfo.stop(time);
	};

	/**
	 * Set the type of oscillator attached to the AutoPanner.
	 * 
	 * @param {string} type of oscillator the panner is attached to (sine|sawtooth|triangle|square)
	 */
	Tone.AutoPanner.prototype.setType = function(type){
		this._lfo.setType(type);
	};

	/**
	 * @return {string} the LFO type
	 */
	Tone.AutoPanner.prototype.getType = function(){
		return this._lfo.getType();
	};

	/**
	 * Set frequency of the oscillator attached to the AutoPanner.
	 * 
	 * @param {number|string} freq in HZ of the oscillator's frequency.
	 */
	Tone.AutoPanner.prototype.setFrequency = function(freq){
		this._lfo.setFrequency(freq);
	};

	/**
	 * @return {number} the current frequency of the oscillator
	 */
	Tone.AutoPanner.prototype.getFrequency = function(){
		return this._lfo.getFrequency();
	};

	/**
	 *  set all of the parameters with an object
	 *  @param {Object} params 
	 */
	Tone.AutoPanner.prototype.set = function(params){
		if (!this.isUndef(params.frequency)) this.setFrequency(params.frequency);
		if (!this.isUndef(params.type)) this.setType(params.type);
		Tone.Effect.prototype.set.call(this, params);
	};

	/**
	 *  clean up
	 */
	Tone.AutoPanner.prototype.dispose = function(){
		Tone.Effect.prototype.dispose.call(this);
		this._lfo.dispose();
		this._panner.dispose();
		this._lfo = null;
		this._panner = null;
	};

	return Tone.AutoPanner;
});