瀏覽代碼

Merge pull request #13163 from mysteryDate/fix-torus-documentation

Change incorrect references in Torus docs
Mr.doob 7 年之前
父節點
當前提交
1ffd8db807

+ 2 - 2
docs/api/geometries/TorusBufferGeometry.html

@@ -44,8 +44,8 @@
 
 		<h3>[name]([page:Float radius], [page:Float tube], [page:Integer radialSegments], [page:Integer tubularSegments], [page:Float arc])</h3>
 		<div>
-		radius  Default is 1. <br />
-		tube — Diameter of the tube.  Default is 0.4. <br />
+		radius - Radius of the torus, from the center of the torus to the center of the tube. Default is 1. <br />
+		tube — Radius of the tube.  Default is 0.4. <br />
 		radialSegments — Default is 8 <br />
 		tubularSegments — Default is 6. <br />
 		arc — Central angle.  Default is Math.PI * 2.

+ 2 - 2
docs/api/geometries/TorusGeometry.html

@@ -44,8 +44,8 @@
 
 		<h3>[name]([page:Float radius], [page:Float tube], [page:Integer radialSegments], [page:Integer tubularSegments], [page:Float arc])</h3>
 		<div>
-		radius  Default is 1. <br />
-		tube — Diameter of the tube.  Default is 0.4. <br />
+		radius - Radius of the torus, from the center of the torus to the center of the tube. Default is 1. <br />
+		tube — Radius of the tube.  Default is 0.4. <br />
 		radialSegments — Default is 8 <br />
 		tubularSegments — Default is 6. <br />
 		arc — Central angle.  Default is Math.PI * 2.

+ 2 - 2
docs/api/geometries/TorusKnotBufferGeometry.html

@@ -45,8 +45,8 @@
 		<h3>[name]([page:Float radius], [page:Float tube], [page:Integer tubularSegments], [page:Integer radialSegments], [page:Integer p], [page:Integer q])</h3>
 		<div>
 			<ul>
-				<li>radius  Default is 1.</li>
-				<li>tube — Diameter of the tube. Default is 0.4.</li>
+				<li>radius - Radius of the torus. Default is 1.</li>
+				<li>tube — Radius of the tube. Default is 0.4.</li>
 				<li>tubularSegments — Default is 64.</li>
 				<li>radialSegments — Default is 8.</li>
 				<li>p — This value determines, how many times the geometry winds around its axis of rotational symmetry. Default is 2.</li>

+ 2 - 2
docs/api/geometries/TorusKnotGeometry.html

@@ -45,8 +45,8 @@
 		<h3>[name]([page:Float radius], [page:Float tube], [page:Integer tubularSegments], [page:Integer radialSegments], [page:Integer p], [page:Integer q])</h3>
 		<div>
 			<ul>
-				<li>radius  Default is 1.</li>
-				<li>tube — Diameter of the tube. Default is 0.4.</li>
+				<li>radius - Radius of the torus. Default is 1.</li>
+				<li>tube — Radius of the tube. Default is 0.4.</li>
 				<li>tubularSegments — Default is 64.</li>
 				<li>radialSegments — Default is 8.</li>
 				<li>p — This value determines, how many times the geometry winds around its axis of rotational symmetry. Default is 2.</li>