Browse Source

Merge remote-tracking branch 'sole/dev' into dev

Mr.doob 13 years ago
parent
commit
adc8959206
2 changed files with 53 additions and 16 deletions
  1. 28 9
      docs/api/materials/LineBasicMaterial.html
  2. 25 7
      docs/api/objects/Line.html

+ 28 - 9
docs/api/materials/LineBasicMaterial.html

@@ -2,27 +2,46 @@
 
 <h1>[name]</h1>
 
-<div class="desc">todo</div>
+<div class="desc">A material for drawing wireframe-style geometries.</div>
 
 
 <h2>Constructor</h2>
 
-<h3>[name]()</h3>
+<h3>[name]( [page:Object parameters] )</h3>
 
+<div>parameters is an object with one or more properties defining the material's appearance.</div>
+<div>
+color — An instance of [page:Color Color]. Default is white.<br />
+linewidth — Line thickness. Default is 1.<br />
+linecap — Define appearance of line ends. Default is 'round'.<br />
+linejoin — Define appearance of line joints. Default is 'round'.<br />
+vertexColors — Define whether the material specifies a color per vertex, or not. Default is false.<br />
+fog — Define whether the material color is affected by global fog settings. Default is false.
+</div>
 
 <h2>Properties</h2>
 
-<h3>.[page:Vector3 todo]</h3>
+<h3>.[page:Color color]</h3>
+<div>An instance of [page:Color THREE.Color]. Default is a white (0xffffff) instance.</div>
 
+<h3>.[page:Float linewidth]</h3>
+<div>Controls line thickness. Default is 1.</div>
 
-<h2>Methods</h2>
+<h3>.[page:String linecap]</h3>
+<div>Define appearance of line ends. Possible values are "butt", "round" and "square". Default is 'round'.</div>
+<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:WebGLRenderer WebGL] renderer, but does work with the [page:CanvasRenderer Canvas] renderer.</div>
 
-<h3>.todo( [page:Vector3 todo] )</h3>
-<div>
-todo — todo<br />
-</div>
+<h3>.[page:String linejoin]</h3>
+<div>Define appearance of line joints. Possible values are "round", "bevel" and "miter". Default is 'round'.</div>
+<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:WebGLRenderer WebGL] renderer, but does work with the [page:CanvasRenderer Canvas] renderer.</div>
+
+<h3>.[page:Boolean vertexColors]</h3>
+<div>Define whether the material specifies a color per vertex, or not.</div>
 
+<h3>.[page:Boolean fog]</h3>
+<div>Define whether the material color is affected by global fog settings.</div>
+<div>This setting might not have any effect when used with certain renderers. For example, it is ignored with the [page:CanvasRenderer Canvas] renderer, but does work with the [page:WebGLRenderer WebGL] renderer.</div>
 
 <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]

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

@@ -1,26 +1,44 @@
+[page:Object3D] &rarr;
 <h1>[name]</h1>
 
-<div class="desc">todo</div>
+<div class="desc">A line or a series of lines.</div>
 
 
 <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>
 
-<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>
-todo — todo<br />
+In OpenGL terms, LineStrip is the classic GL_LINE_STRIP and LinePieces is the equivalent to GL_LINES.
 </div>
 
 
 <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]