Browse Source

Update documentation

Max Godefroy (Clyde) 4 years ago
parent
commit
b429478bdd
2 changed files with 16 additions and 2 deletions
  1. 15 1
      examples/jsm/modifiers/EdgeSplitModifier.d.ts
  2. 1 1
      package-lock.json

+ 15 - 1
examples/jsm/modifiers/EdgeSplitModifier.d.ts

@@ -3,6 +3,20 @@ import { BufferGeometry, Geometry } from '../../../src/Three';
 export class EdgeSplitModifier {
 
 	constructor();
-	modify( geometry: Geometry, cutOffPoint: number ): BufferGeometry;
+
+
+	/**
+	 * @param geometry					The geometry to modify by splitting edges.
+	 * 									This geometry can be any of any type: Geometry or BufferGeometry, indexed or
+	 * 									not...
+	 *
+	 * @param cutOffPoint				The cutoff angle in radians. If the angle between two face normals is higher
+	 * 									than this value, a split will be made.
+	 *
+	 * @param [tryKeepNormals = true]	Set to true to keep the normal values for vertices that won't be split.
+	 * 									To use this feature, you also need to pass an indexed geometry with a 'normal'
+	 * 									BufferAttribute.
+	 */
+	modify( geometry: Geometry, cutOffPoint: number, tryKeepNormals: boolean ): BufferGeometry;
 
 }

+ 1 - 1
package-lock.json

@@ -3105,7 +3105,7 @@
     },
     "path-is-absolute": {
       "version": "1.0.1",
-      "resolved": "http://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
+      "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
       "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=",
       "dev": true
     },