[Bug Fix] Migrate to ES6 classes #334
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
paxorus
commented
Aug 1, 2022
| @@ -5,7 +5,6 @@ window.Physijs = (function() { | |||
| _is_simulating = false, | |||
| _Physijs = Physijs, // used for noConflict method | |||
| Physijs = {}, // object assigned to window.Physijs | |||
| Eventable, // class to provide simple event methods | |||
There was a problem hiding this comment.
I removed this so I could declare it as const below. Happy to undo this.
paxorus
commented
Aug 1, 2022
| Eventable.prototype.addEventListener = function( event_name, callback ) { | ||
| if ( !this._eventListeners.hasOwnProperty( event_name ) ) { | ||
| this._eventListeners[event_name] = []; | ||
| const Eventable = (superclass) => class extends superclass { |
There was a problem hiding this comment.
Following this mix-in style: https://stackoverflow.com/questions/29879267/es6-class-multiple-inheritance
So that we can use this syntax: class Scene extends Eventable(THREE.Scene)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Issue: #329
Users are hitting the fatal error
Uncaught TypeError: class constructors must be invoked with 'new' when trying to create Physijs Scenewith recent versions of Three.js. This is due to the outdated inheritance method used byTHREE.Scene.call( this, params ).Solution
Update to ES6 classes, everywhere. Also, convert Eventable to be a mix-in. This should make Physi.js basically compatible with the current version of Three.js (r143). This is a giant diff, converting all classes to ES6 at once, because of compatibility issues between ES6 classes (prototype read-only) and the old inheritance method (modifies prototype).
Please review the file side-by-side with the current physi.js, locally in two editor windows, as the Git diff computed very poorly, despite there being no changes to business logic. The number of lines changed is in the dozens, not 1,000.
Testing
Ran my personal project (https://github.com/paxorus/physi-creator) which uses Scene and several Mesh types with this version of the code. The error was gone.