super-three 0.173.5 → 0.176.0

package/src/loaders/nodes/NodeLoader.js

@@ -13,7 +13,7 @@ class NodeLoader extends Loader {
 	/**
 	 * Constructs a new node loader.
 	 *
-	 * @param {LoadingManager?} manager - A reference to a loading manager.
+	 * @param {LoadingManager} [manager] - A reference to a loading manager.
 	 */
 	constructor( manager ) {
 
@@ -22,14 +22,14 @@ class NodeLoader extends Loader {
 		/**
 		 * Represents a dictionary of textures.
 		 *
-		 * @type {Object<String,Texture>}
+		 * @type {Object<string,Texture>}
 		 */
 		this.textures = {};
 
 		/**
 		 * Represents a dictionary of node types.
 		 *
-		 * @type {Object<String,Node.constructor>}
+		 * @type {Object<string,Node.constructor>}
 		 */
 		this.nodes = {};
 
@@ -38,7 +38,7 @@ class NodeLoader extends Loader {
 	/**
 	 * Loads the node definitions from the given URL.
 	 *
-	 * @param {String} url - The path/URL of the file to be loaded.
+	 * @param {string} url - The path/URL of the file to be loaded.
 	 * @param {Function} onLoad - Will be called when load completes.
 	 * @param {Function} onProgress - Will be called while load progresses.
 	 * @param {Function} onError - Will be called when errors are thrown during the loading process.
@@ -78,8 +78,8 @@ class NodeLoader extends Loader {
 	/**
 	 * Parse the node dependencies for the loaded node.
 	 *
-	 * @param {Object} json - The JSON definition
-	 * @return {Object<String,Node>} A dictionary with node dependencies.
+	 * @param {Array<Object>} [json] - The JSON definition
+	 * @return {Object<string,Node>} A dictionary with node dependencies.
 	 */
 	parseNodes( json ) {
 
@@ -119,6 +119,10 @@ class NodeLoader extends Loader {
 	 * Parses the node from the given JSON.
 	 *
 	 * @param {Object} json - The JSON definition
+	 * @param {string} json.type - The node type.
+	 * @param {string} json.uuid - The node UUID.
+	 * @param {Array<Object>} [json.nodes] - The node dependencies.
+	 * @param {Object} [json.meta] - The meta data.
 	 * @return {Node} The parsed node.
 	 */
 	parse( json ) {
@@ -142,7 +146,7 @@ class NodeLoader extends Loader {
 	/**
 	 * Defines the dictionary of textures.
 	 *
-	 * @param {Object<String,Texture>} value - The texture library defines as `<uuid,texture>`.
+	 * @param {Object<string,Texture>} value - The texture library defines as `<uuid,texture>`.
 	 * @return {NodeLoader} A reference to this loader.
 	 */
 	setTextures( value ) {
@@ -155,7 +159,7 @@ class NodeLoader extends Loader {
 	/**
 	 * Defines the dictionary of node types.
 	 *
-	 * @param {Object<String,Node.constructor>} value - The node library defined as `<classname,class>`.
+	 * @param {Object<string,Node.constructor>} value - The node library defined as `<classname,class>`.
 	 * @return {NodeLoader} A reference to this loader.
 	 */
 	setNodes( value ) {
@@ -168,7 +172,7 @@ class NodeLoader extends Loader {
 	/**
 	 * Creates a node object from the given type.
 	 *
-	 * @param {String} type - The node type.
+	 * @param {string} type - The node type.
 	 * @return {Node} The created node instance.
 	 */
 	createNodeFromType( type ) {

package/src/loaders/nodes/NodeMaterialLoader.js

@@ -10,7 +10,7 @@ class NodeMaterialLoader extends MaterialLoader {
 	/**
 	 * Constructs a new node material loader.
 	 *
-	 * @param {LoadingManager?} manager - A reference to a loading manager.
+	 * @param {LoadingManager} [manager] - A reference to a loading manager.
 	 */
 	constructor( manager ) {
 
@@ -19,14 +19,14 @@ class NodeMaterialLoader extends MaterialLoader {
 		/**
 		 * Represents a dictionary of node types.
 		 *
-		 * @type {Object<String,Node.constructor>}
+		 * @type {Object<string,Node.constructor>}
 		 */
 		this.nodes = {};
 
 		/**
 		 * Represents a dictionary of node material types.
 		 *
-		 * @type {Object<String,NodeMaterial.constructor>}
+		 * @type {Object<string,NodeMaterial.constructor>}
 		 */
 		this.nodeMaterials = {};
 
@@ -60,7 +60,7 @@ class NodeMaterialLoader extends MaterialLoader {
 	/**
 	 * Defines the dictionary of node types.
 	 *
-	 * @param {Object<String,Node.constructor>} value - The node library defined as `<classname,class>`.
+	 * @param {Object<string,Node.constructor>} value - The node library defined as `<classname,class>`.
 	 * @return {NodeLoader} A reference to this loader.
 	 */
 	setNodes( value ) {
@@ -73,7 +73,7 @@ class NodeMaterialLoader extends MaterialLoader {
 	/**
 	 * Defines the dictionary of node material types.
 	 *
-	 * @param {Object<String,NodeMaterial.constructor>} value - The node material library defined as `<classname,class>`.
+	 * @param {Object<string,NodeMaterial.constructor>} value - The node material library defined as `<classname,class>`.
 	 * @return {NodeLoader} A reference to this loader.
 	 */
 	setNodeMaterials( value ) {
@@ -86,7 +86,7 @@ class NodeMaterialLoader extends MaterialLoader {
 	/**
 	 * Creates a node material from the given type.
 	 *
-	 * @param {String} type - The node material type.
+	 * @param {string} type - The node material type.
 	 * @return {Node} The created node material instance.
 	 */
 	createMaterialFromType( type ) {

package/src/loaders/nodes/NodeObjectLoader.js

@@ -14,7 +14,7 @@ class NodeObjectLoader extends ObjectLoader {
 	/**
 	 * Constructs a new node object loader.
 	 *
-	 * @param {LoadingManager?} manager - A reference to a loading manager.
+	 * @param {LoadingManager} [manager] - A reference to a loading manager.
 	 */
 	constructor( manager ) {
 
@@ -23,14 +23,14 @@ class NodeObjectLoader extends ObjectLoader {
 		/**
 		 * Represents a dictionary of node types.
 		 *
-		 * @type {Object<String,Node.constructor>}
+		 * @type {Object<string,Node.constructor>}
 		 */
 		this.nodes = {};
 
 		/**
 		 * Represents a dictionary of node material types.
 		 *
-		 * @type {Object<String,NodeMaterial.constructor>}
+		 * @type {Object<string,NodeMaterial.constructor>}
 		 */
 		this.nodeMaterials = {};
 
@@ -38,7 +38,7 @@ class NodeObjectLoader extends ObjectLoader {
 		 * A reference to hold the `nodes` JSON property.
 		 *
 		 * @private
-		 * @type {Object?}
+		 * @type {?Object}
 		 */
 		this._nodesJSON = null;
 
@@ -47,8 +47,8 @@ class NodeObjectLoader extends ObjectLoader {
 	/**
 	 * Defines the dictionary of node types.
 	 *
-	 * @param {Object<String,Node.constructor>} value - The node library defined as `<classname,class>`.
-	 * @return {NodeLoader} A reference to this loader.
+	 * @param {Object<string,Node.constructor>} value - The node library defined as `<classname,class>`.
+	 * @return {NodeObjectLoader} A reference to this loader.
 	 */
 	setNodes( value ) {
 
@@ -60,8 +60,8 @@ class NodeObjectLoader extends ObjectLoader {
 	/**
 	 * Defines the dictionary of node material types.
 	 *
-	 * @param {Object<String,NodeMaterial.constructor>} value - The node material library defined as `<classname,class>`.
-	 * @return {NodeLoader} A reference to this loader.
+	 * @param {Object<string,NodeMaterial.constructor>} value - The node material library defined as `<classname,class>`.
+	 * @return {NodeObjectLoader} A reference to this loader.
 	 */
 	setNodeMaterials( value ) {
 
@@ -93,8 +93,8 @@ class NodeObjectLoader extends ObjectLoader {
 	 * Parses the node objects from the given JSON and textures.
 	 *
 	 * @param {Object} json - The JSON definition
-	 * @param {Object<String,Texture>} textures - The texture library.
-	 * @return {Object<String,Node>}. The parsed nodes.
+	 * @param {Object<string,Texture>} textures - The texture library.
+	 * @return {Object<string,Node>}. The parsed nodes.
 	 */
 	parseNodes( json, textures ) {
 
@@ -116,8 +116,8 @@ class NodeObjectLoader extends ObjectLoader {
 	 * Parses the node objects from the given JSON and textures.
 	 *
 	 * @param {Object} json - The JSON definition
-	 * @param {Object<String,Texture>} textures - The texture library.
-	 * @return {Object<String,NodeMaterial>}. The parsed materials.
+	 * @param {Object<string,Texture>} textures - The texture library.
+	 * @return {Object<string,NodeMaterial>}. The parsed materials.
 	 */
 	parseMaterials( json, textures ) {
 

package/src/materials/LineBasicMaterial.js

@@ -1,31 +1,104 @@
 import { Material } from './Material.js';
 import { Color } from '../math/Color.js';
 
+/**
+ * A material for rendering line primitives.
+ *
+ * Materials define the appearance of renderable 3D objects.
+ *
+ * ```js
+ * const material = new THREE.LineBasicMaterial( { color: 0xffffff } );
+ * ```
+ *
+ * @augments Material
+ */
 class LineBasicMaterial extends Material {
 
+	/**
+	 * Constructs a new line basic material.
+	 *
+	 * @param {Object} [parameters] - An object with one or more properties
+	 * defining the material's appearance. Any property of the material
+	 * (including any property from inherited materials) can be passed
+	 * in here. Color values can be passed any type of value accepted
+	 * by {@link Color#set}.
+	 */
 	constructor( parameters ) {
 
 		super();
 
+		/**
+		 * This flag can be used for type testing.
+		 *
+		 * @type {boolean}
+		 * @readonly
+		 * @default true
+		 */
 		this.isLineBasicMaterial = true;
 
 		this.type = 'LineBasicMaterial';
 
+		/**
+		 * Color of the material.
+		 *
+		 * @type {Color}
+		 * @default (1,1,1)
+		 */
 		this.color = new Color( 0xffffff );
 
+		/**
+		 * Sets the color of the lines using data from a texture. The texture map
+		 * color is modulated by the diffuse `color`.
+		 *
+		 * @type {?Texture}
+		 * @default null
+		 */
 		this.map = null;
 
+		/**
+		 * Controls line thickness or lines.
+		 *
+		 * Can only be used with {@link SVGRenderer}. WebGL and WebGPU
+		 * ignore this setting and always render line primitives with a
+		 * width of one pixel.
+		 *
+		 * @type {number}
+		 * @default 1
+		 */
 		this.linewidth = 1;
+
+		/**
+		 * Defines appearance of line ends.
+		 *
+		 * Can only be used with {@link SVGRenderer}.
+		 *
+		 * @type {('butt'|'round'|'square')}
+		 * @default 'round'
+		 */
 		this.linecap = 'round';
+
+		/**
+		 * Defines appearance of line joints.
+		 *
+		 * Can only be used with {@link SVGRenderer}.
+		 *
+		 * @type {('round'|'bevel'|'miter')}
+		 * @default 'round'
+		 */
 		this.linejoin = 'round';
 
+		/**
+		 * Whether the material is affected by fog or not.
+		 *
+		 * @type {boolean}
+		 * @default true
+		 */
 		this.fog = true;
 
 		this.setValues( parameters );
 
 	}
 
-
 	copy( source ) {
 
 		super.copy( source );

package/src/materials/LineDashedMaterial.js

@@ -1,16 +1,68 @@
 import { LineBasicMaterial } from './LineBasicMaterial.js';
 
+/**
+ * A material for rendering line primitives.
+ *
+ * Materials define the appearance of renderable 3D objects.
+ *
+ * ```js
+ * const material = new THREE.LineDashedMaterial( {
+ * 	color: 0xffffff,
+ * 	scale: 1,
+ * 	dashSize: 3,
+ * 	gapSize: 1,
+ * } );
+ * ```
+ *
+ * @augments LineBasicMaterial
+ */
 class LineDashedMaterial extends LineBasicMaterial {
 
+	/**
+	 * Constructs a new line dashed material.
+	 *
+	 * @param {Object} [parameters] - An object with one or more properties
+	 * defining the material's appearance. Any property of the material
+	 * (including any property from inherited materials) can be passed
+	 * in here. Color values can be passed any type of value accepted
+	 * by {@link Color#set}.
+	 */
 	constructor( parameters ) {
 
 		super();
 
+		/**
+		 * This flag can be used for type testing.
+		 *
+		 * @type {boolean}
+		 * @readonly
+		 * @default true
+		 */
 		this.isLineDashedMaterial = true;
 		this.type = 'LineDashedMaterial';
 
+		/**
+		 * The scale of the dashed part of a line.
+		 *
+		 * @type {number}
+		 * @default 1
+		 */
 		this.scale = 1;
+
+		/**
+		 * The size of the dash. This is both the gap with the stroke.
+		 *
+		 * @type {number}
+		 * @default 3
+		 */
 		this.dashSize = 3;
+
+		/**
+		 * The size of the gap.
+		 *
+		 * @type {number}
+		 * @default 1
+		 */
 		this.gapSize = 1;
 
 		this.setValues( parameters );