webgl_clipping_stencil.html 8.2 KB

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