Merged #4743 by hand.

examples/js/math/Lut.js

@@ -4,51 +4,53 @@
 
 THREE.Lut = function ( colormap, numberofcolors ) {
 
-  this.lut = new Array();
-  this.map = THREE.ColorMapKeywords[ colormap ];
-  this.n = numberofcolors;
-  
-  var step = 1. / this.n;
-  
-  for ( var i = 0; i <= 1; i+=step ) {
-  
-    for ( var j = 0; j < this.map.length - 1; j++ ) {
-    
-      if ( i >= this.map[ j ][ 0 ] && i < this.map[ j+1 ][ 0 ] ) {
-      
-        var min = this.map[ j ][ 0 ];
-        var max = this.map[ j+1 ][ 0 ];	
-        var color = new THREE.Color( 0xffffff ); 
-        var minColor = new THREE.Color( 0xffffff ).setHex( this.map[ j ][ 1 ] );
-        var maxColor = new THREE.Color( 0xffffff ).setHex( this.map[ j+1 ][ 1 ] );	
-        			
-        color = minColor.lerp( maxColor, ( i - min ) / ( max - min ) );
-        
-        this.lut.push(color);
-        
-      }
-      
-    }
-    
-  }
-  
-  return this.set( this );
-  
+	this.lut = new Array();
+	this.map = THREE.ColorMapKeywords[ colormap ];
+	this.n = numberofcolors;
+	this.mapname = colormap;
+
+	var step = 1.0 / this.n;
+
+	for ( var i = 0; i <= 1; i+=step ) {
+
+		for ( var j = 0; j < this.map.length - 1; j++ ) {
+
+			if ( i >= this.map[ j ][ 0 ] && i < this.map[ j + 1 ][ 0 ] ) {
+
+				var min = this.map[ j ][ 0 ];
+				var max = this.map[ j + 1 ][ 0 ];
+
+				var color = new THREE.Color( 0xffffff );
+				var minColor = new THREE.Color( 0xffffff ).setHex( this.map[ j ][ 1 ] );
+				var maxColor = new THREE.Color( 0xffffff ).setHex( this.map[ j + 1 ][ 1 ] );
+
+				color = minColor.lerp( maxColor, ( i - min ) / ( max - min ) );
+
+				this.lut.push(color);
+
+			}         
+
+		}   
+
+	}
+
+	return this.set( this );
+
 };
 
 THREE.Lut.prototype = {
 
 	constructor: THREE.Lut,
-  
-        lut: [], map: [], mapname: 'rainbow' , n: 256, minV: 0, maxV: 1,
-  
+
+	lut: [], map: [], mapname: 'rainbow' , n: 256, minV: 0, maxV: 1, legend: null,
+
 	set: function ( value ) {
 
 		if ( value instanceof THREE.Lut ) {
 
 			this.copy( value );
 
-		} 
+		}
 
 		return this;
 
@@ -57,7 +59,7 @@ THREE.Lut.prototype = {
 	setMin: function ( min ) {
 
 		this.minV = min;
-		
+
 		return this;
 
 	},
@@ -65,77 +67,414 @@ THREE.Lut.prototype = {
 	setMax: function ( max ) {
 
 		this.maxV = max;
-		
+
 		return this;
 
 	},
-	
+
 	changeNumberOfColors: function ( numberofcolors ) {
 
 		this.n = numberofcolors;
-		
+
 		return new THREE.Lut( this.mapname, this.n );
 
 	},
-	
+
 	changeColorMap: function ( colormap ) {
-    
-                this.mapname = colormap;
-		
+
+		this.mapname = colormap;
+
 		return new THREE.Lut( this.mapname, this.n );
 
 	},
-  
-        copy: function ( lut ) {
+
+  copy: function ( lut ) {
 
 		this.lut = lut.lut;
 		this.mapname = lut.mapname;
 		this.map = lut.map;
 		this.n = lut.n;
-                this.minV = lut.minV;
-                this.maxV = lut.maxV;
+		this.minV = lut.minV;
+		this.maxV = lut.maxV;
 
 		return this;
 
 	},
-  
-	getColor: function ( alpha ) {
-                
-                
-                if ( alpha <= this.minV ) {
-                
-                            alpha = this.minV;
-                
-                }
-                
-                else if ( alpha >= this.maxV ) {
-                
-                            alpha = this.maxV;               
-                
-                }
-                
-                
-                alpha = ( alpha - this.minV ) / ( this.maxV - this.minV );
-                
-                var colorPosition = Math.round ( alpha * this.n );
-                colorPosition == this.n ? colorPosition -= 1 : colorPosition;
-		
-                return this.lut[ colorPosition ];
-		
-	},
 
-        addColorMap: function ( colormapName, arrayOfColors ) {
-        
-                THREE.ColorMapKeywords[ colormapName ] = arrayOfColors;
+  getColor: function ( alpha ) {
+
+	if ( alpha <= this.minV ) {
+
+		alpha = this.minV;
+
+	}   
+
+	 else if ( alpha >= this.maxV ) {
+
+		alpha = this.maxV;
+
+	}
+
+	alpha = ( alpha - this.minV ) / ( this.maxV - this.minV );
+
+	var colorPosition = Math.round ( alpha * this.n );
+	colorPosition == this.n ? colorPosition -= 1 : colorPosition;
+
+	return this.lut[ colorPosition ];
+
+  },
+
+  addColorMap: function ( colormapName, arrayOfColors ) {
+
+	THREE.ColorMapKeywords[ colormapName ] = arrayOfColors;
+
+  },
+
+  setLegendOn: function ( parameters ) {
+
+	if ( parameters === undefined ) { parameters = {}; }
+
+	this.legend = {};
+
+	this.legend.layout = parameters.hasOwnProperty( 'layout' ) ? parameters[ 'layout' ] : 'vertical';
+
+	this.legend.position = parameters.hasOwnProperty( 'position' ) ? parameters[ 'position' ] : { 'x': 21.5, 'y': 8, 'z': 5 };
+
+	this.legend.dimensions = parameters.hasOwnProperty( 'dimensions' ) ? parameters[ 'dimensions' ] : { 'width': 0.5, 'height': 3 };
+
+	this.legend.canvas = document.createElement( 'canvas' );
+
+	this.legend.canvas.setAttribute( 'id', 'legend' );
+	this.legend.canvas.setAttribute( 'hidden', true );
+
+	document.body.appendChild( this.legend.canvas );
+
+	this.legend.ctx = this.legend.canvas.getContext( '2d' );
+
+	this.legend.canvas.setAttribute( 'width',  1 );
+	this.legend.canvas.setAttribute( 'height', this.n );
+
+	this.legend.texture = new THREE.Texture( this.legend.canvas );
+
+	imageData = this.legend.ctx.getImageData( 0, 0, 1, this.n );
+
+	data = imageData.data;
+	len = data.length;
+
+	this.map = THREE.ColorMapKeywords[ this.mapname ];
+
+	var k = 0;
+
+	var step = 1.0 / this.n;
+
+	for ( var i = 1; i >= 0; i-=step ) {
+
+		for ( var j = this.map.length - 1; j >= 0; j-- ) {
+
+			if ( i < this.map[ j ][ 0 ] && i >= this.map[ j - 1 ][ 0 ]  ) {
+
+				var min = this.map[ j - 1 ][ 0 ];
+				var max = this.map[ j ][ 0 ];
+				var color = new THREE.Color( 0xffffff );
+				var minColor = new THREE.Color( 0xffffff ).setHex( this.map[ j - 1][ 1 ] );
+				
+				color = minColor.lerp( maxColor, ( i - min ) / ( max - min ) );
+
+				data[ k * 4     ] = Math.round( color.r * 255 );
+				data[ k * 4 + 1 ] = Math.round( color.g * 255 );
+				data[ k * 4 + 2 ] = Math.round( color.b * 255 );
+				data[ k * 4 + 3 ] = 255;
+
+				k+=1;
+
+			}
+
+		}
+
+	}   
+
+	this.legend.ctx.putImageData( imageData, 0, 0 );
+	this.legend.texture.needsUpdate = true;
+
+	this.legend.legendGeometry = new THREE.PlaneGeometry( this.legend.dimensions.width , this.legend.dimensions.height  );
+	this.legend.legendMaterial = new THREE.MeshBasicMaterial( { map : this.legend.texture, side : THREE.DoubleSide } );
+
+	this.legend.mesh = new THREE.Mesh( this.legend.legendGeometry, this.legend.legendMaterial );
+
+	if ( this.legend.layout == 'horizontal') {
+
+		this.legend.mesh.rotation.z = - 90 * ( Math.PI / 180 );
+
+		this.legend.mesh.position = new THREE.Vector3( this.legend.position.x, this.legend.position.y, this.legend.position.z );
+
+	}   
+
+	else {
+
+		this.legend.mesh.position = new THREE.Vector3( this.legend.position.x, this.legend.position.y, this.legend.position.z );
+
+	}
+
+	return this.legend.mesh;
+
+  },
+
+  setLegendOff: function () {
+
+	this.legend = null;
+
+	return this.legend;
+
+  },
+
+  setLegendLayout: function ( layout ) {
+
+	if ( ! this.legend ) { return false; }
+
+	if ( this.legend.layout == layout ) { return false; }
+
+	if ( layout != 'horizontal' && layout != 'vertical' ) { return false; }
+
+	this.layout = layout;
+
+	if ( layout == 'horizontal' ) {
+
+		this.legend.mesh.rotation.z = 90 * ( Math.PI / 180 );
+
+	}
+
+	if ( layout == 'vertical' ) {
+
+		this.legend.mesh.rotation.z = -90 * ( Math.PI / 180 );
+
+	}
+
+	return this.legend.mesh;
+
+  },
+
+  setLegendPosition: function ( position ) {
+
+	this.legend.position = new THREE.Vector3( position.x, position.y, position.z );
+
+	return this.legend;
+
+  },
+
+
+  setLegendLabels: function ( parameters, callback ) {
+
+	if ( ! this.legend ) { return false; }
+
+	if ( typeof parameters === 'function') { callback = parameters; }
+
+	if ( parameters === undefined ) { parameters = {}; }
+
+	this.legend.labels = {};
+
+	this.legend.labels.fontsize = parameters.hasOwnProperty( 'fontsize' ) ? parameters[ 'fontsize' ] : 24;
+
+	this.legend.labels.fontface = parameters.hasOwnProperty( 'fontface' ) ? parameters[ 'fontface' ] : 'Arial';
+
+	this.legend.labels.title = parameters.hasOwnProperty( 'title' ) ? parameters[ 'title' ] : '';
+
+	this.legend.labels.um = parameters.hasOwnProperty( 'um' ) ? ' [ '+ parameters[ 'um' ] + ' ]': '';
+
+	this.legend.labels.ticks = parameters.hasOwnProperty( 'ticks' ) ? parameters[ 'ticks' ] : 0;
+
+	this.legend.labels.decimal = parameters.hasOwnProperty( 'decimal' ) ? parameters[ 'decimal' ] : 2;
+
+	this.legend.labels.notation = parameters.hasOwnProperty( 'notation' ) ? parameters[ 'notation' ] : 'standard';
+
+	var backgroundColor = { r: 255, g: 100, b: 100, a: 0.8 };
+	var borderColor =  { r: 255, g: 0, b: 0, a: 1.0 };
+	var borderThickness = 4;
+
+	var canvasTitle = document.createElement( 'canvas' );
+	var contextTitle = canvasTitle.getContext( '2d' );
+
+	contextTitle.font = 'Normal ' + this.legend.labels.fontsize * 1.2 + 'px ' + this.legend.labels.fontface;
+
+	var metrics = contextTitle.measureText( this.legend.labels.title.toString() + this.legend.labels.um.toString() );
+	var textWidth = metrics.width;
+
+	contextTitle.fillStyle   = 'rgba(' + backgroundColor.r + ',' + backgroundColor.g + ',' + backgroundColor.b + ',' + backgroundColor.a + ')';
+
+	contextTitle.strokeStyle = 'rgba(' + borderColor.r + ',' + borderColor.g + ',' + borderColor.b + ',' + borderColor.a + ')';
+
+	contextTitle.lineWidth = borderThickness;
+
+	contextTitle.fillStyle = 'rgba( 0, 0, 0, 1.0 )';
+
+	contextTitle.fillText( this.legend.labels.title.toString() + this.legend.labels.um.toString(), borderThickness, this.legend.labels.fontsize + borderThickness );
+
+	var txtTitle = new THREE.Texture( canvasTitle );
+
+	txtTitle.needsUpdate = true;
+
+	var spriteMaterialTitle = new THREE.SpriteMaterial( { map: txtTitle, useScreenCoordinates: false } );
+
+	var spriteTitle = new THREE.Sprite( spriteMaterialTitle );
+
+	spriteTitle.scale.set( 2, 1, 1.0 );
+
+	if ( this.legend.layout == 'vertical' ) {
+
+		spriteTitle.position.set( this.legend.position.x + this.legend.dimensions.width, this.legend.position.y + ( this.legend.dimensions.height * 0.45 ), this.legend.position.z );
+
+	}
+
+	if ( this.legend.layout == 'horizontal' ) {
+
+		spriteTitle.position.set( this.legend.position.x * 1.015, this.legend.position.y + ( this.legend.dimensions.height * 0.03 ), this.legend.position.z );
+
+	}
+
+	if ( this.legend.labels.ticks > 0 ) {
+
+		var ticks = {};
+		var lines = {};
+
+		if ( this.legend.layout == 'vertical' ) {
+
+			var topPositionY = this.legend.position.y + ( this.legend.dimensions.height * 0.36 );
+			var bottomPositionY = this.legend.position.y - ( this.legend.dimensions.height * 0.61 );
+
+		}
+
+		if ( this.legend.layout == 'horizontal' ) {
+
+			var topPositionX = this.legend.position.x + ( this.legend.dimensions.height * 0.75 );
+			var bottomPositionX = this.legend.position.x - ( this.legend.dimensions.width * 1.2  ) ;
+
+		}
+
+		for ( var i = 0; i < this.legend.labels.ticks; i++ ) {
+
+			var value = ( this.maxV - this.minV ) / ( this.legend.labels.ticks - 1  ) * i ;
+
+			if ( callback ) {
+
+				value = callback ( value );
+
+			}
+
+			else {
+
+				if ( this.legend.labels.notation == 'scientific' ) {
+
+					value = value.toExponential( this.legend.labels.decimal );
+
+				}
+
+				else {
+
+					value = value.toFixed( this.legend.labels.decimal );
+
+				}
+
+			}       
+
+			var canvasTick = document.createElement( 'canvas' );
+			var contextTick = canvasTick.getContext( '2d' );
+
+			contextTick.font = 'Normal ' + this.legend.labels.fontsize + 'px ' + this.legend.labels.fontface;
+
+			var metrics = contextTick.measureText( value.toString() );
+			var textWidth = metrics.width;
+
+			contextTick.fillStyle   = 'rgba(' + backgroundColor.r + ',' + backgroundColor.g + ',' + backgroundColor.b + ',' + backgroundColor.a + ')';
+
+			contextTick.strokeStyle = 'rgba(' + borderColor.r + ',' + borderColor.g + ',' + borderColor.b + ',' + borderColor.a + ')';
+
+			contextTick.lineWidth = borderThickness;
+
+			contextTick.fillStyle = 'rgba( 0, 0, 0, 1.0 )';
+
+			contextTick.fillText( value.toString(), borderThickness, this.legend.labels.fontsize + borderThickness );
+
+			var txtTick = new THREE.Texture( canvasTick );
+
+			txtTick.needsUpdate = true;
+
+			var spriteMaterialTick = new THREE.SpriteMaterial( { map: txtTick, useScreenCoordinates: false } );
+
+			var spriteTick = new THREE.Sprite( spriteMaterialTick );
+
+			spriteTick.scale.set( 2, 1, 1.0 );
+
+			if ( this.legend.layout == 'vertical' ) {
+
+				var position = bottomPositionY + ( topPositionY - bottomPositionY ) * ( value / ( this.maxV - this.minV ) );
+
+				spriteTick.position.set( this.legend.position.x + ( this.legend.dimensions.width * 2.7 ), position, this.legend.position.z );
+
+			}
+
+			if ( this.legend.layout == 'horizontal' ) {
+
+				var position = bottomPositionX + ( topPositionX - bottomPositionX ) * ( value / ( this.maxV - this.minV ) );
+
+				if ( this.legend.labels.ticks > 5 ) {
+
+					if ( i % 2 === 0 ) { var offset = 1.7; }
+
+					else { var offset = 2.1; }
+
+				}             
+
+				else { var offset = 1.7; }
+
+				spriteTick.position.set( position, this.legend.position.y - this.legend.dimensions.width * offset, this.legend.position.z );
+
+			}       
+
+			var material = new THREE.LineBasicMaterial( { color: 0x000000, linewidth: 2 } );
+
+			var geometry = new THREE.Geometry();
+
+
+			if ( this.legend.layout == 'vertical' ) {
+
+				var linePosition = ( this.legend.position.y - ( this.legend.dimensions.height * 0.5 ) + 0.01 ) + ( this.legend.dimensions.height ) * ( value / ( this.maxV - this.minV ) * 0.99 );
+
+				geometry.vertices.push( new THREE.Vector3( this.legend.position.x + this.legend.dimensions.width * 0.55, linePosition , this.legend.position.z  ) );
+
+				geometry.vertices.push( new THREE.Vector3( this.legend.position.x + this.legend.dimensions.width * 0.7, linePosition, this.legend.position.z  ) );
+
+			}
+
+			if ( this.legend.layout == 'horizontal' ) {
+
+				var linePosition = ( this.legend.position.x - ( this.legend.dimensions.height * 0.5 ) + 0.01 ) + ( this.legend.dimensions.height ) * ( value / ( this.maxV - this.minV ) * 0.99 );
+
+				geometry.vertices.push( new THREE.Vector3( linePosition, this.legend.position.y - this.legend.dimensions.width * 0.55, this.legend.position.z  ) );
+
+				geometry.vertices.push( new THREE.Vector3( linePosition, this.legend.position.y - this.legend.dimensions.width * 0.7, this.legend.position.z  ) );
+
+			}       
+
+			var line = new THREE.Line( geometry, material );
+
+			lines[ i ] = line;
+			ticks[ i ] = spriteTick;
+
+		}
+
+	}
+
+	return { 'title': spriteTitle,  'ticks': ticks, 'lines': lines };
+
+  }
 
-        },
-	
 };
 
+
 THREE.ColorMapKeywords = {
 
-                "rainbow": [ [ 0.0, '0x0000FF' ], [ 0.2, '0x00FFFF' ], [ 0.5, '0x00FF00' ], [ 0.8, '0xFFFF00'],  [1.0, '0xFF0000' ] ],
-                "cooltowarm": [ [ 0.0, '0x3C4EC2' ], [ 0.2, '0x9BBCFF' ], [ 0.5, '0xDCDCDC' ], [ 0.8, '0xF6A385'],  [1.0, '0xB40426' ] ],
-                "blackbody" : [ [ 0.0, '0x000000' ], [ 0.2, '0x780000' ], [ 0.5, '0xE63200' ], [ 0.8, '0xFFFF00'],  [1.0, '0xFFFFFF' ] ]
+  "rainbow":    [ [ 0.0, '0x0000FF' ], [ 0.2, '0x00FFFF' ], [ 0.5, '0x00FF00' ], [ 0.8, '0xFFFF00'],  [1.0, '0xFF0000' ] ],
+  "cooltowarm": [ [ 0.0, '0x3C4EC2' ], [ 0.2, '0x9BBCFF' ], [ 0.5, '0xDCDCDC' ], [ 0.8, '0xF6A385'],  [1.0, '0xB40426' ] ],
+  "blackbody" : [ [ 0.0, '0x000000' ], [ 0.2, '0x780000' ], [ 0.5, '0xE63200' ], [ 0.8, '0xFFFF00'],  [1.0, '0xFFFFFF' ] ],
+  "grayscale" : [ [ 0.0, '0x000000' ], [ 0.2, '0x404040' ], [ 0.5, '0x7F7F80' ], [ 0.8, '0xBFBFBF'],  [1.0, '0xFFFFFF' ] ]
 
-}
+};