[p5.js 2.0] Vector nD getter and setter, added values. #7277

holomorfo · 2024-09-20T15:41:32Z

Resolves ##6765

Changes:
Modify Vector class to include a values list to make it n-dimensional while mantaining the existing API of x, y, z by setting up accessors, getter and setter.
Pending Update documentation and add new Unit tests

Screenshots of the change:

PR Checklist

npm run lint passes
Inline documentation is included / updated
Unit tests are included / updated (Didn't modify any existing test, added new tests to increase coverage of the Vector file from 94.59% to 97.12%)

CC: @limzykenneth @davepagurek @Qianqianye

holomorfo · 2024-09-20T15:49:23Z

src/math/p5.Vector.js

+      this._values = newValues.slice()
+    }
+
+    get x() {


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

holomorfo · 2024-09-20T15:50:25Z

src/math/p5.Vector.js

+    get y() {
+      return this._values[1] || 0
+    }
+    get z() {


should we add a w value for 4D? or for nD do users will just search values by number?
@limzykenneth

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

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.

holomorfo · 2024-09-20T15:51:39Z

src/math/p5.Vector.js

+      return this._values[0] || 0
+    }
+
+    setValue(index, value) {


probably I need to create also a get value(index) so users can get entries of the vector by ID
@limzykenneth

limzykenneth · 2024-09-20T17:19:14Z

src/math/p5.Vector.js

@@ -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(', ')}]`;


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.

do you mean something like this?

toString() { return `${this.values.join(', ')}]`; }

yeah perhaps, might be worth considering how other libraries serialize their vector objects if they do at all

holomorfo · 2024-09-24T06:23:56Z

limzykenneth · 2024-09-24T10:35:15Z

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 set() and (set) values, is the idea here that they can be used to change the dimension of the vector or would the dimension of a vector stay the same throughout its lifetime?

For setMag() and others, the name basically all come from Processing and we'll keep them as is for compatibility reasons.

setHeading() and rotate() currently is documented to work only in 2D. For 3D there probably need to be an axis defined or things like xyz/quartenion values, for 4D I'm not sure what it would mean. I think it can be fine to make them 2D only methods but if you have specific ideas or other libraries handle these in some way, do put something together for consideration.

holomorfo · 2024-09-27T05:21:19Z

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.

Sounds good, will do my best now and will revisit the docs later

For set() and (set) values, is the idea here that they can be used to change the dimension of the vector or would the dimension of a vector stay the same throughout its lifetime?

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

For setMag() and others, the name basically all come from Processing and we'll keep them as is for compatibility reasons.

Understood, thanks

setHeading() and rotate() currently is documented to work only in 2D. For 3D there probably need to be an axis defined or things like xyz/quartenion values, for 4D I'm not sure what it would mean. I think it can be fine to make them 2D only methods but if you have specific ideas or other libraries handle these in some way, do put something together for consideration.

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

holomorfo · 2024-09-27T05:23:29Z

I have added the required test for my changes, I increased the cover for the Vector file from:

To

More tests should and will be added to make sure the nD versions of the functions are correct.

CC: @limzykenneth @davepagurek @Qianqianye

holomorfo · 2024-09-27T05:37:04Z

This PR is ready for review.
@limzykenneth @Qianqianye @davepagurek

limzykenneth · 2024-09-27T12:57:43Z

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.

davepagurek

This is looking great! I just flagged some bits that might be inconsistent in case it's unintentional.

davepagurek · 2024-09-27T13:40:59Z

src/math/p5.Vector.js

+      }
+      if (dimensions === 0) {
+        this.dimensions = 2;
+        this._values = [0, 0, 0];


Should the dimensions here match the number of items in _values?

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.

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

src/math/p5.Vector.js

[p5.js 2.0] Matrix move to math folder

…nt of p5 namespace

holomorfo · 2024-11-05T04:33:36Z

I have added my proposal for the adapter for toggling between MatrixLegacy which is what we currently have that is based on the gl-matrix implementation and MatrixNumJs classs.
To toggle between this I currently setup a static constant
export const MATRIX_ENGINE = 'legacy';
export const MATRIX_ENGINE = 'numjs';

All existing tests pass with both versions of the matrix, please let me know your thoughts @limzykenneth @davepagurek.
CC: @Qianqianye

holomorfo · 2024-11-07T04:55:54Z

Since we might have two bundles of p5.js with different matrix engines, maybe we should do a configuration to export differently for example p5.numjs.js or something similar, and on build time pass a specific flag.
I wanted to ask what do you suggest can be a next step to integrate these changes

Vector getter and setter, added values.

88ef80e

holomorfo changed the title ~~[p5.js 2.0](IN_PROGRESS) Vector getter and setter, added values.~~ [p5.js 2.0](IN_PROGRESS) Vector nD getter and setter, added values. Sep 20, 2024

holomorfo requested review from davepagurek and limzykenneth September 20, 2024 15:47

holomorfo self-assigned this Sep 20, 2024

holomorfo added the p5.js 2.0 label Sep 20, 2024

holomorfo commented Sep 20, 2024

View reviewed changes

holomorfo mentioned this pull request Sep 20, 2024

[p5.js 2.0 RFC Proposal]: Using a separate math library for handling p5.js's math operations #6765

Open

21 tasks

limzykenneth reviewed Sep 20, 2024

View reviewed changes

holomorfo added 2 commits September 23, 2024 23:10

Add documentation for new methods getter setter Vector

44d9676

Change the Vector toString implementation

12f7bd4

holomorfo added 3 commits September 24, 2024 22:03

Merge branch 'dev-2.0' into Vector-nd

4ade6d6

Update Vector.div to make it nDimentional

615a6e0

Vector N design coverage increase

d54e31f

holomorfo changed the title ~~[p5.js 2.0](IN_PROGRESS) Vector nD getter and setter, added values.~~ [p5.js 2.0](READY) Vector nD getter and setter, added values. Sep 27, 2024

holomorfo marked this pull request as ready for review September 27, 2024 05:36

davepagurek reviewed Sep 27, 2024

View reviewed changes

Matrix move to math folder

1b8b713

holomorfo mentioned this pull request Oct 11, 2024

[p5.js 2.0] Matrix move to math folder holomorfo/p5.js#1

Merged

3 tasks

holomorfo and others added 3 commits October 11, 2024 22:32

Merge pull request #1 from holomorfo/matrix-refactor

dec0bd3

[p5.js 2.0] Matrix move to math folder

Merge branch 'dev-2.0' into Vector-nd

b6bf8d5

Matrix fix import webgl

56debd1

holomorfo added 6 commits October 14, 2024 19:45

Merge branch 'dev-2.0' into Vector-nd

862f59f

Matrix numjs migration

b2d258a

Extract matrix and vector to individual class, abstarct and independe…

c326ee8

…nt of p5 namespace

Add matrix numjs external adapter

b93ff32

Add matrix numjs external adapter unit test

1f5835d

add matrix unit test coverage

e946499

holomorfo changed the title ~~[p5.js 2.0](READY) Vector nD getter and setter, added values.~~ [p5.js 2.0] Vector nD getter and setter, added values. Oct 30, 2024

holomorfo added 5 commits October 30, 2024 09:49

Merge branch 'dev-2.0' into Vector-nd

f0e247c

fix matrix numjs coverage and tests

0682fd1

Merge branch 'dev-2.0' into Vector-nd

dd41555

Update import and tests for matrix, add constant to select engine

e50f725

Update package lock to include numjs

c9775f7

holomorfo requested review from davepagurek and limzykenneth November 5, 2024 04:28

holomorfo added 2 commits November 4, 2024 20:34

fix vector default dimention for empty values

1501e20

Merge branch 'dev-2.0' into Vector-nd

c427317

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[p5.js 2.0] Vector nD getter and setter, added values. #7277

[p5.js 2.0] Vector nD getter and setter, added values. #7277

holomorfo commented Sep 20, 2024 •

edited

Loading

holomorfo Sep 20, 2024

holomorfo Sep 20, 2024

davepagurek Sep 20, 2024

limzykenneth Sep 20, 2024

holomorfo Sep 20, 2024

limzykenneth Sep 20, 2024

holomorfo Sep 24, 2024

limzykenneth Sep 24, 2024

holomorfo commented Sep 24, 2024 •

edited

Loading

limzykenneth commented Sep 24, 2024

holomorfo commented Sep 27, 2024

holomorfo commented Sep 27, 2024

holomorfo commented Sep 27, 2024

limzykenneth commented Sep 27, 2024

davepagurek left a comment

davepagurek Sep 27, 2024

limzykenneth Sep 27, 2024

davepagurek Sep 27, 2024

holomorfo commented Nov 5, 2024 •

edited

Loading

holomorfo commented Nov 7, 2024

[p5.js 2.0] Vector nD getter and setter, added values. #7277

Are you sure you want to change the base?

[p5.js 2.0] Vector nD getter and setter, added values. #7277

Conversation

holomorfo commented Sep 20, 2024 • edited Loading

PR Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holomorfo commented Sep 24, 2024 • edited Loading

Vector methods

limzykenneth commented Sep 24, 2024

holomorfo commented Sep 27, 2024

holomorfo commented Sep 27, 2024

holomorfo commented Sep 27, 2024

limzykenneth commented Sep 27, 2024

davepagurek left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holomorfo commented Nov 5, 2024 • edited Loading

holomorfo commented Nov 7, 2024

holomorfo commented Sep 20, 2024 •

edited

Loading

holomorfo commented Sep 24, 2024 •

edited

Loading

holomorfo commented Nov 5, 2024 •

edited

Loading