Browse Source

Updates EdgesHelper documentation

Arthur Silber 10 years ago
parent
commit
de45fafa7e
2 changed files with 5 additions and 3 deletions
  1. 4 2
      docs/api/extras/helpers/EdgesHelper.html
  2. 1 1
      src/extras/helpers/EdgesHelper.js

+ 4 - 2
docs/api/extras/helpers/EdgesHelper.html

@@ -27,10 +27,12 @@
 		</code>
 		</code>
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
-		<h3>[name]( [page:Object3D object], [page:Color color] )</h3>
+		<h3>[name]( [page:Object3D object], [page:Color color], [page:Float thresholdAngle] )</h3>
 		<div>
 		<div>
 		object -- Object of which to draw edges <br />
 		object -- Object of which to draw edges <br />
-		color -- Color of the edges.
+		color -- Color of the edges.<br />
+		thresholdAngle -- the minimim angle (in degrees), between the face normals of adjacent faces, that is required to render an edge. Default is 0.1.
+
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a [page:Line], showing only the "hard" edges of the passed object; specifically, no edge will be drawn between faces which are adjacent and coplanar (or nearly coplanar).
 		Creates a [page:Line], showing only the "hard" edges of the passed object; specifically, no edge will be drawn between faces which are adjacent and coplanar (or nearly coplanar).

+ 1 - 1
src/extras/helpers/EdgesHelper.js

@@ -2,7 +2,7 @@
  * @author WestLangley / http://github.com/WestLangley
  * @author WestLangley / http://github.com/WestLangley
  * @param object THREE.Mesh whose geometry will be used
  * @param object THREE.Mesh whose geometry will be used
  * @param hex line color
  * @param hex line color
- * @param thresholdAngle  the minimim angle (in degrees),
+ * @param thresholdAngle the minimim angle (in degrees),
  * between the face normals of adjacent faces,
  * between the face normals of adjacent faces,
  * that is required to render an edge. A value of 10 means
  * that is required to render an edge. A value of 10 means
  * an edge is only rendered if the angle is at least 10 degrees.
  * an edge is only rendered if the angle is at least 10 degrees.