super-three 0.173.5 → 0.176.0

package/src/renderers/common/XRRenderTarget.js

@@ -12,8 +12,8 @@ class XRRenderTarget extends RenderTarget {
 	/**
 	 * Constructs a new XR render target.
 	 *
-	 * @param {Number} [width=1] - The width of the render target.
-	 * @param {Number} [height=1] - The height of the render target.
+	 * @param {number} [width=1] - The width of the render target.
+	 * @param {number} [height=1] - The height of the render target.
 	 * @param {Object} [options={}] - The configuration options.
 	 */
 	constructor( width = 1, height = 1, options = {} ) {
@@ -23,7 +23,7 @@ class XRRenderTarget extends RenderTarget {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -34,7 +34,7 @@ class XRRenderTarget extends RenderTarget {
 		 * are defined by external textures. This flag is
 		 * set to `true` when using the WebXR Layers API.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default false
 		 */
 		this.hasExternalTextures = false;
@@ -50,7 +50,7 @@ class XRRenderTarget extends RenderTarget {
 		 *
 		 * Reference: {@link https://www.w3.org/TR/webxrlayers-1/#dom-xrprojectionlayer-ignoredepthvalues}.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @default true
 		 */
 		this.autoAllocateDepthBuffer = true;

package/src/renderers/common/extras/PMREMGenerator.js

@@ -69,6 +69,8 @@ const _axisDirections = [
 	/*@__PURE__*/ new Vector3( 1, 1, 1 )
 ];
 
+const _origin = /*@__PURE__*/ new Vector3();
+
 // maps blur materials to their uniforms dictionary
 
 const _uniformsMap = new WeakMap();
@@ -93,12 +95,16 @@ const _outputDirection = /*@__PURE__*/ vec3( _direction.x, _direction.y, _direct
  * higher roughness levels. In this way we maintain resolution to smoothly
  * interpolate diffuse lighting while limiting sampling computation.
  *
- * Paper: Fast, Accurate Image-Based Lighting
- * https://drive.google.com/file/d/15y8r_UpKlU9SvV4ILb0C3qCPecS8pvLz/view
+ * Paper: Fast, Accurate Image-Based Lighting:
+ * {@link https://drive.google.com/file/d/15y8r_UpKlU9SvV4ILb0C3qCPecS8pvLz/view}
 */
-
 class PMREMGenerator {
 
+	/**
+	 * Constructs a new PMREM generator.
+	 *
+	 * @param {Renderer} renderer - The renderer.
+	 */
 	constructor( renderer ) {
 
 		this._renderer = renderer;
@@ -128,20 +134,28 @@ class PMREMGenerator {
 	 * Generates a PMREM from a supplied Scene, which can be faster than using an
 	 * image if networking bandwidth is low. Optional sigma specifies a blur radius
 	 * in radians to be applied to the scene before PMREM generation. Optional near
-	 * and far planes ensure the scene is rendered in its entirety (the cubeCamera
-	 * is placed at the origin).
+	 * and far planes ensure the scene is rendered in its entirety.
 	 *
 	 * @param {Scene} scene - The scene to be captured.
-	 * @param {Number} [sigma=0] - The blur radius in radians.
-	 * @param {Number} [near=0.1] - The near plane distance.
-	 * @param {Number} [far=100] - The far plane distance.
-	 * @param {RenderTarget?} [renderTarget=null] - The render target to use.
+	 * @param {number} [sigma=0] - The blur radius in radians.
+	 * @param {number} [near=0.1] - The near plane distance.
+	 * @param {number} [far=100] - The far plane distance.
+	 * @param {Object} [options={}] - The configuration options.
+	 * @param {number} [options.size=256] - The texture size of the PMREM.
+	 * @param {Vector3} [options.renderTarget=origin] - The position of the internal cube camera that renders the scene.
+	 * @param {?RenderTarget} [options.renderTarget=null] - The render target to use.
 	 * @return {RenderTarget} The resulting PMREM.
-	 * @see fromSceneAsync
+	 * @see {@link PMREMGenerator#fromSceneAsync}
 	 */
-	fromScene( scene, sigma = 0, near = 0.1, far = 100, renderTarget = null ) {
+	fromScene( scene, sigma = 0, near = 0.1, far = 100, options = {} ) {
+
+		const {
+			size = 256,
+			position = _origin,
+			renderTarget = null,
+		} = options;
 
-		this._setSize( 256 );
+		this._setSize( size );
 
 		if ( this._hasInitialized === false ) {
 
@@ -149,7 +163,9 @@ class PMREMGenerator {
 
 			const cubeUVRenderTarget = renderTarget || this._allocateTargets();
 
-			this.fromSceneAsync( scene, sigma, near, far, cubeUVRenderTarget );
+			options.renderTarget = cubeUVRenderTarget;
+
+			this.fromSceneAsync( scene, sigma, near, far, options );
 
 			return cubeUVRenderTarget;
 
@@ -162,7 +178,7 @@ class PMREMGenerator {
 		const cubeUVRenderTarget = renderTarget || this._allocateTargets();
 		cubeUVRenderTarget.depthBuffer = true;
 
-		this._sceneToCubeUV( scene, near, far, cubeUVRenderTarget );
+		this._sceneToCubeUV( scene, near, far, cubeUVRenderTarget, position );
 
 		if ( sigma > 0 ) {
 
@@ -186,18 +202,21 @@ class PMREMGenerator {
 	 * is placed at the origin).
 	 *
 	 * @param {Scene} scene - The scene to be captured.
-	 * @param {Number} [sigma=0] - The blur radius in radians.
-	 * @param {Number} [near=0.1] - The near plane distance.
-	 * @param {Number} [far=100] - The far plane distance.
-	 * @param {RenderTarget?} [renderTarget=null] - The render target to use.
-	 * @return {Promise<RenderTarget>} The resulting PMREM.
-	 * @see fromScene
+	 * @param {number} [sigma=0] - The blur radius in radians.
+	 * @param {number} [near=0.1] - The near plane distance.
+	 * @param {number} [far=100] - The far plane distance.
+	 * @param {Object} [options={}] - The configuration options.
+	 * @param {number} [options.size=256] - The texture size of the PMREM.
+	 * @param {Vector3} [options.position=origin] - The position of the internal cube camera that renders the scene.
+	 * @param {?RenderTarget} [options.renderTarget=null] - The render target to use.
+	 * @return {Promise<RenderTarget>} A Promise that resolve with the PMREM when the generation has been finished.
+	 * @see {@link PMREMGenerator#fromScene}
 	 */
-	async fromSceneAsync( scene, sigma = 0, near = 0.1, far = 100, renderTarget = null ) {
+	async fromSceneAsync( scene, sigma = 0, near = 0.1, far = 100, options = {} ) {
 
 		if ( this._hasInitialized === false ) await this._renderer.init();
 
-		return this.fromScene( scene, sigma, near, far, renderTarget );
+		return this.fromScene( scene, sigma, near, far, options );
 
 	}
 
@@ -207,9 +226,9 @@ class PMREMGenerator {
 	 * as this matches best with the 256 x 256 cubemap output.
 	 *
 	 * @param {Texture} equirectangular - The equirectangular texture to be converted.
-	 * @param {RenderTarget?} [renderTarget=null] - The render target to use.
+	 * @param {?RenderTarget} [renderTarget=null] - The render target to use.
 	 * @return {RenderTarget} The resulting PMREM.
-	 * @see fromEquirectangularAsync
+	 * @see {@link PMREMGenerator#fromEquirectangularAsync}
 	 */
 	fromEquirectangular( equirectangular, renderTarget = null ) {
 
@@ -237,9 +256,9 @@ class PMREMGenerator {
 	 * as this matches best with the 256 x 256 cubemap output.
 	 *
 	 * @param {Texture} equirectangular - The equirectangular texture to be converted.
-	 * @param {RenderTarget?} [renderTarget=null] - The render target to use.
+	 * @param {?RenderTarget} [renderTarget=null] - The render target to use.
 	 * @return {Promise<RenderTarget>} The resulting PMREM.
-	 * @see fromEquirectangular
+	 * @see {@link PMREMGenerator#fromEquirectangular}
 	 */
 	async fromEquirectangularAsync( equirectangular, renderTarget = null ) {
 
@@ -255,9 +274,9 @@ class PMREMGenerator {
 	 * as this matches best with the 256 x 256 cubemap output.
 	 *
 	 * @param {Texture} cubemap - The cubemap texture to be converted.
-	 * @param {RenderTarget?} [renderTarget=null] - The render target to use.
+	 * @param {?RenderTarget} [renderTarget=null] - The render target to use.
 	 * @return {RenderTarget} The resulting PMREM.
-	 * @see fromCubemapAsync
+	 * @see {@link PMREMGenerator#fromCubemapAsync}
 	 */
 	fromCubemap( cubemap, renderTarget = null ) {
 
@@ -285,9 +304,9 @@ class PMREMGenerator {
 	 * with the 256 x 256 cubemap output.
 	 *
 	 * @param {Texture} cubemap - The cubemap texture to be converted.
-	 * @param {RenderTarget?} [renderTarget=null] - The render target to use.
+	 * @param {?RenderTarget} [renderTarget=null] - The render target to use.
 	 * @return {Promise<RenderTarget>} The resulting PMREM.
-	 * @see fromCubemap
+	 * @see {@link PMREMGenerator#fromCubemap}
 	 */
 	async fromCubemapAsync( cubemap, renderTarget = null ) {
 
@@ -458,7 +477,7 @@ class PMREMGenerator {
 
 	}
 
-	_sceneToCubeUV( scene, near, far, cubeUVRenderTarget ) {
+	_sceneToCubeUV( scene, near, far, cubeUVRenderTarget, position ) {
 
 		const cubeCamera = _cubeCamera;
 		cubeCamera.near = near;
@@ -528,17 +547,22 @@ class PMREMGenerator {
 			if ( col === 0 ) {
 
 				cubeCamera.up.set( 0, upSign[ i ], 0 );
-				cubeCamera.lookAt( forwardSign[ i ], 0, 0 );
+				cubeCamera.position.set( position.x, position.y, position.z );
+				cubeCamera.lookAt( position.x + forwardSign[ i ], position.y, position.z );
 
 			} else if ( col === 1 ) {
 
 				cubeCamera.up.set( 0, 0, upSign[ i ] );
-				cubeCamera.lookAt( 0, forwardSign[ i ], 0 );
+				cubeCamera.position.set( position.x, position.y, position.z );
+				cubeCamera.lookAt( position.x, position.y + forwardSign[ i ], position.z );
+
 
 			} else {
 
 				cubeCamera.up.set( 0, upSign[ i ], 0 );
-				cubeCamera.lookAt( 0, 0, forwardSign[ i ] );
+				cubeCamera.position.set( position.x, position.y, position.z );
+				cubeCamera.lookAt( position.x, position.y, position.z + forwardSign[ i ] );
+
 
 			}
 
@@ -622,10 +646,11 @@ class PMREMGenerator {
 	 * the poles) to approximate the orthogonally-separable blur. It is least
 	 * accurate at the poles, but still does a decent job.
 	 *
+	 * @private
 	 * @param {RenderTarget} cubeUVRenderTarget - The cubemap render target.
-	 * @param {Number} lodIn - The input level-of-detail.
-	 * @param {Number} lodOut - The output level-of-detail.
-	 * @param {Number} sigma - The blur radius in radians.
+	 * @param {number} lodIn - The input level-of-detail.
+	 * @param {number} lodOut - The output level-of-detail.
+	 * @param {number} sigma - The blur radius in radians.
 	 * @param {Vector3} [poleAxis] - The pole axis.
 	 */
 	_blur( cubeUVRenderTarget, lodIn, lodOut, sigma, poleAxis ) {

package/src/renderers/common/nodes/NodeBuilderState.js

@@ -14,9 +14,9 @@ class NodeBuilderState {
 	/**
 	 * Constructs a new node builder state.
 	 *
-	 * @param {String?} vertexShader - The native vertex shader code.
-	 * @param {String?} fragmentShader - The native fragment shader code.
-	 * @param {String?} computeShader - The native compute shader code.
+	 * @param {string} vertexShader - The native vertex shader code.
+	 * @param {string} fragmentShader - The native fragment shader code.
+	 * @param {string} computeShader - The native compute shader code.
 	 * @param {Array<NodeAttribute>} nodeAttributes - An array of node attributes.
 	 * @param {Array<BindGroup>} bindings - An array of bind groups.
 	 * @param {Array<Node>} updateNodes - An array of nodes that implement their `update()` method.
@@ -30,21 +30,21 @@ class NodeBuilderState {
 		/**
 		 * The native vertex shader code.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.vertexShader = vertexShader;
 
 		/**
 		 * The native fragment shader code.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.fragmentShader = fragmentShader;
 
 		/**
 		 * The native compute shader code.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.computeShader = computeShader;
 
@@ -103,7 +103,7 @@ class NodeBuilderState {
 		/**
 		 * How often this state is used by render objects.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.usedTimes = 0;
 

package/src/renderers/common/nodes/NodeLibrary.js

@@ -23,7 +23,7 @@ class NodeLibrary {
 		/**
 		 * A map that maps materials to node materials.
 		 *
-		 * @type {Map<String,NodeMaterial.constructor>}
+		 * @type {Map<string,NodeMaterial.constructor>}
 		 */
 		this.materialNodes = new Map();
 
@@ -31,7 +31,7 @@ class NodeLibrary {
 		 * A map that maps tone mapping techniques (constants)
 		 * to tone mapping node functions.
 		 *
-		 * @type {Map<Number,Function>}
+		 * @type {Map<number,Function>}
 		 */
 		this.toneMappingNodes = new Map();
 
@@ -75,7 +75,7 @@ class NodeLibrary {
 	 * Adds a tone mapping node function for a tone mapping technique (constant).
 	 *
 	 * @param {Function} toneMappingNode - The tone mapping node function.
-	 * @param {Number} toneMapping - The tone mapping.
+	 * @param {number} toneMapping - The tone mapping.
 	 */
 	addToneMapping( toneMappingNode, toneMapping ) {
 
@@ -86,8 +86,8 @@ class NodeLibrary {
 	/**
 	 * Returns a tone mapping node function for a tone mapping technique (constant).
 	 *
-	 * @param {Number} toneMapping - The tone mapping.
-	 * @return {Function?} The tone mapping node function. Returns `null` if no node function is found.
+	 * @param {number} toneMapping - The tone mapping.
+	 * @return {?Function} The tone mapping node function. Returns `null` if no node function is found.
 	 */
 	getToneMappingFunction( toneMapping ) {
 
@@ -98,8 +98,8 @@ class NodeLibrary {
 	/**
 	 * Returns a node material class definition for a material type.
 	 *
-	 * @param {String} materialType - The material type.
-	 * @return {NodeMaterial.constructor?} The node material class definition. Returns `null` if no node material is found.
+	 * @param {string} materialType - The material type.
+	 * @return {?NodeMaterial.constructor} The node material class definition. Returns `null` if no node material is found.
 	 */
 	getMaterialNodeClass( materialType ) {
 
@@ -111,7 +111,7 @@ class NodeLibrary {
 	 * Adds a node material class definition for a given material type.
 	 *
 	 * @param {NodeMaterial.constructor} materialNodeClass - The node material class definition.
-	 * @param {String} materialClassType - The material type.
+	 * @param {string} materialClassType - The material type.
 	 */
 	addMaterial( materialNodeClass, materialClassType ) {
 
@@ -123,7 +123,7 @@ class NodeLibrary {
 	 * Returns a light node class definition for a light class definition.
 	 *
 	 * @param {Light.constructor} light - The light class definition.
-	 * @return {AnalyticLightNode.constructor?} The light node class definition. Returns `null` if no light node is found.
+	 * @return {?AnalyticLightNode.constructor} The light node class definition. Returns `null` if no light node is found.
 	 */
 	getLightNodeClass( light ) {
 
@@ -146,8 +146,8 @@ class NodeLibrary {
 	/**
 	 * Adds a node class definition for the given type to the provided type library.
 	 *
-	 * @param {Any} nodeClass - The node class definition.
-	 * @param {Number|String} type - The object type.
+	 * @param {any} nodeClass - The node class definition.
+	 * @param {number|string} type - The object type.
 	 * @param {Map} library - The type library.
 	 */
 	addType( nodeClass, type, library ) {
@@ -169,8 +169,8 @@ class NodeLibrary {
 	/**
 	 * Adds a node class definition for the given class definition to the provided type library.
 	 *
-	 * @param {Any} nodeClass - The node class definition.
-	 * @param {Any} baseClass - The class definition.
+	 * @param {any} nodeClass - The node class definition.
+	 * @param {any} baseClass - The class definition.
 	 * @param {WeakMap} library - The type library.
 	 */
 	addClass( nodeClass, baseClass, library ) {

package/src/renderers/common/nodes/NodeSampledTexture.js

@@ -12,10 +12,10 @@ class NodeSampledTexture extends SampledTexture {
 	/**
 	 * Constructs a new node-based sampled texture.
 	 *
-	 * @param {String} name - The textures's name.
+	 * @param {string} name - The textures's name.
 	 * @param {TextureNode} textureNode - The texture node.
 	 * @param {UniformGroupNode} groupNode - The uniform group node.
-	 * @param {String?} [access=null] - The access type.
+	 * @param {?string} [access=null] - The access type.
 	 */
 	constructor( name, textureNode, groupNode, access = null ) {
 
@@ -38,7 +38,7 @@ class NodeSampledTexture extends SampledTexture {
 		/**
 		 * The access type.
 		 *
-		 * @type {String?}
+		 * @type {?string}
 		 * @default null
 		 */
 		this.access = access;
@@ -48,8 +48,8 @@ class NodeSampledTexture extends SampledTexture {
 	/**
 	 * Overwrites the default to additionally check if the node value has changed.
 	 *
-	 * @param {Number} generation - The generation.
-	 * @return {Boolean} Whether an update is required or not.
+	 * @param {number} generation - The generation.
+	 * @return {boolean} Whether an update is required or not.
 	 */
 	needsBindingsUpdate( generation ) {
 
@@ -60,7 +60,7 @@ class NodeSampledTexture extends SampledTexture {
 	/**
 	 * Updates the binding.
 	 *
-	 * @return {Boolean} Whether the texture has been updated and must be
+	 * @return {boolean} Whether the texture has been updated and must be
 	 * uploaded to the GPU.
 	 */
 	update() {
@@ -93,10 +93,10 @@ class NodeSampledCubeTexture extends NodeSampledTexture {
 	/**
 	 * Constructs a new node-based sampled cube texture.
 	 *
-	 * @param {String} name - The textures's name.
+	 * @param {string} name - The textures's name.
 	 * @param {TextureNode} textureNode - The texture node.
 	 * @param {UniformGroupNode} groupNode - The uniform group node.
-	 * @param {String?} [access=null] - The access type.
+	 * @param {?string} [access=null] - The access type.
 	 */
 	constructor( name, textureNode, groupNode, access = null ) {
 
@@ -105,7 +105,7 @@ class NodeSampledCubeTexture extends NodeSampledTexture {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -127,10 +127,10 @@ class NodeSampledTexture3D extends NodeSampledTexture {
 	/**
 	 * Constructs a new node-based sampled 3D texture.
 	 *
-	 * @param {String} name - The textures's name.
+	 * @param {string} name - The textures's name.
 	 * @param {TextureNode} textureNode - The texture node.
 	 * @param {UniformGroupNode} groupNode - The uniform group node.
-	 * @param {String?} [access=null] - The access type.
+	 * @param {?string} [access=null] - The access type.
 	 */
 	constructor( name, textureNode, groupNode, access = null ) {
 
@@ -139,7 +139,7 @@ class NodeSampledTexture3D extends NodeSampledTexture {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */

package/src/renderers/common/nodes/NodeSampler.js

@@ -12,7 +12,7 @@ class NodeSampler extends Sampler {
 	/**
 	 * Constructs a new node-based sampler.
 	 *
-	 * @param {String} name - The samplers's name.
+	 * @param {string} name - The samplers's name.
 	 * @param {TextureNode} textureNode - The texture node.
 	 * @param {UniformGroupNode} groupNode - The uniform group node.
 	 */

package/src/renderers/common/nodes/NodeStorageBuffer.js

@@ -32,7 +32,7 @@ class NodeStorageBuffer extends StorageBuffer {
 		/**
 		 * The access type.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.access = nodeUniform ? nodeUniform.access : NodeAccess.READ_WRITE;
 

package/src/renderers/common/nodes/NodeUniform.js

@@ -33,7 +33,7 @@ class NumberNodeUniform extends NumberUniform {
 	/**
 	 * Overwritten to return the value of the node uniform.
 	 *
-	 * @return {Number} The value.
+	 * @return {number} The value.
 	 */
 	getValue() {
 
@@ -44,7 +44,7 @@ class NumberNodeUniform extends NumberUniform {
 	/**
 	 * Returns the node uniform data type.
 	 *
-	 * @return {String} The data type.
+	 * @return {string} The data type.
 	 */
 	getType() {
 
@@ -95,7 +95,7 @@ class Vector2NodeUniform extends Vector2Uniform {
 	/**
 	 * Returns the node uniform data type.
 	 *
-	 * @return {String} The data type.
+	 * @return {string} The data type.
 	 */
 	getType() {
 
@@ -146,7 +146,7 @@ class Vector3NodeUniform extends Vector3Uniform {
 	/**
 	 * Returns the node uniform data type.
 	 *
-	 * @return {String} The data type.
+	 * @return {string} The data type.
 	 */
 	getType() {
 
@@ -197,7 +197,7 @@ class Vector4NodeUniform extends Vector4Uniform {
 	/**
 	 * Returns the node uniform data type.
 	 *
-	 * @return {String} The data type.
+	 * @return {string} The data type.
 	 */
 	getType() {
 
@@ -248,7 +248,7 @@ class ColorNodeUniform extends ColorUniform {
 	/**
 	 * Returns the node uniform data type.
 	 *
-	 * @return {String} The data type.
+	 * @return {string} The data type.
 	 */
 	getType() {
 
@@ -300,7 +300,7 @@ class Matrix2NodeUniform extends Matrix2Uniform {
 	/**
 	 * Returns the node uniform data type.
 	 *
-	 * @return {String} The data type.
+	 * @return {string} The data type.
 	 */
 	getType() {
 
@@ -351,7 +351,7 @@ class Matrix3NodeUniform extends Matrix3Uniform {
 	/**
 	 * Returns the node uniform data type.
 	 *
-	 * @return {String} The data type.
+	 * @return {string} The data type.
 	 */
 	getType() {
 
@@ -402,7 +402,7 @@ class Matrix4NodeUniform extends Matrix4Uniform {
 	/**
 	 * Returns the node uniform data type.
 	 *
-	 * @return {String} The data type.
+	 * @return {string} The data type.
 	 */
 	getType() {
 

package/src/renderers/common/nodes/NodeUniformsGroup.js

@@ -14,7 +14,7 @@ class NodeUniformsGroup extends UniformsGroup {
 	/**
 	 * Constructs a new node-based uniforms group.
 	 *
-	 * @param {String} name - The group's name.
+	 * @param {string} name - The group's name.
 	 * @param {UniformGroupNode} groupNode - The uniform group node.
 	 */
 	constructor( name, groupNode ) {
@@ -24,7 +24,7 @@ class NodeUniformsGroup extends UniformsGroup {
 		/**
 		 * The group's ID.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.id = _id ++;
 
@@ -38,7 +38,7 @@ class NodeUniformsGroup extends UniformsGroup {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */