Effects w inheritance #178
Conversation
|
this is looking good! Is it still in progress? |
|
not in progress! But I have used continued to use |
| @@ -1,4 +1,4 @@ | |||
| /*! p5.sound.js v0.3.3 2017-06-06 */ | |||
There was a problem hiding this comment.
For the next PR, let's hold off on adding the lib to commits—it'll make it easier to review because we can just focus on the src/ and test/ files.
|
|
||
| this.input = this.ac.createGain(); | ||
| this.output = this.ac.createGain(); | ||
| p5.Effect.call(this); |
There was a problem hiding this comment.
p5.Effect works because of the order of app.js, but it's safer not to depend on that and to instead require dependencies explicitly. Try to use Effect, since that's what we required on line 6. Same goes for Filter, if you feel like cleaning up the lines that refer to p5.Filter (if you don't get to it in this PR, I will be happy to)
There was a problem hiding this comment.
actually I will merge and make this change in a separate PR
There was a problem hiding this comment.
ah, p5.Filter module needed to return/export the p5.Filter...
| this.input.disconnect(); | ||
| this.output.disconnect(); | ||
| Effect.prototype.dispose.apply(this); | ||
|
|
||
| this._split.disconnect(); | ||
| this._leftFilter.disconnect(); | ||
| this._rightFilter.disconnect(); |
There was a problem hiding this comment.
these are p5.Filters, so we should call dispose instead of disconnect to dispose of all its resources/references
this._leftFilter.dispose();
this._rightFilter.dispose();
| // * @method connect | ||
| // * @param {Object} unit | ||
| // */ | ||
| // p5.Distortion.prototype.connect = function(unit) { |
There was a problem hiding this comment.
hmm, we should probably keep documentation like this within each class/module, even though the methods are covered in p5.Effect module. These documentation blocks determine what shows up on https://p5js.org/reference/#/p5.Distortion methods section.
Another way to handle it might be to create documentation for p5.Effect, and then each class that inherits from p5.Effect includes a link in the documentation saying "inherits methods from p5.Effect".
| }; | ||
|
|
||
| /** | ||
| * Send output to a p5.sound or web audio object |
There was a problem hiding this comment.
more documentation that we want to keep accessible
done: delay, reverb, distortion