2
0

objects_style_PatternStyle.js.html 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: objects/style/PatternStyle.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/style/PatternStyle.js</h1>
  17. <section>
  18. <article>
  19. <pre class="prettyprint source linenums"><code>import {Style} from "./Style";
  20. import {GradientStyle} from "./GradientStyle";
  21. import {Matrix} from "../../math/Matrix";
  22. /**
  23. * Pattern style represents an opaque object describing a pattern, based on an image, a canvas, or a video.
  24. *
  25. * The get method returns a CanvasPattern object https://developer.mozilla.org/en-US/docs/Web/API/CanvasPattern created by the context.createPattern() method.
  26. *
  27. * @class
  28. * @extends {Style}
  29. * @param {CanvasImageSource} source Source element of the pattern.
  30. */
  31. function PatternStyle(source)
  32. {
  33. Style.call(this);
  34. /**
  35. * Source of the pattern style. Can be a image, video or another canvas element
  36. *
  37. * By default a empty image element is created.
  38. *
  39. * @type {CanvasImageSource}
  40. */
  41. this.source = source || document.createElement("img");
  42. /**
  43. * Repetition indicates how the pattern image should be repeated.
  44. *
  45. * Possible values are "repeat", "repeat-x", "repeat-y" or "no-repeat".
  46. *
  47. * More information about this attribute here https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createPattern.
  48. *
  49. * @type {string}
  50. */
  51. this.repetition = "repeat"
  52. /**
  53. * Transformation matrix applied to the pattern.
  54. *
  55. * The transformation allows to move, rotate and scale the pattern freely
  56. *
  57. * @type {Matrix}
  58. */
  59. this.matrix = new Matrix();
  60. }
  61. PatternStyle.prototype = Object.create(Style.prototype);
  62. Style.register(PatternStyle, "Pattern");
  63. /**
  64. * Applies an 2x3 transformation matrix representing a linear transform to the pattern.
  65. *
  66. * @param {number[]} transform 2x3 Transformation matrix.
  67. */
  68. PatternStyle.prototype.setTransform = function(transform)
  69. {
  70. this.matrix.m = transform;
  71. this.needsUpdate = true;
  72. };
  73. PatternStyle.prototype.get = function(context)
  74. {
  75. if(this.needsUpdate || this.cache === null)
  76. {
  77. this.cache = context.createPattern(this.source, this.repetition);
  78. this.cache.setTransform(this.matrix.cssTransform());
  79. this.needsUpdate = false;
  80. }
  81. return this.cache;
  82. };
  83. PatternStyle.prototype.serialize = function ()
  84. {
  85. var data = GradientStyle.prototype.serialize.call(this);
  86. Object.assign(data, {
  87. type: "Pattern",
  88. matrix: this.matrix.m,
  89. repetition: this.repetition,
  90. source: this.source
  91. });
  92. return data;
  93. };
  94. PatternStyle.prototype.parse = function (data)
  95. {
  96. GradientStyle.prototype.parse.call(this, data);
  97. this.matrix = new Matrix(data.matrix);
  98. this.repetition = data.repetition;
  99. this.source = data.source;
  100. };
  101. export {PatternStyle};</code></pre>
  102. </article>
  103. </section>
  104. </div>
  105. <nav>
  106. <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>
  107. </nav>
  108. <br class="clear">
  109. <footer>
  110. 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)
  111. </footer>
  112. <script> prettyPrint(); </script>
  113. <script src="scripts/linenumber.js"> </script>
  114. </body>
  115. </html>