2
0

objects_DOM.js.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: objects/DOM.js</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Source: objects/DOM.js</h1>
  17. <section>
  18. <article>
  19. <pre class="prettyprint source linenums"><code>import {Object2D} from "../Object2D.js";
  20. import {Vector2} from "../math/Vector2.js";
  21. /**
  22. * A DOM object transformed using CSS3D to be included in the scene.
  23. *
  24. * DOM objects always stay on top or bellow (depending on the DOM parent placement) of everything else. It is not possible to layer these object with regular canvas objects.
  25. *
  26. * By default mouse events are not supported for these objects (it does not implement pointer collision checking). Use the DOM events for interaction with these types of objects.
  27. *
  28. * @class
  29. * @param {string} type Type of the DOM element (e.g. "div", "p", ...)
  30. * @extends {Object2D}
  31. */
  32. function DOM(type)
  33. {
  34. Object2D.call(this);
  35. /**
  36. * Parent element that contains this DOM object.
  37. *
  38. * The DOM parent element if not set manually is automatically set to the parent of the drawing canvas.
  39. *
  40. * @type {Element}
  41. */
  42. this.parentElement = null;
  43. /**
  44. * DOM element contained by this object.
  45. *
  46. * By default it has the pointerEvents style set to none. In order to use any DOM event with this object first you have to set the element.style.pointerEvents to "auto".
  47. *
  48. * @type {Element}
  49. */
  50. this.element = document.createElement(type || "div");
  51. this.element.style.transformStyle = "preserve-3d";
  52. this.element.style.position = "absolute";
  53. this.element.style.top = "0px";
  54. this.element.style.bottom = "0px";
  55. this.element.style.transformOrigin = "0px 0px";
  56. this.element.style.overflow = "auto";
  57. this.element.style.pointerEvents = "none";
  58. /**
  59. * Size of the DOM element, in world coordinates.
  60. *
  61. * Size is used to set the width and height of the DOM element.
  62. *
  63. * @type {Vector2}
  64. */
  65. this.size = new Vector2(100, 100);
  66. }
  67. DOM.prototype = Object.create(Object2D.prototype);
  68. DOM.prototype.constructor = DOM;
  69. DOM.prototype.type = "DOM";
  70. Object2D.register(DOM, "DOM");
  71. /**
  72. * DOM object implements onAdd() method to automatically attach the DOM object to the DOM tree.
  73. */
  74. DOM.prototype.onAdd = function()
  75. {
  76. if(this.parentElement !== null)
  77. {
  78. this.parentElement.appendChild(this.element);
  79. }
  80. };
  81. /**
  82. * DOM object implements onRemove() method to automatically remove the DOM object to the DOM tree.
  83. */
  84. DOM.prototype.onRemove = function()
  85. {
  86. if(this.parentElement !== null)
  87. {
  88. this.parentElement.removeChild(this.element);
  89. }
  90. };
  91. DOM.prototype.transform = function(context, viewport, canvas, renderer)
  92. {
  93. // Check if the DOM element parent is null
  94. if(this.parentElement === null)
  95. {
  96. this.parentElement = renderer.getDomContainer();
  97. this.parentElement.appendChild(this.element);
  98. }
  99. // CSS transformation matrix
  100. if(this.ignoreViewport)
  101. {
  102. this.element.style.transform = this.globalMatrix.cssTransform();
  103. }
  104. else
  105. {
  106. var projection = viewport.matrix.clone();
  107. projection.multiply(this.globalMatrix);
  108. this.element.style.transform = projection.cssTransform();
  109. }
  110. // Size of the element
  111. this.element.style.width = this.size.x + "px";
  112. this.element.style.height = this.size.y + "px";
  113. // Visibility
  114. this.element.style.display = this.visible ? "block" : "none";
  115. };
  116. DOM.prototype.serialize = function(recursive)
  117. {
  118. var data = Object2D.prototype.serialize.call(this, recursive);
  119. data.size = this.size.toArray();
  120. data.element = this.element.outerHTML;
  121. return data;
  122. };
  123. DOM.prototype.parse = function(data, root)
  124. {
  125. Object2D.prototype.parse.call(this, data, root);
  126. this.size.fromArray(data.size);
  127. var parser = new DOMParser();
  128. var doc = parser.parseFromString(this.element.outerHTML, 'text/html');
  129. this.element = doc.body.children[0];
  130. };
  131. export {DOM};
  132. </code></pre>
  133. </article>
  134. </section>
  135. </div>
  136. <nav>
  137. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnimationTimer.html">AnimationTimer</a></li><li><a href="BarGraph.html">BarGraph</a></li><li><a href="BezierCurve.html">BezierCurve</a></li><li><a href="Box.html">Box</a></li><li><a href="Box2.html">Box2</a></li><li><a href="BoxMask.html">BoxMask</a></li><li><a href="Circle.html">Circle</a></li><li><a href="ColorStyle.html">ColorStyle</a></li><li><a href="DOM.html">DOM</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="FileUtils.html">FileUtils</a></li><li><a href="Gauge.html">Gauge</a></li><li><a href="GradientColorStop.html">GradientColorStop</a></li><li><a href="GradientStyle.html">GradientStyle</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Helpers.html">Helpers</a></li><li><a href="Image.html">Image</a></li><li><a href="Key.html">Key</a></li><li><a href="Line.html">Line</a></li><li><a href="LinearGradientStyle.html">LinearGradientStyle</a></li><li><a href="Mask.html">Mask</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="MultiLineText.html">MultiLineText</a></li><li><a href="Node.html">Node</a></li><li><a href="NodeConnector.html">NodeConnector</a></li><li><a href="NodeGraph.html">NodeGraph</a></li><li><a href="NodeSocket.html">NodeSocket</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Path.html">Path</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="PatternStyle.html">PatternStyle</a></li><li><a href="PieChart.html">PieChart</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="QuadraticCurve.html">QuadraticCurve</a></li><li><a href="RadialGradientStyle.html">RadialGradientStyle</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="RoundedBox.html">RoundedBox</a></li><li><a href="ScatterGraph.html">ScatterGraph</a></li><li><a href="Style.html">Style</a></li><li><a href="Text.html">Text</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="Viewport.html">Viewport</a></li><li><a href="ViewportControls.html">ViewportControls</a></li></ul><h3>Global</h3><ul><li><a href="global.html#writeFile">writeFile</a></li></ul>
  138. </nav>
  139. <br class="clear">
  140. <footer>
  141. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sat Sep 17 2022 14:24:36 GMT+0100 (Hora de verão da Europa Ocidental)
  142. </footer>
  143. <script> prettyPrint(); </script>
  144. <script src="scripts/linenumber.js"> </script>
  145. </body>
  146. </html>