Browse Source

Line docs

sole 13 years ago
parent
commit
49a8650434
1 changed files with 25 additions and 7 deletions
  1. 25 7
      docs/api/objects/Line.html

+ 25 - 7
docs/api/objects/Line.html

@@ -1,26 +1,44 @@
+[page:Object3D] →
 <h1>[name]</h1>
 <h1>[name]</h1>
 
 
-<div class="desc">todo</div>
+<div class="desc">A line or a series of lines.</div>
 
 
 
 
 <h2>Constructor</h2>
 <h2>Constructor</h2>
 
 
-<h3>[name]()</h3>
+<h3>[name]( [page:Geometry geometry], [page:Material material], [page:Integer type] )</h3>
 
 
+<div>
+geometry — Vertices representing the line segment(s).<br />
+material — Material for the line. Default is [page:LineBasicMaterial LineBasicMaterial].<br />
+type — Connection type between vertices. Default is LineStrip.
+</div>
+
+<div>If no material is supplied, a randomized line material will be created and assigned to the object.</div>
+
+<div>Also, if no type is supplied, the default (LineStrip) will be used).</div>
 
 
 <h2>Properties</h2>
 <h2>Properties</h2>
 
 
-<h3>.[page:Vector3 todo]</h3>
+<h3>.[page:Geometry geometry]</h3>
+<div>
+Vertices representing the line segment(s).
+</div>
 
 
+<h3>.[page:Material material]</h3>
+<div>
+Material for the line.
+</div>
 
 
-<h2>Methods</h2>
+<h3>.[page:Integer type]</h3>
+<div>
+Possible values: LineStrip or LinePieces. LineStrip will draw a series of segments connecting each point (first connected to the second, the second connected to the third, and so on and so forth); and LinePieces will draw a series of pairs of segments (first connected to the second, the third connected to the fourth, and so on and so forth).</div>
 
 
-<h3>.todo( [page:Vector3 todo] )</h3>
 <div>
 <div>
-todo — todo<br />
+In OpenGL terms, LineStrip is the classic GL_LINE_STRIP and LinePieces is the equivalent to GL_LINES.
 </div>
 </div>
 
 
 
 
 <h2>Source</h2>
 <h2>Source</h2>
 
 
-[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]