2
0
Эх сурвалжийг харах

Add a bit of documentation for the Projector class

sole 13 жил өмнө
parent
commit
ce183b552a

+ 20 - 1
docs/api/core/Projector.html

@@ -25,12 +25,31 @@
 
 		<h3>.pickingRay( [page:Vector3 vector], [page:Camera camera] ) [page:Ray]</h3>
 		<div>
-		Translates a 2D point from NDC to a [page:Ray] that can be used for picking.
+		Translates a 2D point from NDC (<em>Normalized Device Coordinates</em>) to a [page:Ray] that can be used for picking. NDC range from [-1..1] in x (left to right) and [1.0 .. -1.0] in y (top to bottom).
 		</div>
 
 		<h3>.projectGraph( [page:Object3D root], [page:Boolean sort] ) [page:Object]</h3>
+		<div>
+		[page:Object3D root] — object to project.<br />
+		[page:Boolean sort] — select whether to sort elements using the <a href="http://en.wikipedia.org/wiki/Painter%27s_algorithm">Painter's algorithm</a>.
+		</div>
+		<div>
+		Recursively create a rendering graph, starting from the <em>root</em> object.
+		</div>
 
 		<h3>.projectScene( [page:Scene scene], [page:Camera camera], [page:Boolean sort] ) [page:Object]</h3>
+		<div>
+		[page:Scene scene] — scene to project.<br />
+		[page:Camera camera] — camera to use in the projection.<br />
+		[page:Boolean sort] — select whether to sort elements using the <a href="http://en.wikipedia.org/wiki/Painter%27s_algorithm">Painter's algorithm</a>.
+		</div>
+		
+		<div>
+		Transforms a 3D [page:Scene scene] object into 2D render data that can be rendered in a screen with your renderer of choice, projecting and clipping things out according to the used camera.
+		</div>
+		<div>
+		If the <em>scene</em> were a real scene, this method would be the equivalent of taking a picture with the <em>camera</em> (and developing the film would be the next step, using a Renderer).
+		</div>
 
 
 		<h2>Source</h2>