Ver código fonte

zh doc: scan and sync the diff with en doc from 2b683e69 to r116

gogoend 5 anos atrás
pai
commit
6446269fe6

+ 15 - 15
docs/api/zh/cameras/CubeCamera.html

@@ -12,8 +12,7 @@
 
 		<h1>立方相机([name])</h1>
 
-
-		<p class="desc">创建6个摄像机,并将它们所拍摄的场景渲染到[page:WebGLCubeRenderTarget]上。</p>
+		<p class="desc">创建6个渲染到[page:WebGLCubeRenderTarget]的摄像机。</p>
 
 		<h2>代码示例</h2>
 
@@ -40,7 +39,6 @@
 
 		<p>
 			[example:webgl_materials_cubemap_dynamic materials / cubemap / dynamic ]<br />
-			[example:webgl_materials_cubemap_dynamic2 materials / cubemap / dynamic2 ]<br />
 			[example:webgl_shading_physical shading / physical ]
 		</p>
 
@@ -48,16 +46,20 @@
 
 
 
-		<h3>[name]( [param:Number near], [param:Number far], [param:Number cubeResolution] )</h3>
+		<h3>[name]( [param:Number near], [param:Number far], [param:Number cubeResolution], [param:Object options] )</h3>
 		<p>
-
 		near -- 近剪切面的距离<br />
 		far -- 远剪切面的距离<br />
-		cubeResolution -- 设置立方体边缘的长度
+		cubeResolution -- 设置立方体边缘的长度<br />
+		options - (optional) object that holds texture parameters passed to the auto-generated WebGLCubeRenderTarget.
+		If not specified, the options default to:
+		<code>
+		{ format: RGBFormat, magFilter: LinearFilter, minFilter: LinearFilter }
+		</code>
 		</p>
 		<p>
-			构造一个包含6个[page:PerspectiveCamera PerspectiveCameras](透视摄像机)的立方摄像机,并将其拍摄的场景渲染到一个[page:WebGLCubeRenderTarget]上。
-
+		构造一个包含6个[page:PerspectiveCamera PerspectiveCameras](透视摄像机)的立方摄像机,
+		并将其拍摄的场景渲染到一个[page:WebGLCubeRenderTarget]上。
 		</p>
 
 
@@ -66,29 +68,27 @@
 
 		<h3>[property:WebGLCubeRenderTarget renderTarget]</h3>
 		<p>
-			生成的立方体纹理<br>
-			(译注:生成的立方体纹理保存在其中的.texture对象中,可作为贴图赋值给其他材质)
+		生成的立方体纹理<br>
+		(译注:生成的立方体纹理保存在其中的.texture对象中,可作为贴图赋值给其他材质)
 		</p>
 
 		<h2>方法</h2>
 		<p>共有方法请参见其基类[page:Object3D]。</p>
 
 
-
 		<h3>[method:null update]( [param:WebGLRenderer renderer], [param:Scene scene] )</h3>
 		<p>
 		renderer -- 当前的WebGL渲染器<br />
 		scene -- 当前的场景
 		</p>
 		<p>
-			这个方法用来更新[page:CubeCamera.renderTarget renderTarget](渲染目标对象)。
+		这个方法用来更新[page:CubeCamera.renderTarget renderTarget](渲染目标对象)。
 		</p>
 
 		<h3>[method:null clear]( [param:WebGLRenderer renderer], [param:Boolean color], [param:Boolean depth], [param:Boolean stencil] )</h3>
 		<p>
-			这个方法用来来清除[page:CubeCamera.renderTarget renderTarget]的颜色、深度和/或模板缓冲区。
-			颜色缓冲区设置为渲染器当前的“清除”色。参数默认值均为*true*。
-
+		这个方法用来来清除[page:CubeCamera.renderTarget renderTarget]的颜色、深度和/或模板缓冲区。
+		颜色缓冲区设置为渲染器当前的“清除”色。参数默认值均为*true*。
 		</p>
 
 		<h2>源代码</h2>

+ 3 - 3
docs/api/zh/cameras/StereoCamera.html

@@ -12,8 +12,8 @@
 		<h1>立体相机([name])</h1>
 
 		<p class="desc">
-			双透视摄像机(立体相机)常被用于创建[link:https://en.wikipedia.org/wiki/Anaglyph_3D 3D Anaglyph](3D立体影像)或者[link:https://en.wikipedia.org/wiki/parallax_barrier Parallax Barrier](视差效果)。
-
+			双透视摄像机(立体相机)常被用于创建[link:https://en.wikipedia.org/wiki/Anaglyph_3D 3D Anaglyph](3D立体影像)
+			或者[link:https://en.wikipedia.org/wiki/parallax_barrier Parallax Barrier](视差屏障)。
 		</p>
 
 		<h2>例子</h2>
@@ -46,7 +46,7 @@
 
 		<h3>[method:null update]( [param:PerspectiveCamera camera] )</h3>
 		<p>
-			基于摄像机通过场景,更新立体摄像机。
+		基于摄像机通过场景,更新立体摄像机。
 		</p>
 
 		<h2>源代码</h2>

+ 2 - 2
docs/api/zh/constants/Textures.html

@@ -73,10 +73,10 @@
 		这些常量用于纹理的[page:Texture.magFilter magFilter]属性,它们定义了当被纹理化的像素映射到小于或者等于1纹理元素(texel)的区域时,将要使用的纹理放大函数。<br /><br />
 
 		[page:constant NearestFilter]返回与指定纹理坐标(在曼哈顿距离之内)最接近的纹理元素的值。<br /><br />
+
 		[page:constant LinearFilter]是默认值,返回距离指定的纹理坐标最近的四个纹理元素的加权平均值,
 		并且可以包含纹理的其他部分中,被包裹或者被重复的项目,具体取决于 [page:Texture.wrapS wrapS] 和 [page:Texture.wrapT wrapT] 的值,and on the exact mapping。
-
-	</p>
+		</p>
 
 	<h2>缩小滤镜(Minification Filters)</h2>
 	<code>

+ 2 - 1
docs/api/zh/core/Raycaster.html

@@ -121,7 +121,8 @@
 
 		<h3>[property:Object params]</h3>
 		<p>
-			具有以下属性的对象:<code>
+			具有以下属性的对象:
+			<code>
 {
 	Mesh: {},
 	Line: { threshold: 1 },

+ 1 - 1
docs/api/zh/extras/core/Curve.html

@@ -102,7 +102,7 @@
 
 		<h3>[method:Object computeFrenetFrames]( [param:Integer segments], [param:Boolean closed] )</h3>
 		<p>
-		Generates the Frenet Frames. Used in geometries like [page:TubeGeometry] or [page:ExtrudeGeometry].
+		Generates the Frenet Frames. Requires a curve definition in 3D space. Used in geometries like [page:TubeGeometry] or [page:ExtrudeGeometry].
 		</p>
 
 		<h3>[method:Curve clone]()</h3>

+ 1 - 1
docs/api/zh/extras/curves/ArcCurve.html

@@ -12,7 +12,7 @@
 
 		<h1>弧线([name])</h1>
 
-		<p class="desc">[page:EllipseCurve]的别名</p>
+		<p class="desc">[page:EllipseCurve]的别名</p>
 
 		<h2>属性</h2>
 		<p>共有属性请参见其基类[page:EllipseCurve]。</p>

+ 1 - 1
docs/api/zh/geometries/TubeBufferGeometry.html

@@ -68,7 +68,7 @@
 
 		<h3>[name]([param:Curve path], [param:Integer tubularSegments], [param:Float radius], [param:Integer radialSegments], [param:Boolean closed])</h3>
 		<p>
-				path — [page:Curve] - 一个由基类[page:Curve]继承而来的路径。<br />
+				path — [page:Curve] - 一个由基类[page:Curve]继承而来的3D路径。<br />
 				tubularSegments — [page:Integer] - 组成这一管道的分段数,默认值为64。<br />
 				radius — [page:Float] - 管道的半径,默认值为1。<br />
 				radialSegments — [page:Integer] - 管道横截面的分段数目,默认值为8。<br />

+ 1 - 1
docs/api/zh/geometries/TubeGeometry.html

@@ -68,7 +68,7 @@
 
 		<h3>[name]([param:Curve path], [param:Integer tubularSegments], [param:Float radius], [param:Integer radialSegments], [param:Boolean closed])</h3>
 		<p>
-		path — [page:Curve] - 一个由基类[page:Curve]继承而来的路径。<br />
+		path — [page:Curve] - 一个由基类[page:Curve]继承而来的3D路径。<br />
 		tubularSegments — [page:Integer] - 组成这一管道的分段数,默认值为64。<br />
 		radius — [page:Float] - 管道的半径,默认值为1。<br />
 		radialSegments — [page:Integer] - 管道横截面的分段数目,默认值为8。<br />

+ 3 - 3
docs/api/zh/lights/PointLight.html

@@ -76,7 +76,7 @@
 			表示以"流明(光通量单位)"为单位的光功率。 缺省值 - *4Math.PI*。 <br /><br />
 
 			该值与 [page:.intensity intensity] 直接关联
-  			<code>
+			<code>
 				power = intensity * 4&pi;
 			</code>
 			修改该值也会导致光强度的改变。
@@ -86,8 +86,8 @@
 		<p>
 			[page:PointLightShadow]用与计算此光照的阴影。<br /><br />
 
-			此对象的摄像机被设置为 [page:PerspectiveCamera.fov fov] 为90度,[page:PerspectiveCamera.aspect aspect]为1
-			,近裁剪面  [page:PerspectiveCamera.near near] 为0,远裁剪面[page:PerspectiveCamera.far far]
+			此对象的摄像机被设置为 [page:PerspectiveCamera.fov fov] 为90度,[page:PerspectiveCamera.aspect aspect]为1
+			近裁剪面 [page:PerspectiveCamera.near near] 为0,远裁剪面[page:PerspectiveCamera.far far]
 			为500的透视摄像机 [page:PerspectiveCamera]。
 		</p>
 

+ 1 - 1
docs/api/zh/lights/shadows/LightShadow.html

@@ -69,7 +69,7 @@
 			将此值设置为大于1的值将模糊阴影的边缘。<br />
 
 			较高的值会在阴影中产生不必要的条带效果 - 更大的[page:.mapSize mapSize]将允许在这些效果变得可见之前使用更高的值。<br />
-			If [page:WebGLRenderer.shadowMap.type] is set to [page:Renderer PCFSoftShadowMap], radius has 
+			If [page:WebGLRenderer.shadowMap.type] is set to [page:Renderer PCFSoftShadowMap], radius has
 			no effect and it is recommended to increase softness by decreasing [page:.mapSize mapSize] instead.<br /><br />
 			
 			请注意,如果[page:WebGLRenderer.shadowMap.type]设置为[page:Renderer BasicShadowMap],将会无效。

+ 0 - 1
docs/api/zh/loaders/CubeTextureLoader.html

@@ -40,7 +40,6 @@ scene.background = new THREE.CubeTextureLoader()
 			[example:webgl_materials_cubemap_balls_reflection materials / cubemap / balls / reflection]<br />
 			[example:webgl_materials_cubemap_balls_refraction materials / cubemap / balls / refraction]<br />
 			[example:webgl_materials_cubemap_dynamic materials / cubemap / dynamic]<br />
-			[example:webgl_materials_cubemap_dynamic2 materials / cubemap / dynamic2]<br />
 			[example:webgl_materials_cubemap_refraction materials / cubemap / refraction]
 		</p>
 

+ 2 - 0
docs/api/zh/materials/MeshMatcapMaterial.html

@@ -96,6 +96,8 @@
 
 		<h3>[property:Texture normalMap]</h3>
 		<p> 用于创建法线贴图的纹理。RGB值会影响每个像素片段的曲面法线,并更改颜色照亮的方式。法线贴图不会改变曲面的实际形状,只会改变光照。
+			In case the material has a normal map authored using the left handed convention, the y component of normalScale
+			should be negated to compensate for the different handedness.
 		</p>
 
 		<h3>[property:Integer normalMapType]</h3>

+ 2 - 0
docs/api/zh/materials/MeshNormalMaterial.html

@@ -75,6 +75,8 @@
 
 		<h3>[property:Texture normalMap]</h3>
 		<p> 用于创建法线贴图的纹理。RGB值会影响每个像素片段的曲面法线,并更改颜色照亮的方式。法线贴图不会改变曲面的实际形状,只会改变光照。
+			In case the material has a normal map authored using the left handed convention, the y component of normalScale
+			should be negated to compensate for the different handedness.
 		</p>
 
 		<h3>[property:Integer normalMapType]</h3>

+ 2 - 0
docs/api/zh/materials/MeshPhongMaterial.html

@@ -132,6 +132,8 @@
 
 		<h3>[property:Texture normalMap]</h3>
 		<p> 用于创建法线贴图的纹理。RGB值会影响每个像素片段的曲面法线,并更改颜色照亮的方式。法线贴图不会改变曲面的实际形状,只会改变光照。
+			In case the material has a normal map authored using the left handed convention, the y component of normalScale
+			should be negated to compensate for the different handedness.
 		</p>
 
 		<h3>[property:Integer normalMapType]</h3>

+ 8 - 4
docs/api/zh/materials/MeshStandardMaterial.html

@@ -140,7 +140,7 @@
 			请确保将minFilter设置为其中一个MipMap选项,并且未强制禁用mip贴图。</p>
 		<p>
 			注意:MeshStandardMaterial 仅支持[link:https://threejs.org/docs/#api/textures/CubeTexture cube environment maps]。
-			如果要使用equirectangular贴图,则需要使用 [page:WebGLCubeRenderTarget.fromEquirectangularTexture WebGLCubeRenderTarget.fromEquirectangularTexture]().
+			如果要使用equirectangular贴图,则需要使用 [page:WebGLCubeRenderTarget.fromEquirectangularTexture WebGLCubeRenderTarget.fromEquirectangularTexture]()。
 			详细信息请参阅此示例[link:https://threejs.org/examples/webgl_materials_envmaps_exr.html example]。
 		</p>
 
@@ -174,6 +174,8 @@
 
 		<h3>[property:Texture normalMap]</h3>
 		<p>用于创建法线贴图的纹理。RGB值会影响每个像素片段的曲面法线,并更改颜色照亮的方式。法线贴图不会改变曲面的实际形状,只会改变光照。
+			In case the material has a normal map authored using the left handed convention, the y component of normalScale
+			should be negated to compensate for the different handedness.
 		</p>
 
 		<h3>[property:Integer normalMapType]</h3>
@@ -202,11 +204,13 @@
 		<p>材质是否使用蒙皮。默认值为false。</p>
 
 		<h3>[property:Boolean vertexTangents]</h3>
-		<p>	Defines whether precomputed vertex tangents, which must be provided in a vec4 "tangent" attribute,
-			are used. When disabled, tangents are derived automatically. Using precomputed tangents will give
-			more accurate normal map details in some cases, such as with mirrored UVs. Default is false.
+		<p>
+		Defines whether precomputed vertex tangents, which must be provided in a vec4 "tangent" attribute,
+		are used. When disabled, tangents are derived automatically. Using precomputed tangents will give
+		more accurate normal map details in some cases, such as with mirrored UVs. Default is false.
 		</p>
 
+
 		<h3>[property:Boolean wireframe]</h3>
 		<p>将几何体渲染为线框。默认值为*false*(即渲染为平面多边形)。</p>
 

+ 2 - 0
docs/api/zh/materials/MeshToonMaterial.html

@@ -147,6 +147,8 @@
 		<p>
 			The texture to create a normal map. The RGB values affect the surface normal for each pixel fragment and change
 			the way the color is lit. Normal maps do not change the actual shape of the surface, only the lighting.
+			In case the material has a normal map authored using the left handed convention, the y component of normalScale
+			should be negated to compensate for the different handedness.
 		</p>
 
 		<h3>[property:Integer normalMapType]</h3>

+ 1 - 1
docs/api/zh/math/Box2.html

@@ -11,7 +11,7 @@
 		<h1>[name]</h1>
 
 		<p class="desc">
-			表示二维空间中的一个包围盒。
+			表示二维空间中的一个轴对齐包围盒(axis-aligned bounding box,AABB)
 		</p>
 
 

+ 1 - 1
docs/api/zh/math/Box3.html

@@ -11,7 +11,7 @@
 		<h1>[name]</h1>
 
 		<p class="desc">
-			在3D空间中表示一个盒子或立方体。其主要用于表示物体在世界坐标中的边界框
+			表示二维空间中的一个轴对齐包围盒(axis-aligned bounding box,AABB)
 		</p>
 
 		<h2>代码示例</h2>

+ 1 - 1
docs/api/zh/math/Sphere.html

@@ -16,7 +16,7 @@
 		<h3>[name]( [param:Vector3 center], [param:Float radius] )</h3>
 		<p>
 		[page:Vector3 center] - 球心的位置,默认值是一个位于(0, 0, 0)的[page:Vector3]。<br />
-		[page:Float radius] - 球的半径,默认值是0。<br /><br />
+		[page:Float radius] - 球的半径,默认值是-1。<br /><br />
 
 		创建一个新的[name]。
 

+ 5 - 0
docs/api/zh/math/Vector3.html

@@ -360,6 +360,11 @@
 		设置该向量的[page:.x x]值、[page:.y y]值和[page:.z z]值。
 		</p>
 
+		<h3>[method:this setFromMatrix3Column]( [param:Matrix3 matrix], [param:Integer index] )</h3>
+		<p>
+		Sets this vector's [page:.x x], [page:.y y] and [page:.z z] components from [page:Integer index] column of [page:Matrix3 matrix].
+		</p>
+
 		<h3>[method:this setFromMatrixPosition]( [param:Matrix4 m] )</h3>
 		<p>
 		从变换矩阵([link:https://en.wikipedia.org/wiki/Transformation_matrix transformation matrix])[page:Matrix4 m]中,

+ 4 - 0
docs/api/zh/objects/LOD.html

@@ -85,6 +85,10 @@
 			返回一个LOD对象及其所关联的在特定距离中的物体。
 		</p>
 
+		<h3>[method:integer getCurrentLevel]()</h3>
+		<p>
+		Get the currently active LOD level. As index of the levels array.
+		</p>
 
 		<h3>[method:Object3D getObjectForDistance]( [param:Float distance] )</h3>
 		<p>

+ 2 - 2
docs/api/zh/objects/Mesh.html

@@ -14,7 +14,7 @@
 
 		<p class="desc">
 			表示基于以三角形为[link:https://en.wikipedia.org/wiki/Polygon_mesh polygon mesh](多边形网格)的物体的类。
-		  	同时也作为其他类的基类,例如[page:SkinnedMesh]。
+			同时也作为其他类的基类,例如[page:SkinnedMesh]。
 		</p>
 
 
@@ -49,7 +49,7 @@
 
 		<h3>[property:Material material]</h3>
 		<p>
-			由[page:Material]基类或者一个包含材质的数组派生而来的材质实例,定义了物体的外观。默认值是一个具有随机颜色的[page:MeshBasicMaterial]。
+			由[page:Material]基类或者一个包含材质的数组派生而来的材质实例,定义了物体的外观。默认值是一个[page:MeshBasicMaterial]。
 		</p>
 
 		<h3>[property:Array morphTargetInfluences]</h3>

+ 2 - 2
docs/api/zh/objects/Points.html

@@ -27,7 +27,7 @@
 	<p>
 		[page:Geometry geometry] —— (可选)是一个[page:Geometry]或者[page:BufferGeometry]的实例,默认值是一个新的[page:BufferGeometry]。
 		<br />
-		[page:Material material] —— (可选) 是一个对象,默认值是一个具有随机颜色的新的[page:PointsMaterial]。
+		[page:Material material] —— (可选) 是一个对象,默认值是一个[page:PointsMaterial]。
 	</p>
 
 
@@ -42,7 +42,7 @@
 
 	<h3>[property:Material material]</h3>
 	<p>
-		[page:Material]的实例。定义了物体的外观。默认值是一个具有随机颜色的[page:PointsMaterial]。
+		[page:Material]的实例。定义了物体的外观。默认值是一个的[page:PointsMaterial]。
 	</p>
 
 	<h3>[property:Array morphTargetInfluences]</h3>

+ 1 - 1
docs/api/zh/renderers/WebGLRenderTarget.html

@@ -34,7 +34,7 @@
 		[page:Constant minFilter] - 默认是[page:Textures LinearFilter]. <br />
 		[page:Constant format] - 默认是[page:Textures RGBAFormat]. <br />
 		[page:Constant type] - 默认是[page:Textures UnsignedByteType]. <br />
-		[page:Number anisotropy] - 默认是*1*. 参见[page:Texture.anistropy]<br />
+		[page:Number anisotropy] - 默认是*1*. 参见[page:Texture.anisotropy]<br />
 		[page:Constant encoding] - 默认是[page:Textures LinearEncoding]. <br />
 		[page:Boolean depthBuffer] - 默认是*true*. 如果不需要就设为false <br />
 		[page:Boolean stencilBuffer] - 默认是*true*. 如果不需要就设为false <br /><br />

+ 3 - 3
docs/api/zh/renderers/WebGLRenderer.html

@@ -381,10 +381,10 @@
 		<p>使用相机和指定材质渲染缓冲几何组。</p>
 
 		<h3>[method:null renderBufferImmediate]( [param:Object3D object], [param:WebGLProgram program] )</h3>
-		<p>object - 一个[page:Object3D]实例<br />
-		program - 一个[page:WebGLProgram]实例<br />
+		<p>object - an instance of [page:Object3D]<br />
+		program - an instance of [page:WebGLProgram]<br />
 
-		渲染即使缓冲,由renderObjectImmediate对象调用
+		Renders an instance of [page:ImmediateRenderObject],由renderObjectImmediate对象调用。
 		</p>
 
 		<h3>[method:null setAnimationLoop]( [param:Function callback] )</h3>

+ 3 - 1
docs/api/zh/renderers/shaders/UniformsUtils.html

@@ -10,7 +10,9 @@
 	<body>
 		<h1>[name]</h1>
 
-		<p class="desc">Uniform工具. 支持uniform变量的合并和克隆</p>
+		<p class="desc">
+			Provides utility functions for managing uniforms.
+		</p>
 
 		<h2>方法</h2>
 

+ 2 - 1
docs/api/zh/scenes/Scene.html

@@ -35,7 +35,8 @@
 		<h3>[property:Object background]</h3>
 		<p>
 			若不为空,在渲染场景的时候将设置背景,且背景总是首先被渲染的。
-			可以设置一个用于的“clear”的[page:Color](颜色)、一个覆盖canvas的[page:Texture](纹理),或是一个[page:CubeTexture]。默认值为null。
+			可以设置一个用于的“clear”的[page:Color](颜色)、一个覆盖canvas的[page:Texture](纹理),
+			或是一个 cubemap as a [page:CubeTexture] or [page:WebGLCubeRenderTarget]。默认值为null。
 		</p>
 
 		<h3>[property:Texture environment]</h3>

+ 6 - 3
docs/api/zh/textures/CubeTexture.html

@@ -42,12 +42,15 @@
 
 		<h2>属性</h2>
 
-		<h3>请参阅[page:Texture]页面。</h3>
+		<p>
+		See the base [page:Texture Texture] class for common properties.
+		</p>
 
 		<h2>方法</h2>
 
-
-		<h3>请参阅[page:Texture]页面。</h3>
+		<p>
+		See the base [page:Texture Texture] class for common methods.
+		</p>
 
 		<h2>源代码</h2>
 

+ 7 - 0
docs/api/zh/textures/DataTexture.html

@@ -61,6 +61,10 @@
 
 		<h2>Properties</h2>
 
+		<p>
+		See the base [page:Texture Texture] class for common properties.
+		</p>
+
 		<h3>[property:Image image]</h3>
 		<p>
 		Overridden with a record type holding data, width and height.
@@ -68,6 +72,9 @@
 
 		<h2>Methods</h2>
 
+		<p>
+		See the base [page:Texture Texture] class for common methods.
+		</p>
 
 		<h2>Source</h2>
 

+ 1 - 1
docs/api/zh/textures/Texture.html

@@ -189,7 +189,7 @@
 
 		<h3>[property:boolean premultiplyAlpha]</h3>
 		<p>
-		If set to *true*, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU. Defaut is *false*.<br /><br />
+		If set to *true*, the alpha channel, if present, is multiplied into the color channels when the texture is uploaded to the GPU. Default is *false*.<br /><br />
 
 		Note that this property has no effect for [link:https://developer.mozilla.org/de/docs/Web/API/ImageBitmap ImageBitmap].
 		You need to configure on bitmap creation instead. See [page:ImageBitmapLoader].