@plastic-software/three 0.175.13 → 0.178.0

package/examples/jsm/physics/RapierPhysics.js

@@ -1,6 +1,6 @@
 import { Clock, Vector3, Quaternion, Matrix4 } from 'three';
 
-const RAPIER_PATH = 'https://cdn.skypack.dev/@dimforge/rapier3d-compat@0.12.0';
+const RAPIER_PATH = 'https://cdn.skypack.dev/@dimforge/rapier3d-compat@0.17.3';
 
 const frameRate = 60;
 
@@ -28,6 +28,20 @@ function getShape( geometry ) {
 		const radius = parameters.radius !== undefined ? parameters.radius : 1;
 		return RAPIER.ColliderDesc.ball( radius );
 
+	} else if ( geometry.type === 'CylinderGeometry' ) {
+
+		const radius = parameters.radiusBottom !== undefined ? parameters.radiusBottom : 0.5;
+		const length = parameters.height !== undefined ? parameters.height : 0.5;
+
+		return RAPIER.ColliderDesc.cylinder( length / 2, radius );
+
+	} else if ( geometry.type === 'CapsuleGeometry' ) {
+
+		const radius = parameters.radius !== undefined ? parameters.radius : 0.5;
+		const length = parameters.height !== undefined ? parameters.height : 0.5;
+
+		return RAPIER.ColliderDesc.capsule( length / 2, radius );
+
 	} else if ( geometry.type === 'BufferGeometry' ) {
 
 		const vertices = [];
@@ -66,6 +80,7 @@ function getShape( geometry ) {
  * @name RapierPhysics
  * @class
  * @hideconstructor
+ * @three_import import { RapierPhysics } from 'three/addons/physics/RapierPhysics.js';
  */
 async function RapierPhysics() {
 
@@ -117,14 +132,40 @@ async function RapierPhysics() {
 		shape.setMass( mass );
 		shape.setRestitution( restitution );
 
-		const body = mesh.isInstancedMesh
+		const { body, collider } = mesh.isInstancedMesh
 			? createInstancedBody( mesh, mass, shape )
 			: createBody( mesh.position, mesh.quaternion, mass, shape );
 
+		if ( ! mesh.userData.physics ) mesh.userData.physics = {};
+
+		mesh.userData.physics.body = body;
+		mesh.userData.physics.collider = collider;
+
 		if ( mass > 0 ) {
 
 			meshes.push( mesh );
-			meshMap.set( mesh, body );
+			meshMap.set( mesh, { body, collider } );
+
+		}
+
+	}
+
+	function removeMesh( mesh ) {
+
+		const index = meshes.indexOf( mesh );
+
+		if ( index !== - 1 ) {
+
+			meshes.splice( index, 1 );
+			meshMap.delete( mesh );
+
+			if ( ! mesh.userData.physics ) return;
+
+			const body = mesh.userData.physics.body;
+			const collider = mesh.userData.physics.collider;
+
+			if ( body ) removeBody( body );
+			if ( collider ) removeCollider( collider );
 
 		}
 
@@ -135,15 +176,18 @@ async function RapierPhysics() {
 		const array = mesh.instanceMatrix.array;
 
 		const bodies = [];
+		const colliders = [];
 
 		for ( let i = 0; i < mesh.count; i ++ ) {
 
 			const position = _vector.fromArray( array, i * 16 + 12 );
-			bodies.push( createBody( position, null, mass, shape ) );
+			const { body, collider } = createBody( position, null, mass, shape );
+			bodies.push( body );
+			colliders.push( collider );
 
 		}
 
-		return bodies;
+		return { body: bodies, collider: colliders };
 
 	}
 
@@ -154,15 +198,51 @@ async function RapierPhysics() {
 		if ( quaternion !== null ) desc.setRotation( quaternion );
 
 		const body = world.createRigidBody( desc );
-		world.createCollider( shape, body );
+		const collider = world.createCollider( shape, body );
 
-		return body;
+		return { body, collider };
+
+	}
+
+	function removeBody( body ) {
+
+		if ( Array.isArray( body ) ) {
+
+			for ( let i = 0; i < body.length; i ++ ) {
+
+				world.removeRigidBody( body[ i ] );
+
+			}
+
+		} else {
+
+			world.removeRigidBody( body );
+
+		}
+
+	}
+
+	function removeCollider( collider ) {
+
+		if ( Array.isArray( collider ) ) {
+
+			for ( let i = 0; i < collider.length; i ++ ) {
+
+				world.removeCollider( collider[ i ] );
+
+			}
+
+		} else {
+
+			world.removeCollider( collider );
+
+		}
 
 	}
 
 	function setMeshPosition( mesh, position, index = 0 ) {
 
-		let body = meshMap.get( mesh );
+		let { body } = meshMap.get( mesh );
 
 		if ( mesh.isInstancedMesh ) {
 
@@ -178,7 +258,7 @@ async function RapierPhysics() {
 
 	function setMeshVelocity( mesh, velocity, index = 0 ) {
 
-		let body = meshMap.get( mesh );
+		let { body } = meshMap.get( mesh );
 
 		if ( mesh.isInstancedMesh ) {
 
@@ -190,6 +270,24 @@ async function RapierPhysics() {
 
 	}
 
+	function addHeightfield( mesh, width, depth, heights, scale ) {
+
+		const shape = RAPIER.ColliderDesc.heightfield( width, depth, heights, scale );
+		
+		const bodyDesc = RAPIER.RigidBodyDesc.fixed();
+		bodyDesc.setTranslation( mesh.position.x, mesh.position.y, mesh.position.z );
+		bodyDesc.setRotation( mesh.quaternion );
+		
+		const body = world.createRigidBody( bodyDesc );
+		world.createCollider( shape, body );
+		
+		if ( ! mesh.userData.physics ) mesh.userData.physics = {};
+		mesh.userData.physics.body = body;
+		
+		return body;
+
+	}
+
 	//
 
 	const clock = new Clock();
@@ -208,7 +306,7 @@ async function RapierPhysics() {
 			if ( mesh.isInstancedMesh ) {
 
 				const array = mesh.instanceMatrix.array;
-				const bodies = meshMap.get( mesh );
+				const { body: bodies } = meshMap.get( mesh );
 
 				for ( let j = 0; j < bodies.length; j ++ ) {
 
@@ -226,7 +324,7 @@ async function RapierPhysics() {
 
 			} else {
 
-				const body = meshMap.get( mesh );
+				const { body } = meshMap.get( mesh );
 
 				mesh.position.copy( body.translation() );
 				mesh.quaternion.copy( body.rotation() );
@@ -242,6 +340,8 @@ async function RapierPhysics() {
 	setInterval( step, 1000 / frameRate );
 
 	return {
+		RAPIER,
+		world,
 		/**
 		 * Adds the given scene to this physics simulation. Only meshes with a
 		 * `physics` object in their {@link Object3D#userData} field will be honored.
@@ -267,6 +367,15 @@ async function RapierPhysics() {
 		 */
 		addMesh: addMesh,
 
+		/**
+		 * Removes the given mesh from this physics simulation.
+		 *
+		 * @method
+		 * @name RapierPhysics#removeMesh
+		 * @param {Mesh} mesh The mesh to remove.
+		 */
+		removeMesh: removeMesh,
+
 		/**
 		 * Set the position of the given mesh which is part of the physics simulation. Calling this
 		 * method will reset the current simulated velocity of the mesh.
@@ -288,7 +397,25 @@ async function RapierPhysics() {
 		 * @param {Vector3} velocity - The new velocity.
 		 * @param {number} [index=0] - If the mesh is instanced, the index represents the instanced ID.
 		 */
-		setMeshVelocity: setMeshVelocity
+		setMeshVelocity: setMeshVelocity,
+
+		/**
+		 * Adds a heightfield terrain to the physics simulation.
+		 * 
+		 * @method
+		 * @name RapierPhysics#addHeightfield
+		 * @param {Mesh} mesh - The Three.js mesh representing the terrain.
+		 * @param {number} width - The number of vertices along the width (x-axis) of the heightfield.
+		 * @param {number} depth - The number of vertices along the depth (z-axis) of the heightfield.
+		 * @param {Float32Array} heights - Array of height values for each vertex in the heightfield.
+		 * @param {Object} scale - Scale factors for the heightfield dimensions.
+		 * @param {number} scale.x - Scale factor for width.
+		 * @param {number} scale.y - Scale factor for height.
+		 * @param {number} scale.z - Scale factor for depth.
+		 * @returns {RigidBody} The created Rapier rigid body for the heightfield.
+		 */
+		addHeightfield: addHeightfield
+
 	};
 
 }

package/examples/jsm/postprocessing/AfterimagePass.js

@@ -19,6 +19,7 @@ import { AfterimageShader } from '../shaders/AfterimageShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { AfterimagePass } from 'three/addons/postprocessing/AfterimagePass.js';
  */
 class AfterimagePass extends Pass {
 
@@ -42,7 +43,7 @@ class AfterimagePass extends Pass {
 		 */
 		this.uniforms = UniformsUtils.clone( AfterimageShader.uniforms );
 
-		this.uniforms[ 'damp' ].value = damp;
+		this.damp = damp;
 
 		/**
 		 * The composition material.
@@ -88,6 +89,23 @@ class AfterimagePass extends Pass {
 
 	}
 
+	/**
+	 * The damping intensity, from 0.0 to 1.0. A higher value means a stronger after image effect.
+	 *
+	 * @type {number}
+	 */
+	get damp() {
+
+		return this.uniforms[ 'damp' ].value;
+
+	}
+
+	set damp( value ) {
+
+		this.uniforms[ 'damp' ].value = value;
+
+	}
+
 	/**
 	 * Performs the after image pass.
 	 *
@@ -136,7 +154,7 @@ class AfterimagePass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/BloomPass.js

@@ -21,6 +21,7 @@ import { ConvolutionShader } from '../shaders/ConvolutionShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { BloomPass } from 'three/addons/postprocessing/BloomPass.js';
  */
 class BloomPass extends Pass {
 
@@ -166,7 +167,7 @@ class BloomPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/BokehPass.js

@@ -25,6 +25,7 @@ import { BokehShader } from '../shaders/BokehShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { BokehPass } from 'three/addons/postprocessing/BokehPass.js';
  */
 class BokehPass extends Pass {
 
@@ -178,7 +179,7 @@ class BokehPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/ClearPass.js

@@ -13,6 +13,7 @@ import { Pass } from './Pass.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { ClearPass } from 'three/addons/postprocessing/ClearPass.js';
  */
 class ClearPass extends Pass {
 

package/examples/jsm/postprocessing/CubeTexturePass.js

@@ -21,6 +21,7 @@ import { Pass } from './Pass.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { CubeTexturePass } from 'three/addons/postprocessing/CubeTexturePass.js';
  */
 class CubeTexturePass extends Pass {
 

package/examples/jsm/postprocessing/DotScreenPass.js

@@ -14,6 +14,7 @@ import { DotScreenShader } from '../shaders/DotScreenShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { DotScreenPass } from 'three/addons/postprocessing/DotScreenPass.js';
  */
 class DotScreenPass extends Pass {
 

package/examples/jsm/postprocessing/EffectComposer.js

@@ -36,6 +36,8 @@ import { ClearMaskPass, MaskPass } from './MaskPass.js';
  *
  * }
  * ```
+ *
+ * @three_import import { EffectComposer } from 'three/addons/postprocessing/EffectComposer.js';
  */
 class EffectComposer {
 
@@ -119,7 +121,7 @@ class EffectComposer {
 		this.copyPass.material.blending = NoBlending;
 
 		/**
-		 * The intenral clock for managing time data.
+		 * The internal clock for managing time data.
 		 *
 		 * @private
 		 * @type {Clock}
@@ -185,7 +187,7 @@ class EffectComposer {
 	 * Returns `true` if the pass for the given index is the last enabled pass in the pass chain.
 	 *
 	 * @param {number} passIndex - The pass index.
-	 * @return {boolean} Whether the the pass for the given index is the last pass in the pass chain.
+	 * @return {boolean} Whether the pass for the given index is the last pass in the pass chain.
 	 */
 	isLastEnabledPass( passIndex ) {
 

package/examples/jsm/postprocessing/FXAAPass.js

@@ -0,0 +1,40 @@
+import { FXAAShader } from '../shaders/FXAAShader.js';
+import { ShaderPass } from './ShaderPass.js';
+
+/**
+ * A pass for applying FXAA.
+ *
+ * ```js
+ * const fxaaPass = new FXAAPass();
+ * composer.addPass( fxaaPass );
+ * ```
+ *
+ * @augments ShaderPass
+ * @three_import import { FXAAPass } from 'three/addons/postprocessing/FXAAPass.js';
+ */
+class FXAAPass extends ShaderPass {
+
+	/**
+	 * Constructs a new FXAA pass.
+	 */
+	constructor() {
+
+		super( FXAAShader );
+
+	}
+
+	/**
+	 * Sets the size of the pass.
+	 *
+	 * @param {number} width - The width to set.
+	 * @param {number} height - The height to set.
+	 */
+	setSize( width, height ) {
+
+		this.material.uniforms[ 'resolution' ].value.set( 1 / width, 1 / height );
+
+	}
+
+}
+
+export { FXAAPass };

package/examples/jsm/postprocessing/FilmPass.js

@@ -14,6 +14,7 @@ import { FilmShader } from '../shaders/FilmShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { FilmPass } from 'three/addons/postprocessing/FilmPass.js';
  */
 class FilmPass extends Pass {
 

package/examples/jsm/postprocessing/GTAOPass.js

@@ -38,6 +38,7 @@ import { SimplexNoise } from '../math/SimplexNoise.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { GTAOPass } from 'three/addons/postprocessing/GTAOPass.js';
  */
 class GTAOPass extends Pass {
 
@@ -241,7 +242,7 @@ class GTAOPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 
@@ -366,7 +367,7 @@ class GTAOPass extends Pass {
 	}
 
 	/**
-	 * Updates the GTAO material from the given paramter object.
+	 * Updates the GTAO material from the given parameter object.
 	 *
 	 * @param {Object} parameters - The GTAO material parameters.
 	 */
@@ -420,7 +421,7 @@ class GTAOPass extends Pass {
 	}
 
 	/**
-	 * Updates the Denoise material from the given paramter object.
+	 * Updates the Denoise material from the given parameter object.
 	 *
 	 * @param {Object} parameters - The denoise parameters.
 	 */

package/examples/jsm/postprocessing/GlitchPass.js

@@ -18,6 +18,7 @@ import { DigitalGlitch } from '../shaders/DigitalGlitch.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { GlitchPass } from 'three/addons/postprocessing/GlitchPass.js';
  */
 class GlitchPass extends Pass {
 
@@ -50,7 +51,7 @@ class GlitchPass extends Pass {
 		} );
 
 		/**
-		 * Whether to noticeably increase the effect instensity or not.
+		 * Whether to noticeably increase the effect intensity or not.
 		 *
 		 * @type {boolean}
 		 * @default false

package/examples/jsm/postprocessing/HalftonePass.js

@@ -26,6 +26,7 @@ import { HalftoneShader } from '../shaders/HalftoneShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { HalftonePass } from 'three/addons/postprocessing/HalftonePass.js';
  */
 class HalftonePass extends Pass {
 
@@ -107,7 +108,7 @@ class HalftonePass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
  	setSize( width, height ) {
 

package/examples/jsm/postprocessing/LUTPass.js

@@ -65,6 +65,7 @@ const LUTShader = {
  * ```
  *
  * @augments ShaderPass
+ * @three_import import { LUTPass } from 'three/addons/postprocessing/LUTPass.js';
  */
 class LUTPass extends ShaderPass {
 

package/examples/jsm/postprocessing/MaskPass.js

@@ -12,6 +12,7 @@ import { Pass } from './Pass.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { MaskPass } from 'three/addons/postprocessing/MaskPass.js';
  */
 class MaskPass extends Pass {
 

package/examples/jsm/postprocessing/OutlinePass.js

@@ -26,6 +26,7 @@ import { CopyShader } from '../shaders/CopyShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { OutlinePass } from 'three/addons/postprocessing/OutlinePass.js';
  */
 class OutlinePass extends Pass {
 
@@ -268,7 +269,7 @@ class OutlinePass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 
@@ -557,7 +558,8 @@ class OutlinePass extends Pass {
 			},
 
 			vertexShader:
-				`#include <morphtarget_pars_vertex>
+				`#include <batching_pars_vertex>
+				#include <morphtarget_pars_vertex>
 				#include <skinning_pars_vertex>
 
 				varying vec4 projTexCoord;
@@ -566,6 +568,7 @@ class OutlinePass extends Pass {
 
 				void main() {
 
+					#include <batching_vertex>
 					#include <skinbase_vertex>
 					#include <begin_vertex>
 					#include <morphtarget_vertex>

package/examples/jsm/postprocessing/OutputPass.js

@@ -28,6 +28,7 @@ import { OutputShader } from '../shaders/OutputShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { OutputPass } from 'three/addons/postprocessing/OutputPass.js';
  */
 class OutputPass extends Pass {
 

package/examples/jsm/postprocessing/Pass.js

@@ -11,6 +11,7 @@ import {
  * This module is only relevant for post processing with {@link WebGLRenderer}.
  *
  * @abstract
+ * @three_import import { Pass } from 'three/addons/postprocessing/Pass.js';
  */
 class Pass {
 
@@ -68,7 +69,7 @@ class Pass {
 	 *
 	 * @abstract
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( /* width, height */ ) {}
 
@@ -132,6 +133,7 @@ const _geometry = new FullscreenTriangleGeometry();
  * This module can only be used with {@link WebGLRenderer}.
  *
  * @augments Mesh
+ * @three_import import { FullScreenQuad } from 'three/addons/postprocessing/Pass.js';
  */
 class FullScreenQuad {
 

package/examples/jsm/postprocessing/RenderPass.js

@@ -13,6 +13,7 @@ import { Pass } from './Pass.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { RenderPass } from 'three/addons/postprocessing/RenderPass.js';
  */
 class RenderPass extends Pass {
 

package/examples/jsm/postprocessing/RenderPixelatedPass.js

@@ -19,6 +19,7 @@ import { Pass, FullScreenQuad } from './Pass.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { RenderPixelatedPass } from 'three/addons/postprocessing/RenderPixelatedPass.js';
  */
 class RenderPixelatedPass extends Pass {
 
@@ -120,7 +121,7 @@ class RenderPixelatedPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/RenderTransitionPass.js

@@ -16,6 +16,7 @@ import { FullScreenQuad, Pass } from './Pass.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { RenderTransitionPass } from 'three/addons/postprocessing/RenderTransitionPass.js';
  */
 class RenderTransitionPass extends Pass {
 
@@ -82,7 +83,7 @@ class RenderTransitionPass extends Pass {
 	 * Sets the transition factor. Must be in the range `[0,1]`.
 	 * This value determines to what degree both scenes are mixed.
 	 *
-	 * @param {boolenumberan} value - The transition factor.
+	 * @param {boolean|number} value - The transition factor.
 	 */
 	setTransition( value ) {
 
@@ -116,7 +117,7 @@ class RenderTransitionPass extends Pass {
 	 * Sets the texture threshold. This value defined how strong the texture effects
 	 * the transition. Must be in the range `[0,1]` (0 means full effect, 1 means no effect).
 	 *
-	 * @param {boolenumberan} value - The threshold value.
+	 * @param {boolean|number} value - The threshold value.
 	 */
 	setTextureThreshold( value ) {
 
@@ -128,7 +129,7 @@ class RenderTransitionPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {
 

package/examples/jsm/postprocessing/SAOPass.js

@@ -33,6 +33,7 @@ import { CopyShader } from '../shaders/CopyShader.js';
  * ```
  *
  * @augments Pass
+ * @three_import import { SAOPass } from 'three/addons/postprocessing/SAOPass.js';
  */
 class SAOPass extends Pass {
 
@@ -82,7 +83,7 @@ class SAOPass extends Pass {
 		this._oldClearAlpha = 1;
 
 		/**
-		 * The SAO paramter.
+		 * The SAO parameter.
 		 *
 		 * @type {Object}
 		 */
@@ -293,7 +294,7 @@ class SAOPass extends Pass {
 	 * Sets the size of the pass.
 	 *
 	 * @param {number} width - The width to set.
-	 * @param {number} height - The width to set.
+	 * @param {number} height - The height to set.
 	 */
 	setSize( width, height ) {