[p5.js 2.0] Vector nD getter and setter, added values. #7277
Conversation
holomorfo
changed the title
| this._values = newValues.slice() | ||
| } | ||
|
|
||
| get x() { |
There was a problem hiding this comment.
this allows us to still consume the vector x, y and z without having an explicit class attributes with that name, this making it more flexible
@limzykenneth
| get y() { | ||
| return this._values[1] || 0 | ||
| } | ||
| get z() { |
There was a problem hiding this comment.
should we add a w value for 4D? or for nD do users will just search values by number?
@limzykenneth
There was a problem hiding this comment.
I'm ok adding a w personally, since math for 3D stuff uses 4D vectors/matrices quite often. it seems fairly common in other apis too, e.g. native js DOMPoint. And then anything above 4D would use indices
There was a problem hiding this comment.
Yeah, adding a w is fine for me as well. When working on the documentation we need to balance this convention of using w and it potentially being unintuitive for those very new to linear algebra, possibly by de-emphaiszing w in some way or other solution.
| return this._values[0] || 0 | ||
| } | ||
|
|
||
| setValue(index, value) { |
There was a problem hiding this comment.
probably I need to create also a get value(index) so users can get entries of the vector by ID
@limzykenneth
src/math/p5.Vector.js
Outdated
| @@ -158,7 +207,7 @@ function vector(p5, fn) { | |||
| * </div> | |||
| */ | |||
| toString() { | |||
| return `p5.Vector Object : [${this.x}, ${this.y}, ${this.z}]`; | |||
| return `p5.Vector Object : [${this.values.join(', ')}]`; | |||
There was a problem hiding this comment.
One of the things I'm considering is to have this be serialized into something more standard/machine readable, so maybe just the JSON part at the end.
There was a problem hiding this comment.
do you mean something like this?
toString() {
return `${this.values.join(', ')}]`;
}
There was a problem hiding this comment.
yeah perhaps, might be worth considering how other libraries serialize their vector objects if they do at all
|
I have added new inline documentation for the new methods. Here I share the analysis of the pending methods to update and some questions/challenges I'm facing: Vector methods
Static methods
|
|
For the inline documentation, it is not great at inferring the right name and parent class/module with the code only so we may need to add additional hints around these, you can have a look at the other already documented entries and follow their convention. We can revisit the documentation at a later date though so no need to solve this immediately. For For
|
Sounds good, will do my best now and will revisit the docs later
Actually this is my exact question that I'm facing with operations that have multiple dimensions like div and mult, I have added some comments to the PR, I believe that dimension needs to change also in the setters when the values are changed, increased or decrease in components
Understood, thanks
Sounds right, I will indicate explicitly what functions will stay in fixed dimentions, I will think also of possible generalisations for nD for the defined axis |
|
I have added the required test for my changes, I increased the cover for the Vector file from: More tests should and will be added to make sure the nD versions of the functions are correct. |
holomorfo
changed the title
|
This PR is ready for review. |
|
I'd like to test the documentation generation first to see how it works, will get to it when I have a bit more time, you can go ahead with next steps branching off of this branch. |
| } | ||
| if (dimensions === 0) { | ||
| this.dimensions = 2; | ||
| this._values = [0, 0, 0]; |
There was a problem hiding this comment.
Should the dimensions here match the number of items in _values?
There was a problem hiding this comment.
One thing I'm just now thinking about, should the default vector when no argument is passed be 2D instead of 3D? Seeing as most people start learning to create sketches with 2D before moving into 3D.
There was a problem hiding this comment.
I think that makes sense. Even in webgl mode, you may very well still be using 2D vectors for a number of things, so its not a bad idea to have to be explicit to make 3D vectors
[p5.js 2.0] Matrix move to math folder
…nt of p5 namespace
holomorfo
changed the title
|
I have added my proposal for the adapter for toggling between All existing tests pass with both versions of the matrix, please let me know your thoughts @limzykenneth @davepagurek. |
|
Since we might have two bundles of |
|
@holomorfo I can work on the build a bit later, for now we default to the older glMatrix implementation and keep the numjs class around. |
Resolves ##6765
Changes:
Modify Vector class to include a
valueslist to make it n-dimensional while mantaining the existing API ofx,y,zby setting up accessors, getter and setter.Pending Update documentation and add new Unit tests
Screenshots of the change:
PR Checklist
npm run lintpassesCC: @limzykenneth @davepagurek @Qianqianye