CSS2DRenderer.js 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. import {
  2. Matrix4,
  3. Object3D,
  4. Vector2,
  5. Vector3
  6. } from 'three';
  7. /**
  8. * The only type of 3D object that is supported by {@link CSS2DRenderer}.
  9. *
  10. * @augments Object3D
  11. * @three_import import { CSS2DObject } from 'three/addons/renderers/CSS2DRenderer.js';
  12. */
  13. class CSS2DObject extends Object3D {
  14. /**
  15. * Constructs a new CSS2D object.
  16. *
  17. * @param {DOMElement} [element] - The DOM element.
  18. */
  19. constructor( element = document.createElement( 'div' ) ) {
  20. super();
  21. /**
  22. * This flag can be used for type testing.
  23. *
  24. * @type {boolean}
  25. * @readonly
  26. * @default true
  27. */
  28. this.isCSS2DObject = true;
  29. /**
  30. * The DOM element which defines the appearance of this 3D object.
  31. *
  32. * @type {DOMElement}
  33. * @readonly
  34. * @default true
  35. */
  36. this.element = element;
  37. this.element.style.position = 'absolute';
  38. this.element.style.userSelect = 'none';
  39. this.element.setAttribute( 'draggable', false );
  40. /**
  41. * The 3D objects center point.
  42. * `( 0, 0 )` is the lower left, `( 1, 1 )` is the top right.
  43. *
  44. * @type {Vector2}
  45. * @default (0.5,0.5)
  46. */
  47. this.center = new Vector2( 0.5, 0.5 );
  48. this.addEventListener( 'removed', function () {
  49. this.traverse( function ( object ) {
  50. if (
  51. object.element instanceof object.element.ownerDocument.defaultView.Element &&
  52. object.element.parentNode !== null
  53. ) {
  54. object.element.remove();
  55. }
  56. } );
  57. } );
  58. }
  59. copy( source, recursive ) {
  60. super.copy( source, recursive );
  61. this.element = source.element.cloneNode( true );
  62. this.center = source.center;
  63. return this;
  64. }
  65. }
  66. //
  67. const _vector = new Vector3();
  68. const _viewMatrix = new Matrix4();
  69. const _viewProjectionMatrix = new Matrix4();
  70. const _a = new Vector3();
  71. const _b = new Vector3();
  72. /**
  73. * This renderer is a simplified version of {@link CSS3DRenderer}. The only transformation that is
  74. * supported is translation.
  75. *
  76. * The renderer is very useful if you want to combine HTML based labels with 3D objects. Here too,
  77. * the respective DOM elements are wrapped into an instance of {@link CSS2DObject} and added to the
  78. * scene graph. All other types of renderable 3D objects (like meshes or point clouds) are ignored.
  79. *
  80. * `CSS2DRenderer` only supports 100% browser and display zoom.
  81. *
  82. * @three_import import { CSS2DRenderer } from 'three/addons/renderers/CSS2DRenderer.js';
  83. */
  84. class CSS2DRenderer {
  85. /**
  86. * Constructs a new CSS2D renderer.
  87. *
  88. * @param {CSS2DRenderer~Parameters} [parameters] - The parameters.
  89. */
  90. constructor( parameters = {} ) {
  91. const _this = this;
  92. let _width, _height;
  93. let _widthHalf, _heightHalf;
  94. const cache = {
  95. objects: new WeakMap()
  96. };
  97. const domElement = parameters.element !== undefined ? parameters.element : document.createElement( 'div' );
  98. domElement.style.overflow = 'hidden';
  99. /**
  100. * The DOM where the renderer appends its child-elements.
  101. *
  102. * @type {DOMElement}
  103. */
  104. this.domElement = domElement;
  105. /**
  106. * Returns an object containing the width and height of the renderer.
  107. *
  108. * @return {{width:number,height:number}} The size of the renderer.
  109. */
  110. this.getSize = function () {
  111. return {
  112. width: _width,
  113. height: _height
  114. };
  115. };
  116. /**
  117. * Renders the given scene using the given camera.
  118. *
  119. * @param {Object3D} scene - A scene or any other type of 3D object.
  120. * @param {Camera} camera - The camera.
  121. */
  122. this.render = function ( scene, camera ) {
  123. if ( scene.matrixWorldAutoUpdate === true ) scene.updateMatrixWorld();
  124. if ( camera.parent === null && camera.matrixWorldAutoUpdate === true ) camera.updateMatrixWorld();
  125. _viewMatrix.copy( camera.matrixWorldInverse );
  126. _viewProjectionMatrix.multiplyMatrices( camera.projectionMatrix, _viewMatrix );
  127. renderObject( scene, scene, camera );
  128. zOrder( scene );
  129. };
  130. /**
  131. * Resizes the renderer to the given width and height.
  132. *
  133. * @param {number} width - The width of the renderer.
  134. * @param {number} height - The height of the renderer.
  135. */
  136. this.setSize = function ( width, height ) {
  137. _width = width;
  138. _height = height;
  139. _widthHalf = _width / 2;
  140. _heightHalf = _height / 2;
  141. domElement.style.width = width + 'px';
  142. domElement.style.height = height + 'px';
  143. };
  144. function hideObject( object ) {
  145. if ( object.isCSS2DObject ) object.element.style.display = 'none';
  146. for ( let i = 0, l = object.children.length; i < l; i ++ ) {
  147. hideObject( object.children[ i ] );
  148. }
  149. }
  150. function renderObject( object, scene, camera ) {
  151. if ( object.visible === false ) {
  152. hideObject( object );
  153. return;
  154. }
  155. if ( object.isCSS2DObject ) {
  156. _vector.setFromMatrixPosition( object.matrixWorld );
  157. _vector.applyMatrix4( _viewProjectionMatrix );
  158. const visible = ( _vector.z >= - 1 && _vector.z <= 1 ) && ( object.layers.test( camera.layers ) === true );
  159. const element = object.element;
  160. element.style.display = visible === true ? '' : 'none';
  161. if ( visible === true ) {
  162. object.onBeforeRender( _this, scene, camera );
  163. element.style.transform = 'translate(' + ( - 100 * object.center.x ) + '%,' + ( - 100 * object.center.y ) + '%)' + 'translate(' + ( _vector.x * _widthHalf + _widthHalf ) + 'px,' + ( - _vector.y * _heightHalf + _heightHalf ) + 'px)';
  164. if ( element.parentNode !== domElement ) {
  165. domElement.appendChild( element );
  166. }
  167. object.onAfterRender( _this, scene, camera );
  168. }
  169. const objectData = {
  170. distanceToCameraSquared: getDistanceToSquared( camera, object )
  171. };
  172. cache.objects.set( object, objectData );
  173. }
  174. for ( let i = 0, l = object.children.length; i < l; i ++ ) {
  175. renderObject( object.children[ i ], scene, camera );
  176. }
  177. }
  178. function getDistanceToSquared( object1, object2 ) {
  179. _a.setFromMatrixPosition( object1.matrixWorld );
  180. _b.setFromMatrixPosition( object2.matrixWorld );
  181. return _a.distanceToSquared( _b );
  182. }
  183. function filterAndFlatten( scene ) {
  184. const result = [];
  185. scene.traverseVisible( function ( object ) {
  186. if ( object.isCSS2DObject ) result.push( object );
  187. } );
  188. return result;
  189. }
  190. function zOrder( scene ) {
  191. const sorted = filterAndFlatten( scene ).sort( function ( a, b ) {
  192. if ( a.renderOrder !== b.renderOrder ) {
  193. return b.renderOrder - a.renderOrder;
  194. }
  195. const distanceA = cache.objects.get( a ).distanceToCameraSquared;
  196. const distanceB = cache.objects.get( b ).distanceToCameraSquared;
  197. return distanceA - distanceB;
  198. } );
  199. const zMax = sorted.length;
  200. for ( let i = 0, l = sorted.length; i < l; i ++ ) {
  201. sorted[ i ].element.style.zIndex = zMax - i;
  202. }
  203. }
  204. }
  205. }
  206. /**
  207. * Constructor parameters of `CSS2DRenderer`.
  208. *
  209. * @typedef {Object} CSS2DRenderer~Parameters
  210. * @property {DOMElement} [element] - A DOM element where the renderer appends its child-elements.
  211. * If not passed in here, a new div element will be created.
  212. **/
  213. export { CSS2DObject, CSS2DRenderer };