Skip to content

Commit

Permalink
WebGPURenderer: ReflectorNode (#27611)
Browse files Browse the repository at this point in the history
* Add first prevent update

* GaussianBlurNode: Fix type

* Rename lightNodes -> lightsNode

* Add ReflectorNode

* add reflector examples

* cleanup

* rev

* revision

* rev

* update reflection resolution

* Add prevent update
  • Loading branch information
sunag committed Jan 23, 2024
1 parent c3fedd4 commit 7e226d0
Show file tree
Hide file tree
Showing 11 changed files with 683 additions and 15 deletions.
2 changes: 2 additions & 0 deletions examples/files.json
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,7 @@
"webgpu_occlusion",
"webgpu_particles",
"webgpu_portal",
"webgpu_reflection",
"webgpu_rtt",
"webgpu_sandbox",
"webgpu_shadertoy",
Expand All @@ -369,6 +370,7 @@
"webgpu_tsl_transpiler",
"webgpu_video_panorama",
"webgpu_postprocessing_afterimage",
"webgpu_mirror",
"webgpu_multisampled_renderbuffers",
"webgpu_materials_texture_anisotropy"
],
Expand Down
3 changes: 2 additions & 1 deletion examples/jsm/nodes/Nodes.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ export { default as SplitNode } from './utils/SplitNode.js';
export { default as SpriteSheetUVNode, spritesheetUV } from './utils/SpriteSheetUVNode.js';
export { default as TimerNode, timerLocal, timerGlobal, timerDelta, frameId } from './utils/TimerNode.js';
export { default as TriplanarTexturesNode, triplanarTextures, triplanarTexture } from './utils/TriplanarTexturesNode.js';
export { default as ReflectorNode, reflector } from './utils/ReflectorNode.js';

// shadernode
export * from './shadernode/ShaderNode.js';
Expand Down Expand Up @@ -146,7 +147,7 @@ export { default as DirectionalLightNode } from './lighting/DirectionalLightNode
export { default as SpotLightNode } from './lighting/SpotLightNode.js';
export { default as IESSpotLightNode } from './lighting/IESSpotLightNode.js';
export { default as AmbientLightNode } from './lighting/AmbientLightNode.js';
export { default as LightsNode, lights, lightNodes, addLightNode } from './lighting/LightsNode.js';
export { default as LightsNode, lights, lightsNode, addLightNode } from './lighting/LightsNode.js';
export { default as LightingNode /* @TODO: lighting (abstract), light */ } from './lighting/LightingNode.js';
export { default as LightingContextNode, lightingContext } from './lighting/LightingContextNode.js';
export { default as HemisphereLightNode } from './lighting/HemisphereLightNode.js';
Expand Down
24 changes: 16 additions & 8 deletions examples/jsm/nodes/core/NodeFrame.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,11 @@ class NodeFrame {

if ( frameMap.get( node ) !== this.frameId ) {

frameMap.set( node, this.frameId );
if ( node.updateBefore( this ) !== false ) {

node.updateBefore( this );
frameMap.set( node, this.frameId );

}

}

Expand All @@ -65,9 +67,11 @@ class NodeFrame {

if ( renderMap.get( node ) !== this.renderId ) {

renderMap.set( node, this.renderId );
if ( node.updateBefore( this ) !== false ) {

renderMap.set( node, this.renderId );

node.updateBefore( this );
}

}

Expand All @@ -90,9 +94,11 @@ class NodeFrame {

if ( frameMap.get( node ) !== this.frameId ) {

frameMap.set( node, this.frameId );
if ( node.update( this ) !== false ) {

node.update( this );
frameMap.set( node, this.frameId );

}

}

Expand All @@ -102,9 +108,11 @@ class NodeFrame {

if ( renderMap.get( node ) !== this.renderId ) {

renderMap.set( node, this.renderId );
if ( node.update( this ) !== false ) {

renderMap.set( node, this.renderId );

node.update( this );
}

}

Expand Down
2 changes: 1 addition & 1 deletion examples/jsm/nodes/display/GaussianBlurNode.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class GaussianBlurNode extends TempNode {

constructor( textureNode, sigma = 2 ) {

super( textureNode );
super( 'vec4' );

this.textureNode = textureNode;
this.sigma = sigma;
Expand Down
2 changes: 1 addition & 1 deletion examples/jsm/nodes/lighting/LightsNode.js
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ class LightsNode extends Node {
export default LightsNode;

export const lights = ( lights ) => nodeObject( new LightsNode().fromLights( lights ) );
export const lightNodes = nodeProxy( LightsNode );
export const lightsNode = nodeProxy( LightsNode );

export function addLightNode( lightClass, lightNodeClass ) {

Expand Down
8 changes: 4 additions & 4 deletions examples/jsm/nodes/materials/NodeMaterial.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { skinning } from '../accessors/SkinningNode.js';
import { morph } from '../accessors/MorphNode.js';
import { texture } from '../accessors/TextureNode.js';
import { cubeTexture } from '../accessors/CubeTextureNode.js';
import { lightNodes } from '../lighting/LightsNode.js';
import { lightsNode } from '../lighting/LightsNode.js';
import { mix } from '../math/MathNode.js';
import { float, vec3, vec4 } from '../shadernode/ShaderNode.js';
import AONode from '../lighting/AONode.js';
Expand Down Expand Up @@ -289,15 +289,15 @@ class NodeMaterial extends ShaderMaterial {

}

let lightsNode = this.lightsNode || builder.lightsNode;
let lightsN = this.lightsNode || builder.lightsNode;

if ( materialLightsNode.length > 0 ) {

lightsNode = lightNodes( [ ...lightsNode.lightNodes, ...materialLightsNode ] );
lightsN = lightsNode( [ ...lightsN.lightNodes, ...materialLightsNode ] );

}

return lightsNode;
return lightsN;

}

Expand Down
227 changes: 227 additions & 0 deletions examples/jsm/nodes/utils/ReflectorNode.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,227 @@
import TextureNode from '../accessors/TextureNode.js';
import { nodeObject, vec2 } from '../shadernode/ShaderNode.js';
import { NodeUpdateType } from '../core/constants.js';
import { viewportTopLeft } from '../display/ViewportNode.js';
import { Matrix4, Vector2, Vector3, Vector4, Object3D, Plane, RenderTarget, HalfFloatType, LinearMipMapLinearFilter } from 'three';

const _reflectorPlane = new Plane();
const _normal = new Vector3();
const _reflectorWorldPosition = new Vector3();
const _cameraWorldPosition = new Vector3();
const _rotationMatrix = new Matrix4();
const _lookAtPosition = new Vector3( 0, 0, - 1 );
const clipPlane = new Vector4();

const _view = new Vector3();
const _target = new Vector3();
const _q = new Vector4();

const _size = new Vector2();

const _defaultRT = new RenderTarget();
const _defaultUV = vec2( viewportTopLeft.x.oneMinus(), viewportTopLeft.y );

let _inReflector = false;

class ReflectorNode extends TextureNode {

constructor( parameters = {} ) {

super( _defaultRT.texture, _defaultUV );

const {
target = new Object3D(),
resolution = 1,
generateMipmaps = false,
bounces = true
} = parameters;

//

this.target = target;
this.resolution = resolution;
this.generateMipmaps = generateMipmaps;
this.bounces = bounces;

this.updateBeforeType = bounces ? NodeUpdateType.RENDER : NodeUpdateType.FRAME;

this.virtualCameras = new WeakMap();
this.renderTargets = new WeakMap();


}

_updateResolution( renderTarget, renderer ) {

const resolution = this.resolution;

renderer.getDrawingBufferSize( _size );

renderTarget.setSize( Math.round( _size.width * resolution ), Math.round( _size.height * resolution ) );

}

setup( builder ) {

this._updateResolution( _defaultRT, builder.renderer );

return super.setup( builder );

}

getTextureNode() {

return this.textureNode;

}

getVirtualCamera( camera ) {

let virtualCamera = this.virtualCameras.get( camera );

if ( virtualCamera === undefined ) {

virtualCamera = camera.clone();

this.virtualCameras.set( camera, virtualCamera );

}

return virtualCamera;

}

getRenderTarget( camera ) {

let renderTarget = this.renderTargets.get( camera );

if ( renderTarget === undefined ) {

renderTarget = new RenderTarget( 0, 0, { type: HalfFloatType } );

if ( this.generateMipmaps === true ) {

renderTarget.texture.minFilter = LinearMipMapLinearFilter;
renderTarget.texture.generateMipmaps = true;

}

this.renderTargets.set( camera, renderTarget );

}

return renderTarget;

}

updateBefore( frame ) {

if ( this.bounces === false && _inReflector ) return false;

_inReflector = true;

const { scene, camera, renderer, material } = frame;
const { target } = this;

const virtualCamera = this.getVirtualCamera( camera );
const renderTarget = this.getRenderTarget( virtualCamera );

renderer.getDrawingBufferSize( _size );

this._updateResolution( renderTarget, renderer );

//

_reflectorWorldPosition.setFromMatrixPosition( target.matrixWorld );
_cameraWorldPosition.setFromMatrixPosition( camera.matrixWorld );

_rotationMatrix.extractRotation( target.matrixWorld );

_normal.set( 0, 0, 1 );
_normal.applyMatrix4( _rotationMatrix );

_view.subVectors( _reflectorWorldPosition, _cameraWorldPosition );

// Avoid rendering when reflector is facing away

if ( _view.dot( _normal ) > 0 ) return;

_view.reflect( _normal ).negate();
_view.add( _reflectorWorldPosition );

_rotationMatrix.extractRotation( camera.matrixWorld );

_lookAtPosition.set( 0, 0, - 1 );
_lookAtPosition.applyMatrix4( _rotationMatrix );
_lookAtPosition.add( _cameraWorldPosition );

_target.subVectors( _reflectorWorldPosition, _lookAtPosition );
_target.reflect( _normal ).negate();
_target.add( _reflectorWorldPosition );

//

virtualCamera.coordinateSystem = camera.coordinateSystem;
virtualCamera.position.copy( _view );
virtualCamera.up.set( 0, 1, 0 );
virtualCamera.up.applyMatrix4( _rotationMatrix );
virtualCamera.up.reflect( _normal );
virtualCamera.lookAt( _target );

virtualCamera.near = camera.near;
virtualCamera.far = camera.far;

virtualCamera.updateMatrixWorld();
virtualCamera.projectionMatrix.copy( camera.projectionMatrix );

// Now update projection matrix with new clip plane, implementing code from: http://www.terathon.com/code/oblique.html
// Paper explaining this technique: http://www.terathon.com/lengyel/Lengyel-Oblique.pdf
_reflectorPlane.setFromNormalAndCoplanarPoint( _normal, _reflectorWorldPosition );
_reflectorPlane.applyMatrix4( virtualCamera.matrixWorldInverse );

clipPlane.set( _reflectorPlane.normal.x, _reflectorPlane.normal.y, _reflectorPlane.normal.z, _reflectorPlane.constant );

const projectionMatrix = virtualCamera.projectionMatrix;

_q.x = ( Math.sign( clipPlane.x ) + projectionMatrix.elements[ 8 ] ) / projectionMatrix.elements[ 0 ];
_q.y = ( Math.sign( clipPlane.y ) + projectionMatrix.elements[ 9 ] ) / projectionMatrix.elements[ 5 ];
_q.z = - 1.0;
_q.w = ( 1.0 + projectionMatrix.elements[ 10 ] ) / projectionMatrix.elements[ 14 ];

// Calculate the scaled plane vector
clipPlane.multiplyScalar( 1.0 / clipPlane.dot( _q ) );

const clipBias = 0;

// Replacing the third row of the projection matrix
projectionMatrix.elements[ 2 ] = clipPlane.x;
projectionMatrix.elements[ 6 ] = clipPlane.y;
projectionMatrix.elements[ 10 ] = clipPlane.z - clipBias;
projectionMatrix.elements[ 14 ] = clipPlane.w;

//

this.value = renderTarget.texture;

material.visible = false;

const currentRenderTarget = renderer.getRenderTarget();

renderer.setRenderTarget( renderTarget );

renderer.render( scene, virtualCamera );

renderer.setRenderTarget( currentRenderTarget );

material.visible = true;

_inReflector = false;

}

}

export const reflector = ( parameters ) => nodeObject( new ReflectorNode( parameters ) );

export default ReflectorNode;

Binary file added examples/screenshots/webgpu_mirror.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/screenshots/webgpu_reflection.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7e226d0

Please sign in to comment.