Water.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  1. /**
  2. * @author jbouny / https://github.com/jbouny
  3. *
  4. * Work based on :
  5. * @author Slayvin / http://slayvin.net : Flat mirror for three.js
  6. * @author Stemkoski / http://www.adelphi.edu/~stemkoski : An implementation of water shader based on the flat mirror
  7. * @author Jonas Wagner / http://29a.ch/ && http://29a.ch/slides/2012/webglwater/ : Water shader explanations in WebGL
  8. */
  9. THREE.Water = function ( geometry, options ) {
  10. THREE.Mesh.call( this, geometry );
  11. var scope = this;
  12. options = options || {};
  13. var textureWidth = options.textureWidth !== undefined ? options.textureWidth : 512;
  14. var textureHeight = options.textureHeight !== undefined ? options.textureHeight : 512;
  15. var clipBias = options.clipBias !== undefined ? options.clipBias : 0.0;
  16. var alpha = options.alpha !== undefined ? options.alpha : 1.0;
  17. var time = options.time !== undefined ? options.time : 0.0;
  18. var normalSampler = options.waterNormals !== undefined ? options.waterNormals : null;
  19. var sunDirection = options.sunDirection !== undefined ? options.sunDirection : new THREE.Vector3( 0.70707, 0.70707, 0.0 );
  20. var sunColor = new THREE.Color( options.sunColor !== undefined ? options.sunColor : 0xffffff );
  21. var waterColor = new THREE.Color( options.waterColor !== undefined ? options.waterColor : 0x7F7F7F );
  22. var eye = options.eye !== undefined ? options.eye : new THREE.Vector3( 0, 0, 0 );
  23. var distortionScale = options.distortionScale !== undefined ? options.distortionScale : 20.0;
  24. var side = options.side !== undefined ? options.side : THREE.FrontSide;
  25. var fog = options.fog !== undefined ? options.fog : false;
  26. //
  27. var mirrorPlane = new THREE.Plane();
  28. var normal = new THREE.Vector3();
  29. var mirrorWorldPosition = new THREE.Vector3();
  30. var cameraWorldPosition = new THREE.Vector3();
  31. var rotationMatrix = new THREE.Matrix4();
  32. var lookAtPosition = new THREE.Vector3( 0, 0, - 1 );
  33. var clipPlane = new THREE.Vector4();
  34. var view = new THREE.Vector3();
  35. var target = new THREE.Vector3();
  36. var q = new THREE.Vector4();
  37. var textureMatrix = new THREE.Matrix4();
  38. var mirrorCamera = new THREE.PerspectiveCamera();
  39. var parameters = {
  40. minFilter: THREE.LinearFilter,
  41. magFilter: THREE.LinearFilter,
  42. format: THREE.RGBFormat,
  43. stencilBuffer: false
  44. };
  45. var renderTarget = new THREE.WebGLRenderTarget( textureWidth, textureHeight, parameters );
  46. if ( ! THREE.Math.isPowerOfTwo( textureWidth ) || ! THREE.Math.isPowerOfTwo( textureHeight ) ) {
  47. renderTarget.texture.generateMipmaps = false;
  48. }
  49. var mirrorShader = {
  50. uniforms: THREE.UniformsUtils.merge( [
  51. THREE.UniformsLib[ 'fog' ],
  52. THREE.UniformsLib[ 'lights' ],
  53. {
  54. normalSampler: { value: null },
  55. mirrorSampler: { value: null },
  56. alpha: { value: 1.0 },
  57. time: { value: 0.0 },
  58. size: { value: 1.0 },
  59. distortionScale: { value: 20.0 },
  60. textureMatrix: { value: new THREE.Matrix4() },
  61. sunColor: { value: new THREE.Color( 0x7F7F7F ) },
  62. sunDirection: { value: new THREE.Vector3( 0.70707, 0.70707, 0 ) },
  63. eye: { value: new THREE.Vector3() },
  64. waterColor: { value: new THREE.Color( 0x555555 ) }
  65. }
  66. ] ),
  67. vertexShader: [
  68. 'uniform mat4 textureMatrix;',
  69. 'uniform float time;',
  70. 'varying vec4 mirrorCoord;',
  71. 'varying vec4 worldPosition;',
  72. THREE.ShaderChunk[ 'fog_pars_vertex' ],
  73. THREE.ShaderChunk[ 'shadowmap_pars_vertex' ],
  74. 'void main() {',
  75. ' mirrorCoord = modelMatrix * vec4( position, 1.0 );',
  76. ' worldPosition = mirrorCoord.xyzw;',
  77. ' mirrorCoord = textureMatrix * mirrorCoord;',
  78. ' vec4 mvPosition = modelViewMatrix * vec4( position, 1.0 );',
  79. ' gl_Position = projectionMatrix * mvPosition;',
  80. THREE.ShaderChunk[ 'fog_vertex' ],
  81. THREE.ShaderChunk[ 'shadowmap_vertex' ],
  82. '}'
  83. ].join( '\n' ),
  84. fragmentShader: [
  85. 'uniform sampler2D mirrorSampler;',
  86. 'uniform float alpha;',
  87. 'uniform float time;',
  88. 'uniform float size;',
  89. 'uniform float distortionScale;',
  90. 'uniform sampler2D normalSampler;',
  91. 'uniform vec3 sunColor;',
  92. 'uniform vec3 sunDirection;',
  93. 'uniform vec3 eye;',
  94. 'uniform vec3 waterColor;',
  95. 'varying vec4 mirrorCoord;',
  96. 'varying vec4 worldPosition;',
  97. 'vec4 getNoise( vec2 uv ) {',
  98. ' vec2 uv0 = ( uv / 103.0 ) + vec2(time / 17.0, time / 29.0);',
  99. ' vec2 uv1 = uv / 107.0-vec2( time / -19.0, time / 31.0 );',
  100. ' vec2 uv2 = uv / vec2( 8907.0, 9803.0 ) + vec2( time / 101.0, time / 97.0 );',
  101. ' vec2 uv3 = uv / vec2( 1091.0, 1027.0 ) - vec2( time / 109.0, time / -113.0 );',
  102. ' vec4 noise = texture2D( normalSampler, uv0 ) +',
  103. ' texture2D( normalSampler, uv1 ) +',
  104. ' texture2D( normalSampler, uv2 ) +',
  105. ' texture2D( normalSampler, uv3 );',
  106. ' return noise * 0.5 - 1.0;',
  107. '}',
  108. 'void sunLight( const vec3 surfaceNormal, const vec3 eyeDirection, float shiny, float spec, float diffuse, inout vec3 diffuseColor, inout vec3 specularColor ) {',
  109. ' vec3 reflection = normalize( reflect( -sunDirection, surfaceNormal ) );',
  110. ' float direction = max( 0.0, dot( eyeDirection, reflection ) );',
  111. ' specularColor += pow( direction, shiny ) * sunColor * spec;',
  112. ' diffuseColor += max( dot( sunDirection, surfaceNormal ), 0.0 ) * sunColor * diffuse;',
  113. '}',
  114. THREE.ShaderChunk[ 'common' ],
  115. THREE.ShaderChunk[ 'packing' ],
  116. THREE.ShaderChunk[ 'bsdfs' ],
  117. THREE.ShaderChunk[ 'fog_pars_fragment' ],
  118. THREE.ShaderChunk[ 'lights_pars_begin' ],
  119. THREE.ShaderChunk[ 'shadowmap_pars_fragment' ],
  120. THREE.ShaderChunk[ 'shadowmask_pars_fragment' ],
  121. 'void main() {',
  122. ' vec4 noise = getNoise( worldPosition.xz * size );',
  123. ' vec3 surfaceNormal = normalize( noise.xzy * vec3( 1.5, 1.0, 1.5 ) );',
  124. ' vec3 diffuseLight = vec3(0.0);',
  125. ' vec3 specularLight = vec3(0.0);',
  126. ' vec3 worldToEye = eye-worldPosition.xyz;',
  127. ' vec3 eyeDirection = normalize( worldToEye );',
  128. ' sunLight( surfaceNormal, eyeDirection, 100.0, 2.0, 0.5, diffuseLight, specularLight );',
  129. ' float distance = length(worldToEye);',
  130. ' vec2 distortion = surfaceNormal.xz * ( 0.001 + 1.0 / distance ) * distortionScale;',
  131. ' vec3 reflectionSample = vec3( texture2D( mirrorSampler, mirrorCoord.xy / mirrorCoord.w + distortion ) );',
  132. ' float theta = max( dot( eyeDirection, surfaceNormal ), 0.0 );',
  133. ' float rf0 = 0.3;',
  134. ' float reflectance = rf0 + ( 1.0 - rf0 ) * pow( ( 1.0 - theta ), 5.0 );',
  135. ' vec3 scatter = max( 0.0, dot( surfaceNormal, eyeDirection ) ) * waterColor;',
  136. ' vec3 albedo = mix( ( sunColor * diffuseLight * 0.3 + scatter ) * getShadowMask(), ( vec3( 0.1 ) + reflectionSample * 0.9 + reflectionSample * specularLight ), reflectance);',
  137. ' vec3 outgoingLight = albedo;',
  138. ' gl_FragColor = vec4( outgoingLight, alpha );',
  139. THREE.ShaderChunk[ 'tonemapping_fragment' ],
  140. THREE.ShaderChunk[ 'fog_fragment' ],
  141. '}'
  142. ].join( '\n' )
  143. };
  144. var material = new THREE.ShaderMaterial( {
  145. fragmentShader: mirrorShader.fragmentShader,
  146. vertexShader: mirrorShader.vertexShader,
  147. uniforms: THREE.UniformsUtils.clone( mirrorShader.uniforms ),
  148. transparent: true,
  149. lights: true,
  150. side: side,
  151. fog: fog
  152. } );
  153. material.uniforms.mirrorSampler.value = renderTarget.texture;
  154. material.uniforms.textureMatrix.value = textureMatrix;
  155. material.uniforms.alpha.value = alpha;
  156. material.uniforms.time.value = time;
  157. material.uniforms.normalSampler.value = normalSampler;
  158. material.uniforms.sunColor.value = sunColor;
  159. material.uniforms.waterColor.value = waterColor;
  160. material.uniforms.sunDirection.value = sunDirection;
  161. material.uniforms.distortionScale.value = distortionScale;
  162. material.uniforms.eye.value = eye;
  163. scope.material = material;
  164. scope.onBeforeRender = function ( renderer, scene, camera ) {
  165. mirrorWorldPosition.setFromMatrixPosition( scope.matrixWorld );
  166. cameraWorldPosition.setFromMatrixPosition( camera.matrixWorld );
  167. rotationMatrix.extractRotation( scope.matrixWorld );
  168. normal.set( 0, 0, 1 );
  169. normal.applyMatrix4( rotationMatrix );
  170. view.subVectors( mirrorWorldPosition, cameraWorldPosition );
  171. // Avoid rendering when mirror is facing away
  172. if ( view.dot( normal ) > 0 ) return;
  173. view.reflect( normal ).negate();
  174. view.add( mirrorWorldPosition );
  175. rotationMatrix.extractRotation( camera.matrixWorld );
  176. lookAtPosition.set( 0, 0, - 1 );
  177. lookAtPosition.applyMatrix4( rotationMatrix );
  178. lookAtPosition.add( cameraWorldPosition );
  179. target.subVectors( mirrorWorldPosition, lookAtPosition );
  180. target.reflect( normal ).negate();
  181. target.add( mirrorWorldPosition );
  182. mirrorCamera.position.copy( view );
  183. mirrorCamera.up.set( 0, 1, 0 );
  184. mirrorCamera.up.applyMatrix4( rotationMatrix );
  185. mirrorCamera.up.reflect( normal );
  186. mirrorCamera.lookAt( target );
  187. mirrorCamera.far = camera.far; // Used in WebGLBackground
  188. mirrorCamera.updateMatrixWorld();
  189. mirrorCamera.projectionMatrix.copy( camera.projectionMatrix );
  190. // Update the texture matrix
  191. textureMatrix.set(
  192. 0.5, 0.0, 0.0, 0.5,
  193. 0.0, 0.5, 0.0, 0.5,
  194. 0.0, 0.0, 0.5, 0.5,
  195. 0.0, 0.0, 0.0, 1.0
  196. );
  197. textureMatrix.multiply( mirrorCamera.projectionMatrix );
  198. textureMatrix.multiply( mirrorCamera.matrixWorldInverse );
  199. // Now update projection matrix with new clip plane, implementing code from: http://www.terathon.com/code/oblique.html
  200. // Paper explaining this technique: http://www.terathon.com/lengyel/Lengyel-Oblique.pdf
  201. mirrorPlane.setFromNormalAndCoplanarPoint( normal, mirrorWorldPosition );
  202. mirrorPlane.applyMatrix4( mirrorCamera.matrixWorldInverse );
  203. clipPlane.set( mirrorPlane.normal.x, mirrorPlane.normal.y, mirrorPlane.normal.z, mirrorPlane.constant );
  204. var projectionMatrix = mirrorCamera.projectionMatrix;
  205. q.x = ( Math.sign( clipPlane.x ) + projectionMatrix.elements[ 8 ] ) / projectionMatrix.elements[ 0 ];
  206. q.y = ( Math.sign( clipPlane.y ) + projectionMatrix.elements[ 9 ] ) / projectionMatrix.elements[ 5 ];
  207. q.z = - 1.0;
  208. q.w = ( 1.0 + projectionMatrix.elements[ 10 ] ) / projectionMatrix.elements[ 14 ];
  209. // Calculate the scaled plane vector
  210. clipPlane.multiplyScalar( 2.0 / clipPlane.dot( q ) );
  211. // Replacing the third row of the projection matrix
  212. projectionMatrix.elements[ 2 ] = clipPlane.x;
  213. projectionMatrix.elements[ 6 ] = clipPlane.y;
  214. projectionMatrix.elements[ 10 ] = clipPlane.z + 1.0 - clipBias;
  215. projectionMatrix.elements[ 14 ] = clipPlane.w;
  216. eye.setFromMatrixPosition( camera.matrixWorld );
  217. //
  218. var currentRenderTarget = renderer.getRenderTarget();
  219. var currentVrEnabled = renderer.vr.enabled;
  220. var currentShadowAutoUpdate = renderer.shadowMap.autoUpdate;
  221. scope.visible = false;
  222. renderer.vr.enabled = false; // Avoid camera modification and recursion
  223. renderer.shadowMap.autoUpdate = false; // Avoid re-computing shadows
  224. renderer.render( scene, mirrorCamera, renderTarget, true );
  225. scope.visible = true;
  226. renderer.vr.enabled = currentVrEnabled;
  227. renderer.shadowMap.autoUpdate = currentShadowAutoUpdate;
  228. renderer.setRenderTarget( currentRenderTarget );
  229. };
  230. };
  231. THREE.Water.prototype = Object.create( THREE.Mesh.prototype );
  232. THREE.Water.prototype.constructor = THREE.Water;