@needle-tools/three 0.169.20-experimental.0 → 0.183.2-canary.0

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

@@ -1,24 +1,56 @@
 import { SampledTexture } from '../SampledTexture.js';
 
+/**
+ * A special form of sampled texture binding type.
+ * It's texture value is managed by a node object.
+ *
+ * @private
+ * @augments SampledTexture
+ */
 class NodeSampledTexture extends SampledTexture {
 
+	/**
+	 * Constructs a new node-based sampled texture.
+	 *
+	 * @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.
+	 */
 	constructor( name, textureNode, groupNode, access = null ) {
 
 		super( name, textureNode ? textureNode.value : null );
 
+		/**
+		 * The texture node.
+		 *
+		 * @type {TextureNode}
+		 */
 		this.textureNode = textureNode;
+
+		/**
+		 * The uniform group node.
+		 *
+		 * @type {UniformGroupNode}
+		 */
 		this.groupNode = groupNode;
 
+		/**
+		 * The access type.
+		 *
+		 * @type {?string}
+		 * @default null
+		 */
 		this.access = access;
 
 	}
 
-	needsBindingsUpdate( generation ) {
-
-		return this.textureNode.value !== this.texture || super.needsBindingsUpdate( generation );
-
-	}
-
+	/**
+	 * Updates the binding.
+	 *
+	 * @return {boolean} Whether the texture has been updated and must be
+	 * uploaded to the GPU.
+	 */
 	update() {
 
 		const { textureNode } = this;
@@ -37,24 +69,68 @@ class NodeSampledTexture extends SampledTexture {
 
 }
 
+/**
+ * A special form of sampled cube texture binding type.
+ * It's texture value is managed by a node object.
+ *
+ * @private
+ * @augments NodeSampledTexture
+ */
 class NodeSampledCubeTexture extends NodeSampledTexture {
 
-	constructor( name, textureNode, groupNode, access ) {
+	/**
+	 * Constructs a new node-based sampled cube texture.
+	 *
+	 * @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.
+	 */
+	constructor( name, textureNode, groupNode, access = null ) {
 
 		super( name, textureNode, groupNode, access );
 
+		/**
+		 * This flag can be used for type testing.
+		 *
+		 * @type {boolean}
+		 * @readonly
+		 * @default true
+		 */
 		this.isSampledCubeTexture = true;
 
 	}
 
 }
 
+/**
+ * A special form of sampled 3D texture binding type.
+ * It's texture value is managed by a node object.
+ *
+ * @private
+ * @augments NodeSampledTexture
+ */
 class NodeSampledTexture3D extends NodeSampledTexture {
 
-	constructor( name, textureNode, groupNode, access ) {
+	/**
+	 * Constructs a new node-based sampled 3D texture.
+	 *
+	 * @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.
+	 */
+	constructor( name, textureNode, groupNode, access = null ) {
 
 		super( name, textureNode, groupNode, access );
 
+		/**
+		 * This flag can be used for type testing.
+		 *
+		 * @type {boolean}
+		 * @readonly
+		 * @default true
+		 */
 		this.isSampledTexture3D = true;
 
 	}

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

@@ -1,19 +1,59 @@
 import Sampler from '../Sampler.js';
 
+/**
+ * A special form of sampler binding type.
+ * It's texture value is managed by a node object.
+ *
+ * @private
+ * @augments Sampler
+ */
 class NodeSampler extends Sampler {
 
+	/**
+	 * Constructs a new node-based sampler.
+	 *
+	 * @param {string} name - The samplers's name.
+	 * @param {TextureNode} textureNode - The texture node.
+	 * @param {UniformGroupNode} groupNode - The uniform group node.
+	 */
 	constructor( name, textureNode, groupNode ) {
 
 		super( name, textureNode ? textureNode.value : null );
 
+		/**
+		 * The texture node.
+		 *
+		 * @type {TextureNode}
+		 */
 		this.textureNode = textureNode;
+
+		/**
+		 * The uniform group node.
+		 *
+		 * @type {UniformGroupNode}
+		 */
 		this.groupNode = groupNode;
 
 	}
 
+	/**
+	 * Updates the texture value of this sampler.
+	 *
+	 * @return {boolean} Whether the sampler needs an update or not.
+	 */
 	update() {
 
-		this.texture = this.textureNode.value;
+		const { textureNode } = this;
+
+		if ( this.texture !== textureNode.value ) {
+
+			this.texture = textureNode.value;
+
+			return true;
+
+		}
+
+		return super.update();
 
 	}
 

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

@@ -1,24 +1,69 @@
 import StorageBuffer from '../StorageBuffer.js';
-import { GPUBufferBindingType } from '../../webgpu/utils/WebGPUConstants.js';
+import { NodeAccess } from '../../../nodes/core/constants.js';
 
 let _id = 0;
 
+/**
+ * A special form of storage buffer binding type.
+ * It's buffer value is managed by a node object.
+ *
+ * @private
+ * @augments StorageBuffer
+ */
 class NodeStorageBuffer extends StorageBuffer {
 
+	/**
+	 * Constructs a new node-based storage buffer.
+	 *
+	 * @param {StorageBufferNode} nodeUniform - The storage buffer node.
+	 * @param {UniformGroupNode} groupNode - The uniform group node.
+	 */
 	constructor( nodeUniform, groupNode ) {
 
 		super( 'StorageBuffer_' + _id ++, nodeUniform ? nodeUniform.value : null );
 
+		/**
+		 * The node uniform.
+		 *
+		 * @type {StorageBufferNode}
+		 */
 		this.nodeUniform = nodeUniform;
-		this.access = nodeUniform ? nodeUniform.access : GPUBufferBindingType.Storage;
+
+		/**
+		 * The access type.
+		 *
+		 * @type {string}
+		 */
+		this.access = nodeUniform ? nodeUniform.access : NodeAccess.READ_WRITE;
+
+		/**
+		 * The uniform group node.
+		 *
+		 * @type {UniformGroupNode}
+		 */
 		this.groupNode = groupNode;
 
+	}
+
+	/**
+	 * The storage buffer attribute node.
+	 *
+	 * @type {StorageBufferAttribute}
+	 */
+	get attribute() {
+
+		return this.nodeUniform.value;
 
 	}
 
+	/**
+	 * The storage buffer.
+	 *
+	 * @type {Float32Array}
+	 */
 	get buffer() {
 
-		return this.nodeUniform.value;
+		return this.nodeUniform.value.array;
 
 	}
 

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

@@ -1,135 +1,418 @@
 import {
 	NumberUniform, Vector2Uniform, Vector3Uniform, Vector4Uniform,
-	ColorUniform, Matrix3Uniform, Matrix4Uniform
+	ColorUniform, Matrix2Uniform, Matrix3Uniform, Matrix4Uniform
 } from '../Uniform.js';
 
+/**
+ * A special form of Number uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments NumberUniform
+ */
 class NumberNodeUniform extends NumberUniform {
 
+	/**
+	 * Constructs a new node-based Number uniform.
+	 *
+	 * @param {NodeUniform} nodeUniform - The node uniform.
+	 */
 	constructor( nodeUniform ) {
 
 		super( nodeUniform.name, nodeUniform.value );
 
+		/**
+		 * The node uniform.
+		 *
+		 * @type {NodeUniform}
+		 */
 		this.nodeUniform = nodeUniform;
 
 	}
 
+	/**
+	 * Overwritten to return the value of the node uniform.
+	 *
+	 * @return {number} The value.
+	 */
 	getValue() {
 
 		return this.nodeUniform.value;
 
 	}
 
+	/**
+	 * Returns the node uniform data type.
+	 *
+	 * @return {string} The data type.
+	 */
+	getType() {
+
+		return this.nodeUniform.type;
+
+	}
+
 }
 
+/**
+ * A special form of Vector2 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Vector2Uniform
+ */
 class Vector2NodeUniform extends Vector2Uniform {
 
+	/**
+	 * Constructs a new node-based Vector2 uniform.
+	 *
+	 * @param {NodeUniform} nodeUniform - The node uniform.
+	 */
 	constructor( nodeUniform ) {
 
 		super( nodeUniform.name, nodeUniform.value );
 
+		/**
+		 * The node uniform.
+		 *
+		 * @type {NodeUniform}
+		 */
 		this.nodeUniform = nodeUniform;
 
 	}
 
+	/**
+	 * Overwritten to return the value of the node uniform.
+	 *
+	 * @return {Vector2} The value.
+	 */
 	getValue() {
 
 		return this.nodeUniform.value;
 
 	}
 
+	/**
+	 * Returns the node uniform data type.
+	 *
+	 * @return {string} The data type.
+	 */
+	getType() {
+
+		return this.nodeUniform.type;
+
+	}
+
 }
 
+/**
+ * A special form of Vector3 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Vector3Uniform
+ */
 class Vector3NodeUniform extends Vector3Uniform {
 
+	/**
+	 * Constructs a new node-based Vector3 uniform.
+	 *
+	 * @param {NodeUniform} nodeUniform - The node uniform.
+	 */
 	constructor( nodeUniform ) {
 
 		super( nodeUniform.name, nodeUniform.value );
 
+		/**
+		 * The node uniform.
+		 *
+		 * @type {NodeUniform}
+		 */
 		this.nodeUniform = nodeUniform;
 
 	}
 
+	/**
+	 * Overwritten to return the value of the node uniform.
+	 *
+	 * @return {Vector3} The value.
+	 */
 	getValue() {
 
 		return this.nodeUniform.value;
 
 	}
 
+	/**
+	 * Returns the node uniform data type.
+	 *
+	 * @return {string} The data type.
+	 */
+	getType() {
+
+		return this.nodeUniform.type;
+
+	}
+
 }
 
+/**
+ * A special form of Vector4 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Vector4Uniform
+ */
 class Vector4NodeUniform extends Vector4Uniform {
 
+	/**
+	 * Constructs a new node-based Vector4 uniform.
+	 *
+	 * @param {NodeUniform} nodeUniform - The node uniform.
+	 */
 	constructor( nodeUniform ) {
 
 		super( nodeUniform.name, nodeUniform.value );
 
+		/**
+		 * The node uniform.
+		 *
+		 * @type {NodeUniform}
+		 */
 		this.nodeUniform = nodeUniform;
 
 	}
 
+	/**
+	 * Overwritten to return the value of the node uniform.
+	 *
+	 * @return {Vector4} The value.
+	 */
 	getValue() {
 
 		return this.nodeUniform.value;
 
 	}
 
+	/**
+	 * Returns the node uniform data type.
+	 *
+	 * @return {string} The data type.
+	 */
+	getType() {
+
+		return this.nodeUniform.type;
+
+	}
+
 }
 
+/**
+ * A special form of Color uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments ColorUniform
+ */
 class ColorNodeUniform extends ColorUniform {
 
+	/**
+	 * Constructs a new node-based Color uniform.
+	 *
+	 * @param {NodeUniform} nodeUniform - The node uniform.
+	 */
 	constructor( nodeUniform ) {
 
 		super( nodeUniform.name, nodeUniform.value );
 
+		/**
+		 * The node uniform.
+		 *
+		 * @type {NodeUniform}
+		 */
 		this.nodeUniform = nodeUniform;
 
 	}
 
+	/**
+	 * Overwritten to return the value of the node uniform.
+	 *
+	 * @return {Color} The value.
+	 */
 	getValue() {
 
 		return this.nodeUniform.value;
 
 	}
 
+	/**
+	 * Returns the node uniform data type.
+	 *
+	 * @return {string} The data type.
+	 */
+	getType() {
+
+		return this.nodeUniform.type;
+
+	}
+
 }
 
+
+/**
+ * A special form of Matrix2 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Matrix2Uniform
+ */
+class Matrix2NodeUniform extends Matrix2Uniform {
+
+	/**
+	 * Constructs a new node-based Matrix2 uniform.
+	 *
+	 * @param {NodeUniform} nodeUniform - The node uniform.
+	 */
+	constructor( nodeUniform ) {
+
+		super( nodeUniform.name, nodeUniform.value );
+
+		/**
+		 * The node uniform.
+		 *
+		 * @type {NodeUniform}
+		 */
+		this.nodeUniform = nodeUniform;
+
+	}
+
+	/**
+	 * Overwritten to return the value of the node uniform.
+	 *
+	 * @return {Matrix2} The value.
+	 */
+	getValue() {
+
+		return this.nodeUniform.value;
+
+	}
+
+	/**
+	 * Returns the node uniform data type.
+	 *
+	 * @return {string} The data type.
+	 */
+	getType() {
+
+		return this.nodeUniform.type;
+
+	}
+
+}
+
+/**
+ * A special form of Matrix3 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Matrix3Uniform
+ */
 class Matrix3NodeUniform extends Matrix3Uniform {
 
+	/**
+	 * Constructs a new node-based Matrix3 uniform.
+	 *
+	 * @param {NodeUniform} nodeUniform - The node uniform.
+	 */
 	constructor( nodeUniform ) {
 
 		super( nodeUniform.name, nodeUniform.value );
 
+		/**
+		 * The node uniform.
+		 *
+		 * @type {NodeUniform}
+		 */
 		this.nodeUniform = nodeUniform;
 
 	}
 
+	/**
+	 * Overwritten to return the value of the node uniform.
+	 *
+	 * @return {Matrix3} The value.
+	 */
 	getValue() {
 
 		return this.nodeUniform.value;
 
 	}
 
+	/**
+	 * Returns the node uniform data type.
+	 *
+	 * @return {string} The data type.
+	 */
+	getType() {
+
+		return this.nodeUniform.type;
+
+	}
+
 }
 
+/**
+ * A special form of Matrix4 uniform binding type.
+ * It's value is managed by a node object.
+ *
+ * @private
+ * @augments Matrix4Uniform
+ */
 class Matrix4NodeUniform extends Matrix4Uniform {
 
+	/**
+	 * Constructs a new node-based Matrix4 uniform.
+	 *
+	 * @param {NodeUniform} nodeUniform - The node uniform.
+	 */
 	constructor( nodeUniform ) {
 
 		super( nodeUniform.name, nodeUniform.value );
 
+		/**
+		 * The node uniform.
+		 *
+		 * @type {NodeUniform}
+		 */
 		this.nodeUniform = nodeUniform;
 
 	}
 
+	/**
+	 * Overwritten to return the value of the node uniform.
+	 *
+	 * @return {Matrix4} The value.
+	 */
 	getValue() {
 
 		return this.nodeUniform.value;
 
 	}
 
+	/**
+	 * Returns the node uniform data type.
+	 *
+	 * @return {string} The data type.
+	 */
+	getType() {
+
+		return this.nodeUniform.type;
+
+	}
+
 }
 
 export {
 	NumberNodeUniform, Vector2NodeUniform, Vector3NodeUniform, Vector4NodeUniform,
-	ColorNodeUniform, Matrix3NodeUniform, Matrix4NodeUniform
+	ColorNodeUniform, Matrix2NodeUniform, Matrix3NodeUniform, Matrix4NodeUniform
 };