mirror of
https://github.com/Tonejs/Tone.js
synced 2024-12-28 12:33:12 +00:00
f17249691d
now in the form Tone.Something instead of using `import { Something } from "tone"`. It makes the example runner on the docs page work much faster
85 lines
2.2 KiB
TypeScript
85 lines
2.2 KiB
TypeScript
import { Gain } from "../core/context/Gain";
|
|
import { Param } from "../core/context/Param";
|
|
import { optionsFromArguments } from "../core/util/Defaults";
|
|
import { Signal, SignalOptions } from "./Signal";
|
|
import { InputNode, OutputNode } from "../core/context/ToneAudioNode";
|
|
|
|
/**
|
|
* Multiply two incoming signals. Or, if a number is given in the constructor,
|
|
* multiplies the incoming signal by that value.
|
|
*
|
|
* @example
|
|
* // multiply two signals
|
|
* const mult = new Tone.Multiply();
|
|
* const sigA = new Tone.Signal(3);
|
|
* const sigB = new Tone.Signal(4);
|
|
* sigA.connect(mult);
|
|
* sigB.connect(mult.factor);
|
|
* // output of mult is 12.
|
|
* @example
|
|
* // multiply a signal and a number
|
|
* const mult = new Tone.Multiply(10);
|
|
* const sig = new Tone.Signal(2).connect(mult);
|
|
* // the output of mult is 20.
|
|
* @category Signal
|
|
*/
|
|
export class Multiply<TypeName extends "number" | "positive" = "number"> extends Signal<TypeName> {
|
|
|
|
readonly name: string = "Multiply";
|
|
|
|
/**
|
|
* Indicates if the value should be overridden on connection
|
|
*/
|
|
readonly override = false;
|
|
|
|
/**
|
|
* the input gain node
|
|
*/
|
|
private _mult: Gain;
|
|
|
|
/**
|
|
* The multiplicand input.
|
|
*/
|
|
input: InputNode;
|
|
|
|
/**
|
|
* The product of the input and {@link factor}
|
|
*/
|
|
output: OutputNode;
|
|
|
|
/**
|
|
* The multiplication factor. Can be set directly or a signal can be connected to it.
|
|
*/
|
|
factor: Param<TypeName>;
|
|
|
|
/**
|
|
* @param value Constant value to multiple
|
|
*/
|
|
constructor(value?: number);
|
|
constructor(options?: Partial<SignalOptions<TypeName>>);
|
|
constructor() {
|
|
super(Object.assign(optionsFromArguments(Multiply.getDefaults(), arguments, ["value"])));
|
|
const options = optionsFromArguments(Multiply.getDefaults(), arguments, ["value"]);
|
|
|
|
this._mult = this.input = this.output = new Gain({
|
|
context: this.context,
|
|
minValue: options.minValue,
|
|
maxValue: options.maxValue,
|
|
});
|
|
|
|
this.factor = this._param = this._mult.gain as unknown as Param<TypeName>;
|
|
this.factor.setValueAtTime(options.value, 0);
|
|
}
|
|
|
|
static getDefaults(): SignalOptions<any> {
|
|
return Object.assign(Signal.getDefaults(), {
|
|
value: 0,
|
|
});
|
|
}
|
|
|
|
dispose(): this {
|
|
super.dispose();
|
|
this._mult.dispose();
|
|
return this;
|
|
}
|
|
}
|