paper 0.12.18 → 0.12.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (228) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/dist/docs/assets/js/paper.js +91 -53
  3. package/dist/docs/classes/Color.html +2 -2
  4. package/dist/docs/classes/CompoundPath.html +2 -2
  5. package/dist/docs/classes/Curve.html +2 -2
  6. package/dist/docs/classes/CurveLocation.html +2 -2
  7. package/dist/docs/classes/Event.html +2 -2
  8. package/dist/docs/classes/Gradient.html +2 -2
  9. package/dist/docs/classes/GradientStop.html +2 -2
  10. package/dist/docs/classes/Group.html +2 -2
  11. package/dist/docs/classes/HitResult.html +2 -2
  12. package/dist/docs/classes/Item.html +2 -2
  13. package/dist/docs/classes/Key.html +2 -2
  14. package/dist/docs/classes/KeyEvent.html +2 -2
  15. package/dist/docs/classes/Layer.html +2 -2
  16. package/dist/docs/classes/Matrix.html +2 -2
  17. package/dist/docs/classes/MouseEvent.html +2 -2
  18. package/dist/docs/classes/PaperScope.html +2 -2
  19. package/dist/docs/classes/PaperScript.html +2 -2
  20. package/dist/docs/classes/Path.html +2 -2
  21. package/dist/docs/classes/PathItem.html +2 -2
  22. package/dist/docs/classes/Point.html +2 -2
  23. package/dist/docs/classes/PointText.html +2 -2
  24. package/dist/docs/classes/Project.html +2 -2
  25. package/dist/docs/classes/Raster.html +2 -2
  26. package/dist/docs/classes/Rectangle.html +2 -2
  27. package/dist/docs/classes/Segment.html +2 -2
  28. package/dist/docs/classes/Shape.html +2 -2
  29. package/dist/docs/classes/Size.html +2 -2
  30. package/dist/docs/classes/Style.html +2 -2
  31. package/dist/docs/classes/SymbolDefinition.html +2 -2
  32. package/dist/docs/classes/SymbolItem.html +2 -2
  33. package/dist/docs/classes/TextItem.html +2 -2
  34. package/dist/docs/classes/Tool.html +2 -2
  35. package/dist/docs/classes/ToolEvent.html +2 -2
  36. package/dist/docs/classes/Tween.html +2 -2
  37. package/dist/docs/classes/View.html +2 -2
  38. package/dist/docs/classes/global.html +2 -2
  39. package/dist/docs/classes/index.html +2 -2
  40. package/dist/docs/index.html +1 -1
  41. package/dist/paper-core.js +90 -52
  42. package/dist/paper-core.min.js +3 -3
  43. package/dist/paper-full.js +91 -53
  44. package/dist/paper-full.min.js +3 -3
  45. package/dist/paper.d.ts +2 -2
  46. package/package.json +5 -2
  47. package/dist/paperjs/LICENSE.txt +0 -23
  48. package/dist/paperjs/dist/node/canvas.js +0 -66
  49. package/dist/paperjs/dist/node/extend.js +0 -156
  50. package/dist/paperjs/dist/node/self.js +0 -58
  51. package/dist/paperjs/dist/node/xml.js +0 -40
  52. package/dist/paperjs/dist/paper-core.d.ts +0 -1
  53. package/dist/paperjs/dist/paper-core.js +0 -15703
  54. package/dist/paperjs/dist/paper-core.min.js +0 -32
  55. package/dist/paperjs/dist/paper-full.js +0 -17472
  56. package/dist/paperjs/dist/paper-full.min.js +0 -32
  57. package/dist/paperjs/dist/paper.d.ts +0 -7394
  58. package/dist/paperjs/docs/assets/css/docs.css +0 -414
  59. package/dist/paperjs/docs/assets/js/codemirror.js +0 -4
  60. package/dist/paperjs/docs/assets/js/docs.js +0 -493
  61. package/dist/paperjs/docs/assets/js/jquery.js +0 -6
  62. package/dist/paperjs/docs/assets/js/paper.js +0 -17472
  63. package/dist/paperjs/docs/classes/Color.html +0 -2188
  64. package/dist/paperjs/docs/classes/CompoundPath.html +0 -8877
  65. package/dist/paperjs/docs/classes/Curve.html +0 -2323
  66. package/dist/paperjs/docs/classes/CurveLocation.html +0 -672
  67. package/dist/paperjs/docs/classes/Event.html +0 -176
  68. package/dist/paperjs/docs/classes/Gradient.html +0 -240
  69. package/dist/paperjs/docs/classes/GradientStop.html +0 -273
  70. package/dist/paperjs/docs/classes/Group.html +0 -6864
  71. package/dist/paperjs/docs/classes/HitResult.html +0 -239
  72. package/dist/paperjs/docs/classes/Item.html +0 -6628
  73. package/dist/paperjs/docs/classes/Key.html +0 -139
  74. package/dist/paperjs/docs/classes/KeyEvent.html +0 -308
  75. package/dist/paperjs/docs/classes/Layer.html +0 -6850
  76. package/dist/paperjs/docs/classes/Matrix.html +0 -1744
  77. package/dist/paperjs/docs/classes/MouseEvent.html +0 -355
  78. package/dist/paperjs/docs/classes/PaperScope.html +0 -459
  79. package/dist/paperjs/docs/classes/PaperScript.html +0 -198
  80. package/dist/paperjs/docs/classes/Path.html +0 -11775
  81. package/dist/paperjs/docs/classes/PathItem.html +0 -8639
  82. package/dist/paperjs/docs/classes/Point.html +0 -2699
  83. package/dist/paperjs/docs/classes/PointText.html +0 -7029
  84. package/dist/paperjs/docs/classes/Project.html +0 -1305
  85. package/dist/paperjs/docs/classes/Raster.html +0 -7843
  86. package/dist/paperjs/docs/classes/Rectangle.html +0 -1654
  87. package/dist/paperjs/docs/classes/Segment.html +0 -939
  88. package/dist/paperjs/docs/classes/Shape.html +0 -7363
  89. package/dist/paperjs/docs/classes/Size.html +0 -1825
  90. package/dist/paperjs/docs/classes/Style.html +0 -919
  91. package/dist/paperjs/docs/classes/SymbolDefinition.html +0 -311
  92. package/dist/paperjs/docs/classes/SymbolItem.html +0 -6755
  93. package/dist/paperjs/docs/classes/TextItem.html +0 -6869
  94. package/dist/paperjs/docs/classes/Tool.html +0 -761
  95. package/dist/paperjs/docs/classes/ToolEvent.html +0 -446
  96. package/dist/paperjs/docs/classes/Tween.html +0 -374
  97. package/dist/paperjs/docs/classes/View.html +0 -1772
  98. package/dist/paperjs/docs/classes/global.html +0 -425
  99. package/dist/paperjs/docs/classes/index.html +0 -88
  100. package/dist/paperjs/docs/index.html +0 -11
  101. package/dist/paperjs/examples/Animated/AnimatedStar.html +0 -53
  102. package/dist/paperjs/examples/Animated/BooleanOperations.html +0 -115
  103. package/dist/paperjs/examples/Animated/CandyCrash.html +0 -151
  104. package/dist/paperjs/examples/Animated/Extruded.html +0 -50
  105. package/dist/paperjs/examples/Animated/Lines.html +0 -53
  106. package/dist/paperjs/examples/Animated/Smoothing.html +0 -70
  107. package/dist/paperjs/examples/Animated/Space.html +0 -86
  108. package/dist/paperjs/examples/Animated/SpaceUsingShapes.html +0 -79
  109. package/dist/paperjs/examples/Games/Paperoids.html +0 -569
  110. package/dist/paperjs/examples/JSON/Circle Testing.html +0 -34
  111. package/dist/paperjs/examples/JSON/Compound Path.html +0 -25
  112. package/dist/paperjs/examples/JSON/Empty Path Testing.html +0 -31
  113. package/dist/paperjs/examples/JSON/Gradients.html +0 -34
  114. package/dist/paperjs/examples/JSON/Group Transform.html +0 -28
  115. package/dist/paperjs/examples/JSON/Line Testing.html +0 -44
  116. package/dist/paperjs/examples/JSON/Random Path Testing.html +0 -42
  117. package/dist/paperjs/examples/JSON/Raster.html +0 -29
  118. package/dist/paperjs/examples/JSON/Rect and Attribute Testing.html +0 -56
  119. package/dist/paperjs/examples/JSON/Rotated Primitives.html +0 -55
  120. package/dist/paperjs/examples/JSON/Selection.html +0 -43
  121. package/dist/paperjs/examples/JSON/Shapes.html +0 -54
  122. package/dist/paperjs/examples/JSON/Symbols.html +0 -30
  123. package/dist/paperjs/examples/JSON/Text Testing.html +0 -38
  124. package/dist/paperjs/examples/JSON/Tiger.html +0 -19
  125. package/dist/paperjs/examples/JSON/Transform Test 1.html +0 -32
  126. package/dist/paperjs/examples/JSON/Transform Test 2.html +0 -30
  127. package/dist/paperjs/examples/Node.js/AnimatedStar.js +0 -52
  128. package/dist/paperjs/examples/Node.js/BooleanOperations.js +0 -36
  129. package/dist/paperjs/examples/Node.js/JSONtoPDF.js +0 -20
  130. package/dist/paperjs/examples/Node.js/Raster.js +0 -32
  131. package/dist/paperjs/examples/Node.js/RasterRemote.js +0 -33
  132. package/dist/paperjs/examples/Node.js/SvgExport.js +0 -52
  133. package/dist/paperjs/examples/Node.js/SvgImport.js +0 -23
  134. package/dist/paperjs/examples/Node.js/Tadpoles.js +0 -16
  135. package/dist/paperjs/examples/Node.js/Tadpoles.pjs +0 -278
  136. package/dist/paperjs/examples/Node.js/in.json +0 -1
  137. package/dist/paperjs/examples/Node.js/in.svg +0 -16
  138. package/dist/paperjs/examples/Paperjs.org/BooleanOperattions.html +0 -115
  139. package/dist/paperjs/examples/Paperjs.org/BouncingBalls.html +0 -103
  140. package/dist/paperjs/examples/Paperjs.org/Chain.html +0 -54
  141. package/dist/paperjs/examples/Paperjs.org/DivisionRaster.html +0 -72
  142. package/dist/paperjs/examples/Paperjs.org/FutureSplash.html +0 -122
  143. package/dist/paperjs/examples/Paperjs.org/HitTesting.html +0 -103
  144. package/dist/paperjs/examples/Paperjs.org/InteractiveTiger.html +0 -777
  145. package/dist/paperjs/examples/Paperjs.org/MetaBalls.html +0 -132
  146. package/dist/paperjs/examples/Paperjs.org/NyanRainbow.html +0 -202
  147. package/dist/paperjs/examples/Paperjs.org/PathIntersections.html +0 -76
  148. package/dist/paperjs/examples/Paperjs.org/Qbertify.html +0 -146
  149. package/dist/paperjs/examples/Paperjs.org/RadialRainbows.html +0 -80
  150. package/dist/paperjs/examples/Paperjs.org/RoundedRectangles.html +0 -41
  151. package/dist/paperjs/examples/Paperjs.org/SatieLikedToDraw.html +0 -140
  152. package/dist/paperjs/examples/Paperjs.org/Simplify.html +0 -63
  153. package/dist/paperjs/examples/Paperjs.org/SpiralRaster.html +0 -120
  154. package/dist/paperjs/examples/Paperjs.org/Tadpoles.html +0 -283
  155. package/dist/paperjs/examples/Paperjs.org/Voronoi.html +0 -134
  156. package/dist/paperjs/examples/Rasters/PhyllotaxisRaster.html +0 -96
  157. package/dist/paperjs/examples/Rasters/Raster.html +0 -34
  158. package/dist/paperjs/examples/Rasters/RotationRaster.html +0 -44
  159. package/dist/paperjs/examples/Rasters/Smoothing.html +0 -36
  160. package/dist/paperjs/examples/SVG Export/Circle Testing.html +0 -32
  161. package/dist/paperjs/examples/SVG Export/Clipping.html +0 -17
  162. package/dist/paperjs/examples/SVG Export/Compound Path.html +0 -22
  163. package/dist/paperjs/examples/SVG Export/Empty Path Testing.html +0 -28
  164. package/dist/paperjs/examples/SVG Export/Gradients.html +0 -52
  165. package/dist/paperjs/examples/SVG Export/Group Transform.html +0 -25
  166. package/dist/paperjs/examples/SVG Export/Line Testing.html +0 -41
  167. package/dist/paperjs/examples/SVG Export/Random Path Testing.html +0 -39
  168. package/dist/paperjs/examples/SVG Export/Raster.html +0 -21
  169. package/dist/paperjs/examples/SVG Export/Rect and Attribute Testing.html +0 -53
  170. package/dist/paperjs/examples/SVG Export/Rotated Primitives.html +0 -80
  171. package/dist/paperjs/examples/SVG Export/Shapes.html +0 -58
  172. package/dist/paperjs/examples/SVG Export/Symbols.html +0 -27
  173. package/dist/paperjs/examples/SVG Export/Text Testing.html +0 -45
  174. package/dist/paperjs/examples/SVG Export/Tiger.html +0 -23
  175. package/dist/paperjs/examples/SVG Export/Transform Test 1.html +0 -29
  176. package/dist/paperjs/examples/SVG Export/Transform Test 2.html +0 -27
  177. package/dist/paperjs/examples/SVG Import/Arcs.html +0 -78
  178. package/dist/paperjs/examples/SVG Import/Butterfly.html +0 -223
  179. package/dist/paperjs/examples/SVG Import/Circle and Ellipse Testing.html +0 -26
  180. package/dist/paperjs/examples/SVG Import/Clipping.html +0 -100
  181. package/dist/paperjs/examples/SVG Import/From File.html +0 -30
  182. package/dist/paperjs/examples/SVG Import/Gradient.html +0 -138
  183. package/dist/paperjs/examples/SVG Import/Gradients.html +0 -30
  184. package/dist/paperjs/examples/SVG Import/Inkscape Pivot.html +0 -52
  185. package/dist/paperjs/examples/SVG Import/Inkscape.html +0 -88
  186. package/dist/paperjs/examples/SVG Import/Line Testing.html +0 -24
  187. package/dist/paperjs/examples/SVG Import/MoreGradients.html +0 -107
  188. package/dist/paperjs/examples/SVG Import/Multiple Paths Test 1.html +0 -42
  189. package/dist/paperjs/examples/SVG Import/Multiple Paths Test 2.html +0 -33
  190. package/dist/paperjs/examples/SVG Import/Nested Groups Test.html +0 -78
  191. package/dist/paperjs/examples/SVG Import/Polybezier.html +0 -43
  192. package/dist/paperjs/examples/SVG Import/Rect Testing.html +0 -25
  193. package/dist/paperjs/examples/SVG Import/Symbols.html +0 -24
  194. package/dist/paperjs/examples/SVG Import/Testing.html +0 -40
  195. package/dist/paperjs/examples/SVG Import/Text Testing.html +0 -19
  196. package/dist/paperjs/examples/SVG Import/Tiger.html +0 -742
  197. package/dist/paperjs/examples/SVG Import/Transform Testing.html +0 -22
  198. package/dist/paperjs/examples/SVG Import/Viewbox.html +0 -38
  199. package/dist/paperjs/examples/Scripts/Arcs.html +0 -39
  200. package/dist/paperjs/examples/Scripts/BlendModes.html +0 -77
  201. package/dist/paperjs/examples/Scripts/BooleanOperations.html +0 -937
  202. package/dist/paperjs/examples/Scripts/CompoundPath.html +0 -19
  203. package/dist/paperjs/examples/Scripts/CurveTimeParameterization.html +0 -61
  204. package/dist/paperjs/examples/Scripts/HslColor.html +0 -53
  205. package/dist/paperjs/examples/Scripts/PathStructure.html +0 -82
  206. package/dist/paperjs/examples/Scripts/PathTangents.html +0 -73
  207. package/dist/paperjs/examples/Scripts/Resize.html +0 -42
  208. package/dist/paperjs/examples/Scripts/RoundRectangle.html +0 -28
  209. package/dist/paperjs/examples/Scripts/Shapes.html +0 -54
  210. package/dist/paperjs/examples/Scripts/StrokeBounds.html +0 -101
  211. package/dist/paperjs/examples/Scripts/StrokeScaling.html +0 -65
  212. package/dist/paperjs/examples/Tools/BezierTool.html +0 -90
  213. package/dist/paperjs/examples/Tools/Circles.html +0 -28
  214. package/dist/paperjs/examples/Tools/Clouds.html +0 -35
  215. package/dist/paperjs/examples/Tools/DrippingBrush.html +0 -73
  216. package/dist/paperjs/examples/Tools/FancyBrush.html +0 -82
  217. package/dist/paperjs/examples/Tools/Grid.html +0 -44
  218. package/dist/paperjs/examples/Tools/MultiLines.html +0 -44
  219. package/dist/paperjs/examples/Tools/MultipleTools.html +0 -44
  220. package/dist/paperjs/examples/Tools/PathEditing.html +0 -95
  221. package/dist/paperjs/examples/Tools/SquareRounded.html +0 -76
  222. package/dist/paperjs/examples/Tools/Stars.html +0 -38
  223. package/dist/paperjs/examples/Tools/Vektor.html +0 -200
  224. package/dist/paperjs/examples/Tools/Wave.html +0 -50
  225. package/dist/paperjs/examples/Tools/WormFarm.html +0 -88
  226. package/dist/paperjs/examples/Worker/Main.html +0 -53
  227. package/dist/paperjs/examples/Worker/Worker.js +0 -14
  228. package/dist/paperjs/examples/css/style.css +0 -12
@@ -1,1825 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="UTF-8">
5
- <title>Size</title>
6
- <base target="class-frame">
7
- <link href="../assets/css/docs.css" rel="stylesheet" type="text/css">
8
- <script src="../assets/js/paper.js"></script>
9
- <script src="../assets/js/jquery.js"></script>
10
- <script src="../assets/js/codemirror.js"></script>
11
- <script src="../assets/js/docs.js"></script>
12
- </head>
13
- <body>
14
- <article class="reference">
15
- <div class="reference-class">
16
- <h1>Size</h1>
17
-
18
- <p>The Size object is used to describe the size or dimensions of something, through its <a href="../classes/Size.html#width"><tt>width</tt></a> and <a href="../classes/Size.html#height"><tt>height</tt></a> properties.</p>
19
- <h4>Example:<span class="description">Create a size that is 10pt wide and 5pt high, and use it to define a rectangle:</span></h4>
20
-
21
-
22
- <pre><code>var size = new Size(10, 5);
23
- console.log(size.width); // 10
24
- console.log(size.height); // 5
25
- var rect = new Rectangle(new Point(20, 15), size);
26
- console.log(rect); // { x: 20, y: 15, width: 10, height: 5 }</code></pre>
27
-
28
- </div>
29
-
30
- <!-- =============================== constructors ========================== -->
31
- <div class="reference-members">
32
- <h2>Constructors</h2>
33
-
34
-
35
- <div id="size-width-height" class="member">
36
- <div class="member-link">
37
- <a name="size-width-height" href="#size-width-height"><tt><b>Size</b>(width, height)</tt></a>
38
- </div>
39
- <div class="member-description hidden">
40
- <div class="member-text">
41
- <p>Creates a Size object with the given width and height values.</p>
42
-
43
-
44
- <ul class="member-list">
45
- <h4>Parameters:</h4>
46
-
47
- <li>
48
- <tt>width:</tt>
49
- <tt>Number</tt>
50
- &mdash;&nbsp;the width
51
-
52
- </li>
53
-
54
- <li>
55
- <tt>height:</tt>
56
- <tt>Number</tt>
57
- &mdash;&nbsp;the height
58
-
59
- </li>
60
-
61
- </ul>
62
-
63
-
64
- <ul class="member-list">
65
- <h4>Returns:</h4>
66
-
67
- <li>
68
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
69
- </li>
70
-
71
-
72
- </ul>
73
-
74
-
75
-
76
-
77
- <h4>Example:<span class="description">Create a size that is 10pt wide and 5pt high</span></h4>
78
-
79
-
80
- <pre><code>var size = new Size(10, 5);
81
- console.log(size.width); // 10
82
- console.log(size.height); // 5</code></pre>
83
-
84
- </div>
85
- </div>
86
- </div>
87
-
88
-
89
- <div id="size-array" class="member">
90
- <div class="member-link">
91
- <a name="size-array" href="#size-array"><tt><b>Size</b>(array)</tt></a>
92
- </div>
93
- <div class="member-description hidden">
94
- <div class="member-text">
95
- <p>Creates a Size object using the numbers in the given array as dimensions.</p>
96
-
97
-
98
- <ul class="member-list">
99
- <h4>Parameters:</h4>
100
-
101
- <li>
102
- <tt>array:</tt>
103
- <tt>Array</tt>
104
-
105
-
106
- </li>
107
-
108
- </ul>
109
-
110
-
111
- <ul class="member-list">
112
- <h4>Returns:</h4>
113
-
114
- <li>
115
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
116
- </li>
117
-
118
-
119
- </ul>
120
-
121
-
122
-
123
-
124
- <h4>Example:<span class="description">Creating a size of width: 320, height: 240 using an array of numbers:</span></h4>
125
-
126
-
127
- <pre><code>var array = [320, 240];
128
- var size = new Size(array);
129
- console.log(size.width); // 320
130
- console.log(size.height); // 240</code></pre>
131
-
132
- </div>
133
- </div>
134
- </div>
135
-
136
-
137
- <div id="size-object" class="member">
138
- <div class="member-link">
139
- <a name="size-object" href="#size-object"><tt><b>Size</b>(object)</tt></a>
140
- </div>
141
- <div class="member-description hidden">
142
- <div class="member-text">
143
- <p>Creates a Size object using the properties in the given object.</p>
144
-
145
-
146
- <ul class="member-list">
147
- <h4>Parameters:</h4>
148
-
149
- <li>
150
- <tt>object:</tt>
151
- <tt>Object</tt>
152
-
153
-
154
- </li>
155
-
156
- </ul>
157
-
158
-
159
- <ul class="member-list">
160
- <h4>Returns:</h4>
161
-
162
- <li>
163
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
164
- </li>
165
-
166
-
167
- </ul>
168
-
169
-
170
-
171
-
172
- <h4>Example:<span class="description">Creating a size of width: 10, height: 20 using an object literal:</span></h4>
173
-
174
-
175
- <pre><code>var size = new Size({
176
- width: 10,
177
- height: 20
178
- });
179
- console.log(size.width); // 10
180
- console.log(size.height); // 20</code></pre>
181
-
182
- </div>
183
- </div>
184
- </div>
185
-
186
-
187
- <div id="size-size" class="member">
188
- <div class="member-link">
189
- <a name="size-size" href="#size-size"><tt><b>Size</b>(size)</tt></a>
190
- </div>
191
- <div class="member-description hidden">
192
- <div class="member-text">
193
- <p>Creates a Size object using the coordinates of the given Size object.</p>
194
-
195
-
196
- <ul class="member-list">
197
- <h4>Parameters:</h4>
198
-
199
- <li>
200
- <tt>size:</tt>
201
- <a href="../classes/Size.html"><tt>Size</tt></a>
202
-
203
-
204
- </li>
205
-
206
- </ul>
207
-
208
-
209
- <ul class="member-list">
210
- <h4>Returns:</h4>
211
-
212
- <li>
213
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
214
- </li>
215
-
216
-
217
- </ul>
218
-
219
-
220
-
221
-
222
-
223
- </div>
224
- </div>
225
- </div>
226
-
227
-
228
- <div id="size-point" class="member">
229
- <div class="member-link">
230
- <a name="size-point" href="#size-point"><tt><b>Size</b>(point)</tt></a>
231
- </div>
232
- <div class="member-description hidden">
233
- <div class="member-text">
234
- <p>Creates a Size object using the <a href="../classes/Point.html#x"><tt>point.x</tt></a> and <a href="../classes/Point.html#y"><tt>point.y</tt></a> values of the given Point object.</p>
235
-
236
-
237
- <ul class="member-list">
238
- <h4>Parameters:</h4>
239
-
240
- <li>
241
- <tt>point:</tt>
242
- <a href="../classes/Point.html"><tt>Point</tt></a>
243
-
244
-
245
- </li>
246
-
247
- </ul>
248
-
249
-
250
- <ul class="member-list">
251
- <h4>Returns:</h4>
252
-
253
- <li>
254
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
255
- </li>
256
-
257
-
258
- </ul>
259
-
260
-
261
-
262
-
263
- <h4>Example:</h4>
264
-
265
-
266
- <pre><code>var point = new Point(50, 50);
267
- var size = new Size(point);
268
- console.log(size.width); // 50
269
- console.log(size.height); // 50</code></pre>
270
-
271
- </div>
272
- </div>
273
- </div>
274
-
275
- </div>
276
-
277
-
278
-
279
- <!-- ================================ operators ============================ -->
280
- <div class="reference-members">
281
- <h2>Operators</h2>
282
-
283
- <div id="add" class="member">
284
- <div class="member-link">
285
- <a name="add" href="#add"><tt><tt><b>+</b>number</tt>, <tt><b>+</b>size</tt></tt></a>
286
- </div>
287
- <div class="member-description hidden">
288
-
289
-
290
- <div class="member-text">
291
- <p>Returns the addition of the supplied value to the width and height of the size as a new size. The object itself is not modified!</p>
292
-
293
- <ul class="member-list">
294
- <h4>Parameters:</h4>
295
-
296
- <li>
297
- <tt>number:</tt>
298
- <tt>Number</tt>
299
- &mdash;&nbsp;the number to add
300
-
301
- </li>
302
-
303
- </ul>
304
-
305
-
306
- <ul class="member-list">
307
- <h4>Returns:</h4>
308
-
309
- <li>
310
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the addition of the size and the value as a new size
311
- </li>
312
-
313
-
314
- </ul>
315
-
316
-
317
-
318
-
319
- <h4>Example:</h4>
320
-
321
-
322
- <pre><code>var size = new Size(5, 10);
323
- var result = size + 20;
324
- console.log(result); // {width: 25, height: 30}</code></pre>
325
-
326
- </div>
327
-
328
-
329
-
330
- <div class="member-text">
331
- <p>Returns the addition of the width and height of the supplied size to the size as a new size. The object itself is not modified!</p>
332
-
333
- <ul class="member-list">
334
- <h4>Parameters:</h4>
335
-
336
- <li>
337
- <tt>size:</tt>
338
- <a href="../classes/Size.html"><tt>Size</tt></a>
339
- &mdash;&nbsp;the size to add
340
-
341
- </li>
342
-
343
- </ul>
344
-
345
-
346
- <ul class="member-list">
347
- <h4>Returns:</h4>
348
-
349
- <li>
350
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the addition of the two sizes as a new size
351
- </li>
352
-
353
-
354
- </ul>
355
-
356
-
357
-
358
-
359
- <h4>Example:</h4>
360
-
361
-
362
- <pre><code>var size1 = new Size(5, 10);
363
- var size2 = new Size(10, 20);
364
- var result = size1 + size2;
365
- console.log(result); // {width: 15, height: 30}</code></pre>
366
-
367
- </div>
368
-
369
-
370
- </div>
371
- </div>
372
-
373
-
374
- <div id="subtract" class="member">
375
- <div class="member-link">
376
- <a name="subtract" href="#subtract"><tt><tt><b>-</b>number</tt>, <tt><b>-</b>size</tt></tt></a>
377
- </div>
378
- <div class="member-description hidden">
379
-
380
-
381
- <div class="member-text">
382
- <p>Returns the subtraction of the supplied value from the width and height of the size as a new size. The object itself is not modified! The object itself is not modified!</p>
383
-
384
- <ul class="member-list">
385
- <h4>Parameters:</h4>
386
-
387
- <li>
388
- <tt>number:</tt>
389
- <tt>Number</tt>
390
- &mdash;&nbsp;the number to subtract
391
-
392
- </li>
393
-
394
- </ul>
395
-
396
-
397
- <ul class="member-list">
398
- <h4>Returns:</h4>
399
-
400
- <li>
401
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the subtraction of the size and the value as a new size
402
- </li>
403
-
404
-
405
- </ul>
406
-
407
-
408
-
409
-
410
- <h4>Example:</h4>
411
-
412
-
413
- <pre><code>var size = new Size(10, 20);
414
- var result = size - 5;
415
- console.log(result); // {width: 5, height: 15}</code></pre>
416
-
417
- </div>
418
-
419
-
420
-
421
- <div class="member-text">
422
- <p>Returns the subtraction of the width and height of the supplied size from the size as a new size. The object itself is not modified!</p>
423
-
424
- <ul class="member-list">
425
- <h4>Parameters:</h4>
426
-
427
- <li>
428
- <tt>size:</tt>
429
- <a href="../classes/Size.html"><tt>Size</tt></a>
430
- &mdash;&nbsp;the size to subtract
431
-
432
- </li>
433
-
434
- </ul>
435
-
436
-
437
- <ul class="member-list">
438
- <h4>Returns:</h4>
439
-
440
- <li>
441
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the subtraction of the two sizes as a new size
442
- </li>
443
-
444
-
445
- </ul>
446
-
447
-
448
-
449
-
450
- <h4>Example:</h4>
451
-
452
-
453
- <pre><code>var firstSize = new Size(10, 20);
454
- var secondSize = new Size(5, 5);
455
- var result = firstSize - secondSize;
456
- console.log(result); // {width: 5, height: 15}</code></pre>
457
-
458
- </div>
459
-
460
-
461
- </div>
462
- </div>
463
-
464
-
465
- <div id="multiply" class="member">
466
- <div class="member-link">
467
- <a name="multiply" href="#multiply"><tt><tt><b>*</b>number</tt>, <tt><b>*</b>size</tt></tt></a>
468
- </div>
469
- <div class="member-description hidden">
470
-
471
-
472
- <div class="member-text">
473
- <p>Returns the multiplication of the supplied value with the width and height of the size as a new size. The object itself is not modified!</p>
474
-
475
- <ul class="member-list">
476
- <h4>Parameters:</h4>
477
-
478
- <li>
479
- <tt>number:</tt>
480
- <tt>Number</tt>
481
- &mdash;&nbsp;the number to multiply by
482
-
483
- </li>
484
-
485
- </ul>
486
-
487
-
488
- <ul class="member-list">
489
- <h4>Returns:</h4>
490
-
491
- <li>
492
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the multiplication of the size and the value as a new size
493
- </li>
494
-
495
-
496
- </ul>
497
-
498
-
499
-
500
-
501
- <h4>Example:</h4>
502
-
503
-
504
- <pre><code>var size = new Size(10, 20);
505
- var result = size * 2;
506
- console.log(result); // {width: 20, height: 40}</code></pre>
507
-
508
- </div>
509
-
510
-
511
-
512
- <div class="member-text">
513
- <p>Returns the multiplication of the width and height of the supplied size with the size as a new size. The object itself is not modified!</p>
514
-
515
- <ul class="member-list">
516
- <h4>Parameters:</h4>
517
-
518
- <li>
519
- <tt>size:</tt>
520
- <a href="../classes/Size.html"><tt>Size</tt></a>
521
- &mdash;&nbsp;the size to multiply by
522
-
523
- </li>
524
-
525
- </ul>
526
-
527
-
528
- <ul class="member-list">
529
- <h4>Returns:</h4>
530
-
531
- <li>
532
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the multiplication of the two sizes as a new size
533
- </li>
534
-
535
-
536
- </ul>
537
-
538
-
539
-
540
-
541
- <h4>Example:</h4>
542
-
543
-
544
- <pre><code>var firstSize = new Size(5, 10);
545
- var secondSize = new Size(4, 2);
546
- var result = firstSize * secondSize;
547
- console.log(result); // {width: 20, height: 20}</code></pre>
548
-
549
- </div>
550
-
551
-
552
- </div>
553
- </div>
554
-
555
-
556
- <div id="divide" class="member">
557
- <div class="member-link">
558
- <a name="divide" href="#divide"><tt><tt><b>/</b>number</tt>, <tt><b>/</b>size</tt></tt></a>
559
- </div>
560
- <div class="member-description hidden">
561
-
562
-
563
- <div class="member-text">
564
- <p>Returns the division of the supplied value by the width and height of the size as a new size. The object itself is not modified!</p>
565
-
566
- <ul class="member-list">
567
- <h4>Parameters:</h4>
568
-
569
- <li>
570
- <tt>number:</tt>
571
- <tt>Number</tt>
572
- &mdash;&nbsp;the number to divide by
573
-
574
- </li>
575
-
576
- </ul>
577
-
578
-
579
- <ul class="member-list">
580
- <h4>Returns:</h4>
581
-
582
- <li>
583
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the division of the size and the value as a new size
584
- </li>
585
-
586
-
587
- </ul>
588
-
589
-
590
-
591
-
592
- <h4>Example:</h4>
593
-
594
-
595
- <pre><code>var size = new Size(10, 20);
596
- var result = size / 2;
597
- console.log(result); // {width: 5, height: 10}</code></pre>
598
-
599
- </div>
600
-
601
-
602
-
603
- <div class="member-text">
604
- <p>Returns the division of the width and height of the supplied size by the size as a new size. The object itself is not modified!</p>
605
-
606
- <ul class="member-list">
607
- <h4>Parameters:</h4>
608
-
609
- <li>
610
- <tt>size:</tt>
611
- <a href="../classes/Size.html"><tt>Size</tt></a>
612
- &mdash;&nbsp;the size to divide by
613
-
614
- </li>
615
-
616
- </ul>
617
-
618
-
619
- <ul class="member-list">
620
- <h4>Returns:</h4>
621
-
622
- <li>
623
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the division of the two sizes as a new size
624
- </li>
625
-
626
-
627
- </ul>
628
-
629
-
630
-
631
-
632
- <h4>Example:</h4>
633
-
634
-
635
- <pre><code>var firstSize = new Size(8, 10);
636
- var secondSize = new Size(2, 5);
637
- var result = firstSize / secondSize;
638
- console.log(result); // {width: 4, height: 2}</code></pre>
639
-
640
- </div>
641
-
642
-
643
- </div>
644
- </div>
645
-
646
-
647
- <div id="modulo" class="member">
648
- <div class="member-link">
649
- <a name="modulo" href="#modulo"><tt><tt><b>%</b>number</tt>, <tt><b>%</b>size</tt></tt></a>
650
- </div>
651
- <div class="member-description hidden">
652
-
653
-
654
- <div class="member-text">
655
- <p>The modulo operator returns the integer remainders of dividing the size by the supplied value as a new size.</p>
656
-
657
- <ul class="member-list">
658
- <h4>Parameters:</h4>
659
-
660
- <li>
661
- <tt>value:</tt>
662
- <tt>Number</tt>
663
-
664
-
665
- </li>
666
-
667
- </ul>
668
-
669
-
670
- <ul class="member-list">
671
- <h4>Returns:</h4>
672
-
673
- <li>
674
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the integer remainders of dividing the size by the value as a new size
675
- </li>
676
-
677
-
678
- </ul>
679
-
680
-
681
-
682
-
683
- <h4>Example:</h4>
684
-
685
-
686
- <pre><code>var size = new Size(12, 6);
687
- console.log(size % 5); // {width: 2, height: 1}</code></pre>
688
-
689
- </div>
690
-
691
-
692
-
693
- <div class="member-text">
694
- <p>The modulo operator returns the integer remainders of dividing the size by the supplied size as a new size.</p>
695
-
696
- <ul class="member-list">
697
- <h4>Parameters:</h4>
698
-
699
- <li>
700
- <tt>size:</tt>
701
- <a href="../classes/Size.html"><tt>Size</tt></a>
702
-
703
-
704
- </li>
705
-
706
- </ul>
707
-
708
-
709
- <ul class="member-list">
710
- <h4>Returns:</h4>
711
-
712
- <li>
713
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the integer remainders of dividing the sizes by each other as a new size
714
- </li>
715
-
716
-
717
- </ul>
718
-
719
-
720
-
721
-
722
- <h4>Example:</h4>
723
-
724
-
725
- <pre><code>var size = new Size(12, 6);
726
- console.log(size % new Size(5, 2)); // {width: 2, height: 0}</code></pre>
727
-
728
- </div>
729
-
730
-
731
- </div>
732
- </div>
733
-
734
-
735
- </div>
736
-
737
-
738
-
739
- <!-- ================================ properties =========================== -->
740
- <div class="reference-members">
741
- <h2>Properties</h2>
742
-
743
-
744
- <div id="width" class="member">
745
- <div class="member-link">
746
- <a name="width" href="#width"><tt><b>width</b></tt></a>
747
- </div>
748
- <div class="member-description hidden">
749
-
750
- <div class="member-text">
751
- <p>The width of the size</p>
752
-
753
-
754
-
755
- <ul class="member-list">
756
- <h4>Type:</h4>
757
- <li>
758
- <tt>Number</tt>
759
- </li>
760
- </ul>
761
-
762
-
763
-
764
- </div>
765
-
766
- </div>
767
- </div>
768
-
769
-
770
- <div id="height" class="member">
771
- <div class="member-link">
772
- <a name="height" href="#height"><tt><b>height</b></tt></a>
773
- </div>
774
- <div class="member-description hidden">
775
-
776
- <div class="member-text">
777
- <p>The height of the size</p>
778
-
779
-
780
-
781
- <ul class="member-list">
782
- <h4>Type:</h4>
783
- <li>
784
- <tt>Number</tt>
785
- </li>
786
- </ul>
787
-
788
-
789
-
790
- </div>
791
-
792
- </div>
793
- </div>
794
-
795
- </div>
796
-
797
-
798
-
799
-
800
-
801
- <!-- ============================== methods ================================ -->
802
- <div class="reference-members">
803
- <h2>Methods</h2>
804
-
805
-
806
- <div id="set-values" class="member">
807
- <div class="member-link">
808
- <a name="set-values" href="#set-values"><tt><b>set</b>(...values)</tt></a>
809
- </div>
810
- <div class="member-description hidden">
811
- <div class="member-text">
812
- <p>Sets the size to the passed values. Note that any sequence of parameters that is supported by the various <a href="../classes/Size.html"><tt>Size</tt></a>() constructors also work for calls of <code>set()</code>.</p>
813
-
814
-
815
- <ul class="member-list">
816
- <h4>Parameters:</h4>
817
-
818
- <li>
819
- <tt>values:</tt>
820
- <tt>any value</tt>
821
-
822
-
823
- </li>
824
-
825
- </ul>
826
-
827
-
828
- <ul class="member-list">
829
- <h4>Returns:</h4>
830
-
831
- <li>
832
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
833
- </li>
834
-
835
-
836
- </ul>
837
-
838
-
839
-
840
-
841
-
842
- </div>
843
- </div>
844
- </div>
845
-
846
-
847
- <div id="equals-size" class="member">
848
- <div class="member-link">
849
- <a name="equals-size" href="#equals-size"><tt><b>equals</b>(size)</tt></a>
850
- </div>
851
- <div class="member-description hidden">
852
- <div class="member-text">
853
- <p>Checks whether the width and height of the size are equal to those of the supplied size.</p>
854
-
855
-
856
- <ul class="member-list">
857
- <h4>Parameters:</h4>
858
-
859
- <li>
860
- <tt>size:</tt>
861
- <a href="../classes/Size.html"><tt>Size</tt></a>
862
- &mdash;&nbsp;the size to compare to
863
-
864
- </li>
865
-
866
- </ul>
867
-
868
-
869
- <ul class="member-list">
870
- <h4>Returns:</h4>
871
-
872
- <li>
873
- <tt><tt>Boolean</tt></tt>
874
- </li>
875
-
876
-
877
- </ul>
878
-
879
-
880
-
881
-
882
- <h4>Example:</h4>
883
-
884
-
885
- <pre><code>var size = new Size(5, 10);
886
- console.log(size == new Size(5, 10)); // true
887
- console.log(size == new Size(1, 1)); // false
888
- console.log(size != new Size(1, 1)); // true</code></pre>
889
-
890
- </div>
891
- </div>
892
- </div>
893
-
894
-
895
- <div id="clone" class="member">
896
- <div class="member-link">
897
- <a name="clone" href="#clone"><tt><b>clone</b>()</tt></a>
898
- </div>
899
- <div class="member-description hidden">
900
- <div class="member-text">
901
- <p>Returns a copy of the size.</p>
902
-
903
-
904
-
905
- <ul class="member-list">
906
- <h4>Returns:</h4>
907
-
908
- <li>
909
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
910
- </li>
911
-
912
-
913
- </ul>
914
-
915
-
916
-
917
-
918
-
919
- </div>
920
- </div>
921
- </div>
922
-
923
-
924
- <div id="tostring" class="member">
925
- <div class="member-link">
926
- <a name="tostring" href="#tostring"><tt><b>toString</b>()</tt></a>
927
- </div>
928
- <div class="member-description hidden">
929
- <div class="member-text">
930
-
931
-
932
-
933
-
934
- <ul class="member-list">
935
- <h4>Returns:</h4>
936
-
937
- <li>
938
- <tt><tt>String</tt></tt>&nbsp;&mdash;&nbsp;a string representation of the size
939
- </li>
940
-
941
-
942
- </ul>
943
-
944
-
945
-
946
-
947
-
948
- </div>
949
- </div>
950
- </div>
951
-
952
-
953
- <h3>Tests</h3>
954
-
955
- <div id="iszero" class="member">
956
- <div class="member-link">
957
- <a name="iszero" href="#iszero"><tt><b>isZero</b>()</tt></a>
958
- </div>
959
- <div class="member-description hidden">
960
- <div class="member-text">
961
- <p>Checks if this size has both the width and height set to 0.</p>
962
-
963
-
964
-
965
- <ul class="member-list">
966
- <h4>Returns:</h4>
967
-
968
- <li>
969
- <tt><tt>Boolean</tt></tt>&nbsp;&mdash;&nbsp;<tt>true</tt> if both width and height are 0, <tt>false</tt> otherwise
970
- </li>
971
-
972
-
973
- </ul>
974
-
975
-
976
-
977
-
978
-
979
- </div>
980
- </div>
981
- </div>
982
-
983
-
984
- <div id="isnan" class="member">
985
- <div class="member-link">
986
- <a name="isnan" href="#isnan"><tt><b>isNaN</b>()</tt></a>
987
- </div>
988
- <div class="member-description hidden">
989
- <div class="member-text">
990
- <p>Checks if the width or the height of the size are NaN.</p>
991
-
992
-
993
-
994
- <ul class="member-list">
995
- <h4>Returns:</h4>
996
-
997
- <li>
998
- <tt><tt>Boolean</tt></tt>&nbsp;&mdash;&nbsp;<tt>true</tt> if the width or height of the size are NaN, <tt>false</tt> otherwise
999
- </li>
1000
-
1001
-
1002
- </ul>
1003
-
1004
-
1005
-
1006
-
1007
-
1008
- </div>
1009
- </div>
1010
- </div>
1011
-
1012
-
1013
- <h3>Math Functions</h3>
1014
-
1015
- <div id="round" class="member">
1016
- <div class="member-link">
1017
- <a name="round" href="#round"><tt><b>round</b>()</tt></a>
1018
- </div>
1019
- <div class="member-description hidden">
1020
- <div class="member-text">
1021
- <p>Returns a new size with rounded <a href="../classes/Size.html#width"><tt>width</tt></a> and <a href="../classes/Size.html#height"><tt>height</tt></a> values. The object itself is not modified!</p>
1022
-
1023
-
1024
-
1025
- <ul class="member-list">
1026
- <h4>Returns:</h4>
1027
-
1028
- <li>
1029
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
1030
- </li>
1031
-
1032
-
1033
- </ul>
1034
-
1035
-
1036
-
1037
-
1038
- <h4>Example:</h4>
1039
-
1040
-
1041
- <pre><code>var size = new Size(10.2, 10.9);
1042
- var roundSize = size.round();
1043
- console.log(roundSize); // {x: 10, y: 11}</code></pre>
1044
-
1045
- </div>
1046
- </div>
1047
- </div>
1048
-
1049
-
1050
- <div id="ceil" class="member">
1051
- <div class="member-link">
1052
- <a name="ceil" href="#ceil"><tt><b>ceil</b>()</tt></a>
1053
- </div>
1054
- <div class="member-description hidden">
1055
- <div class="member-text">
1056
- <p>Returns a new size with the nearest greater non-fractional values to the specified <a href="../classes/Size.html#width"><tt>width</tt></a> and <a href="../classes/Size.html#height"><tt>height</tt></a> values. The object itself is not modified!</p>
1057
-
1058
-
1059
-
1060
- <ul class="member-list">
1061
- <h4>Returns:</h4>
1062
-
1063
- <li>
1064
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
1065
- </li>
1066
-
1067
-
1068
- </ul>
1069
-
1070
-
1071
-
1072
-
1073
- <h4>Example:</h4>
1074
-
1075
-
1076
- <pre><code>var size = new Size(10.2, 10.9);
1077
- var ceilSize = size.ceil();
1078
- console.log(ceilSize); // {x: 11, y: 11}</code></pre>
1079
-
1080
- </div>
1081
- </div>
1082
- </div>
1083
-
1084
-
1085
- <div id="floor" class="member">
1086
- <div class="member-link">
1087
- <a name="floor" href="#floor"><tt><b>floor</b>()</tt></a>
1088
- </div>
1089
- <div class="member-description hidden">
1090
- <div class="member-text">
1091
- <p>Returns a new size with the nearest smaller non-fractional values to the specified <a href="../classes/Size.html#width"><tt>width</tt></a> and <a href="../classes/Size.html#height"><tt>height</tt></a> values. The object itself is not modified!</p>
1092
-
1093
-
1094
-
1095
- <ul class="member-list">
1096
- <h4>Returns:</h4>
1097
-
1098
- <li>
1099
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
1100
- </li>
1101
-
1102
-
1103
- </ul>
1104
-
1105
-
1106
-
1107
-
1108
- <h4>Example:</h4>
1109
-
1110
-
1111
- <pre><code>var size = new Size(10.2, 10.9);
1112
- var floorSize = size.floor();
1113
- console.log(floorSize); // {x: 10, y: 10}</code></pre>
1114
-
1115
- </div>
1116
- </div>
1117
- </div>
1118
-
1119
-
1120
- <div id="abs" class="member">
1121
- <div class="member-link">
1122
- <a name="abs" href="#abs"><tt><b>abs</b>()</tt></a>
1123
- </div>
1124
- <div class="member-description hidden">
1125
- <div class="member-text">
1126
- <p>Returns a new size with the absolute values of the specified <a href="../classes/Size.html#width"><tt>width</tt></a> and <a href="../classes/Size.html#height"><tt>height</tt></a> values. The object itself is not modified!</p>
1127
-
1128
-
1129
-
1130
- <ul class="member-list">
1131
- <h4>Returns:</h4>
1132
-
1133
- <li>
1134
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>
1135
- </li>
1136
-
1137
-
1138
- </ul>
1139
-
1140
-
1141
-
1142
-
1143
- <h4>Example:</h4>
1144
-
1145
-
1146
- <pre><code>var size = new Size(-5, 10);
1147
- var absSize = size.abs();
1148
- console.log(absSize); // {x: 5, y: 10}</code></pre>
1149
-
1150
- </div>
1151
- </div>
1152
- </div>
1153
-
1154
-
1155
-
1156
- <h3>Math Operator Functions</h3>
1157
-
1158
-
1159
-
1160
- <div id="add-number" class="member">
1161
- <div class="member-link">
1162
- <a name="add-number" href="#add-number"><tt><b>add</b>(number)</tt></a>
1163
- </div>
1164
- <div class="member-description hidden">
1165
- <div class="member-text">
1166
- <p>Returns the addition of the supplied value to the width and height of the size as a new size. The object itself is not modified!</p>
1167
-
1168
-
1169
- <ul class="member-list">
1170
- <h4>Parameters:</h4>
1171
-
1172
- <li>
1173
- <tt>number:</tt>
1174
- <tt>Number</tt>
1175
- &mdash;&nbsp;the number to add
1176
-
1177
- </li>
1178
-
1179
- </ul>
1180
-
1181
-
1182
- <ul class="member-list">
1183
- <h4>Returns:</h4>
1184
-
1185
- <li>
1186
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the addition of the size and the value as a new size
1187
- </li>
1188
-
1189
-
1190
- </ul>
1191
-
1192
-
1193
-
1194
-
1195
- <h4>Example:</h4>
1196
-
1197
-
1198
- <pre><code>var size = new Size(5, 10);
1199
- var result = size + 20;
1200
- console.log(result); // {width: 25, height: 30}</code></pre>
1201
-
1202
- </div>
1203
- </div>
1204
- </div>
1205
-
1206
-
1207
- <div id="add-size" class="member">
1208
- <div class="member-link">
1209
- <a name="add-size" href="#add-size"><tt><b>add</b>(size)</tt></a>
1210
- </div>
1211
- <div class="member-description hidden">
1212
- <div class="member-text">
1213
- <p>Returns the addition of the width and height of the supplied size to the size as a new size. The object itself is not modified!</p>
1214
-
1215
-
1216
- <ul class="member-list">
1217
- <h4>Parameters:</h4>
1218
-
1219
- <li>
1220
- <tt>size:</tt>
1221
- <a href="../classes/Size.html"><tt>Size</tt></a>
1222
- &mdash;&nbsp;the size to add
1223
-
1224
- </li>
1225
-
1226
- </ul>
1227
-
1228
-
1229
- <ul class="member-list">
1230
- <h4>Returns:</h4>
1231
-
1232
- <li>
1233
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the addition of the two sizes as a new size
1234
- </li>
1235
-
1236
-
1237
- </ul>
1238
-
1239
-
1240
-
1241
-
1242
- <h4>Example:</h4>
1243
-
1244
-
1245
- <pre><code>var size1 = new Size(5, 10);
1246
- var size2 = new Size(10, 20);
1247
- var result = size1 + size2;
1248
- console.log(result); // {width: 15, height: 30}</code></pre>
1249
-
1250
- </div>
1251
- </div>
1252
- </div>
1253
-
1254
-
1255
-
1256
-
1257
-
1258
- <div id="subtract-number" class="member">
1259
- <div class="member-link">
1260
- <a name="subtract-number" href="#subtract-number"><tt><b>subtract</b>(number)</tt></a>
1261
- </div>
1262
- <div class="member-description hidden">
1263
- <div class="member-text">
1264
- <p>Returns the subtraction of the supplied value from the width and height of the size as a new size. The object itself is not modified! The object itself is not modified!</p>
1265
-
1266
-
1267
- <ul class="member-list">
1268
- <h4>Parameters:</h4>
1269
-
1270
- <li>
1271
- <tt>number:</tt>
1272
- <tt>Number</tt>
1273
- &mdash;&nbsp;the number to subtract
1274
-
1275
- </li>
1276
-
1277
- </ul>
1278
-
1279
-
1280
- <ul class="member-list">
1281
- <h4>Returns:</h4>
1282
-
1283
- <li>
1284
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the subtraction of the size and the value as a new size
1285
- </li>
1286
-
1287
-
1288
- </ul>
1289
-
1290
-
1291
-
1292
-
1293
- <h4>Example:</h4>
1294
-
1295
-
1296
- <pre><code>var size = new Size(10, 20);
1297
- var result = size - 5;
1298
- console.log(result); // {width: 5, height: 15}</code></pre>
1299
-
1300
- </div>
1301
- </div>
1302
- </div>
1303
-
1304
-
1305
- <div id="subtract-size" class="member">
1306
- <div class="member-link">
1307
- <a name="subtract-size" href="#subtract-size"><tt><b>subtract</b>(size)</tt></a>
1308
- </div>
1309
- <div class="member-description hidden">
1310
- <div class="member-text">
1311
- <p>Returns the subtraction of the width and height of the supplied size from the size as a new size. The object itself is not modified!</p>
1312
-
1313
-
1314
- <ul class="member-list">
1315
- <h4>Parameters:</h4>
1316
-
1317
- <li>
1318
- <tt>size:</tt>
1319
- <a href="../classes/Size.html"><tt>Size</tt></a>
1320
- &mdash;&nbsp;the size to subtract
1321
-
1322
- </li>
1323
-
1324
- </ul>
1325
-
1326
-
1327
- <ul class="member-list">
1328
- <h4>Returns:</h4>
1329
-
1330
- <li>
1331
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the subtraction of the two sizes as a new size
1332
- </li>
1333
-
1334
-
1335
- </ul>
1336
-
1337
-
1338
-
1339
-
1340
- <h4>Example:</h4>
1341
-
1342
-
1343
- <pre><code>var firstSize = new Size(10, 20);
1344
- var secondSize = new Size(5, 5);
1345
- var result = firstSize - secondSize;
1346
- console.log(result); // {width: 5, height: 15}</code></pre>
1347
-
1348
- </div>
1349
- </div>
1350
- </div>
1351
-
1352
-
1353
-
1354
-
1355
-
1356
- <div id="multiply-number" class="member">
1357
- <div class="member-link">
1358
- <a name="multiply-number" href="#multiply-number"><tt><b>multiply</b>(number)</tt></a>
1359
- </div>
1360
- <div class="member-description hidden">
1361
- <div class="member-text">
1362
- <p>Returns the multiplication of the supplied value with the width and height of the size as a new size. The object itself is not modified!</p>
1363
-
1364
-
1365
- <ul class="member-list">
1366
- <h4>Parameters:</h4>
1367
-
1368
- <li>
1369
- <tt>number:</tt>
1370
- <tt>Number</tt>
1371
- &mdash;&nbsp;the number to multiply by
1372
-
1373
- </li>
1374
-
1375
- </ul>
1376
-
1377
-
1378
- <ul class="member-list">
1379
- <h4>Returns:</h4>
1380
-
1381
- <li>
1382
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the multiplication of the size and the value as a new size
1383
- </li>
1384
-
1385
-
1386
- </ul>
1387
-
1388
-
1389
-
1390
-
1391
- <h4>Example:</h4>
1392
-
1393
-
1394
- <pre><code>var size = new Size(10, 20);
1395
- var result = size * 2;
1396
- console.log(result); // {width: 20, height: 40}</code></pre>
1397
-
1398
- </div>
1399
- </div>
1400
- </div>
1401
-
1402
-
1403
- <div id="multiply-size" class="member">
1404
- <div class="member-link">
1405
- <a name="multiply-size" href="#multiply-size"><tt><b>multiply</b>(size)</tt></a>
1406
- </div>
1407
- <div class="member-description hidden">
1408
- <div class="member-text">
1409
- <p>Returns the multiplication of the width and height of the supplied size with the size as a new size. The object itself is not modified!</p>
1410
-
1411
-
1412
- <ul class="member-list">
1413
- <h4>Parameters:</h4>
1414
-
1415
- <li>
1416
- <tt>size:</tt>
1417
- <a href="../classes/Size.html"><tt>Size</tt></a>
1418
- &mdash;&nbsp;the size to multiply by
1419
-
1420
- </li>
1421
-
1422
- </ul>
1423
-
1424
-
1425
- <ul class="member-list">
1426
- <h4>Returns:</h4>
1427
-
1428
- <li>
1429
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the multiplication of the two sizes as a new size
1430
- </li>
1431
-
1432
-
1433
- </ul>
1434
-
1435
-
1436
-
1437
-
1438
- <h4>Example:</h4>
1439
-
1440
-
1441
- <pre><code>var firstSize = new Size(5, 10);
1442
- var secondSize = new Size(4, 2);
1443
- var result = firstSize * secondSize;
1444
- console.log(result); // {width: 20, height: 20}</code></pre>
1445
-
1446
- </div>
1447
- </div>
1448
- </div>
1449
-
1450
-
1451
-
1452
-
1453
-
1454
- <div id="divide-number" class="member">
1455
- <div class="member-link">
1456
- <a name="divide-number" href="#divide-number"><tt><b>divide</b>(number)</tt></a>
1457
- </div>
1458
- <div class="member-description hidden">
1459
- <div class="member-text">
1460
- <p>Returns the division of the supplied value by the width and height of the size as a new size. The object itself is not modified!</p>
1461
-
1462
-
1463
- <ul class="member-list">
1464
- <h4>Parameters:</h4>
1465
-
1466
- <li>
1467
- <tt>number:</tt>
1468
- <tt>Number</tt>
1469
- &mdash;&nbsp;the number to divide by
1470
-
1471
- </li>
1472
-
1473
- </ul>
1474
-
1475
-
1476
- <ul class="member-list">
1477
- <h4>Returns:</h4>
1478
-
1479
- <li>
1480
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the division of the size and the value as a new size
1481
- </li>
1482
-
1483
-
1484
- </ul>
1485
-
1486
-
1487
-
1488
-
1489
- <h4>Example:</h4>
1490
-
1491
-
1492
- <pre><code>var size = new Size(10, 20);
1493
- var result = size / 2;
1494
- console.log(result); // {width: 5, height: 10}</code></pre>
1495
-
1496
- </div>
1497
- </div>
1498
- </div>
1499
-
1500
-
1501
- <div id="divide-size" class="member">
1502
- <div class="member-link">
1503
- <a name="divide-size" href="#divide-size"><tt><b>divide</b>(size)</tt></a>
1504
- </div>
1505
- <div class="member-description hidden">
1506
- <div class="member-text">
1507
- <p>Returns the division of the width and height of the supplied size by the size as a new size. The object itself is not modified!</p>
1508
-
1509
-
1510
- <ul class="member-list">
1511
- <h4>Parameters:</h4>
1512
-
1513
- <li>
1514
- <tt>size:</tt>
1515
- <a href="../classes/Size.html"><tt>Size</tt></a>
1516
- &mdash;&nbsp;the size to divide by
1517
-
1518
- </li>
1519
-
1520
- </ul>
1521
-
1522
-
1523
- <ul class="member-list">
1524
- <h4>Returns:</h4>
1525
-
1526
- <li>
1527
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the division of the two sizes as a new size
1528
- </li>
1529
-
1530
-
1531
- </ul>
1532
-
1533
-
1534
-
1535
-
1536
- <h4>Example:</h4>
1537
-
1538
-
1539
- <pre><code>var firstSize = new Size(8, 10);
1540
- var secondSize = new Size(2, 5);
1541
- var result = firstSize / secondSize;
1542
- console.log(result); // {width: 4, height: 2}</code></pre>
1543
-
1544
- </div>
1545
- </div>
1546
- </div>
1547
-
1548
-
1549
-
1550
-
1551
-
1552
- <div id="modulo-value" class="member">
1553
- <div class="member-link">
1554
- <a name="modulo-value" href="#modulo-value"><tt><b>modulo</b>(value)</tt></a>
1555
- </div>
1556
- <div class="member-description hidden">
1557
- <div class="member-text">
1558
- <p>The modulo operator returns the integer remainders of dividing the size by the supplied value as a new size.</p>
1559
-
1560
-
1561
- <ul class="member-list">
1562
- <h4>Parameters:</h4>
1563
-
1564
- <li>
1565
- <tt>value:</tt>
1566
- <tt>Number</tt>
1567
-
1568
-
1569
- </li>
1570
-
1571
- </ul>
1572
-
1573
-
1574
- <ul class="member-list">
1575
- <h4>Returns:</h4>
1576
-
1577
- <li>
1578
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the integer remainders of dividing the size by the value as a new size
1579
- </li>
1580
-
1581
-
1582
- </ul>
1583
-
1584
-
1585
-
1586
-
1587
- <h4>Example:</h4>
1588
-
1589
-
1590
- <pre><code>var size = new Size(12, 6);
1591
- console.log(size % 5); // {width: 2, height: 1}</code></pre>
1592
-
1593
- </div>
1594
- </div>
1595
- </div>
1596
-
1597
-
1598
- <div id="modulo-size" class="member">
1599
- <div class="member-link">
1600
- <a name="modulo-size" href="#modulo-size"><tt><b>modulo</b>(size)</tt></a>
1601
- </div>
1602
- <div class="member-description hidden">
1603
- <div class="member-text">
1604
- <p>The modulo operator returns the integer remainders of dividing the size by the supplied size as a new size.</p>
1605
-
1606
-
1607
- <ul class="member-list">
1608
- <h4>Parameters:</h4>
1609
-
1610
- <li>
1611
- <tt>size:</tt>
1612
- <a href="../classes/Size.html"><tt>Size</tt></a>
1613
-
1614
-
1615
- </li>
1616
-
1617
- </ul>
1618
-
1619
-
1620
- <ul class="member-list">
1621
- <h4>Returns:</h4>
1622
-
1623
- <li>
1624
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the integer remainders of dividing the sizes by each other as a new size
1625
- </li>
1626
-
1627
-
1628
- </ul>
1629
-
1630
-
1631
-
1632
-
1633
- <h4>Example:</h4>
1634
-
1635
-
1636
- <pre><code>var size = new Size(12, 6);
1637
- console.log(size % new Size(5, 2)); // {width: 2, height: 0}</code></pre>
1638
-
1639
- </div>
1640
- </div>
1641
- </div>
1642
-
1643
-
1644
-
1645
-
1646
- </div>
1647
-
1648
-
1649
- <div class="reference-members">
1650
- <h2>Static Methods</h2>
1651
-
1652
-
1653
- <div id="min-size1-size2" class="member">
1654
- <div class="member-link">
1655
- <a name="min-size1-size2" href="#min-size1-size2"><tt><b>Size.min</b>(size1, size2)</tt></a>
1656
- </div>
1657
- <div class="member-description hidden">
1658
- <div class="member-text">
1659
- <p>Returns a new size object with the smallest <a href="../classes/Size.html#width"><tt>width</tt></a> and <a href="../classes/Size.html#height"><tt>height</tt></a> of the supplied sizes.</p>
1660
-
1661
-
1662
- <ul class="member-list">
1663
- <h4>Parameters:</h4>
1664
-
1665
- <li>
1666
- <tt>size1:</tt>
1667
- <a href="../classes/Size.html"><tt>Size</tt></a>
1668
-
1669
-
1670
- </li>
1671
-
1672
- <li>
1673
- <tt>size2:</tt>
1674
- <a href="../classes/Size.html"><tt>Size</tt></a>
1675
-
1676
-
1677
- </li>
1678
-
1679
- </ul>
1680
-
1681
-
1682
- <ul class="member-list">
1683
- <h4>Returns:</h4>
1684
-
1685
- <li>
1686
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the newly created size object
1687
- </li>
1688
-
1689
-
1690
- </ul>
1691
-
1692
-
1693
-
1694
-
1695
- <h4>Example:</h4>
1696
-
1697
-
1698
- <pre><code>var size1 = new Size(10, 100);
1699
- var size2 = new Size(200, 5);
1700
- var minSize = Size.min(size1, size2);
1701
- console.log(minSize); // {width: 10, height: 5}</code></pre>
1702
-
1703
- <h4>Example:<span class="description">Find the minimum of multiple sizes:</span></h4>
1704
-
1705
-
1706
- <pre><code>var size1 = new Size(60, 100);
1707
- var size2 = new Size(200, 5);
1708
- var size3 = new Size(250, 35);
1709
- [size1, size2, size3].reduce(Size.min) // {width: 60, height: 5}</code></pre>
1710
-
1711
- </div>
1712
- </div>
1713
- </div>
1714
-
1715
-
1716
- <div id="max-size1-size2" class="member">
1717
- <div class="member-link">
1718
- <a name="max-size1-size2" href="#max-size1-size2"><tt><b>Size.max</b>(size1, size2)</tt></a>
1719
- </div>
1720
- <div class="member-description hidden">
1721
- <div class="member-text">
1722
- <p>Returns a new size object with the largest <a href="../classes/Size.html#width"><tt>width</tt></a> and <a href="../classes/Size.html#height"><tt>height</tt></a> of the supplied sizes.</p>
1723
-
1724
-
1725
- <ul class="member-list">
1726
- <h4>Parameters:</h4>
1727
-
1728
- <li>
1729
- <tt>size1:</tt>
1730
- <a href="../classes/Size.html"><tt>Size</tt></a>
1731
-
1732
-
1733
- </li>
1734
-
1735
- <li>
1736
- <tt>size2:</tt>
1737
- <a href="../classes/Size.html"><tt>Size</tt></a>
1738
-
1739
-
1740
- </li>
1741
-
1742
- </ul>
1743
-
1744
-
1745
- <ul class="member-list">
1746
- <h4>Returns:</h4>
1747
-
1748
- <li>
1749
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the newly created size object
1750
- </li>
1751
-
1752
-
1753
- </ul>
1754
-
1755
-
1756
-
1757
-
1758
- <h4>Example:</h4>
1759
-
1760
-
1761
- <pre><code>var size1 = new Size(10, 100);
1762
- var size2 = new Size(200, 5);
1763
- var maxSize = Size.max(size1, size2);
1764
- console.log(maxSize); // {width: 200, height: 100}</code></pre>
1765
-
1766
- <h4>Example:<span class="description">Find the maximum of multiple sizes:</span></h4>
1767
-
1768
-
1769
- <pre><code>var size1 = new Size(60, 100);
1770
- var size2 = new Size(200, 5);
1771
- var size3 = new Size(250, 35);
1772
- [size1, size2, size3].reduce(Size.max) // {width: 250, height: 100}</code></pre>
1773
-
1774
- </div>
1775
- </div>
1776
- </div>
1777
-
1778
-
1779
- <div id="random" class="member">
1780
- <div class="member-link">
1781
- <a name="random" href="#random"><tt><b>Size.random</b>()</tt></a>
1782
- </div>
1783
- <div class="member-description hidden">
1784
- <div class="member-text">
1785
- <p>Returns a size object with random <a href="../classes/Size.html#width"><tt>width</tt></a> and <a href="../classes/Size.html#height"><tt>height</tt></a> values between <code>0</code> and <code>1</code>.</p>
1786
-
1787
-
1788
-
1789
- <ul class="member-list">
1790
- <h4>Returns:</h4>
1791
-
1792
- <li>
1793
- <tt><a href="../classes/Size.html"><tt>Size</tt></a></tt>&nbsp;&mdash;&nbsp;the newly created size object
1794
- </li>
1795
-
1796
-
1797
- </ul>
1798
-
1799
-
1800
-
1801
-
1802
- <h4>Example:</h4>
1803
-
1804
-
1805
- <pre><code>var maxSize = new Size(100, 100);
1806
- var randomSize = Size.random();
1807
- var size = maxSize * randomSize;</code></pre>
1808
-
1809
- </div>
1810
- </div>
1811
- </div>
1812
-
1813
- </div>
1814
-
1815
-
1816
-
1817
- <!-- =========================== copyright notice ========================== -->
1818
- <p class="footer">
1819
- Paper.js v0.12.17<br>
1820
- Copyright &#169; 2011—2022 <a href="http://www.lehni.org" target="_blank">J&uuml;rg Lehni</a> &amp; <a href="http://www.jonathanpuckey.com" target="_blank">Jonathan Puckey</a>. All Rights Reserved.</p>
1821
- <div class="content-end"></div>
1822
-
1823
-
1824
- </article>
1825
- </body>