Tone.js/Tone/signal/Negate.ts
Yotam Mann 3e2de8f259 fixing spacing
typedoc wants one space before the "@"
2019-08-30 09:06:38 -07:00

41 lines
908 B
TypeScript

import { ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
import { optionsFromArguments } from "../core/util/Defaults";
import { Multiply } from "./Multiply";
import { SignalOperator } from "./SignalOperator";
/**
* Negate the incoming signal. i.e. an input signal of 10 will output -10
*
* @example
* var neg = new Negate();
* var sig = new Signal(-2).connect(neg);
* //output of neg is positive 2.
*/
export class Negate extends SignalOperator<ToneAudioNodeOptions> {
name = "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;
}
}