X Tutup
The Wayback Machine - https://web.archive.org/web/20200526153626/https://github.com/mrdoob/three.js/issues/18680
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing some properties in MeshPhysicalMaterial document #18680

Open
takahirox opened this issue Feb 20, 2020 · 6 comments
Open

Missing some properties in MeshPhysicalMaterial document #18680

takahirox opened this issue Feb 20, 2020 · 6 comments
Labels

Comments

@takahirox
Copy link
Collaborator

@takahirox takahirox commented Feb 20, 2020

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
  • Dev
  • r113
  • ...
Browser
  • All of them
  • Chrome
  • Firefox
  • Internet Explorer
OS
  • All of them
  • Windows
  • macOS
  • Linux
  • Android
  • iOS
Hardware Requirements (graphics card, VR Device, ...)
@donmccurdy
Copy link
Collaborator

@donmccurdy donmccurdy commented Feb 20, 2020

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" 😓

@takahirox
Copy link
Collaborator Author

@takahirox takahirox commented Feb 20, 2020

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.

@donmccurdy
Copy link
Collaborator

@donmccurdy donmccurdy commented Feb 20, 2020

super secret, tell no one 😎

@Mugen87
Copy link
Collaborator

@Mugen87 Mugen87 commented Feb 20, 2020

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

@QuidCode
Copy link

@QuidCode QuidCode commented Apr 4, 2020

[property:Float clearcoatNormalMap]

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

@Mugen87
Copy link
Collaborator

@Mugen87 Mugen87 commented Apr 4, 2020

@QuidCode Thanks for reporting. Fixed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.
X Tutup