Steps for merging the ES6 feature into master

[kalwalt]

Introduction

The ES6 feature #116 is merged into the dev branch. There are some steps to do before merging into master. I found some issues and i think we need to improve the code. I think that is better to face them in small steps than in a BIG PR.

Things to do

• I found a bug in artoolkit5-js #11 that make the app crash with a out of memory message.
• add arjs-nft-init-data event to artoolkit5-js and then to AR.js This will be done in another PR.
• Removing not necessary artoolkit.init()

  AR.js/three.js/src/threex/arjs-context.js

  Line 208 in 3bf97f3

  artoolkit.init().then(_ => {

  because it is already initied inside the ARController _initialize https://github.com/AR-js-org/artoolkit5-js/blob/aa21c379d51b08e9a0d52b26f9f6928084ddb844/src/ARController.js#L1260
• Pattern examples works differently on Mobile devices, differences between Aframe and Threex. This happens because we not provide to the arController the right 'orientation'. Fixed in PR Testing improved artoolkit5 js #359
• Three.js location based integration (dist bundle.js missed?)
• OnResize should be optional? This will be done in another PR or at least need some discussion in an issue.
• OnResize could be injected? This will be done in another PR or at least need some discussion in an issue.
• Threex should be in a different package? Same as above.
• passing only ImageData to _copyImageToHeap(sourceImage) see discussion here Understanding / Improving element sizing #266
• fix some three.js marker examples with the new orientation routine.
• fix bug with labelingMode (white_markers) see White_region Markers not properly working #384
• update README about npm package, with minimal infos (how to install and use)

I will update this list, i hope to not enlarge too much...

[kalwalt]

@nickw1 just a quick question: There is no bundled file in the three.js location based (TLB) folder. This is intentionally because is experimental? or we can find a kind of integration? I'm asking this for the npm package, actually TLB can't not be used as a npm package in the @ar-js-org/ar.js distribution. Just thinking how to proceed.

[nickw1]

@kalwalt yes, Yes you're right, there is no bundle. This was due to it being experimental; however I can build one.

[nickw1]

@kalwalt ok I have fixed it to build a bundle, the bundle is in the repo. However this is using my own webpack build script rather than the build script for the whole AR.js source code. Shall I leave it up to you to integrate it with the rest of the build?

[kalwalt]

@kalwalt yes, Yes you're right, there is no bundle. This was due to it being experimental; however I can build one.

ok I can do it, don't worry. Just asking for clearity. I will try it and maybe i can find to integate into threex.

Right now i'm working on the marker examples. They looks different (i'm testing on Mobile devices), Three.js examples in dev branch are displayed ok in portrait and landscape mode, but Aframe examples looks wierd in portrait and good in landscape. ANd when i say the y looks wierd i mean that the ube or the mesh is kewed or not perfectly alligned to the marker.
I have this branch where i'm testing a different approach with a modified _copyImageToHeap inside artoolkit5-js.

[kalwalt]

@kalwalt ok I have fixed it to build a bundle, the bundle is in the repo. However this is using my own webpack build script rather than the build script for the whole AR.js source code. Shall I leave it up to you to integrate it with the rest of the build?

yes thank you!

[wd40bomber7]

I'm on the latest developer version and I'm hitting a problem where everything works great on desktop, but on mobile the cube's orientation is constantly wrong and jumps around. Is this a known issue?

[kalwalt]

I'm on the latest developer version and I'm hitting a problem where everything works great on desktop, but on mobile the cube's orientation is constantly wrong and jumps around. Is this a known issue?

Yes i know, as i said in a comment above and on the top of the thread. I'm testing now this branch if you want to take a look at. But be aware it's not completely solved. Try only the three.js/examples/minimal_ES6.html and aframe/examples/marker-based/minimal_ES6.html. I will open a WIP PR very soon.

[wd40bomber7]

Ah sorry, I didn't quite understand what "Pattern differences working differently" meant. I'll keep my eyes out for the WIP PR. Thank you!

[kalwalt]

Ah sorry, I didn't quite understand what "Pattern differences working differently" meant. I'll keep my eyes out for the WIP PR. Thank you!

No problem, my fault i should explain better the issue.
The issue (with mobile devices) is more on the Aframe side. Meshes in Three.js examples looks correctly (not skewed and placed correctly onto the marker). @wd40bomber7 can you confirm this?

[kalwalt]

I think i have fixed the aframe marker examples, can someone test please the code in PR #359? You can test these examples: marker-camera.html, marker-events.html, minimal_ES6.html, minimal.html, multiple-independent-markers.html and white-region-marker.html.
I think we are close to merge it in the dev branch!

[kalwalt]

I also removed some tasks because i think we can do them in another PRs, does not make sense postpone to merge the ES6 feature again. All that changes/improvements can be done after, we need to close this and go ahead.

[kalwalt]

Fixed bug with white region markers with commit 99bda00 see #384. That was fixed also in master branch 99bda00

[kalwalt]

PR #359 has been merged in dev. I think now we need only to fix some small bugs and improve/update the Readme and the documentation and we are ready to merge ES6 feature into master!

[kalwalt]

ES6 feature merged into master #400