2
0

objects_Pattern.js.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: objects/Pattern.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/Pattern.js</h1>
  17. <section>
  18. <article>
  19. <pre class="prettyprint source linenums"><code>import {Object2D} from "../Object2D.js";
  20. import {Box2} from "../math/Box2.js";
  21. /**
  22. * Pattern object draw a image repeated as a pattern.
  23. *
  24. * Its similar to the Image class but the image can be repeat infinitely.
  25. *
  26. * @class
  27. * @extends {Object2D}
  28. * @param {string} src Source image URL.
  29. */
  30. function Pattern(src)
  31. {
  32. Object2D.call(this);
  33. /**
  34. * Box object containing the size of the object.
  35. *
  36. * @type {Box2}
  37. */
  38. this.box = new Box2();
  39. /**
  40. * Image source DOM element. Used as a source for the pattern image.
  41. *
  42. * This element can be replaced by one of other type (e.g canvas, video).
  43. *
  44. * @type {Element}
  45. */
  46. this.image = document.createElement("img");
  47. /**
  48. * Repetition indicates how the pattern image should be repeated.
  49. *
  50. * Possible values are "repeat", "repeat-x", "repeat-y" or "no-repeat".
  51. *
  52. * More information about this attribute here https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createPattern.
  53. *
  54. * @type {string}
  55. */
  56. this.repetition = "repeat"
  57. if(src !== undefined)
  58. {
  59. this.setImage(src);
  60. }
  61. }
  62. Pattern.prototype = Object.create(Object2D.prototype);
  63. Pattern.prototype.constructor = Pattern;
  64. Pattern.prototype.type = "Pattern";
  65. Object2D.register(Pattern, "Pattern");
  66. /**
  67. * Set the image source of the object. Can be anything accepted by the src field of an img element.
  68. *
  69. * Automatically sets the box size to match the image.
  70. *
  71. * @param {string} src Image source string.
  72. */
  73. Pattern.prototype.setImage = function(src)
  74. {
  75. var self = this;
  76. this.image.onload = function()
  77. {
  78. self.box.min.set(0, 0);
  79. self.box.max.set(this.naturalWidth, this.naturalHeight);
  80. };
  81. this.image.src = src;
  82. };
  83. Pattern.prototype.isInside = function(point)
  84. {
  85. return this.box.containsPoint(point);
  86. };
  87. Pattern.prototype.draw = function(context, viewport, canvas)
  88. {
  89. var width = this.box.max.x - this.box.min.x;
  90. var height = this.box.max.y - this.box.min.y;
  91. if(this.image.src.length > 0)
  92. {
  93. var pattern = context.createPattern(this.image, this.repetition);
  94. context.fillStyle = pattern;
  95. context.fillRect(this.box.min.x, this.box.min.y, width, height);
  96. }
  97. };
  98. Pattern.prototype.serialize = function(recursive)
  99. {
  100. var data = Object2D.prototype.serialize.call(this, recursive);
  101. data.box = this.box.toArray();
  102. data.image = this.image.src;
  103. data.repetition = this.repetition;
  104. return data;
  105. };
  106. Pattern.prototype.parse = function(data, root)
  107. {
  108. Object2D.prototype.parse.call(this, data, root);
  109. this.box.fromArray(data.box);
  110. this.image.src = data.image;
  111. this.repetition = data.repetition;
  112. };
  113. export {Pattern};
  114. </code></pre>
  115. </article>
  116. </section>
  117. </div>
  118. <nav>
  119. <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>
  120. </nav>
  121. <br class="clear">
  122. <footer>
  123. 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)
  124. </footer>
  125. <script> prettyPrint(); </script>
  126. <script src="scripts/linenumber.js"> </script>
  127. </body>
  128. </html>