mrdoob / three.js

JavaScript 3D Library.
https://threejs.org/
MIT License
102.24k stars 35.35k forks source link

GroundProjectedEnv naming is confusing as it's a background, not an environment #25287

Closed hybridherbst closed 1 year ago

hybridherbst commented 1 year ago

Description

Since #24311 there is a way to make a ground projected environment - which works great!

But the naming is now somewhat confusing:

Version

latest

Mugen87 commented 1 year ago

We went for GroundProjectedEnv because the technique behind the class is called "ground projected environment maps". According to my personal experience up to this point, GroundProjectedEnv as a module name had a good acceptance so far since especially experienced devs know the technique and thus understand the purpose of the class.

it should probably be a GroundProjectedBackground and not Env (?)

As you have mentioned GroundProjectedEnv is not assigned to Scene.background so I would find this name actually worse. The current one at least describes the technique. But I admit there is a the conflict with Scene.environment...

Maybe GroundProjectedSkybox?

melMass commented 1 year ago

Glad I finally found this issue, I was only seeing references of GroundProjectedEnv everywhere, my IDE wasn't complaining but vite was (@types/three is outdated)