@needle-tools/three 0.145.4 → 0.146.2

package/examples/js/loaders/lwo/IFFParser.js

@@ -33,10 +33,10 @@
  * - The entire file is contained in one top level FORM
  *
  **/
-
 	function IFFParser() {
 
-		this.debugger = new Debugger(); // this.debugger.enable(); // un-comment to log IFF hierarchy.
+		this.debugger = new Debugger();
+		// this.debugger.enable(); // un-comment to log IFF hierarchy.
 
 	}
 
@@ -50,23 +50,21 @@
 				layers: [],
 				tags: [],
 				textures: []
-			}; // start out at the top level to add any data before first layer is encountered
+			};
 
+			// start out at the top level to add any data before first layer is encountered
 			this.currentLayer = this.tree;
 			this.currentForm = this.tree;
 			this.parseTopForm();
 			if ( this.tree.format === undefined ) return;
-
 			if ( this.tree.format === 'LWO2' ) {
 
 				this.parser = new THREE.LWO2Parser( this );
-
 				while ( ! this.reader.endOfFile() ) this.parser.parseBlock();
 
 			} else if ( this.tree.format === 'LWO3' ) {
 
 				this.parser = new THREE.LWO3Parser( this );
-
 				while ( ! this.reader.endOfFile() ) this.parser.parseBlock();
 
 			}
@@ -76,12 +74,10 @@
 			return this.tree;
 
 		},
-
 		parseTopForm() {
 
 			this.debugger.offset = this.reader.offset;
 			var topForm = this.reader.getIDTag();
-
 			if ( topForm !== 'FORM' ) {
 
 				console.warn( 'LWOLoader: Top-level FORM missing.' );
@@ -93,7 +89,6 @@
 			this.debugger.dataOffset = this.reader.offset;
 			this.debugger.length = length;
 			var type = this.reader.getIDTag();
-
 			if ( type === 'LWO2' ) {
 
 				this.tree.format = type;
@@ -110,42 +105,37 @@
 			return;
 
 		},
-
 		///
 		// FORM PARSING METHODS
 		///
+
 		// Forms are organisational and can contain any number of sub chunks and sub forms
 		// FORM ::= 'FORM'[ID4], length[U4], type[ID4], ( chunk[CHUNK] | form[FORM] ) * }
 		parseForm( length ) {
 
 			var type = this.reader.getIDTag();
-
 			switch ( type ) {
 
 				// SKIPPED FORMS
 				// if skipForm( length ) is called, the entire form and any sub forms and chunks are skipped
-				case 'ISEQ': // Image sequence
 
+				case 'ISEQ': // Image sequence
 				case 'ANIM': // plug in animation
-
 				case 'STCC': // Color-cycling Still
-
 				case 'VPVL':
 				case 'VPRM':
 				case 'NROT':
 				case 'WRPW': // image wrap w ( for cylindrical and spherical projections)
-
 				case 'WRPH': // image wrap h
-
 				case 'FUNC':
 				case 'FALL':
 				case 'OPAC':
 				case 'GRAD': // gradient texture
-
 				case 'ENVS':
 				case 'VMOP':
-				case 'VMBG': // Car Material FORMS
+				case 'VMBG':
 
+					// Car Material FORMS
 				case 'OMAX':
 				case 'STEX':
 				case 'CKBG':
@@ -154,48 +144,40 @@
 				case 'VMLB':
 					this.debugger.skipped = true;
 					this.skipForm( length ); // not currently supported
-
 					break;
+
 					// if break; is called directly, the position in the lwoTree is not created
 					// any sub chunks and forms are added to the parent form instead
-
 				case 'META':
 				case 'NNDS':
 				case 'NODS':
 				case 'NDTA':
 				case 'ADAT':
 				case 'AOVS':
-				case 'BLOK': // used by texture nodes
+				case 'BLOK':
 
+					// used by texture nodes
 				case 'IBGC': // imageBackgroundColor
-
 				case 'IOPC': // imageOpacity
-
 				case 'IIMG': // hold reference to image path
-
 				case 'TXTR':
 					// this.setupForm( type, length );
 					this.debugger.length = 4;
 					this.debugger.skipped = true;
 					break;
-
 				case 'IFAL': // imageFallof
-
 				case 'ISCL': // imageScale
-
 				case 'IPOS': // imagePosition
-
 				case 'IROT': // imageRotation
-
 				case 'IBMP':
 				case 'IUTD':
 				case 'IVTD':
 					this.parseTextureNodeAttribute( type );
 					break;
-
 				case 'ENVL':
 					this.parseEnvelope( length );
 					break;
+
 					// CLIP FORM AND SUB FORMS
 
 				case 'CLIP':
@@ -210,93 +192,81 @@
 					}
 
 					break;
-
 				case 'STIL':
 					this.parseImage();
 					break;
-
 				case 'XREF':
 					// clone of another STIL
 					this.reader.skip( 8 ); // unknown
-
 					this.currentForm.referenceTexture = {
 						index: this.reader.getUint32(),
 						refName: this.reader.getString() // internal unique ref
-
 					};
+
 					break;
+
 					// Not in spec, used by texture nodes
 
 				case 'IMST':
 					this.parseImageStateForm( length );
 					break;
+
 					// SURF FORM AND SUB FORMS
 
 				case 'SURF':
 					this.parseSurfaceForm( length );
 					break;
-
 				case 'VALU':
 					// Not in spec
 					this.parseValueForm( length );
 					break;
-
 				case 'NTAG':
 					this.parseSubNode( length );
 					break;
-
 				case 'ATTR': // BSDF Node Attributes
-
 				case 'SATR':
 					// Standard Node Attributes
 					this.setupForm( 'attributes', length );
 					break;
-
 				case 'NCON':
 					this.parseConnections( length );
 					break;
-
 				case 'SSHA':
 					this.parentForm = this.currentForm;
 					this.currentForm = this.currentSurface;
 					this.setupForm( 'surfaceShader', length );
 					break;
-
 				case 'SSHD':
 					this.setupForm( 'surfaceShaderData', length );
 					break;
-
 				case 'ENTR':
 					// Not in spec
 					this.parseEntryForm( length );
 					break;
+
 					// Image Map Layer
 
 				case 'IMAP':
 					this.parseImageMap( length );
 					break;
-
 				case 'TAMP':
 					this.parseXVAL( 'amplitude', length );
 					break;
+
 					//Texture Mapping Form
 
 				case 'TMAP':
 					this.setupForm( 'textureMap', length );
 					break;
-
 				case 'CNTR':
 					this.parseXVAL3( 'center', length );
 					break;
-
 				case 'SIZE':
 					this.parseXVAL3( 'scale', length );
 					break;
-
 				case 'ROTA':
 					this.parseXVAL3( 'rotation', length );
 					break;
-
 				default:
 					this.parseUnknownForm( type, length );
 
@@ -307,13 +277,11 @@
 			this.debugger.log();
 
 		},
-
 		setupForm( type, length ) {
 
 			if ( ! this.currentForm ) this.currentForm = this.currentNode;
 			this.currentFormEnd = this.reader.offset + length;
 			this.parentForm = this.currentForm;
-
 			if ( ! this.currentForm[ type ] ) {
 
 				this.currentForm[ type ] = {};
@@ -328,13 +296,11 @@
 			}
 
 		},
-
 		skipForm( length ) {
 
 			this.reader.skip( length - 4 );
 
 		},
-
 		parseUnknownForm( type, length ) {
 
 			console.warn( 'LWOLoader: unknown FORM encountered: ' + type, length );
@@ -342,7 +308,6 @@
 			this.reader.skip( length - 4 );
 
 		},
-
 		parseSurfaceForm( length ) {
 
 			this.reader.skip( 8 ); // unknown Uint32 x2
@@ -364,7 +329,6 @@
 			this.currentFormEnd = this.reader.offset + length;
 
 		},
-
 		parseSurfaceLwo2( length ) {
 
 			var name = this.reader.getString();
@@ -383,14 +347,13 @@
 			this.currentFormEnd = this.reader.offset + length;
 
 		},
-
 		parseSubNode( length ) {
 
 			// parse the NRNM CHUNK of the subnode FORM to get
 			// a meaningful name for the subNode
 			// some subnodes can be renamed, but Input and Surface cannot
-			this.reader.skip( 8 ); // NRNM + length
 
+			this.reader.skip( 8 ); // NRNM + length
 			var name = this.reader.getString();
 			var node = {
 				name: name
@@ -400,7 +363,6 @@
 			this.currentFormEnd = this.reader.offset + length;
 
 		},
-
 		// collect attributes from all nodes at the top level of a surface
 		parseConnections( length ) {
 
@@ -409,18 +371,15 @@
 			this.currentForm = this.currentSurface.connections;
 
 		},
-
 		// surface node attribute data, e.g. specular, roughness etc
 		parseEntryForm( length ) {
 
 			this.reader.skip( 8 ); // NAME + length
-
 			var name = this.reader.getString();
 			this.currentForm = this.currentNode.attributes;
 			this.setupForm( name, length );
 
 		},
-
 		// parse values from material - doesn't match up to other LWO3 data types
 		// sub form of entry form
 		parseValueForm() {
@@ -428,7 +387,6 @@
 			this.reader.skip( 8 ); // unknown + length
 
 			var valueType = this.reader.getString();
-
 			if ( valueType === 'double' ) {
 
 				this.currentForm.value = this.reader.getUint64();
@@ -450,7 +408,6 @@
 			}
 
 		},
-
 		// holds various data about texture node image state
 		// Data other thanmipMapLevel unknown
 		parseImageStateForm() {
@@ -460,7 +417,6 @@
 			this.currentForm.mipMapLevel = this.reader.getFloat32();
 
 		},
-
 		// LWO2 style image data node OR LWO3 textures defined at top level in editor (not as SURF node)
 		parseImageMap( length ) {
 
@@ -485,27 +441,21 @@
 				case 'ISCL':
 					this.currentNode.scale = this.reader.getFloat32Array( 3 );
 					break;
-
 				case 'IPOS':
 					this.currentNode.position = this.reader.getFloat32Array( 3 );
 					break;
-
 				case 'IROT':
 					this.currentNode.rotation = this.reader.getFloat32Array( 3 );
 					break;
-
 				case 'IFAL':
 					this.currentNode.falloff = this.reader.getFloat32Array( 3 );
 					break;
-
 				case 'IBMP':
 					this.currentNode.amplitude = this.reader.getFloat32();
 					break;
-
 				case 'IUTD':
 					this.currentNode.uTiles = this.reader.getFloat32();
 					break;
-
 				case 'IVTD':
 					this.currentNode.vTiles = this.reader.getFloat32();
 					break;
@@ -526,21 +476,23 @@
 		///
 		// CHUNK PARSING METHODS
 		///
+
 		// clips can either be defined inside a surface node, or at the top
 		// level and they have a different format in each case
 		parseClip( length ) {
 
-			var tag = this.reader.getIDTag(); // inside surface node
+			var tag = this.reader.getIDTag();
 
+			// inside surface node
 			if ( tag === 'FORM' ) {
 
 				this.reader.skip( 16 );
 				this.currentNode.fileName = this.reader.getString();
 				return;
 
-			} // otherwise top level
-
+			}
 
+			// otherwise top level
 			this.reader.setOffset( this.reader.offset - 4 );
 			this.currentFormEnd = this.reader.offset + length;
 			this.parentForm = this.currentForm;
@@ -553,19 +505,18 @@
 			this.currentForm = texture;
 
 		},
-
 		parseClipLwo2( length ) {
 
 			var texture = {
 				index: this.reader.getUint32(),
 				fileName: ''
-			}; // seach STIL block
+			};
 
+			// seach STIL block
 			while ( true ) {
 
 				var tag = this.reader.getIDTag();
 				var n_length = this.reader.getUint16();
-
 				if ( tag === 'STIL' ) {
 
 					texture.fileName = this.reader.getString();
@@ -585,15 +536,12 @@
 			this.currentForm = texture;
 
 		},
-
 		parseImage() {
 
 			this.reader.skip( 8 ); // unknown
-
 			this.currentForm.fileName = this.reader.getString();
 
 		},
-
 		parseXVAL( type, length ) {
 
 			var endOffset = this.reader.offset + length - 4;
@@ -615,7 +563,6 @@
 			this.reader.setOffset( endOffset );
 
 		},
-
 		// Tags associated with an object
 		// OTAG { type[ID4], tag-string[S0] }
 		parseObjectTag() {
@@ -626,7 +573,6 @@
 			};
 
 		},
-
 		// Signals the start of a new layer. All the data chunks which follow will be included in this layer until another layer chunk is encountered.
 		// LAYR: number[U2], flags[U2], pivot[VEC12], name[S0], parent[U2]
 		parseLayer( length ) {
@@ -642,8 +588,8 @@
 			this.tree.layers.push( layer );
 			this.currentLayer = layer;
 			var parsedLength = 16 + stringOffset( this.currentLayer.name ); // index ( 2 ) + flags( 2 ) + pivot( 12 ) + stringlength
-			// if we have not reached then end of the layer block, there must be a parent defined
 
+			// if we have not reached then end of the layer block, there must be a parent defined
 			this.currentLayer.parent = parsedLength < length ? this.reader.getUint16() : - 1; // omitted or -1 for no parent
 
 		},
@@ -654,7 +600,6 @@
 		parsePoints( length ) {
 
 			this.currentPoints = [];
-
 			for ( var i = 0; i < length / 4; i += 3 ) {
 
 				// z -> -z to match three.js right handed coords
@@ -663,10 +608,10 @@
 			}
 
 		},
-
 		// parse VMAP or VMAD
 		// Associates a set of floating-point vectors with a set of points.
 		// VMAP: { type[ID4], dimension[U2], name[S0], ( vert[VX], value[F4] # dimension ) * }
+
 		// VMAD Associates a set of floating-point vectors with the vertices of specific polygons.
 		// Similar to VMAP UVs, but associates with polygon vertices rather than points
 		// to solve to problem of UV seams:  VMAD chunks are paired with VMAPs of the same name,
@@ -677,36 +622,30 @@
 
 			var finalOffset = this.reader.offset + length;
 			var channelName = this.reader.getString();
-
 			if ( this.reader.offset === finalOffset ) {
 
 				// then we are in a texture node and the VMAP chunk is just a reference to a UV channel name
 				this.currentForm.UVChannel = channelName;
 				return;
 
-			} // otherwise reset to initial length and parse normal VMAP CHUNK
-
+			}
 
+			// otherwise reset to initial length and parse normal VMAP CHUNK
 			this.reader.setOffset( this.reader.offset - stringOffset( channelName ) );
 			var type = this.reader.getIDTag();
 			this.reader.getUint16(); // dimension
-
 			var name = this.reader.getString();
 			var remainingLength = length - 6 - stringOffset( name );
-
 			switch ( type ) {
 
 				case 'TXUV':
 					this.parseUVMapping( name, finalOffset, discontinuous );
 					break;
-
 				case 'MORF':
 				case 'SPOT':
 					this.parseMorphTargets( name, finalOffset, type ); // can't be discontinuous
-
 					break;
 					// unsupported VMAPs
-
 				case 'APSL':
 				case 'NORM':
 				case 'WGHT':
@@ -716,7 +655,6 @@
 				case 'RGBA':
 					this.reader.skip( remainingLength );
 					break;
-
 				default:
 					console.warn( 'LWOLoader: unknown vertex map type: ' + type );
 					this.reader.skip( remainingLength );
@@ -724,13 +662,11 @@
 			}
 
 		},
-
 		parseUVMapping( name, finalOffset, discontinuous ) {
 
 			var uvIndices = [];
 			var polyIndices = [];
 			var uvs = [];
-
 			while ( this.reader.offset < finalOffset ) {
 
 				uvIndices.push( this.reader.getVariableLengthIndex() );
@@ -759,17 +695,15 @@
 			}
 
 		},
-
 		parseMorphTargets( name, finalOffset, type ) {
 
 			var indices = [];
 			var points = [];
 			type = type === 'MORF' ? 'relative' : 'absolute';
-
 			while ( this.reader.offset < finalOffset ) {
 
-				indices.push( this.reader.getVariableLengthIndex() ); // z -> -z to match three.js right handed coords
-
+				indices.push( this.reader.getVariableLengthIndex() );
+				// z -> -z to match three.js right handed coords
 				points.push( this.reader.getFloat32(), this.reader.getFloat32(), - this.reader.getFloat32() );
 
 			}
@@ -782,25 +716,23 @@
 			};
 
 		},
-
 		// A list of polygons for the current layer.
 		// POLS { type[ID4], ( numvert+flags[U2], vert[VX] # numvert ) * }
 		parsePolygonList( length ) {
 
 			var finalOffset = this.reader.offset + length;
 			var type = this.reader.getIDTag();
-			var indices = []; // hold a list of polygon sizes, to be split up later
+			var indices = [];
 
+			// hold a list of polygon sizes, to be split up later
 			var polygonDimensions = [];
-
 			while ( this.reader.offset < finalOffset ) {
 
-				var numverts = this.reader.getUint16(); //var flags = numverts & 64512; // 6 high order bits are flags - ignoring for now
+				var numverts = this.reader.getUint16();
 
+				//var flags = numverts & 64512; // 6 high order bits are flags - ignoring for now
 				numverts = numverts & 1023; // remaining ten low order bits are vertex num
-
 				polygonDimensions.push( numverts );
-
 				for ( var j = 0; j < numverts; j ++ ) indices.push( this.reader.getVariableLengthIndex() );
 
 			}
@@ -810,13 +742,13 @@
 				vertexIndices: indices,
 				polygonDimensions: polygonDimensions,
 				points: this.currentPoints
-			}; // Note: assuming that all polys will be lines or points if the first is
+			};
 
+			// Note: assuming that all polys will be lines or points if the first is
 			if ( polygonDimensions[ 0 ] === 1 ) geometryData.type = 'points'; else if ( polygonDimensions[ 0 ] === 2 ) geometryData.type = 'lines';
 			this.currentLayer.geometry = geometryData;
 
 		},
-
 		// Lists the tag strings that can be associated with polygons by the PTAG chunk.
 		// TAGS { tag-string[S0] * }
 		parseTagStrings( length ) {
@@ -824,7 +756,6 @@
 			this.tree.tags = this.reader.getStringArray( length );
 
 		},
-
 		// Associates tags of a given type with polygons in the most recent POLS chunk.
 		// PTAG { type[ID4], ( poly[VX], tag[U2] ) * }
 		parsePolygonTagMapping( length ) {
@@ -834,17 +765,16 @@
 			if ( type === 'SURF' ) this.parseMaterialIndices( finalOffset ); else {
 
 				//PART, SMGP, COLR not supported
+
 				this.reader.skip( length - 4 );
 
 			}
 
 		},
-
 		parseMaterialIndices( finalOffset ) {
 
 			// array holds polygon index followed by material index
 			this.currentLayer.geometry.materialIndices = [];
-
 			while ( this.reader.offset < finalOffset ) {
 
 				var polygonIndex = this.reader.getVariableLengthIndex();
@@ -854,19 +784,18 @@
 			}
 
 		},
-
 		parseUnknownCHUNK( blockID, length ) {
 
-			console.warn( 'LWOLoader: unknown chunk type: ' + blockID + ' length: ' + length ); // print the chunk plus some bytes padding either side
+			console.warn( 'LWOLoader: unknown chunk type: ' + blockID + ' length: ' + length );
+
+			// print the chunk plus some bytes padding either side
 			// printBuffer( this.reader.dv.buffer, this.reader.offset - 20, length + 40 );
 
 			var data = this.reader.getString( length );
 			this.currentForm[ blockID ] = data;
 
 		}
-
 	};
-
 	function DataViewReader( buffer ) {
 
 		this.dv = new DataView( buffer );
@@ -881,7 +810,6 @@
 			return this.dv.buffer.byteLength;
 
 		},
-
 		setOffset( offset ) {
 
 			if ( offset > 0 && offset < this.dv.buffer.byteLength ) {
@@ -895,7 +823,6 @@
 			}
 
 		},
-
 		endOfFile: function () {
 
 			if ( this.offset >= this.size() ) return true;
@@ -953,7 +880,6 @@
 		getFloat32Array: function ( size ) {
 
 			var a = [];
-
 			for ( var i = 0; i < size; i ++ ) {
 
 				a.push( this.getFloat32() );
@@ -973,7 +899,6 @@
 		getFloat64Array: function ( size ) {
 
 			var a = [];
-
 			for ( var i = 0; i < size; i ++ ) {
 
 				a.push( this.getFloat64() );
@@ -983,7 +908,6 @@
 			return a;
 
 		},
-
 		// get variable-length index data type
 		// VX ::= index[U2] | (index + 0xFF000000)[U4]
 		// If the index value is less than 65,280 (0xFF00),then VX === U2
@@ -993,7 +917,6 @@
 		getVariableLengthIndex() {
 
 			var firstByte = this.getUint8();
-
 			if ( firstByte === 255 ) {
 
 				return this.getUint8() * 65536 + this.getUint8() * 256 + this.getUint8();
@@ -1003,20 +926,18 @@
 			return firstByte * 256 + this.getUint8();
 
 		},
-
 		// An ID tag is a sequence of 4 bytes containing 7-bit ASCII values
 		getIDTag() {
 
 			return this.getString( 4 );
 
 		},
-
 		getString: function ( size ) {
 
-			if ( size === 0 ) return; // note: safari 9 doesn't support Uint8Array.indexOf; create intermediate array instead
+			if ( size === 0 ) return;
 
+			// note: safari 9 doesn't support Uint8Array.indexOf; create intermediate array instead
 			var a = [];
-
 			if ( size ) {
 
 				for ( var i = 0; i < size; i ++ ) {
@@ -1029,7 +950,6 @@
 
 				var currentChar;
 				var len = 0;
-
 				while ( currentChar !== 0 ) {
 
 					currentChar = this.getUint8();
@@ -1052,7 +972,9 @@
 			return a.filter( Boolean ); // return array with any empty strings removed
 
 		}
-	}; // ************** DEBUGGER  **************
+	};
+
+	// ************** DEBUGGER  **************
 
 	function Debugger() {
 
@@ -1073,17 +995,14 @@
 
 			if ( ! this.active ) return;
 			var nodeType;
-
 			switch ( this.node ) {
 
 				case 0:
 					nodeType = 'FORM';
 					break;
-
 				case 1:
 					nodeType = 'CHK';
 					break;
-
 				case 2:
 					nodeType = 'S-CHK';
 					break;
@@ -1091,7 +1010,6 @@
 			}
 
 			console.log( '| '.repeat( this.depth ) + nodeType, this.nodeID, `( ${this.offset} ) -> ( ${this.dataOffset + this.length} )`, this.node == 0 ? ' {' : '', this.skipped ? 'SKIPPED' : '', this.node == 0 && this.skipped ? '}' : '' );
-
 			if ( this.node == 0 && ! this.skipped ) {
 
 				this.depth += 1;
@@ -1105,7 +1023,6 @@
 		closeForms: function () {
 
 			if ( ! this.active ) return;
-
 			for ( var i = this.formList.length - 1; i >= 0; i -- ) {
 
 				if ( this.offset >= this.formList[ i ] ) {
@@ -1119,24 +1036,26 @@
 			}
 
 		}
-	}; // ************** UTILITY FUNCTIONS **************
+	};
+
+	// ************** UTILITY FUNCTIONS **************
 
 	function isEven( num ) {
 
 		return num % 2;
 
-	} // calculate the length of the string in the buffer
-	// this will be string.length + nullbyte + optional padbyte to make the length even
-
+	}
 
+	// calculate the length of the string in the buffer
+	// this will be string.length + nullbyte + optional padbyte to make the length even
 	function stringOffset( string ) {
 
 		return string.length + 1 + ( isEven( string.length + 1 ) ? 1 : 0 );
 
-	} // for testing purposes, dump buffer to console
-	// printBuffer( this.reader.dv.buffer, this.reader.offset, length );
-
+	}
 
+	// for testing purposes, dump buffer to console
+	// printBuffer( this.reader.dv.buffer, this.reader.offset, length );
 	function printBuffer( buffer, from, to ) {
 
 		console.log( THREE.LoaderUtils.decodeText( new Uint8Array( buffer, from, to ) ) );