webgl_clipping_stencil.html 8.2 KB

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