@plastic-software/three 0.174.0 → 0.175.0

package/examples/jsm/misc/Volume.js

@@ -6,44 +6,61 @@ import {
 import { VolumeSlice } from '../misc/VolumeSlice.js';
 
 /**
- * This class had been written to handle the output of the NRRD loader.
- * It contains a volume of data and information about it.
- * For now it only handles 3 dimensional data.
- * See the webgl_loader_nrrd.html example and the loaderNRRD.js file to see how to use this class.
- * @class
+ * This class had been written to handle the output of the {@link NRRDLoader}.
+ * It contains a volume of data and information about it. For now it only handles 3 dimensional data.
  */
 class Volume {
 
 	/**
-	 * @param   {number}        xLength         Width of the volume
-	 * @param   {number}        yLength         Length of the volume
-	 * @param   {number}        zLength         Depth of the volume
-	 * @param   {string}        type            The type of data (uint8, uint16, ...)
-	 * @param   {ArrayBuffer}   arrayBuffer     The buffer with volume data
+	 * Constructs a new volume.
+	 *
+	 * @param {number} [xLength] - Width of the volume.
+	 * @param {number} [yLength] - Length of the volume.
+	 * @param {number} [zLength] - Depth of the volume.
+	 * @param {string} [type] - The type of data (uint8, uint16, ...).
+	 * @param {ArrayBuffer} [arrayBuffer] - The buffer with volume data.
 	 */
 	constructor( xLength, yLength, zLength, type, arrayBuffer ) {
 
 		if ( xLength !== undefined ) {
 
 			/**
-			 * @member {number} xLength Width of the volume in the IJK coordinate system
+			 * Width of the volume in the IJK coordinate system.
+			 *
+			 * @type {number}
+			 * @default 1
 			 */
 			this.xLength = Number( xLength ) || 1;
+
 			/**
-			 * @member {number} yLength Height of the volume in the IJK coordinate system
+			 * Height of the volume in the IJK coordinate system.
+			 *
+			 * @type {number}
+			 * @default 1
 			 */
 			this.yLength = Number( yLength ) || 1;
+
 			/**
-			 * @member {number} zLength Depth of the volume in the IJK coordinate system
+			 * Depth of the volume in the IJK coordinate system.
+			 *
+			 * @type {number}
+			 * @default 1
 			 */
 			this.zLength = Number( zLength ) || 1;
+
 			/**
-			 * @member {Array<string>} The order of the Axis dictated by the NRRD header
+			 * The order of the Axis dictated by the NRRD header
+			 *
+			 * @type {Array<string>}
 			 */
 			this.axisOrder = [ 'x', 'y', 'z' ];
+
 			/**
-			 * @member {TypedArray} data Data of the volume
+			 * The data of the volume.
+			 *
+			 * @type {TypedArray}
 			 */
+			this.data;
 
 			switch ( type ) {
 
@@ -129,25 +146,34 @@ class Volume {
 		}
 
 		/**
-		 * @member {Array}  spacing Spacing to apply to the volume from IJK to RAS coordinate system
+		 * Spacing to apply to the volume from IJK to RAS coordinate system
+		 *
+		 * @type {Array<number>}
 		 */
 		this.spacing = [ 1, 1, 1 ];
+
 		/**
-		 * @member {Array}  offset Offset of the volume in the RAS coordinate system
+		 * Offset of the volume in the RAS coordinate system
+		 *
+		 * @type {Array<number>}
 		 */
 		this.offset = [ 0, 0, 0 ];
+
 		/**
-		 * @member {Martrix3} matrix The IJK to RAS matrix
+		 * The IJK to RAS matrix.
+		 *
+		 * @type {Martrix3}
 		 */
 		this.matrix = new Matrix3();
 		this.matrix.identity();
+
 		/**
-		 * @member {Martrix3} inverseMatrix The RAS to IJK matrix
-		 */
-		/**
-		 * @member {number} lowerThreshold The voxels with values under this threshold won't appear in the slices.
-		 *                      If changed, geometryNeedsUpdate is automatically set to true on all the slices associated to this volume
+		 * The RAS to IJK matrix.
+		 *
+		 * @type {Martrix3}
 		 */
+		this.inverseMatrix = new Matrix3();
+
 		let lowerThreshold = - Infinity;
 		Object.defineProperty( this, 'lowerThreshold', {
 			get: function () {
@@ -155,6 +181,14 @@ class Volume {
 				return lowerThreshold;
 
 			},
+			/**
+			 * The voxels with values under this threshold won't appear in the slices.
+			 * If changed, geometryNeedsUpdate is automatically set to true on all the slices associated to this volume.
+			 *
+			 * @name Volume#lowerThreshold
+			 * @type {number}
+			 * @param {number} value
+			 */
 			set: function ( value ) {
 
 				lowerThreshold = value;
@@ -166,10 +200,7 @@ class Volume {
 
 			}
 		} );
-		/**
-		 * @member {number} upperThreshold The voxels with values over this threshold won't appear in the slices.
-		 *                      If changed, geometryNeedsUpdate is automatically set to true on all the slices associated to this volume
-		 */
+
 		let upperThreshold = Infinity;
 		Object.defineProperty( this, 'upperThreshold', {
 			get: function () {
@@ -177,6 +208,14 @@ class Volume {
 				return upperThreshold;
 
 			},
+			/**
+			 * The voxels with values over this threshold won't appear in the slices.
+			 * If changed, geometryNeedsUpdate is automatically set to true on all the slices associated to this volume
+			 *
+			 * @name Volume#upperThreshold
+			 * @type {number}
+			 * @param {number} value
+			 */
 			set: function ( value ) {
 
 				upperThreshold = value;
@@ -191,33 +230,38 @@ class Volume {
 
 
 		/**
-		 * @member {Array} sliceList The list of all the slices associated to this volume
+		 * The list of all the slices associated to this volume
+		 *
+		 * @type {Array}
 		 */
 		this.sliceList = [];
 
-
 		/**
-		 * @member {boolean} segmentation in segmentation mode, it can load 16-bits nrrds correctly
+		 * Whether to use segmentation mode or not.
+		 * It can load 16-bits nrrds correctly.
+		 *
+		 * @type {boolean}
+		 * @default false
 		 */
 		this.segmentation = false;
 
 
 		/**
-		 * @member {Array} RASDimensions This array holds the dimensions of the volume in the RAS space
+		 * This array holds the dimensions of the volume in the RAS space
+		 *
+		 * @type {Array<number>}
 		 */
-
-
+		this.RASDimensions = [];
 
 	}
 
 	/**
-	 * Shortcut for data[access(i,j,k)]
+	 * Shortcut for data[access(i,j,k)].
 	 *
-	 * @memberof Volume
-	 * @param {number} i    First coordinate
-	 * @param {number} j    Second coordinate
-	 * @param {number} k    Third coordinate
-	 * @returns {number}  value in the data array
+	 * @param {number} i - First coordinate.
+	 * @param {number} j - Second coordinate.
+	 * @param {number} k - Third coordinate.
+	 * @returns {number} The value in the data array.
 	 */
 	getData( i, j, k ) {
 
@@ -226,13 +270,12 @@ class Volume {
 	}
 
 	/**
-	 * Compute the index in the data array corresponding to the given coordinates in IJK system
+	 * Compute the index in the data array corresponding to the given coordinates in IJK system.
 	 *
-	 * @memberof Volume
-	 * @param {number} i    First coordinate
-	 * @param {number} j    Second coordinate
-	 * @param {number} k    Third coordinate
-	 * @returns {number}  index
+	 * @param {number} i - First coordinate.
+	 * @param {number} j - Second coordinate.
+	 * @param {number} k - Third coordinate.
+	 * @returns {number} The index.
 	 */
 	access( i, j, k ) {
 
@@ -241,11 +284,10 @@ class Volume {
 	}
 
 	/**
-	 * Retrieve the IJK coordinates of the voxel corresponding of the given index in the data
+	 * Retrieve the IJK coordinates of the voxel corresponding of the given index in the data.
 	 *
-	 * @memberof Volume
-	 * @param {number} index index of the voxel
-	 * @returns {Array}  [x,y,z]
+	 * @param {number} index - Index of the voxel.
+	 * @returns {Array<number>} The IJK coordinates as `[x,y,z]`.
 	 */
 	reverseAccess( index ) {
 
@@ -257,15 +299,12 @@ class Volume {
 	}
 
 	/**
-	 * Apply a function to all the voxels, be careful, the value will be replaced
+	 * Apply a function to all the voxels, be careful, the value will be replaced.
 	 *
-	 * @memberof Volume
-	 * @param {Function} functionToMap A function to apply to every voxel, will be called with the following parameters :
-	 *                                 value of the voxel
-	 *                                 index of the voxel
-	 *                                 the data (TypedArray)
-	 * @param {Object}   context    You can specify a context in which call the function, default if this Volume
-	 * @returns {Volume}   this
+	 * @param {Function} functionToMap A function to apply to every voxel, will be called with the following parameters:
+	 * value of the voxel, index of the voxel, the data (TypedArray).
+	 * @param {Object} context - You can specify a context in which call the function, default if this Volume.
+	 * @returns {Volume} A reference to this instance.
 	 */
 	map( functionToMap, context ) {
 
@@ -283,12 +322,12 @@ class Volume {
 	}
 
 	/**
-	 * Compute the orientation of the slice and returns all the information relative to the geometry such as sliceAccess, the plane matrix (orientation and position in RAS coordinate) and the dimensions of the plane in both coordinate system.
+	 * Compute the orientation of the slice and returns all the information relative to the geometry such as sliceAccess,
+	 * the plane matrix (orientation and position in RAS coordinate) and the dimensions of the plane in both coordinate system.
 	 *
-	 * @memberof Volume
-	 * @param {string}            axis  the normal axis to the slice 'x' 'y' or 'z'
-	 * @param {number}            RASIndex the index of the slice
-	 * @returns {Object} an object containing all the useful information on the geometry of the slice
+	 * @param {('x'|'y'|'z')} axis - The normal axis to the slice.
+	 * @param {number} RASIndex - The index of the slice.
+	 * @returns {Object} An object containing all the useful information on the geometry of the slice.
 	 */
 	extractPerpendicularPlane( axis, RASIndex ) {
 
@@ -411,10 +450,9 @@ class Volume {
 	 * Returns a slice corresponding to the given axis and index.
 	 * The coordinate are given in the Right Anterior Superior coordinate format.
 	 *
-	 * @memberof Volume
-	 * @param {string}            axis  the normal axis to the slice 'x' 'y' or 'z'
-	 * @param {number}            index the index of the slice
-	 * @returns {VolumeSlice} the extracted slice
+	 * @param {('x'|'y'|'z')} axis - The normal axis to the slice.
+	 * @param {number} index - The index of the slice.
+	 * @returns {VolumeSlice} The extracted slice.
 	 */
 	extractSlice( axis, index ) {
 
@@ -425,11 +463,10 @@ class Volume {
 	}
 
 	/**
-	 * Call repaint on all the slices extracted from this volume
+	 * Call repaint on all the slices extracted from this volume.
 	 *
 	 * @see {@link VolumeSlice#repaint}
-	 * @memberof Volume
-	 * @returns {Volume} this
+	 * @returns {Volume} A reference to this volume.
 	 */
 	repaintAllSlices() {
 
@@ -444,10 +481,9 @@ class Volume {
 	}
 
 	/**
-	 * Compute the minimum and the maximum of the data in the volume
+	 * Compute the minimum and the maximum of the data in the volume.
 	 *
-	 * @memberof Volume
-	 * @returns {Array} [min,max]
+	 * @returns {Array<number>} The min/max data as `[min,max]`.
 	 */
 	computeMinMax() {
 

package/examples/jsm/misc/VolumeSlice.js

@@ -10,34 +10,45 @@ import {
 } from 'three';
 
 /**
- * This class has been made to hold a slice of a volume data
- * @class
+ * This class has been made to hold a slice of a volume data.
+ *
  * @see {@link Volume}
  */
 class VolumeSlice {
 
 	/**
- 	 * @param {Volume} volume     The associated volume
- 	 * @param {number} [index=0]  The index of the slice
- 	 * @param {string} [axis='z'] For now only 'x', 'y' or 'z' but later it will change to a normal vector
+	 * Constructs a new volume slice.
+	 *
+ 	 * @param {Volume} volume - The associated volume.
+ 	 * @param {number} [index=0] - The index of the slice.
+ 	 * @param {('x'|'y'|'z')} [axis='z'] - For now only 'x', 'y' or 'z' but later it will change to a normal vector.
 	 */
-	constructor( volume, index, axis ) {
+	constructor( volume, index = 0, axis = 'z' ) {
 
 		const slice = this;
+
 		/**
-		 * @member {Volume} volume The associated volume
+		 * The associated volume.
+		 *
+		 * @type {Volume}
 		 */
 		this.volume = volume;
-		/**
-		 * @member {number} index The index of the slice, if changed, will automatically call updateGeometry at the next repaint
-		 */
-		index = index || 0;
+
 		Object.defineProperty( this, 'index', {
 			get: function () {
 
 				return index;
 
 			},
+			/**
+			 * The index of the slice, if changed, will automatically call updateGeometry at the next repaint.
+			 *
+			 * @name VolumeSlice#index
+			 * @type {number}
+			 * @default 0
+			 * @param {number} value
+			 * @return {number}
+			 */
 			set: function ( value ) {
 
 				index = value;
@@ -46,25 +57,42 @@ class VolumeSlice {
 
 			}
 		} );
-		/**
-		 * @member {string} axis The normal axis
-		 */
-		this.axis = axis || 'z';
 
 		/**
-		 * @member {HTMLCanvasElement} canvas The final canvas used for the texture
+		 * The normal axis.
+		 *
+		 * @type {('x'|'y'|'z')}
 		 */
+		this.axis = axis;
+
 		/**
-		 * @member {CanvasRenderingContext2D} ctx Context of the canvas
+		 * The final canvas used for the texture.
+		 *
+		 * @type {HTMLCanvasElement}
 		 */
 		this.canvas = document.createElement( 'canvas' );
+
 		/**
-		 * @member {HTMLCanvasElement} canvasBuffer The intermediary canvas used to paint the data
+		 * The rendering context of the canvas.
+		 *
+		 * @type {CanvasRenderingContext2D}
 		 */
+		this.ctx;
+
 		/**
-		 * @member {CanvasRenderingContext2D} ctxBuffer Context of the canvas buffer
+		 * The intermediary canvas used to paint the data.
+		 *
+		 * @type {HTMLCanvasElement}
 		 */
 		this.canvasBuffer = document.createElement( 'canvas' );
+
+		/**
+		 * The rendering context of the canvas buffer,
+		 *
+		 * @type {CanvasRenderingContext2D}
+		 */
+		this.ctxBuffer;
+
 		this.updateGeometry();
 
 
@@ -74,39 +102,52 @@ class VolumeSlice {
 		canvasMap.wrapS = canvasMap.wrapT = ClampToEdgeWrapping;
 		canvasMap.colorSpace = SRGBColorSpace;
 		const material = new MeshBasicMaterial( { map: canvasMap, side: DoubleSide, transparent: true } );
+
 		/**
-		 * @member {Mesh} mesh The mesh ready to get used in the scene
+		 * The mesh ready to get used in the scene.
+		 *
+		 * @type {Mesh}
 		 */
 		this.mesh = new Mesh( this.geometry, material );
 		this.mesh.matrixAutoUpdate = false;
+
 		/**
-		 * @member {boolean} geometryNeedsUpdate If set to true, updateGeometry will be triggered at the next repaint
+		 * If set to `true`, `updateGeometry()` will be triggered at the next repaint.
+		 *
+		 * @type {boolean}
+		 * @default true
 		 */
 		this.geometryNeedsUpdate = true;
 		this.repaint();
 
 		/**
-		 * @member {number} iLength Width of slice in the original coordinate system, corresponds to the width of the buffer canvas
+		 * Width of slice in the original coordinate system, corresponds to the width of the buffer canvas.
+		 *
+		 * @type {number}
+		 * @default 0
 		 */
+		this.iLength = 0;
 
 		/**
-		 * @member {number} jLength Height of slice in the original coordinate system, corresponds to the height of the buffer canvas
+		 * Height of slice in the original coordinate system, corresponds to the height of the buffer canvas.
+		 *
+		 * @type {number}
+		 * @default 0
 		 */
+		this.jLength = 0;
 
 		/**
-		 * @member {Function} sliceAccess Function that allow the slice to access right data
+		 * Function that allow the slice to access right data.
+		 *
+		 * @type {?Function}
 		 * @see {@link Volume#extractPerpendicularPlane}
-		 * @param {number} i The first coordinate
-		 * @param {number} j The second coordinate
-		 * @returns {number} the index corresponding to the voxel in volume.data of the given position in the slice
 		 */
-
+		this.sliceAccess = null;
 
 	}
 
 	/**
-	 * Refresh the texture and the geometry if geometryNeedsUpdate is set to true
-	 * @memberof VolumeSlice
+	 * Refresh the texture and the geometry if geometryNeedsUpdate is set to `true`.
 	 */
 	repaint() {
 
@@ -138,23 +179,26 @@ class VolumeSlice {
 
 		if ( volume.dataType === 'label' ) {
 
-			//this part is currently useless but will be used when colortables will be handled
-			for ( let j = 0; j < jLength; j ++ ) {
+			console.error( 'THREE.VolumeSlice.repaint: label are not supported yet' );
 
-				for ( let i = 0; i < iLength; i ++ ) {
+			// This part is currently useless but will be used when colortables will be handled
 
-					let label = volumeData[ sliceAccess( i, j ) ];
-					label = label >= this.colorMap.length ? ( label % this.colorMap.length ) + 1 : label;
-					const color = this.colorMap[ label ];
-					data[ 4 * pixelCount ] = ( color >> 24 ) & 0xff;
-					data[ 4 * pixelCount + 1 ] = ( color >> 16 ) & 0xff;
-					data[ 4 * pixelCount + 2 ] = ( color >> 8 ) & 0xff;
-					data[ 4 * pixelCount + 3 ] = color & 0xff;
-					pixelCount ++;
+			// for ( let j = 0; j < jLength; j ++ ) {
 
-				}
+			// 	for ( let i = 0; i < iLength; i ++ ) {
 
-			}
+			// 		let label = volumeData[ sliceAccess( i, j ) ];
+			// 		label = label >= this.colorMap.length ? ( label % this.colorMap.length ) + 1 : label;
+			// 		const color = this.colorMap[ label ];
+			// 		data[ 4 * pixelCount ] = ( color >> 24 ) & 0xff;
+			// 		data[ 4 * pixelCount + 1 ] = ( color >> 16 ) & 0xff;
+			// 		data[ 4 * pixelCount + 2 ] = ( color >> 8 ) & 0xff;
+			// 		data[ 4 * pixelCount + 3 ] = color & 0xff;
+			// 		pixelCount ++;
+
+			// 	}
+
+			// }
 
 		} else {
 
@@ -191,9 +235,8 @@ class VolumeSlice {
 	}
 
 	/**
-	 * Refresh the geometry according to axis and index
+	 * Refresh the geometry according to axis and index.
 	 * @see {@link Volume#extractPerpendicularPlane}
-	 * @memberof VolumeSlice
 	 */
 	updateGeometry() {