Tone.js/Tone/signal/Negate.ts
2024-05-03 11:09:28 -04:00

40 lines
904 B
TypeScript

import { ToneAudioNodeOptions } from "../core/context/ToneAudioNode.js";
import { Multiply } from "./Multiply.js";
import { SignalOperator } from "./SignalOperator.js";
/**
* Negate the incoming signal. i.e. an input signal of 10 will output -10
*
* @example
* const neg = new Tone.Negate();
* const sig = new Tone.Signal(-2).connect(neg);
* // output of neg is positive 2.
* @category Signal
*/
export class Negate extends SignalOperator<ToneAudioNodeOptions> {
readonly name: string = "Negate";
/**
* negation is done by multiplying by -1
*/
private _multiply: Multiply = new Multiply({
context: this.context,
value: -1,
});
/**
* The input and output are equal to the multiply node
*/
input = this._multiply;
output = this._multiply;
/**
* clean up
* @returns {Negate} this
*/
dispose(): this {
super.dispose();
this._multiply.dispose();
return this;
}
}