Docs: Updated structure.

volos · Dec 27, 2012 · b980f46 · b980f46
1 parent 050821e
commit b980f46
Show file tree

Hide file tree

Showing 48 changed files with 806 additions and 354 deletions.
diff --git a/docs/api/renderers/DOMRenderer.html → docs/api/core/BufferGeometry.html b/docs/api/renderers/DOMRenderer.html → docs/api/core/BufferGeometry.html
diff --git a/docs/api/core/Ray.html b/docs/api/core/Ray.html
diff --git a/docs/api/renderers/SVGRenderer.html → docs/api/core/Raycaster.html b/docs/api/renderers/SVGRenderer.html → docs/api/core/Raycaster.html
diff --git a/docs/api/core/Rectangle.html b/docs/api/core/Rectangle.html
diff --git a/docs/api/core/UV.html b/docs/api/core/UV.html
diff --git a/docs/api/extras/FontUtils.html b/docs/api/extras/FontUtils.html
@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8">
+		<script src="../../list.js"></script>
+		<script src="../../page.js"></script>
+		<link type="text/css" rel="stylesheet" href="../../page.css" />
+	</head>
+	<body>
+		<h1>[name]</h1>
+
+		<div class="desc">This is a utility class to handle values in <a href="https://en.wikipedia.org/wiki/RGB_color_model">RGB</a> and <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> color spaces.</div>
+
+
+		<h2>Methods</h2>
+
+		<h3>.adjustHSV( [page:Color color], [page:Number h], [page:Number s], [page:Number v] )</h3>
+
+		<div class="desc">Taking a color as input, converts it to HSV, and applies the h, s, v parameters in place, i.e. no new color is returned but the original object is modified.</div>
+
+		<div>
+		[page:Color color] — source color to be adjusted<br />
+		[page:Number h] — hue change amount<br />
+		[page:Number s] — saturation change amount<br />
+		[page:Number v] — value change amount
+		</div>
+
+		<h3>.rgbToHsv( [page:Color color], [page:Object hsv] )</h3>
+
+		<div class="desc">Converts an RGB color into an HSV triplet and returns the converted color.</div>
+
+		<div>
+		[page:Color color] — source color to be converted<br />
+		[page:Object hsv] — object in which the return value will be stored, if not null
+		</div>
+
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>
diff --git a/docs/api/extras/core/Curve.rst b/docs/api/extras/core/Curve.rst
diff --git a/docs/api/extras/core/CurvePath.rst b/docs/api/extras/core/CurvePath.rst
diff --git a/docs/api/extras/core/Path.rst b/docs/api/extras/core/Path.rst
diff --git a/docs/api/extras/core/Shape.rst b/docs/api/extras/core/Shape.rst
diff --git a/docs/api/extras/core/TextPath.rst b/docs/api/extras/core/TextPath.rst
diff --git a/docs/api/extras/geometries/AsteriskGeometry.html b/docs/api/extras/geometries/AsteriskGeometry.html
@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8">
+		<script src="../../../list.js"></script>
+		<script src="../../../page.js"></script>
+		<link type="text/css" rel="stylesheet" href="../../../page.css" />
+	</head>
+	<body>
+		<h1>[name]</h1>
+
+		<div class="desc">todo</div>
+
+
+		<h2>Constructor</h2>
+
+		<h3>[name]( radius, detail )</h3>
+
+
+		<h2>Properties</h2>
+
+		<h3>.[page:Vector3 todo]</h3>
+
+
+		<h2>Methods</h2>
+
+		<h3>.todo( [page:Vector3 todo] )</h3>
+		<div>
+		todo — todo<br />
+		</div>
+
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>
diff --git a/docs/api/extras/geometries/CircleGeometry.html b/docs/api/extras/geometries/CircleGeometry.html
@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8">
+		<script src="../../../list.js"></script>
+		<script src="../../../page.js"></script>
+		<link type="text/css" rel="stylesheet" href="../../../page.css" />
+	</head>
+	<body>
+		<h1>[name]</h1>
+
+		<div class="desc">todo</div>
+
+
+		<h2>Constructor</h2>
+
+		<h3>[name]( radius, detail )</h3>
+
+
+		<h2>Properties</h2>
+
+		<h3>.[page:Vector3 todo]</h3>
+
+
+		<h2>Methods</h2>
+
+		<h3>.todo( [page:Vector3 todo] )</h3>
+		<div>
+		todo — todo<br />
+		</div>
+
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>