Three.js: Missing some properties in MeshPhysicalMaterial document

Created on 20 Feb 2020  Â·  6Comments  Â·  Source: mrdoob/three.js

Description of the problem

It seems lack of some properties in MeshPhysicalMaterial document.

https://threejs.org/docs/#api/en/materials/MeshPhysicalMaterial

Ever what I noticed are

  • clearcoatNormalScale
  • clearcoatNormalMap
  • sheen
  • transparency

We should update.

Three.js version
  • [x] Dev
  • [ ] r113
  • [ ] ...
Browser
  • [x] All of them
  • [ ] Chrome
  • [ ] Firefox
  • [ ] Internet Explorer
OS
  • [x] All of them
  • [ ] Windows
  • [ ] macOS
  • [ ] Linux
  • [ ] Android
  • [ ] iOS
Hardware Requirements (graphics card, VR Device, ...)
Documentation

Most helpful comment

✨ super secret, tell no one 😎 ✨

All 6 comments

There might be some justification for leaving them undocumented if we think the API is still evolving... that might be true of sheen? But I think clearcoatNormalScale and clearcoatNormalMap are unlikely to change. I have no idea about ".transparency" 😓

Oh, I forgot that there may be a chance that it is intentional.. Anyone knows about it?

Off topic, it may be helpful for devs to add note in the code if we intentionally undocument certain properties/methods.

✨ super secret, tell no one 😎 ✨

I think it's safe to document clearcoatNormalScale, clearcoatNormalMap and transparency. I would wait with sheen until #17700 is resolved.

[property:Float clearcoatNormalMap]

Incorrectly documented as a Float - minor issue, yet clearly, and correctly specified in the Class

@QuidCode Thanks for reporting. Fixed!

Was this page helpful?
0 / 5 - 0 ratings