@needle-tools/three 0.145.2 → 0.146.1

package/examples/js/animation/MMDAnimationHelper.js

@@ -12,7 +12,6 @@
  * TODO
  *  - more precise grant skinning support.
  */
-
 	class MMDAnimationHelper {
 
 		/**
@@ -43,16 +42,14 @@
 				physics: true,
 				cameraAnimation: true
 			};
+			this.onBeforePhysics = function /* mesh */ () {};
 
-			this.onBeforePhysics = function
-			/* mesh */
-			() {}; // experimental
-
-
+			// experimental
 			this.sharedPhysics = false;
 			this.masterPhysics = null;
 
 		}
+
 		/**
    * Adds an Three.js Object to helper and setups animation.
    * The anmation durations of added objects are synched
@@ -69,8 +66,6 @@
    * @param {Number} params.delayTime - Only for THREE.Audio. Default is 0.0.
    * @return {MMDAnimationHelper}
    */
-
-
 		add( object, params = {} ) {
 
 			if ( object.isSkinnedMesh ) {
@@ -95,14 +90,13 @@
 			return this;
 
 		}
+
 		/**
    * Removes an Three.js Object from helper.
    *
    * @param {THREE.SkinnedMesh|THREE.Camera|THREE.Audio} object
    * @return {MMDAnimationHelper}
    */
-
-
 		remove( object ) {
 
 			if ( object.isSkinnedMesh ) {
@@ -127,18 +121,16 @@
 			return this;
 
 		}
+
 		/**
    * Updates the animation.
    *
    * @param {Number} delta
    * @return {MMDAnimationHelper}
    */
-
-
 		update( delta ) {
 
 			if ( this.audioManager !== null ) this.audioManager.control( delta );
-
 			for ( let i = 0; i < this.meshes.length; i ++ ) {
 
 				this._animateMesh( this.meshes[ i ], delta );
@@ -150,6 +142,7 @@
 			return this;
 
 		}
+
 		/**
    * Changes the pose of SkinnedMesh as VPD specifies.
    *
@@ -161,15 +154,12 @@
    * @param {boolean} params.grant - Default is true.
    * @return {MMDAnimationHelper}
    */
-
-
 		pose( mesh, vpd, params = {} ) {
 
 			if ( params.resetPose !== false ) mesh.pose();
 			const bones = mesh.skeleton.bones;
 			const boneParams = vpd.bones;
 			const boneNameDictionary = {};
-
 			for ( let i = 0, il = bones.length; i < il; i ++ ) {
 
 				boneNameDictionary[ bones[ i ].name ] = i;
@@ -178,7 +168,6 @@
 
 			const vector = new THREE.Vector3();
 			const quaternion = new THREE.Quaternion();
-
 			for ( let i = 0, il = boneParams.length; i < il; i ++ ) {
 
 				const boneParam = boneParams[ i ];
@@ -190,15 +179,14 @@
 
 			}
 
-			mesh.updateMatrixWorld( true ); // PMX animation system special path
+			mesh.updateMatrixWorld( true );
 
+			// PMX animation system special path
 			if ( this.configuration.pmxAnimation && mesh.geometry.userData.MMD && mesh.geometry.userData.MMD.format === 'pmx' ) {
 
 				const sortedBonesData = this._sortBoneDataArray( mesh.geometry.userData.MMD.bones.slice() );
-
 				const ikSolver = params.ik !== false ? this._createCCDIKSolver( mesh ) : null;
 				const grantSolver = params.grant !== false ? this.createGrantSolver( mesh ) : null;
-
 				this._animatePMXMesh( mesh, sortedBonesData, ikSolver, grantSolver );
 
 			} else {
@@ -220,6 +208,7 @@
 			return this;
 
 		}
+
 		/**
    * Enabes/Disables an animation feature.
    *
@@ -227,8 +216,6 @@
    * @param {boolean} enabled
    * @return {MMDAnimationHelper}
    */
-
-
 		enable( key, enabled ) {
 
 			if ( this.enabled[ key ] === undefined ) {
@@ -238,7 +225,6 @@
 			}
 
 			this.enabled[ key ] = enabled;
-
 			if ( key === 'physics' ) {
 
 				for ( let i = 0, il = this.meshes.length; i < il; i ++ ) {
@@ -252,20 +238,20 @@
 			return this;
 
 		}
+
 		/**
    * Creates an GrantSolver instance.
    *
    * @param {THREE.SkinnedMesh} mesh
    * @return {GrantSolver}
    */
-
-
 		createGrantSolver( mesh ) {
 
 			return new GrantSolver( mesh, mesh.geometry.userData.MMD.grants );
 
-		} // private methods
+		}
 
+		// private methods
 
 		_addMesh( mesh, params ) {
 
@@ -279,9 +265,7 @@
 			this.objects.set( mesh, {
 				looped: false
 			} );
-
 			this._setupMeshAnimation( mesh, params.animation );
-
 			if ( params.physics !== false ) {
 
 				this._setupMeshPhysics( mesh, params );
@@ -291,7 +275,6 @@
 			return this;
 
 		}
-
 		_setupCamera( camera, params ) {
 
 			if ( this.camera === camera ) {
@@ -304,7 +287,6 @@
 			this.camera = camera;
 			camera.add( this.cameraTarget );
 			this.objects.set( camera, {} );
-
 			if ( params.animation !== undefined ) {
 
 				this._setupCameraAnimation( camera, params.animation );
@@ -314,7 +296,6 @@
 			return this;
 
 		}
-
 		_setupAudio( audio, params ) {
 
 			if ( this.audio === audio ) {
@@ -332,12 +313,10 @@
 			return this;
 
 		}
-
 		_removeMesh( mesh ) {
 
 			let found = false;
 			let writeIndex = 0;
-
 			for ( let i = 0, il = this.meshes.length; i < il; i ++ ) {
 
 				if ( this.meshes[ i ] === mesh ) {
@@ -362,7 +341,6 @@
 			return this;
 
 		}
-
 		_clearCamera( camera ) {
 
 			if ( camera !== this.camera ) {
@@ -377,7 +355,6 @@
 			return this;
 
 		}
-
 		_clearAudio( audio ) {
 
 			if ( audio !== this.audio ) {
@@ -392,23 +369,20 @@
 			return this;
 
 		}
-
 		_setupMeshAnimation( mesh, animation ) {
 
 			const objects = this.objects.get( mesh );
-
 			if ( animation !== undefined ) {
 
 				const animations = Array.isArray( animation ) ? animation : [ animation ];
 				objects.mixer = new THREE.AnimationMixer( mesh );
-
 				for ( let i = 0, il = animations.length; i < il; i ++ ) {
 
 					objects.mixer.clipAction( animations[ i ] ).play();
 
-				} // TODO: find a workaround not to access ._clip looking like a private property
-
+				}
 
+				// TODO: find a workaround not to access ._clip looking like a private property
 				objects.mixer.addEventListener( 'loop', function ( event ) {
 
 					const tracks = event.action._clip.tracks;
@@ -424,13 +398,11 @@
 			return this;
 
 		}
-
 		_setupCameraAnimation( camera, animation ) {
 
 			const animations = Array.isArray( animation ) ? animation : [ animation ];
 			const objects = this.objects.get( camera );
 			objects.mixer = new THREE.AnimationMixer( camera );
-
 			for ( let i = 0, il = animations.length; i < il; i ++ ) {
 
 				objects.mixer.clipAction( animations[ i ] ).play();
@@ -438,35 +410,31 @@
 			}
 
 		}
-
 		_setupMeshPhysics( mesh, params ) {
 
-			const objects = this.objects.get( mesh ); // shared physics is experimental
+			const objects = this.objects.get( mesh );
+
+			// shared physics is experimental
 
 			if ( params.world === undefined && this.sharedPhysics ) {
 
 				const masterPhysics = this._getMasterPhysics();
-
 				if ( masterPhysics !== null ) world = masterPhysics.world; // eslint-disable-line no-undef
 
 			}
 
 			objects.physics = this._createMMDPhysics( mesh, params );
-
 			if ( objects.mixer && params.animationWarmup !== false ) {
 
 				this._animateMesh( mesh, 0 );
-
 				objects.physics.reset();
 
 			}
 
 			objects.physics.warmup( params.warmup !== undefined ? params.warmup : 60 );
-
 			this._optimizeIK( mesh, true );
 
 		}
-
 		_animateMesh( mesh, delta ) {
 
 			const objects = this.objects.get( mesh );
@@ -475,23 +443,20 @@
 			const grantSolver = objects.grantSolver;
 			const physics = objects.physics;
 			const looped = objects.looped;
-
 			if ( mixer && this.enabled.animation ) {
 
 				// alternate solution to save/restore bones but less performant?
 				//mesh.pose();
 				//this._updatePropertyMixersBuffer( mesh );
-				this._restoreBones( mesh );
 
+				this._restoreBones( mesh );
 				mixer.update( delta );
+				this._saveBones( mesh );
 
-				this._saveBones( mesh ); // PMX animation system special path
-
-
+				// PMX animation system special path
 				if ( this.configuration.pmxAnimation && mesh.geometry.userData.MMD && mesh.geometry.userData.MMD.format === 'pmx' ) {
 
 					if ( ! objects.sortedBonesData ) objects.sortedBonesData = this._sortBoneDataArray( mesh.geometry.userData.MMD.bones.slice() );
-
 					this._animatePMXMesh( mesh, objects.sortedBonesData, ikSolver && this.enabled.ik ? ikSolver : null, grantSolver && this.enabled.grant ? grantSolver : null );
 
 				} else {
@@ -527,11 +492,11 @@
 
 			}
 
-		} // Sort bones in order by 1. transformationClass and 2. bone index.
+		}
+
+		// Sort bones in order by 1. transformationClass and 2. bone index.
 		// In PMX animation system, bone transformations should be processed
 		// in this order.
-
-
 		_sortBoneDataArray( boneDataArray ) {
 
 			return boneDataArray.sort( function ( a, b ) {
@@ -548,21 +513,19 @@
 
 			} );
 
-		} // PMX Animation system is a bit too complex and doesn't great match to
+		}
+
+		// PMX Animation system is a bit too complex and doesn't great match to
 		// Three.js Animation system. This method attempts to simulate it as much as
 		// possible but doesn't perfectly simulate.
 		// This method is more costly than the regular one so
 		// you are recommended to set constructor parameter "pmxAnimation: true"
 		// only if your PMX model animation doesn't work well.
 		// If you need better method you would be required to write your own.
-
-
 		_animatePMXMesh( mesh, sortedBonesData, ikSolver, grantSolver ) {
 
 			_quaternionIndex = 0;
-
 			_grantResultMap.clear();
-
 			for ( let i = 0, il = sortedBonesData.length; i < il; i ++ ) {
 
 				updateOne( mesh, sortedBonesData[ i ].index, ikSolver, grantSolver );
@@ -573,11 +536,9 @@
 			return this;
 
 		}
-
 		_animateCamera( camera, delta ) {
 
 			const mixer = this.objects.get( camera ).mixer;
-
 			if ( mixer && this.enabled.cameraAnimation ) {
 
 				mixer.update( delta );
@@ -589,21 +550,17 @@
 			}
 
 		}
-
 		_optimizeIK( mesh, physicsEnabled ) {
 
 			const iks = mesh.geometry.userData.MMD.iks;
 			const bones = mesh.geometry.userData.MMD.bones;
-
 			for ( let i = 0, il = iks.length; i < il; i ++ ) {
 
 				const ik = iks[ i ];
 				const links = ik.links;
-
 				for ( let j = 0, jl = links.length; j < jl; j ++ ) {
 
 					const link = links[ j ];
-
 					if ( physicsEnabled === true ) {
 
 						// disable IK of the bone the corresponding rigidBody type of which is 1 or 2
@@ -621,7 +578,6 @@
 			}
 
 		}
-
 		_createCCDIKSolver( mesh ) {
 
 			if ( THREE.CCDIKSolver === undefined ) {
@@ -633,7 +589,6 @@
 			return new THREE.CCDIKSolver( mesh, mesh.geometry.userData.MMD.iks );
 
 		}
-
 		_createMMDPhysics( mesh, params ) {
 
 			if ( THREE.MMDPhysics === undefined ) {
@@ -645,29 +600,28 @@
 			return new THREE.MMDPhysics( mesh, mesh.geometry.userData.MMD.rigidBodies, mesh.geometry.userData.MMD.constraints, params );
 
 		}
+
 		/*
    * Detects the longest duration and then sets it to them to sync.
    * TODO: Not to access private properties ( ._actions and ._clip )
    */
-
-
 		_syncDuration() {
 
 			let max = 0.0;
 			const objects = this.objects;
 			const meshes = this.meshes;
 			const camera = this.camera;
-			const audioManager = this.audioManager; // get the longest duration
+			const audioManager = this.audioManager;
+
+			// get the longest duration
 
 			for ( let i = 0, il = meshes.length; i < il; i ++ ) {
 
 				const mixer = this.objects.get( meshes[ i ] ).mixer;
 				if ( mixer === undefined ) continue;
-
 				for ( let j = 0; j < mixer._actions.length; j ++ ) {
 
 					const clip = mixer._actions[ j ]._clip;
-
 					if ( ! objects.has( clip ) ) {
 
 						objects.set( clip, {
@@ -685,13 +639,11 @@
 			if ( camera !== null ) {
 
 				const mixer = this.objects.get( camera ).mixer;
-
 				if ( mixer !== undefined ) {
 
 					for ( let i = 0, il = mixer._actions.length; i < il; i ++ ) {
 
 						const clip = mixer._actions[ i ]._clip;
-
 						if ( ! objects.has( clip ) ) {
 
 							objects.set( clip, {
@@ -714,13 +666,14 @@
 
 			}
 
-			max += this.configuration.afterglow; // update the duration
+			max += this.configuration.afterglow;
+
+			// update the duration
 
 			for ( let i = 0, il = this.meshes.length; i < il; i ++ ) {
 
 				const mixer = this.objects.get( this.meshes[ i ] ).mixer;
 				if ( mixer === undefined ) continue;
-
 				for ( let j = 0, jl = mixer._actions.length; j < jl; j ++ ) {
 
 					mixer._actions[ j ]._clip.duration = max;
@@ -732,7 +685,6 @@
 			if ( camera !== null ) {
 
 				const mixer = this.objects.get( camera ).mixer;
-
 				if ( mixer !== undefined ) {
 
 					for ( let i = 0, il = mixer._actions.length; i < il; i ++ ) {
@@ -751,15 +703,15 @@
 
 			}
 
-		} // workaround
+		}
 
+		// workaround
 
 		_updatePropertyMixersBuffer( mesh ) {
 
 			const mixer = this.objects.get( mesh ).mixer;
 			const propertyMixers = mixer._bindings;
 			const accuIndex = mixer._accuIndex;
-
 			for ( let i = 0, il = propertyMixers.length; i < il; i ++ ) {
 
 				const propertyMixer = propertyMixers[ i ];
@@ -771,6 +723,7 @@
 			}
 
 		}
+
 		/*
    * Avoiding these two issues by restore/save bones before/after mixer animation.
    *
@@ -780,14 +733,11 @@
    *
    * 2. Applying Grant two or more times without reset the posing breaks model.
    */
-
-
 		_saveBones( mesh ) {
 
 			const objects = this.objects.get( mesh );
 			const bones = mesh.skeleton.bones;
 			let backupBones = objects.backupBones;
-
 			if ( backupBones === undefined ) {
 
 				backupBones = new Float32Array( bones.length * 7 );
@@ -804,14 +754,12 @@
 			}
 
 		}
-
 		_restoreBones( mesh ) {
 
 			const objects = this.objects.get( mesh );
 			const backupBones = objects.backupBones;
 			if ( backupBones === undefined ) return;
 			const bones = mesh.skeleton.bones;
-
 			for ( let i = 0, il = bones.length; i < il; i ++ ) {
 
 				const bone = bones[ i ];
@@ -820,17 +768,16 @@
 
 			}
 
-		} // experimental
+		}
 
+		// experimental
 
 		_getMasterPhysics() {
 
 			if ( this.masterPhysics !== null ) return this.masterPhysics;
-
 			for ( let i = 0, il = this.meshes.length; i < il; i ++ ) {
 
 				const physics = this.meshes[ i ].physics;
-
 				if ( physics !== undefined && physics !== null ) {
 
 					this.masterPhysics = physics;
@@ -843,19 +790,14 @@
 			return null;
 
 		}
-
 		_updateSharedPhysics( delta ) {
 
 			if ( this.meshes.length === 0 || ! this.enabled.physics || ! this.sharedPhysics ) return;
-
 			const physics = this._getMasterPhysics();
-
 			if ( physics === null ) return;
-
 			for ( let i = 0, il = this.meshes.length; i < il; i ++ ) {
 
 				const p = this.meshes[ i ].physics;
-
 				if ( p !== null && p !== undefined ) {
 
 					p.updateRigidBodies();
@@ -865,11 +807,9 @@
 			}
 
 			physics.stepSimulation( delta );
-
 			for ( let i = 0, il = this.meshes.length; i < il; i ++ ) {
 
 				const p = this.meshes[ i ].physics;
-
 				if ( p !== null && p !== undefined ) {
 
 					p.updateBones();
@@ -880,12 +820,11 @@
 
 		}
 
-	} // Keep working quaternions for less GC
-
+	}
 
+	// Keep working quaternions for less GC
 	const _quaternions = [];
 	let _quaternionIndex = 0;
-
 	function getQuaternion() {
 
 		if ( _quaternionIndex >= _quaternions.length ) {
@@ -896,33 +835,33 @@
 
 		return _quaternions[ _quaternionIndex ++ ];
 
-	} // Save rotation whose grant and IK are already applied
-	// used by grant children
-
+	}
 
+	// Save rotation whose grant and IK are already applied
+	// used by grant children
 	const _grantResultMap = new Map();
-
 	function updateOne( mesh, boneIndex, ikSolver, grantSolver ) {
 
 		const bones = mesh.skeleton.bones;
 		const bonesData = mesh.geometry.userData.MMD.bones;
 		const boneData = bonesData[ boneIndex ];
-		const bone = bones[ boneIndex ]; // Return if already updated by being referred as a grant parent.
+		const bone = bones[ boneIndex ];
 
+		// Return if already updated by being referred as a grant parent.
 		if ( _grantResultMap.has( boneIndex ) ) return;
-		const quaternion = getQuaternion(); // Initialize grant result here to prevent infinite loop.
+		const quaternion = getQuaternion();
+
+		// Initialize grant result here to prevent infinite loop.
 		// If it's referred before updating with actual result later
 		// result without applyting IK or grant is gotten
 		// but better than composing of infinite loop.
+		_grantResultMap.set( boneIndex, quaternion.copy( bone.quaternion ) );
 
-		_grantResultMap.set( boneIndex, quaternion.copy( bone.quaternion ) ); // @TODO: Support global grant and grant position
-
-
+		// @TODO: Support global grant and grant position
 		if ( grantSolver && boneData.grant && ! boneData.grant.isLocal && boneData.grant.affectRotation ) {
 
 			const parentIndex = boneData.grant.parentIndex;
 			const ratio = boneData.grant.ratio;
-
 			if ( ! _grantResultMap.has( parentIndex ) ) {
 
 				updateOne( mesh, parentIndex, ikSolver, grantSolver );
@@ -938,16 +877,15 @@
 			// @TODO: Updating world matrices every time solving an IK bone is
 			// costly. Optimize if possible.
 			mesh.updateMatrixWorld( true );
-			ikSolver.updateOne( boneData.ik ); // No confident, but it seems the grant results with ik links should be updated?
+			ikSolver.updateOne( boneData.ik );
 
+			// No confident, but it seems the grant results with ik links should be updated?
 			const links = boneData.ik.links;
-
 			for ( let i = 0, il = links.length; i < il; i ++ ) {
 
 				const link = links[ i ];
 				if ( link.enabled === false ) continue;
 				const linkIndex = link.index;
-
 				if ( _grantResultMap.has( linkIndex ) ) {
 
 					_grantResultMap.set( linkIndex, _grantResultMap.get( linkIndex ).copy( bones[ linkIndex ].quaternion ) );
@@ -956,13 +894,14 @@
 
 			}
 
-		} // Update with the actual result here
-
+		}
 
+		// Update with the actual result here
 		quaternion.copy( bone.quaternion );
 
-	} //
+	}
 
+	//
 
 	class AudioManager {
 
@@ -981,12 +920,11 @@
 			this.duration = this.audioDuration + this.delayTime;
 
 		}
+
 		/**
    * @param {Number} delta
    * @return {AudioManager}
    */
-
-
 		control( delta ) {
 
 			this.elapsed += delta;
@@ -995,26 +933,26 @@
 			if ( this._shouldStartAudio() ) this.audio.play();
 			return this;
 
-		} // private methods
+		}
 
+		// private methods
 
 		_shouldStartAudio() {
 
 			if ( this.audio.isPlaying ) return false;
-
 			while ( this.currentTime >= this.duration ) {
 
 				this.currentTime -= this.duration;
 
 			}
 
-			if ( this.currentTime < this.delayTime ) return false; // 'duration' can be bigger than 'audioDuration + delayTime' because of sync configuration
+			if ( this.currentTime < this.delayTime ) return false;
 
+			// 'duration' can be bigger than 'audioDuration + delayTime' because of sync configuration
 			if ( this.currentTime - this.delayTime > this.audioDuration ) return false;
 			return true;
 
 		}
-
 		_shouldStopAudio() {
 
 			return this.audio.isPlaying && this.currentTime >= this.duration;
@@ -1022,8 +960,8 @@
 		}
 
 	}
-
 	const _q = new THREE.Quaternion();
+
 	/**
  * Solver for Grant (Fuyo in Japanese. I just google translated because
  * Fuyo may be MMD specific term and may not be common word in 3D CG terms.)
@@ -1032,8 +970,6 @@
  * @param {THREE.SkinnedMesh} mesh
  * @param {Array<Object>} grants
  */
-
-
 	class GrantSolver {
 
 		constructor( mesh, grants = [] ) {
@@ -1042,16 +978,14 @@
 			this.grants = grants;
 
 		}
+
 		/**
    * Solve all the grant bones
    * @return {GrantSolver}
    */
-
-
 		update() {
 
 			const grants = this.grants;
-
 			for ( let i = 0, il = grants.length; i < il; i ++ ) {
 
 				this.updateOne( grants[ i ] );
@@ -1061,25 +995,23 @@
 			return this;
 
 		}
+
 		/**
    * Solve a grant bone
    * @param {Object} grant - grant parameter
    * @return {GrantSolver}
    */
-
-
 		updateOne( grant ) {
 
 			const bones = this.mesh.skeleton.bones;
 			const bone = bones[ grant.index ];
 			const parentBone = bones[ grant.parentIndex ];
-
 			if ( grant.isLocal ) {
 
 				// TODO: implement
-				if ( grant.affectPosition ) {} // TODO: implement
-
+				if ( grant.affectPosition ) {}
 
+				// TODO: implement
 				if ( grant.affectRotation ) {}
 
 			} else {
@@ -1098,13 +1030,10 @@
 			return this;
 
 		}
-
 		addGrantRotation( bone, q, ratio ) {
 
 			_q.set( 0, 0, 0, 1 );
-
 			_q.slerp( q, ratio );
-
 			bone.quaternion.multiply( _q );
 			return this;