Three.js: Docs - LightProbe, LightProbeGenerator entries are missing!

Created on 23 Jan 2020 · 10Comments · Source: mrdoob/three.js

It seems that documentation entries for

THREE.LightProbe
THREE.LightProbeGenerator
are missing ..
(missing entries in /docs/list.js)

LightProbe were integrated around r104.

What I only found is a doc entry for

THREE.LightProbeHelper

BTW, maybe a tiny tool would be helpful,
that could check the accordance between
the source code classes tree,
and their corresponding doc entries/file existance .. ?

Pls drop me a word, if I could contribute ..
(.. is LightProbe developer Info available ?)

Documentation

Source

wolfgangvonludwigsburg

👍3 ❤1

Most helpful comment

I'm sorry - due to Corona issues in my company I've had to shift acitivity priorities ..

but I'll manage it 'til end of this week.

wolfgangvonludwigsburg on 23 Mar 2020

❤3

All 10 comments

Feel free to create the doc pages for LightProbe and LightProbeGenerator. You may want to start just with the technical skeleton (method names, signature etc.) and add the description with a subsequent PR. From my experience, adding the description will take noticeable more time for review.

Mugen87 on 23 Jan 2020

Ok, I will try my best to do it ..
Since I am new to this, it will take a little time ..

wolfgangvonludwigsburg on 23 Jan 2020

👍3

@wolfgangvonludwigsburg Are you still planning to make this change?

Mugen87 on 22 Feb 2020

yes, I am on research, one more week, please ..

wolfgangvonludwigsburg on 22 Feb 2020

👍1

Hey @wolfgangvonludwigsburg Any progress with the docs? :innocent:

DolphinIQ on 23 Mar 2020

I'm sorry - due to Corona issues in my company I've had to shift acitivity priorities ..

but I'll manage it 'til end of this week.

wolfgangvonludwigsburg on 23 Mar 2020

❤3

Thanks :) Would be awesome if this was included in r115

DolphinIQ on 23 Mar 2020

Could anyone give a, for example, 2 sentence explanation of what a LightProbe in Three.js is, and how Three.js uses them? I've found almost no information after going through the docs, the source code and the examples. There's weirdly more documentation on how LightProbeHelper works than LightProbe.

Right now I'm just trying to find a basic explanation on what they even do.

I mean I'm just guessing based on experience from other engines, but would I be correct in saying you can create and place lightprobes throughout a scene and Three.js will somehow interpolate between them for indirect light? I'm guessing that's what they do but I can't find any information to confirm that or any information on how Three.js interpolates between them if that is indeed how they work, or any guides on how to use them with Three.js. Is there a limit on the number you can have in a scene?

Just a real quick summary from perhaps whoever wrote the code for LightProbes would be nice.

mindinsomnia on 11 May 2020

@wolfgangvonludwigsburg Any updates on this issue? If you have no time, I suggest someone else adds the documentation.

Mugen87 on 11 May 2020

@mindinsomnia

I mean I'm just guessing based on experience from other engines, but would I be correct in saying you can create and place lightprobes throughout a scene and Three.js will somehow interpolate between them for indirect light?

Not yet. That's what #18371 is trying to implement.

Currently LightProbe and PMREMGenerator kind of serves the same purpose.

However, WebXR/AR provides the light estimation from the user's camera using Spherical Harmonics which is what LightProbe uses and that'll give it more use.