Tone.js/Tone/signal/Clip.js

define(["Tone/core/Tone", "Tone/signal/Max", "Tone/signal/Min", "Tone/signal/Signal"], function(Tone){

	"use strict";

	/**
	 * 	@class  Clip the incoming signal so that the output is always between min and max.
	 * 	
	 *  @constructor
	 *  @extends {Tone.SignalBase}
	 *  @param {number} min the minimum value of the outgoing signal
	 *  @param {number} max the maximum value of the outgoing signal
	 *  @example
	 * var clip = new Tone.Clip(0.5, 1);
	 * var osc = new Tone.Oscillator().connect(clip);
	 * //clips the output of the oscillator to between 0.5 and 1.
	 */
	Tone.Clip = function(min, max){
		//make sure the args are in the right order
		if (min > max){
			var tmp = min;
			min = max;
			max = tmp;
		}
		
		/**
		 *  The min clip value
		 *  @type {Number}
		 *  @signal
		 */
		this.min = this.input = new Tone.Min(max);
		this._readOnly("min");

		/**
		 *  The max clip value
		 *  @type {Number}
		 *  @signal
		 */
		this.max = this.output = new Tone.Max(min);
		this._readOnly("max");

		this.min.connect(this.max);
	};

	Tone.extend(Tone.Clip, Tone.SignalBase);

	/**
	 *  clean up
	 *  @returns {Tone.Clip} this
	 */
	Tone.Clip.prototype.dispose = function(){
		Tone.prototype.dispose.call(this);
		this._writable("min");
		this.min.dispose();
		this.min = null;
		this._writable("max");
		this.max.dispose();
		this.max = null;
		return this;
	};

	return Tone.Clip;
});