Browse Source

Updated LineSegments doc

Lewy Blue 8 years ago
parent
commit
fcf7abe89a
2 changed files with 21 additions and 22 deletions
  1. 9 1
      docs/api/objects/Line.html
  2. 12 21
      docs/api/objects/LineSegments.html

+ 9 - 1
docs/api/objects/Line.html

@@ -12,7 +12,15 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">A continuous line.</div>
+		<div class="desc">
+			A continuous line.<br /><br />
+
+			This is nearly the same
+			as [page:LineSegments]; the only difference is that it is rendered using
+			[link:https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/drawElements gl.LINES]
+			instead of [link:https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/drawElements gl.LINE_STRIP]
+
+		</div>
 
 
 		<h2>Example</h2>

+ 12 - 21
docs/api/objects/LineSegments.html

@@ -12,7 +12,13 @@
 
 		<h1>[name]</h1>
 
-		<div class="desc">A series of lines drawn between pairs of vertices.</div>
+		<div class="desc">
+			A series of lines drawn between pairs of vertices.<br /><br />
+
+			This is nearly the same	as [page:Line]; the only difference is that it is rendered using
+			[link:https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/drawElements gl.LINE_STRIP]
+			instead of [link:https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/drawElements gl.LINES]
+		</div>
 
 
 		<h2>Constructor</h2>
@@ -20,8 +26,8 @@
 		<h3>[name]( [page:Geometry geometry], [page:Material material] )</h3>
 
 		<div>
-		geometry — Pair(s) of vertices representing each line segment(s).<br />
-		material — Material for the line. Default is [page:LineBasicMaterial LineBasicMaterial].
+		[page:Geometry geometry] — Pair(s) of vertices representing each line segment(s).<br />
+		[page:Material material] — Material for the line. Default is [page:LineBasicMaterial LineBasicMaterial].
 		</div>
 
 		<div>If no material is supplied, a randomized line material will be created and assigned to the object.</div>
@@ -30,32 +36,17 @@
 		<h2>Properties</h2>
 		<div>See the base [page:Line] class for common properties.</div>
 
-		<h3>[property:Geometry geometry]</h3>
+		<h3>[property:Boolean isLineSegments]</h3>
 		<div>
-		Pair(s) of vertices representing the line segment(s).
-		</div>
+			Used to check whether this or derived classes are line segments. Default is *true*.<br /><br />
 
-		<h3>[property:Material material]</h3>
-		<div>
-		Material for the line.
+			You should not change this, as it used internally for optimisation.
 		</div>
 
 
 		<h2>Methods</h2>
 		<div>See the base [page:Line] class for common methods.</div>
 
-		<h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects] )</h3>
-		<div>
-		Get intersections between a casted ray and this Line. [page:Raycaster.intersectObject] will call this method.
-		</div>
-
-		<h3>[method:LineSegments clone]()</h3>
-		<div>
-		Returns a clone of this LineSegments object and its descendants.
-		</div>
-
-
-
 		<h2>Source</h2>
 
 		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]