Revamp CSG functions, make curve canvases consistent & more

[Cloud7050]

The changes in this PR are described below.

CSG

Changes in: package.json, src/bundles/csg/, src/common/utilities.ts, src/tabs/Csg/, yarn.lock.

• Revamp CSG exports
  • Add new ability to ungroup() Groups while applying accumulated transforms
  • Change centring of some primitives for better usability and consistency, instead of aligning all min bounds to origin, as not all primitives have full 1x1x1 bounding box dimensions. Closes Tweak primitive alignments Cloud7050/modules#30
    • Geodesic sphere & star now centred at (0.5, 0.5, 0.5) instead of aligning to origin
    • Square pyramid now has base length 1 with sides aligned to axes. No longer rotated 45° with corners touching 1x1 box by way of low resolution cone generator
    • Prism now centred instead of aligning to origin. Flat side now aligned with y axis instead of x
    • Torus now centred higher at (0.5, 0.5, 0.5). Ring is now slightly thicker, while maintaining 1x1 dimensions
  • Rewrite all user documentation. Fix various outdated/wrong information. Add significantly more detail. Closes Transformation/centre changes Cloud7050/modules#33
    • Add proper summary to documentation, with sample usage and link to all GitHub samples. Closes [CSG]: expose sample snippets in module documentation #230
    • Fix primitives losing @category. Add fitting categories to all exports
  • Officially support rendering directly passed Shapes as opposed to only Groups
  • Add more parameter checks to avoid likely user pitfalls and reduce unhelpful error messages. Enhance existing error messages and increase specificity
  • Rename shape_to_stl() to download_shape_stl() as it triggers a file download
  • Rename V2 Entity to Operable to avoid ambiguity with renderer and JSCAD internal entities. Operables are now a user-facing term
• Finally upgrade to real BlueprintJS tooltips now that we have the technology. Fixes buggy tooltip positions that were meant to be a temporary measure. Tweak control hint text. Closes True BlueprintJS tooltips + new layout Cloud7050/modules#22
• Upgrade to real js-slang List types and related functions now that we have the technology
• Split samples into their own files. Add many new samples. Update existing samples to improve them and make them work with current CSG. Closes [CSG]: include Sierpinsky example in samples #231
• Refactor, simplify, and move implementations, such as for primitives and utilities
  • Lists now only used in main functions file, as importing a file that works with real Lists from the tab end causes build failures. Add note regarding limitation. Groups now store arrays instead of Lists
  • Remove Entity cloning
  • Remove unused code
• Move relevant CSS constants into their own common file. Update them for BlueprintJS V4
• Lock @jscad/modeling version to match patch file exactly. Also remove unused lodash & @types/lodash
• Remove commented references to fork issues. Now all resolved or transferred to main repo
• Change default renderer colour

Curve

Changes in: src/bundles/curve/, src/tabs/Curve/, src/tabs/Rune/, src/tabs/common/ src/tabs/physics_2d/DebugDrawCanvas.tsx.

• Enhance 4 canvases (2 of which are shared with rune)
  • Make all 4 canvases used by curve consistent wrt size & controls
    • Fix AnimationCanvas controls being to the right. Resolves [Feature Request]: curve: layout of animate_curve and animate_3D_curve #218
    • Move CanvasCurve3D controls to the top to match Improve placement of model in curve3D render tab #219
    • Allow all canvases to size up larger than the 512x512 rendered resolution (resolution does not actually increase, only canvas size, see [Feature Request]: curve: layout of animate_curve and animate_3D_curve #218)
    • Rename canvases for clarity
  • Reset button now also stops playing if animation is running
  • Rename auto play to auto loop
  • Extract some repeated elements into their own shared React components. 3D curve play button now has tooltip which matches other canvases
  • Specify explicit tooltip placements for consistency and to avoid blocking canvas
  • Switch to common CSS constants extracted from frontend, BlueprintJS, and Ace. Improve spacings and alignments for consistency
  • Trim unnecessary CSS styling and simplify. Use flex gaps instead of margins
• Add parameter check to disallow make_sound() with duration <= 0. Closes [SOUND]: make_sound should check for negative duration #110
• Add samples
• Enhance documentation
  • Fix typos and elaborate on animated Curve functions

Build

Changes in: scripts/.

• Fix yarn scripts build modules not building any tabs (used in yarn dev)
• Change retrieveBundlesAndTabs() to clarify returned bundle/tab logic based on user input, and update jest test to match
• Documentation & refactoring

Rune

Changes in: src/bundles/rune/rune_ops.ts/.

• Fix low resolution heart. Fixes [RUNE]: heart has too low resolution #170

[sayomaki]

Here is just some of my initial comments as I have not looked thoroughly at the CSG-related code and refactor yet (not my forte), but for the HTML/React related code it is looking pretty good to me although I do have a few small comments on that.

I have not yet tested these changes locally yet, but I will let you know if I find any problems.

[Cloud7050]

@sayomaki @leeyi45 do you have any further comments for proceeding with the PR?

[leeyi45]

@sayomaki @leeyi45 do you have any further comments for proceeding with the PR?

Nope, everything on my side is good. More improvements are yet to be made, but that'll be on my side.

[RichDom2185]

A lot of files (especially newly-created and renamed ones) have incorrect line-endings, triggering ESLint warnings.

Could you correct them please? Thanks!

[Cloud7050]

The TypeDoc used to talk about reflections being a matter of scaling with negative factors. I have found in #206 that JSCAD doesn't like this, and Prof Low's decision regarding it. Therefore I am once again disallowing negative factors in scale().

[Cloud7050]

A lot of files (especially newly-created and renamed ones) have incorrect line-endings, triggering ESLint warnings.

Could you correct them please? Thanks!

I seem to be encountering the same hiccup as in #204. Actually the files are CRLF in my working dir, but looks like git is converting them to LF due to autocrlf.

To my understanding, the current LF/CRLF in the index is inconsistent. I would also like to accomodate different eol checkouts depending on OS, which the current eslint will complain about locally.

I was in the middle of some eslint changes in another branch that was for #136, so I didn't touch eslint here. There are actually some changes as well as fixes I wish to make to the eslintrcs (and probably gitattributes per #209), wider sweeping than in the draft of #241. Iirc eslint is currently operating wrongly in a few ways.

@RichDom2185 Do you think I could take over with my own tailored PR wrt eslint? I will note the existing changes you have made and try to incorporate them. There are reasons behind some of the choices made in the current config which could be further discussed in such a PR, eg the reason behind so many commented rules and options.

As for this PR, I would like to proceed knowing the checks are not happy with the eol, and address them in one swoop in the aforementioned PR.

[RichDom2185]

I would also like to accomodate different eol checkouts depending on OS

I agree with this. I'm not sure why our ESLint config enforces a specific line ending when git normally auto-adapts line endings when cloning to different OSses.

Do you think I could take over with my own tailored PR wrt eslint?

Sure, thanks. So far, all the changes in #241 are backwards-compatible so feel free to approve it if you me to merge it first (I'll edit the PR description accordingly).

As for this PR, I would like to proceed knowing the checks are not happy with the eol, and address them in one swoop in the aforementioned PR.

Ok, I'll review the rest of the files, ignoring these warnings for now.

[leeyi45]

If this PR is ready for merging I'd like to go ahead with it, as there's another long line of changes that I need to merge too

[martin-henz]

Looks like everyone is ok with merging it so I'm merging it.