These are chat archives for highfidelity/hifi

21st
Apr 2014
Clément Brisset
@Atlante45
Apr 21 2014 17:22
Hey everyone, just letting you know that the editVoxels script changed a little bit. If you want to place an import, you now need to hit Command + V, left click will not do it anymore.
Grayson Stebbins
@problem
Apr 21 2014 17:49
we should start an Editing Voxels wiki, @Atlante45
Clément Brisset
@Atlante45
Apr 21 2014 17:49
Even a script wiki.
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 18:36
@Atlante45 - Philip started a script wiki already... we should enhance it with new details.
Clément Brisset
@Atlante45
Apr 21 2014 18:37
Really?
Clément Brisset
@Atlante45
Apr 21 2014 18:37
Ok, I’ll track it down and add some stuff on what I modified in edtiVoxels and how to use inspect.js/
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 18:38
ah - well - maybe you had something else in mind
he was documenting the JS API
Thijs Wenker
@thoys
Apr 21 2014 18:38
no print function in there hehe
Clément Brisset
@Atlante45
Apr 21 2014 18:38
Oh, it’s the wiki on the API, we where thinking more for the user side
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 18:38
maybe you're saying we should have a wiki to explain the scripts themselves... yes - that's a good idea too.
Clément Brisset
@Atlante45
Apr 21 2014 18:38
But yeah it definitely needs update.
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 18:39
@thoys - well - we didn't document ALL of JS... some of that stuff is just built in...
Clément Brisset
@Atlante45
Apr 21 2014 18:39
Yep, nothing about the overlays and local trees either.
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 18:39
yep - lot's missing.
Thijs Wenker
@thoys
Apr 21 2014 18:40
ah ok, in browser JS its usually console.log(), so it might be helpful to note
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 18:40
We need to include in our code reviews, that you must also update the wiki if you add a new JS API.
Clément Brisset
@Atlante45
Apr 21 2014 18:42
Yeah, good idea.
Andrew Meadows
@AndrewMeadows
Apr 21 2014 21:31
in the long term it will be very hard to maintain the JS API
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 21:32
it's the nature of the beast isn't it?
Andrew Meadows
@AndrewMeadows
Apr 21 2014 21:32
especially since it will be easy to add new/custom functionality
yes, but harder to do it by enforcement of updating the wiki I think. Short term it will work ok.
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 21:32
agreed - what are better ideas?
Andrew Meadows
@AndrewMeadows
Apr 21 2014 21:33
probably best to force a doxygen style of documentation for long term, I think
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 21:33
I suggested that to Philip... but I think he was skeptical
It certainly would be easier to enforce that on code reviews
Andrew Meadows
@AndrewMeadows
Apr 21 2014 21:34
however... I think the JS API is going to evolve. We'll probably realize that we need to enable plugins
each plugin would have its own documentation, sorta like Python modules
I'm willing to update the wiki for now. We'll see how that works.
I added some functionality to JS a couple of weeks ago. I'll try to remember what I did and add documentation for it.
Andrew Meadows
@AndrewMeadows
Apr 21 2014 21:41
@ZappoMan what do we call those "things" in JS like MyAvatar and Vec3?
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 21:41
techincally they're global variables
or objects
we sort of use them as a cross between objects (MyAvatar) and libraries/packages (Vec3)
and then of course you have some that are kind of both... (Controller, Voxels, etc)
Andrew Meadows
@AndrewMeadows
Apr 21 2014 21:43
right, they look kinda like modules on the JS side, but are objects on the C++ side
in any case, each one in JS has its own API
so I guess we should list all the exposed Objects/Modules, give them a meaningful name, and document their API's on that wiki page
I'm just thinking though what needs to be done out loud I guess. I'm willing to help.
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 21:45
Philip took a crack at it... that's what's up there now.
Andrew Meadows
@AndrewMeadows
Apr 21 2014 21:46
it's a wiki! I can update it. Just need to find the time.
Konstantin
@SydoxX
Apr 21 2014 21:56
I sometimes get a "couldn't get _writeArraysLock.LockForRead()..." spam in my console. Is this normal?
Brad Hefta-Gaub
@ZappoMan
Apr 21 2014 21:56
it's not per se an error
we should make it less noisy
Konstantin
@SydoxX
Apr 21 2014 22:00
Maybe print it out only every 3 seconds it happens.