webgl_clipping_stencil.html 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>three.js webgl - clipping stencil</title>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <link type="text/css" rel="stylesheet" href="main.css">
  8. </head>
  9. <body>
  10. <div id="info"><a href="https://threejs.org" target="_blank" rel="noopener">three.js</a> - solid geometry with clip planes and stencil materials</div>
  11. <!-- Import maps polyfill -->
  12. <!-- Remove this when import maps will be widely supported -->
  13. <script async src="https://unpkg.com/[email protected]/dist/es-module-shims.js"></script>
  14. <script type="importmap">
  15. {
  16. "imports": {
  17. "three": "../build/three.module.js",
  18. "three/addons/": "./jsm/"
  19. }
  20. }
  21. </script>
  22. <script type="module">
  23. import * as THREE from 'three';
  24. import { OrbitControls } from 'three/addons/controls/OrbitControls.js';
  25. import { GUI } from 'three/addons/libs/lil-gui.module.min.js';
  26. import Stats from 'three/addons/libs/stats.module.js';
  27. let camera, scene, renderer, object, stats;
  28. let planes, planeObjects, planeHelpers;
  29. let clock;
  30. const params = {
  31. animate: true,
  32. planeX: {
  33. constant: 0,
  34. negated: false,
  35. displayHelper: false
  36. },
  37. planeY: {
  38. constant: 0,
  39. negated: false,
  40. displayHelper: false
  41. },
  42. planeZ: {
  43. constant: 0,
  44. negated: false,
  45. displayHelper: false
  46. }
  47. };
  48. init();
  49. animate();
  50. function createPlaneStencilGroup( geometry, plane, renderOrder ) {
  51. const group = new THREE.Group();
  52. const baseMat = new THREE.MeshBasicMaterial();
  53. baseMat.depthWrite = false;
  54. baseMat.depthTest = false;
  55. baseMat.colorWrite = false;
  56. baseMat.stencilWrite = true;
  57. baseMat.stencilFunc = THREE.AlwaysStencilFunc;
  58. // back faces
  59. const mat0 = baseMat.clone();
  60. mat0.side = THREE.BackSide;
  61. mat0.clippingPlanes = [ plane ];
  62. mat0.stencilFail = THREE.IncrementWrapStencilOp;
  63. mat0.stencilZFail = THREE.IncrementWrapStencilOp;
  64. mat0.stencilZPass = THREE.IncrementWrapStencilOp;
  65. const mesh0 = new THREE.Mesh( geometry, mat0 );
  66. mesh0.renderOrder = renderOrder;
  67. group.add( mesh0 );
  68. // front faces
  69. const mat1 = baseMat.clone();
  70. mat1.side = THREE.FrontSide;
  71. mat1.clippingPlanes = [ plane ];
  72. mat1.stencilFail = THREE.DecrementWrapStencilOp;
  73. mat1.stencilZFail = THREE.DecrementWrapStencilOp;
  74. mat1.stencilZPass = THREE.DecrementWrapStencilOp;
  75. const mesh1 = new THREE.Mesh( geometry, mat1 );
  76. mesh1.renderOrder = renderOrder;
  77. group.add( mesh1 );
  78. return group;
  79. }
  80. function init() {
  81. clock = new THREE.Clock();
  82. scene = new THREE.Scene();
  83. camera = new THREE.PerspectiveCamera( 36, window.innerWidth / window.innerHeight, 1, 100 );
  84. camera.position.set( 2, 2, 2 );
  85. scene.add( new THREE.AmbientLight( 0xffffff, 0.5 ) );
  86. const dirLight = new THREE.DirectionalLight( 0xffffff, 1 );
  87. dirLight.position.set( 5, 10, 7.5 );
  88. dirLight.castShadow = true;
  89. dirLight.shadow.camera.right = 2;
  90. dirLight.shadow.camera.left = - 2;
  91. dirLight.shadow.camera.top = 2;
  92. dirLight.shadow.camera.bottom = - 2;
  93. dirLight.shadow.mapSize.width = 1024;
  94. dirLight.shadow.mapSize.height = 1024;
  95. scene.add( dirLight );
  96. planes = [
  97. new THREE.Plane( new THREE.Vector3( - 1, 0, 0 ), 0 ),
  98. new THREE.Plane( new THREE.Vector3( 0, - 1, 0 ), 0 ),
  99. new THREE.Plane( new THREE.Vector3( 0, 0, - 1 ), 0 )
  100. ];
  101. planeHelpers = planes.map( p => new THREE.PlaneHelper( p, 2, 0xffffff ) );
  102. planeHelpers.forEach( ph => {
  103. ph.visible = false;
  104. scene.add( ph );
  105. } );
  106. const geometry = new THREE.TorusKnotGeometry( 0.4, 0.15, 220, 60 );
  107. object = new THREE.Group();
  108. scene.add( object );
  109. // Set up clip plane rendering
  110. planeObjects = [];
  111. const planeGeom = new THREE.PlaneGeometry( 4, 4 );
  112. for ( let i = 0; i < 3; i ++ ) {
  113. const poGroup = new THREE.Group();
  114. const plane = planes[ i ];
  115. const stencilGroup = createPlaneStencilGroup( geometry, plane, i + 1 );
  116. // plane is clipped by the other clipping planes
  117. const planeMat =
  118. new THREE.MeshStandardMaterial( {
  119. color: 0xE91E63,
  120. metalness: 0.1,
  121. roughness: 0.75,
  122. clippingPlanes: planes.filter( p => p !== plane ),
  123. stencilWrite: true,
  124. stencilRef: 0,
  125. stencilFunc: THREE.NotEqualStencilFunc,
  126. stencilFail: THREE.ReplaceStencilOp,
  127. stencilZFail: THREE.ReplaceStencilOp,
  128. stencilZPass: THREE.ReplaceStencilOp,
  129. } );
  130. const po = new THREE.Mesh( planeGeom, planeMat );
  131. po.onAfterRender = function ( renderer ) {
  132. renderer.clearStencil();
  133. };
  134. po.renderOrder = i + 1.1;
  135. object.add( stencilGroup );
  136. poGroup.add( po );
  137. planeObjects.push( po );
  138. scene.add( poGroup );
  139. }
  140. const material = new THREE.MeshStandardMaterial( {
  141. color: 0xFFC107,
  142. metalness: 0.1,
  143. roughness: 0.75,
  144. clippingPlanes: planes,
  145. clipShadows: true,
  146. shadowSide: THREE.DoubleSide,
  147. } );
  148. // add the color
  149. const clippedColorFront = new THREE.Mesh( geometry, material );
  150. clippedColorFront.castShadow = true;
  151. clippedColorFront.renderOrder = 6;
  152. object.add( clippedColorFront );
  153. const ground = new THREE.Mesh(
  154. new THREE.PlaneGeometry( 9, 9, 1, 1 ),
  155. new THREE.ShadowMaterial( { color: 0x000000, opacity: 0.25, side: THREE.DoubleSide } )
  156. );
  157. ground.rotation.x = - Math.PI / 2; // rotates X/Y to X/Z
  158. ground.position.y = - 1;
  159. ground.receiveShadow = true;
  160. scene.add( ground );
  161. // Stats
  162. stats = new Stats();
  163. document.body.appendChild( stats.dom );
  164. // Renderer
  165. renderer = new THREE.WebGLRenderer( { antialias: true } );
  166. renderer.shadowMap.enabled = true;
  167. renderer.setPixelRatio( window.devicePixelRatio );
  168. renderer.setSize( window.innerWidth, window.innerHeight );
  169. renderer.setClearColor( 0x263238 );
  170. window.addEventListener( 'resize', onWindowResize );
  171. document.body.appendChild( renderer.domElement );
  172. renderer.localClippingEnabled = true;
  173. // Controls
  174. const controls = new OrbitControls( camera, renderer.domElement );
  175. controls.minDistance = 2;
  176. controls.maxDistance = 20;
  177. controls.update();
  178. // GUI
  179. const gui = new GUI();
  180. gui.add( params, 'animate' );
  181. const planeX = gui.addFolder( 'planeX' );
  182. planeX.add( params.planeX, 'displayHelper' ).onChange( v => planeHelpers[ 0 ].visible = v );
  183. planeX.add( params.planeX, 'constant' ).min( - 1 ).max( 1 ).onChange( d => planes[ 0 ].constant = d );
  184. planeX.add( params.planeX, 'negated' ).onChange( () => {
  185. planes[ 0 ].negate();
  186. params.planeX.constant = planes[ 0 ].constant;
  187. } );
  188. planeX.open();
  189. const planeY = gui.addFolder( 'planeY' );
  190. planeY.add( params.planeY, 'displayHelper' ).onChange( v => planeHelpers[ 1 ].visible = v );
  191. planeY.add( params.planeY, 'constant' ).min( - 1 ).max( 1 ).onChange( d => planes[ 1 ].constant = d );
  192. planeY.add( params.planeY, 'negated' ).onChange( () => {
  193. planes[ 1 ].negate();
  194. params.planeY.constant = planes[ 1 ].constant;
  195. } );
  196. planeY.open();
  197. const planeZ = gui.addFolder( 'planeZ' );
  198. planeZ.add( params.planeZ, 'displayHelper' ).onChange( v => planeHelpers[ 2 ].visible = v );
  199. planeZ.add( params.planeZ, 'constant' ).min( - 1 ).max( 1 ).onChange( d => planes[ 2 ].constant = d );
  200. planeZ.add( params.planeZ, 'negated' ).onChange( () => {
  201. planes[ 2 ].negate();
  202. params.planeZ.constant = planes[ 2 ].constant;
  203. } );
  204. planeZ.open();
  205. }
  206. function onWindowResize() {
  207. camera.aspect = window.innerWidth / window.innerHeight;
  208. camera.updateProjectionMatrix();
  209. renderer.setSize( window.innerWidth, window.innerHeight );
  210. }
  211. function animate() {
  212. const delta = clock.getDelta();
  213. requestAnimationFrame( animate );
  214. if ( params.animate ) {
  215. object.rotation.x += delta * 0.5;
  216. object.rotation.y += delta * 0.2;
  217. }
  218. for ( let i = 0; i < planeObjects.length; i ++ ) {
  219. const plane = planes[ i ];
  220. const po = planeObjects[ i ];
  221. plane.coplanarPoint( po.position );
  222. po.lookAt(
  223. po.position.x - plane.normal.x,
  224. po.position.y - plane.normal.y,
  225. po.position.z - plane.normal.z,
  226. );
  227. }
  228. stats.begin();
  229. renderer.render( scene, camera );
  230. stats.end();
  231. }
  232. </script>
  233. </body>
  234. </html>