Skip to content

Commit

Permalink
Docs: Improve MeshPhysicalMaterial page. (#23831)
Browse files Browse the repository at this point in the history
* Docs: Improve MeshPhysicalMaterial page.

* Docs: Clean up.
  • Loading branch information
Mugen87 authored Apr 4, 2022
1 parent dded976 commit 97f9899
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/api/en/materials/MeshPhysicalMaterial.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,16 @@ <h3>[name]( [param:Object parameters] )</h3>
<h2>Properties</h2>
<p>See the base [page:Material] and [page:MeshStandardMaterial] classes for common properties.</p>

<h3>[property:Color attenuationColor]</h3>
<p>
The color that white light turns into due to absorption when reaching the attenuation distance. Default is *white* (0xffffff).
</p>

<h3>[property:Float attenuationDistance]</h3>
<p>
Density of the medium given as the average distance that light travels in the medium before interacting with a particle. The value is given in world space. Default is *0*.
</p>

<h3>[property:Float clearcoat]</h3>
<p>
Represents the intensity of the clear coat layer, from *0.0* to *1.0*. Use clear coat related properties to enable multilayer
Expand Down Expand Up @@ -180,6 +190,16 @@ <h3>[property:Texture specularColorMap]</h3>
The RGB channels of this texture are multiplied against [page:.specularColor], for per-pixel control over specular color. Default is *null*.
</p>

<h3>[property:Float thickness]</h3>
<p>
The thickness of the volume beneath the surface. The value is given in the coordinate space of the mesh. If the value is 0 the material is thin-walled. Otherwise the material is a volume boundary. Default is *0*.
</p>

<h3>[property:Texture thicknessMap]</h3>
<p>
A texture that defines the thickness, stored in the G channel. This will be multiplied by [page:.thickness]. Default is *null*.
</p>

<h3>[property:Float transmission]</h3>
<p>
Degree of transmission (or optical transparency), from *0.0* to *1.0*. Default is *0.0*.<br />
Expand Down
21 changes: 21 additions & 0 deletions docs/api/zh/materials/MeshPhysicalMaterial.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,16 @@ <h3>[name]( [param:Object parameters] )</h3>
<h2>属性(Properties)</h2>
<p>共有属性请参见其基类[page:Material]和[page:MeshStandardMaterial]。</p>

<h3>[property:Color attenuationColor]</h3>
<p>
The color that white light turns into due to absorption when reaching the attenuation distance. Default is *white* (0xffffff).
</p>

<h3>[property:Float attenuationDistance]</h3>
<p>
Density of the medium given as the average distance that light travels in the medium before interacting with a particle. The value is given in world space. Default is *0*.
</p>

<h3>[property:Float clearcoat]</h3>
<p>
表示clear coat层的强度,范围从*0.0*到*1.0*m,当需要在表面加一层薄薄的半透明材质的时候,可以使用与clear coat相关的属性,默认为*0.0*;
Expand Down Expand Up @@ -165,6 +175,17 @@ <h3>[property:Texture specularColorMap]</h3>
此纹理的alpha通道将与[page:.specularColor]相乘,用于逐像素地控制高光颜色。默认值为*null*。
</p>

<h3>[property:Float thickness]</h3>
<p>
The thickness of the volume beneath the surface. The value is given in the coordinate space of the mesh. If the value is 0 the material is thin-walled. Otherwise the material is a volume boundary. Default is *0*.
</p>

<h3>[property:Texture thicknessMap]</h3>
<p>
A texture that defines the thickness, stored in the G channel. This will be multiplied by [page:.thickness]. Default is *null*.
</p>


<h3>[property:Float transmission]</h3>
<p>
透光率(或者说透光性),范围从*0.0*到*1.0*。默认值是*0.0*。<br />
Expand Down

0 comments on commit 97f9899

Please sign in to comment.