super-three 0.173.5 → 0.176.0

package/src/renderers/common/RenderContexts.js

@@ -23,7 +23,7 @@ class RenderContexts {
 		 * A dictionary that manages render contexts in chain maps
 		 * for each attachment state.
 		 *
-		 * @type {Object<String,ChainMap>}
+		 * @type {Object<string,ChainMap>}
 		 */
 		this.chainMaps = {};
 
@@ -34,7 +34,7 @@ class RenderContexts {
 	 *
 	 * @param {Scene} scene - The scene.
 	 * @param {Camera} camera - The camera that is used to render the scene.
-	 * @param {RenderTarget?} [renderTarget=null] - The active render target.
+	 * @param {?RenderTarget} [renderTarget=null] - The active render target.
 	 * @return {RenderContext} The render context.
 	 */
 	get( scene, camera, renderTarget = null ) {
@@ -80,7 +80,7 @@ class RenderContexts {
 	/**
 	 * Returns a render context intended for clear operations.
 	 *
-	 * @param {RenderTarget?} [renderTarget=null] - The active render target.
+	 * @param {?RenderTarget} [renderTarget=null] - The active render target.
 	 * @return {RenderContext} The render context.
 	 */
 	getForClear( renderTarget = null ) {
@@ -93,7 +93,7 @@ class RenderContexts {
 	 * Returns a chain map for the given attachment state.
 	 *
 	 * @private
-	 * @param {String} attachmentState - The attachment state.
+	 * @param {string} attachmentState - The attachment state.
 	 * @return {ChainMap} The chain map.
 	 */
 	_getChainMap( attachmentState ) {

package/src/renderers/common/RenderList.js

@@ -7,7 +7,7 @@ import { DoubleSide } from '../../constants.js';
  * @function
  * @param {Object} a - The first render item.
  * @param {Object} b - The second render item.
- * @return {Number} A numeric value which defines the sort order.
+ * @return {number} A numeric value which defines the sort order.
  */
 function painterSortStable( a, b ) {
 
@@ -42,7 +42,7 @@ function painterSortStable( a, b ) {
  * @function
  * @param {Object} a - The first render item.
  * @param {Object} b - The second render item.
- * @return {Number} A numeric value which defines the sort order.
+ * @return {number} A numeric value which defines the sort order.
  */
 function reversePainterSortStable( a, b ) {
 
@@ -72,7 +72,7 @@ function reversePainterSortStable( a, b ) {
  * @private
  * @function
  * @param {Material} material - The transparent material.
- * @return {Boolean} Whether the given material requires a double pass or not.
+ * @return {boolean} Whether the given material requires a double pass or not.
  */
 function needsDoublePass( material ) {
 
@@ -114,7 +114,7 @@ class RenderList {
 		/**
 		 * The current render items index.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 * @default 0
 		 */
 		this.renderItemsIndex = 0;
@@ -182,7 +182,7 @@ class RenderList {
 		/**
 		 * How many objects perform occlusion query tests.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 * @default 0
 		 */
 		this.occlusionQueryCount = 0;
@@ -223,9 +223,9 @@ class RenderList {
 	 * @param {Object3D} object - The 3D object.
 	 * @param {BufferGeometry} geometry - The 3D object's geometry.
 	 * @param {Material} material - The 3D object's material.
-	 * @param {Number} groupOrder - The current group order.
-	 * @param {Number} z - Th 3D object's depth value (z value in clip space).
-	 * @param {Number?} group - {Object?} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
+	 * @param {number} groupOrder - The current group order.
+	 * @param {number} z - Th 3D object's depth value (z value in clip space).
+	 * @param {?number} group - {?Object} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
 	 * @param {ClippingContext} clippingContext - The current clipping context.
 	 * @return {Object} The render item.
 	 */
@@ -276,9 +276,9 @@ class RenderList {
 	 * @param {Object3D} object - The 3D object.
 	 * @param {BufferGeometry} geometry - The 3D object's geometry.
 	 * @param {Material} material - The 3D object's material.
-	 * @param {Number} groupOrder - The current group order.
-	 * @param {Number} z - Th 3D object's depth value (z value in clip space).
-	 * @param {Number?} group - {Object?} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
+	 * @param {number} groupOrder - The current group order.
+	 * @param {number} z - Th 3D object's depth value (z value in clip space).
+	 * @param {?number} group - {?Object} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
 	 * @param {ClippingContext} clippingContext - The current clipping context.
 	 */
 	push( object, geometry, material, groupOrder, z, group, clippingContext ) {
@@ -308,9 +308,9 @@ class RenderList {
 	 * @param {Object3D} object - The 3D object.
 	 * @param {BufferGeometry} geometry - The 3D object's geometry.
 	 * @param {Material} material - The 3D object's material.
-	 * @param {Number} groupOrder - The current group order.
-	 * @param {Number} z - Th 3D object's depth value (z value in clip space).
-	 * @param {Number?} group - {Object?} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
+	 * @param {number} groupOrder - The current group order.
+	 * @param {number} z - Th 3D object's depth value (z value in clip space).
+	 * @param {?number} group - {?Object} group - Only relevant for objects using multiple materials. This represents a group entry from the respective `BufferGeometry`.
 	 * @param {ClippingContext} clippingContext - The current clipping context.
 	 */
 	unshift( object, geometry, material, groupOrder, z, group, clippingContext ) {
@@ -356,8 +356,8 @@ class RenderList {
 	/**
 	 * Sorts the internal render lists.
 	 *
-	 * @param {function(Any, Any): Number} customOpaqueSort - A custom sort function for opaque objects.
-	 * @param {function(Any, Any): Number} customTransparentSort -  A custom sort function for transparent objects.
+	 * @param {?function(any, any): number} customOpaqueSort - A custom sort function for opaque objects.
+	 * @param {?function(any, any): number} customTransparentSort -  A custom sort function for transparent objects.
 	 */
 	sort( customOpaqueSort, customTransparentSort ) {
 

package/src/renderers/common/RenderObject.js

@@ -149,14 +149,14 @@ class RenderObject {
 		/**
 		 * The render object's version.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.version = material.version;
 
 		/**
 		 * The draw range of the geometry.
 		 *
-		 * @type {Object?}
+		 * @type {?Object}
 		 * @default null
 		 */
 		this.drawRange = null;
@@ -166,7 +166,7 @@ class RenderObject {
 		 * of the render object. This entails attribute
 		 * definitions on geometry and node level.
 		 *
-		 * @type {Array<BufferAttribute>?}
+		 * @type {?Array<BufferAttribute>}
 		 * @default null
 		 */
 		this.attributes = null;
@@ -185,7 +185,7 @@ class RenderObject {
 		 * multiple materials. This represents a group entry
 		 * from the respective `BufferGeometry`.
 		 *
-		 * @type {{start: Number, count: Number}?}
+		 * @type {?{start: number, count: number}}
 		 * @default null
 		 */
 		this.group = null;
@@ -194,7 +194,7 @@ class RenderObject {
 		 * An array holding the vertex buffers which can
 		 * be buffer attributes but also interleaved buffers.
 		 *
-		 * @type {Array<BufferAttribute|InterleavedBuffer>?}
+		 * @type {?Array<BufferAttribute|InterleavedBuffer>}
 		 * @default null
 		 */
 		this.vertexBuffers = null;
@@ -202,7 +202,7 @@ class RenderObject {
 		/**
 		 * The parameters for the draw command.
 		 *
-		 * @type {Object?}
+		 * @type {?Object}
 		 * @default null
 		 */
 		this.drawParams = null;
@@ -211,7 +211,7 @@ class RenderObject {
 		 * If this render object is used inside a render bundle,
 		 * this property points to the respective bundle group.
 		 *
-		 * @type {BundleGroup?}
+		 * @type {?BundleGroup}
 		 * @default null
 		 */
 		this.bundle = null;
@@ -226,28 +226,28 @@ class RenderObject {
 		/**
 		 * The clipping context's cache key.
 		 *
-		 * @type {String}
+		 * @type {string}
 		 */
 		this.clippingContextCacheKey = clippingContext !== null ? clippingContext.cacheKey : '';
 
 		/**
 		 * The initial node cache key.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.initialNodesCacheKey = this.getDynamicCacheKey();
 
 		/**
 		 * The initial cache key.
 		 *
-		 * @type {Number}
+		 * @type {number}
 		 */
 		this.initialCacheKey = this.getCacheKey();
 
 		/**
 		 * The node builder state.
 		 *
-		 * @type {NodeBuilderState?}
+		 * @type {?NodeBuilderState}
 		 * @private
 		 * @default null
 		 */
@@ -256,7 +256,7 @@ class RenderObject {
 		/**
 		 * An array of bindings.
 		 *
-		 * @type {Array<BindGroup>?}
+		 * @type {?Array<BindGroup>}
 		 * @private
 		 * @default null
 		 */
@@ -265,7 +265,7 @@ class RenderObject {
 		/**
 		 * Reference to the node material observer.
 		 *
-		 * @type {NodeMaterialObserver?}
+		 * @type {?NodeMaterialObserver}
 		 * @private
 		 * @default null
 		 */
@@ -282,7 +282,7 @@ class RenderObject {
 		/**
 		 * This flag can be used for type testing.
 		 *
-		 * @type {Boolean}
+		 * @type {boolean}
 		 * @readonly
 		 * @default true
 		 */
@@ -318,7 +318,7 @@ class RenderObject {
 	/**
 	 * Whether the clipping requires an update or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @readonly
 	 */
 	get clippingNeedsUpdate() {
@@ -334,7 +334,7 @@ class RenderObject {
 	/**
 	 * The number of clipping planes defined in context of hardware clipping.
 	 *
-	 * @type {Number}
+	 * @type {number}
 	 * @readonly
 	 */
 	get hardwareClippingPlanes() {
@@ -379,8 +379,8 @@ class RenderObject {
 	/**
 	 * Returns a binding group by group name of this render object.
 	 *
-	 * @param {String} name - The name of the binding group.
-	 * @return {BindGroup?} The bindings.
+	 * @param {string} name - The name of the binding group.
+	 * @return {?BindGroup} The bindings.
 	 */
 	getBindingGroup( name ) {
 
@@ -399,7 +399,7 @@ class RenderObject {
 	/**
 	 * Returns the index of the render object's geometry.
 	 *
-	 * @return {BufferAttribute?} The index. Returns `null` for non-indexed geometries.
+	 * @return {?BufferAttribute} The index. Returns `null` for non-indexed geometries.
 	 */
 	getIndex() {
 
@@ -410,7 +410,7 @@ class RenderObject {
 	/**
 	 * Returns the indirect buffer attribute.
 	 *
-	 * @return {BufferAttribute?} The indirect attribute. `null` if no indirect drawing is used.
+	 * @return {?BufferAttribute} The indirect attribute. `null` if no indirect drawing is used.
 	 */
 	getIndirect() {
 
@@ -494,7 +494,7 @@ class RenderObject {
 	/**
 	 * Returns the draw parameters for the render object.
 	 *
-	 * @return {{vertexCount: Number, firstVertex: Number, instanceCount: Number, firstInstance: Number}} The draw parameters.
+	 * @return {?{vertexCount: number, firstVertex: number, instanceCount: number, firstInstance: number}} The draw parameters.
 	 */
 	getDrawParameters() {
 
@@ -567,7 +567,7 @@ class RenderObject {
 	 *
 	 * The geometry cache key is part of the material cache key.
 	 *
-	 * @return {String} The geometry cache key.
+	 * @return {string} The geometry cache key.
 	 */
 	getGeometryCacheKey() {
 
@@ -623,7 +623,7 @@ class RenderObject {
 	 *
 	 * The material cache key is part of the render object cache key.
 	 *
-	 * @return {Number} The material cache key.
+	 * @return {number} The material cache key.
 	 */
 	getMaterialCacheKey() {
 
@@ -720,7 +720,7 @@ class RenderObject {
 	/**
 	 * Whether the geometry requires an update or not.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @readonly
 	 */
 	get needsGeometryUpdate() {
@@ -743,7 +743,7 @@ class RenderObject {
 	 * TODO: Investigate if it's possible to merge both steps so there is only a single place
 	 * that performs the 'needsUpdate' check.
 	 *
-	 * @type {Boolean}
+	 * @type {boolean}
 	 * @readonly
 	 */
 	get needsUpdate() {
@@ -755,7 +755,7 @@ class RenderObject {
 	/**
 	 * Returns the dynamic cache key which represents a key that is computed per draw command.
 	 *
-	 * @return {Number} The cache key.
+	 * @return {number} The cache key.
 	 */
 	getDynamicCacheKey() {
 
@@ -789,7 +789,7 @@ class RenderObject {
 	/**
 	 * Returns the render object's cache key.
 	 *
-	 * @return {Number} The cache key.
+	 * @return {number} The cache key.
 	 */
 	getCacheKey() {
 

package/src/renderers/common/RenderObjects.js

@@ -68,7 +68,7 @@ class RenderObjects {
 		 * A dictionary that manages render contexts in chain maps
 		 * for each pass ID.
 		 *
-		 * @type {Object<String,ChainMap>}
+		 * @type {Object<string,ChainMap>}
 		 */
 		this.chainMaps = {};
 
@@ -84,7 +84,7 @@ class RenderObjects {
 	 * @param {LightsNode} lightsNode - The lights node.
 	 * @param {RenderContext} renderContext - The render context.
 	 * @param {ClippingContext} clippingContext - The clipping context.
-	 * @param {String?} passId - An optional ID for identifying the pass.
+	 * @param {string} [passId] - An optional ID for identifying the pass.
 	 * @return {RenderObject} The render object.
 	 */
 	get( object, material, scene, camera, lightsNode, renderContext, clippingContext, passId ) {
@@ -142,7 +142,7 @@ class RenderObjects {
 	/**
 	 * Returns a chain map for the given pass ID.
 	 *
-	 * @param {String} [passId='default'] - The pass ID.
+	 * @param {string} [passId='default'] - The pass ID.
 	 * @return {ChainMap} The chain map.
 	 */
 	getChainMap( passId = 'default' ) {
@@ -173,7 +173,7 @@ class RenderObjects {
 	 * @param {LightsNode} lightsNode - The lights node.
 	 * @param {RenderContext} renderContext - The render context.
 	 * @param {ClippingContext} clippingContext - The clipping context.
-	 * @param {String?} passId - An optional ID for identifying the pass.
+	 * @param {string} [passId] - An optional ID for identifying the pass.
 	 * @return {RenderObject} The render object.
 	 */
 	createRenderObject( nodes, geometries, renderer, object, material, scene, camera, lightsNode, renderContext, clippingContext, passId ) {

package/src/renderers/common/RenderPipeline.js

@@ -11,7 +11,7 @@ class RenderPipeline extends Pipeline {
 	/**
 	 * Constructs a new render pipeline.
 	 *
-	 * @param {String} cacheKey - The pipeline's cache key.
+	 * @param {string} cacheKey - The pipeline's cache key.
 	 * @param {ProgrammableStage} vertexProgram - The pipeline's vertex shader.
 	 * @param {ProgrammableStage} fragmentProgram - The pipeline's fragment shader.
 	 */