Tone.js/Tone/signal/Multiply.js

60 lines
1.4 KiB
JavaScript
Raw Normal View History

2014-08-24 19:47:59 +00:00
define(["Tone/core/Tone", "Tone/signal/Signal"], function(Tone){
"use strict";
2014-06-17 00:05:54 +00:00
/**
2015-06-19 04:52:04 +00:00
* @class Multiply two incoming signals. Or, if a number is given in the constructor,
* multiplies the incoming signal by that value.
2014-06-17 00:05:54 +00:00
*
* @constructor
2015-02-23 05:30:53 +00:00
* @extends {Tone.Signal}
2015-06-19 04:52:04 +00:00
* @param {number=} value Constant value to multiple. If no value is provided,
* it will return the product of the first and second inputs
2015-02-27 18:40:35 +00:00
* @example
2015-06-19 04:52:04 +00:00
* var mult = new Tone.Multiply();
* var sigA = new Tone.Signal(3);
* var sigB = new Tone.Signal(4);
* sigA.connect(mult, 0, 0);
* sigB.connect(mult, 0, 1);
* //output of mult is 12.
2014-06-17 00:05:54 +00:00
*/
Tone.Multiply = function(value){
2014-10-23 01:20:43 +00:00
Tone.call(this, 2, 0);
2014-10-23 01:20:43 +00:00
2014-06-17 15:42:38 +00:00
/**
* the input node is the same as the output node
* it is also the GainNode which handles the scaling of incoming signal
*
* @type {GainNode}
2014-10-23 01:20:43 +00:00
* @private
*/
this._mult = this.input[0] = this.output = this.context.createGain();
/**
* the scaling parameter
* @type {AudioParam}
* @private
2014-06-17 15:42:38 +00:00
*/
2015-02-23 05:30:53 +00:00
this._value = this.input[1] = this.output.gain;
2014-06-30 21:11:46 +00:00
2015-02-23 05:30:53 +00:00
this._value.value = this.defaultArg(value, 0);
2014-06-15 21:38:59 +00:00
};
2015-02-23 05:30:53 +00:00
Tone.extend(Tone.Multiply, Tone.Signal);
2014-06-20 04:38:14 +00:00
/**
* clean up
* @returns {Tone.Multiply} this
2014-06-20 04:38:14 +00:00
*/
Tone.Multiply.prototype.dispose = function(){
Tone.prototype.dispose.call(this);
2015-04-05 18:42:14 +00:00
this._mult.disconnect();
2014-10-23 01:20:43 +00:00
this._mult = null;
2015-02-23 05:30:53 +00:00
this._value = null;
2015-02-02 03:56:33 +00:00
return this;
2014-06-20 04:38:14 +00:00
};
return Tone.Multiply;
2014-06-15 21:38:59 +00:00
});