2
0

objects_Line.js.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: objects/Line.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/Line.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. import {ColorStyle} from "./style/ColorStyle";
  22. import {Style} from "./style/Style";
  23. /**
  24. * Line object draw a line from one point to another without any kind of interpolation.
  25. *
  26. * For drawing lines with interpolation check {BezierCurve}
  27. *
  28. * @class
  29. * @extends {Object2D}
  30. */
  31. function Line()
  32. {
  33. Object2D.call(this);
  34. /**
  35. * Initial point of the line.
  36. *
  37. * Can be equal to the position object of another object. Making it automatically follow that object.
  38. *
  39. * @type {Vector2}
  40. */
  41. this.from = new Vector2();
  42. /**
  43. * Final point of the line.
  44. *
  45. * Can be equal to the position object of another object. Making it automatically follow that object.
  46. *
  47. * @type {Vector2}
  48. */
  49. this.to = new Vector2();
  50. /**
  51. * Dash line pattern to be used, if empty draws a solid line.
  52. *
  53. * Dash pattern is defined as the size of dashes as pairs of space with no line and with line.
  54. *
  55. * E.g if the dash pattern is [1, 2] we get 1 point with line, 2 without line repeat infinitelly.
  56. *
  57. * @type {number[]}
  58. */
  59. this.dashPattern = [5, 5];
  60. /**
  61. * Style of the object line.
  62. *
  63. * @type {Style}
  64. */
  65. this.strokeStyle = new ColorStyle("#000000");
  66. /**
  67. * Line width of the line.
  68. *
  69. * @type {number}
  70. */
  71. this.lineWidth = 1;
  72. }
  73. Line.prototype = Object.create(Object2D.prototype);
  74. Line.prototype.constructor = Line;
  75. Line.prototype.type = "Line";
  76. Object2D.register(Line, "Line");
  77. Line.prototype.style = function(context, viewport, canvas)
  78. {
  79. context.lineWidth = this.lineWidth;
  80. context.strokeStyle = this.strokeStyle.get(context);
  81. context.setLineDash(this.dashPattern);
  82. };
  83. Line.prototype.draw = function(context, viewport, canvas)
  84. {
  85. context.beginPath();
  86. context.moveTo(this.from.x, this.from.y);
  87. context.lineTo(this.to.x, this.to.y);
  88. context.stroke();
  89. };
  90. Line.prototype.serialize = function(recursive)
  91. {
  92. var data = Object2D.prototype.serialize.call(this, recursive);
  93. data.from = this.from.toArray();
  94. data.to = this.to.toArray();
  95. data.dashPattern = this.dashPattern;
  96. data.strokeStyle = this.strokeStyle !== null ? this.strokeStyle.serialize() : null;
  97. data.lineWidth = this.lineWidth;
  98. return data;
  99. };
  100. Line.prototype.parse = function(data, root)
  101. {
  102. Object2D.prototype.parse.call(this, data, root);
  103. this.to.fromArray(data.to);
  104. this.from.fromArray(data.from);
  105. this.dashPattern = data.dashPattern;
  106. this.strokeStyle = data.strokeStyle !== null ? Style.parse(data.strokeStyle) : null;
  107. this.lineWidth = data.lineWidth;
  108. };
  109. export {Line};
  110. </code></pre>
  111. </article>
  112. </section>
  113. </div>
  114. <nav>
  115. <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>
  116. </nav>
  117. <br class="clear">
  118. <footer>
  119. 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)
  120. </footer>
  121. <script> prettyPrint(); </script>
  122. <script src="scripts/linenumber.js"> </script>
  123. </body>
  124. </html>