Port work from 'dev' to master #32

sritchie · 2022-04-17T23:21:08Z

This PR moves over all of @unconed 's work from the dev branch that I lost during my initial conversion to JS. Notes from that CHANGELOG:

0.0.6-dev

When specifying fps on a data buffer, catch up correctly if starting late (e.g. on a slide)
Add indices and channels props to <shader /> to match <resample />.
Add missing docs for line width.
Rename expr in script steps (steps, play, ...) to bind to avoid collision with expr prop.
Fix origin/range changes not being picked up
Force <layer /> to flatten to an orthogonal view
Fix rendering of partially filled buffers
Make closed lines/vectors work properly
Make closed surfaces work properly
Add optional normals to <surface />
Add <latch /> to control expr/data updates when conditions change

unconed · 2022-04-18T11:39:59Z

Could you please not tag me if it's not actually addressed to me because otherwise I will turn off all notifications.

sritchie · 2022-04-18T11:40:54Z

Noted!

sritchie · 2022-04-18T13:44:39Z

src/primitives/types/data/latch.js

+  return x && JSON.parse(JSON.stringify(x));
+}
+
+function deepEq(a, b) {


Let's replace these with the equivalent lodash.

BTW: re import { isEqual } from 'lodash' vs import isEqual from lodash.isequal... I used to use the method-specific packages but stopped because https://lodash.com/per-method-packages

Ah, nice - so instead I will import with a deeper relative import and we’ll be set.

sritchie · 2022-04-18T15:13:37Z

src/render/meshes/sprite.js

@@ -112,7 +112,7 @@ export class Sprite extends Base {
    this.geometry.dispose();
    this.edgeMaterial.dispose();
    this.fillMaterial.dispose();
-    this.nreders =
+    this.renders =


typo fixed!

sritchie · 2022-04-18T15:16:10Z

@ChristopherChudzicki this is ready for a look, if you wouldn't mind!

ChristopherChudzicki

This all looks good to me 👍 I have not tried to understand the reverse/latch primitives much, but the examples seem to work.

I left a few minor js comments about arguments.

One thing that I think should be added—and parts or all of this could be done separately—is typescript definitions. Things I think should happen:

add a test using expect-type that would fail if a PR, such as this, added more primitives without adding the types. This wasn't high on my priority list since I didn't think we'd be adding more primitives...and maybe we won't after this. But it would be easy to do, so might as well do it.

expect-type is a package I've used before that is nice for compile-time assertions about typescript. I first came across its use in https://github.com/sequelize/sequelize when I added a type there, and I've been very happy with it.
Add types + ts-documentation for the new latch and reveal primitives. This would involve:
- in node_types.ts, new interfaces SetTraitsReverse, GetTraitsReverse corresponding to the new reverse trait added in traits.ts
```
This defines a type for the "reverse" trait which is ued as part of the new Reverse primitive. The reason there would be two interfaces (the Get and Set variants) is that mathbox allows multiple ways of setting a prop, then standardizes to single array. (E.g., "classes" can be set as a space-separated string or an array, but it is always standardized to an array.)
```
- in node_types.ts, new ReversePropsNormalized and ReverseProps. The props for the primitive are determined by the traits used in the primitive, so it's just a matter of something like
```
export interface ReversePropsNormalized
  extends GetTraitsNode,
    GetTraitsOperator,
    GetTraitsReverse {}
```
  And something similar, with the Set traits, for ReverseProps.
- in node_types.ts, add the new indices and channels props to GetTraitsShader and SetTraitsShader
- Add reveal and latch methods to MathboxSelection, etc, in types.ts.
- Add tsdoc comments in node_types.ts and types.ts for the new traits + props, as well as for the
Re this last point... I would eventually like to stop using src/docs for doc-generation, and instead generate docs just for the tsdoc comments. The tsdoc comments are much more verbose (in terms of lines of code, I mean). But they are more standard.

I've been experimenting with typedoc as an alternative to src/docs. You can see its current output with npm run typedoc. It's pretty good, if a bit click-heavy on the navigation.

I am happy to do any or all those items. Let me know your preference.

ChristopherChudzicki · 2022-04-18T18:13:44Z

src/primitives/types/operator/reverse.js

+  }
+
+  make() {
+    super.make(...arguments);


Suggested change

super.make(...arguments);

super.make();

This superclass's make method has no args. I am confident this never does anything.

Sounds good, this was a suggestion from a decaffeinate script I ran to check my conversion!

ChristopherChudzicki · 2022-04-18T18:14:18Z

src/primitives/types/operator/reverse.js

+  }
+
+  unmake() {
+    return super.unmake(...arguments);


Same: The superclass's unmake has no args anyway (and does not reference the special arguments object)

ChristopherChudzicki · 2022-04-18T18:18:51Z

src/primitives/types/operator/reverse.js

+      this._resolveOffset("items", dims)
+    );
+
+    return super.resize(...arguments);


ChristopherChudzicki · 2022-04-18T21:05:10Z

examples/test/scatter.html

+        size: 10,
+        points: "<<",
+        colors: "<",
+      });


Suggested change

});

color: 0xFFFFFF

});

For the nice bright colors...

Maybe this should happen by default if colors is provided and color is not...

This is a followup to #32, adding typescript definitions for those changes

sritchie added 2 commits April 17, 2022 17:20

dev work

e00d4b2

final code changes

459dfc6

down to reverse

19c80b3

sritchie changed the title ~~Port work from 'dev' to master [in progress]~~ Port work from 'dev' to master Apr 18, 2022

sritchie self-assigned this Apr 18, 2022

fix src

198273c

sritchie force-pushed the sritchie/new_dev branch from 0ba7e59 to 198273c Compare April 18, 2022 12:18

sritchie added 2 commits April 18, 2022 06:59

new examples

9788e56

appease linter

d1065ea

sritchie commented Apr 18, 2022

View reviewed changes

use lodash

fff0e0f

sritchie added 2 commits April 18, 2022 09:22

sort imports

3a606de

fix isequal

55cb1ee

ChristopherChudzicki approved these changes Apr 18, 2022

View reviewed changes

address review

9df35fe

sritchie merged commit fbf7880 into master Apr 19, 2022

ChristopherChudzicki added a commit that referenced this pull request Apr 19, 2022

add new types for latch, reveal, etc

b6a087a

This is a followup to #32, adding typescript definitions for those changes

ChristopherChudzicki mentioned this pull request Apr 19, 2022

add new types for latch, reveal, etc #34

Merged

ChristopherChudzicki added a commit that referenced this pull request Apr 19, 2022

add new types for latch, reveal, etc

aa8d406

This is a followup to #32, adding typescript definitions for those changes

ChristopherChudzicki added a commit that referenced this pull request Apr 23, 2022

add new types for latch, reveal, etc (#34)

093b835

This is a followup to #32, adding typescript definitions for those changes

ChristopherChudzicki mentioned this pull request Dec 27, 2022

docs are broken #48

Closed

sritchie deleted the sritchie/new_dev branch December 27, 2022 16:18

ChristopherChudzicki mentioned this pull request Dec 28, 2022

fix docs (add latch, reverse) #51

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port work from 'dev' to master #32

Port work from 'dev' to master #32

sritchie commented Apr 17, 2022 •

edited

Loading

unconed commented Apr 18, 2022

sritchie commented Apr 18, 2022

sritchie Apr 18, 2022

ChristopherChudzicki Apr 18, 2022

sritchie Apr 18, 2022

sritchie Apr 18, 2022

sritchie commented Apr 18, 2022

ChristopherChudzicki left a comment •

edited

Loading

ChristopherChudzicki Apr 18, 2022

sritchie Apr 19, 2022

ChristopherChudzicki Apr 18, 2022

ChristopherChudzicki Apr 18, 2022

ChristopherChudzicki Apr 18, 2022

ChristopherChudzicki Apr 18, 2022

sritchie Apr 19, 2022

Port work from 'dev' to master #32

Port work from 'dev' to master #32

Conversation

sritchie commented Apr 17, 2022 • edited Loading

unconed commented Apr 18, 2022

sritchie commented Apr 18, 2022

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

sritchie commented Apr 18, 2022

ChristopherChudzicki left a comment • edited Loading

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

sritchie commented Apr 17, 2022 •

edited

Loading

ChristopherChudzicki left a comment •

edited

Loading