fabric 5.3.0-browser → 6.0.0-beta1

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 (533) hide show
  1. package/.babelrc +11 -0
  2. package/.babelrcAlt +19 -0
  3. package/.browserslistrc +5 -0
  4. package/.eslintrc.js +43 -0
  5. package/.eslintrc.json +38 -46
  6. package/.eslintrc_tests +12 -0
  7. package/.gitattributes +2 -0
  8. package/.prettierignore +16 -0
  9. package/.prettierrc +4 -0
  10. package/CHANGELOG.md +491 -189
  11. package/CONTRIBUTING.md +226 -58
  12. package/README.md +188 -239
  13. package/bower.json +1 -3
  14. package/dist/fabric.d.ts +1021 -0
  15. package/dist/index.cjs +28027 -0
  16. package/dist/index.cjs.map +1 -0
  17. package/dist/index.d.ts +2 -0
  18. package/dist/index.min.js +1 -0
  19. package/dist/index.mjs +27964 -0
  20. package/dist/index.mjs.map +1 -0
  21. package/dist/index.node.cjs +28092 -0
  22. package/dist/index.node.cjs.map +1 -0
  23. package/dist/index.node.d.ts +15 -0
  24. package/dist/index.node.mjs +28035 -0
  25. package/dist/index.node.mjs.map +1 -0
  26. package/dist/src/Collection.d.ts +126 -0
  27. package/dist/src/CommonMethods.d.ts +32 -0
  28. package/dist/src/EventTypeDefs.d.ts +226 -0
  29. package/dist/src/Intersection.d.ts +100 -0
  30. package/dist/src/Observable.d.ts +54 -0
  31. package/dist/src/Pattern.d.ts +104 -0
  32. package/dist/src/Point.d.ts +232 -0
  33. package/dist/src/Shadow.d.ts +87 -0
  34. package/dist/src/brushes/BaseBrush.d.ts +105 -0
  35. package/dist/src/brushes/CircleBrush.d.ts +49 -0
  36. package/dist/src/brushes/PatternBrush.d.ts +23 -0
  37. package/dist/src/brushes/PencilBrush.d.ts +92 -0
  38. package/dist/src/brushes/SprayBrush.d.ts +79 -0
  39. package/dist/src/cache.d.ts +46 -0
  40. package/dist/src/canvas/Canvas.d.ts +567 -0
  41. package/dist/src/canvas/SelectableCanvas.d.ts +723 -0
  42. package/dist/src/canvas/StaticCanvas.d.ts +751 -0
  43. package/dist/src/canvas/TextEditingManager.d.ts +17 -0
  44. package/dist/src/canvas/canvas_gestures.mixin.d.ts +2 -0
  45. package/dist/src/color/Color.d.ts +174 -0
  46. package/dist/src/color/color_map.d.ts +155 -0
  47. package/dist/src/color/constants.d.ts +22 -0
  48. package/dist/src/color/util.d.ts +12 -0
  49. package/dist/src/config.d.ts +115 -0
  50. package/dist/src/constants.d.ts +14 -0
  51. package/dist/src/controls/Control.d.ts +228 -0
  52. package/dist/src/controls/changeWidth.d.ts +13 -0
  53. package/dist/src/controls/controls.render.d.ts +29 -0
  54. package/dist/src/controls/default_controls.d.ts +50 -0
  55. package/dist/src/controls/drag.d.ts +12 -0
  56. package/dist/src/controls/polyControl.d.ts +5 -0
  57. package/dist/src/controls/rotate.d.ts +12 -0
  58. package/dist/src/controls/scale.d.ts +47 -0
  59. package/dist/src/controls/scaleSkew.d.ts +39 -0
  60. package/dist/src/controls/skew.d.ts +33 -0
  61. package/dist/src/controls/util.d.ts +41 -0
  62. package/dist/src/controls/wrapWithFireEvent.d.ts +8 -0
  63. package/dist/src/controls/wrapWithFixedAnchor.d.ts +9 -0
  64. package/dist/src/env/browser.d.ts +3 -0
  65. package/dist/src/env/index.d.ts +7 -0
  66. package/dist/src/env/node.d.ts +3 -0
  67. package/dist/src/env/types.d.ts +15 -0
  68. package/dist/src/filters/BaseFilter.d.ts +156 -0
  69. package/dist/src/filters/BlendColor.d.ts +80 -0
  70. package/dist/src/filters/BlendImage.d.ts +90 -0
  71. package/dist/src/filters/Blur.d.ts +50 -0
  72. package/dist/src/filters/Boilerplate.d.ts +46 -0
  73. package/dist/src/filters/Brightness.d.ts +46 -0
  74. package/dist/src/filters/Canvas2dFilterBackend.d.ts +27 -0
  75. package/dist/src/filters/ColorMatrix.d.ts +62 -0
  76. package/dist/src/filters/ColorMatrixFilters.d.ts +1169 -0
  77. package/dist/src/filters/Composed.d.ts +47 -0
  78. package/dist/src/filters/Contrast.d.ts +44 -0
  79. package/dist/src/filters/Convolute.d.ts +82 -0
  80. package/dist/src/filters/FilterBackend.d.ts +14 -0
  81. package/dist/src/filters/Gamma.d.ts +53 -0
  82. package/dist/src/filters/Grayscale.d.ts +45 -0
  83. package/dist/src/filters/HueRotation.d.ts +24 -0
  84. package/dist/src/filters/Invert.d.ts +54 -0
  85. package/dist/src/filters/Noise.d.ts +53 -0
  86. package/dist/src/filters/Pixelate.d.ts +43 -0
  87. package/dist/src/filters/RemoveColor.d.ts +62 -0
  88. package/dist/src/filters/Resize.d.ts +134 -0
  89. package/dist/src/filters/Saturation.d.ts +47 -0
  90. package/dist/src/filters/Vibrance.d.ts +47 -0
  91. package/dist/src/filters/WebGLFilterBackend.d.ts +126 -0
  92. package/dist/src/filters/WebGLProbe.d.ts +28 -0
  93. package/dist/src/filters/typedefs.d.ts +49 -0
  94. package/dist/src/gradient/Gradient.d.ts +149 -0
  95. package/dist/src/gradient/constants.d.ts +15 -0
  96. package/dist/src/gradient/parser/index.d.ts +4 -0
  97. package/dist/src/gradient/parser/misc.d.ts +4 -0
  98. package/dist/src/gradient/parser/parseColorStops.d.ts +6 -0
  99. package/dist/src/gradient/parser/parseCoords.d.ts +17 -0
  100. package/dist/src/gradient/typedefs.d.ts +93 -0
  101. package/dist/src/mixins/eraser_brush.mixin.d.ts +2 -0
  102. package/dist/src/mixins/stateful.mixin.d.ts +18 -0
  103. package/dist/src/parkinglot/canvas_animation.mixin.d.ts +2 -0
  104. package/dist/src/parkinglot/straighten.d.ts +2 -0
  105. package/dist/src/parser/applyViewboxTransform.d.ts +5 -0
  106. package/dist/src/parser/attributes.d.ts +6 -0
  107. package/dist/src/parser/constants.d.ts +54 -0
  108. package/dist/src/parser/doesSomeParentMatch.d.ts +2 -0
  109. package/dist/src/parser/elementById.d.ts +6 -0
  110. package/dist/src/parser/elementMatchesRule.d.ts +5 -0
  111. package/dist/src/parser/elements_parser.d.ts +3 -0
  112. package/dist/src/parser/getCSSRules.d.ts +7 -0
  113. package/dist/src/parser/getGlobalStylesForElement.d.ts +5 -0
  114. package/dist/src/parser/getGradientDefs.d.ts +7 -0
  115. package/dist/src/parser/getMultipleNodes.d.ts +2 -0
  116. package/dist/src/parser/getSvgRegex.d.ts +2 -0
  117. package/dist/src/parser/hasAncestorWithNodeName.d.ts +2 -0
  118. package/dist/src/parser/loadSVGFromString.d.ts +12 -0
  119. package/dist/src/parser/loadSVGFromURL.d.ts +13 -0
  120. package/dist/src/parser/normalizeAttr.d.ts +2 -0
  121. package/dist/src/parser/normalizeValue.d.ts +2 -0
  122. package/dist/src/parser/parseAttributes.d.ts +9 -0
  123. package/dist/src/parser/parseElements.d.ts +11 -0
  124. package/dist/src/parser/parseFontDeclaration.d.ts +10 -0
  125. package/dist/src/parser/parsePointsAttribute.d.ts +12 -0
  126. package/dist/src/parser/parseSVGDocument.d.ts +15 -0
  127. package/dist/src/parser/parseStyleAttribute.d.ts +9 -0
  128. package/dist/src/parser/parseStyleObject.d.ts +2 -0
  129. package/dist/src/parser/parseStyleString.d.ts +2 -0
  130. package/dist/src/parser/parseTransformAttribute.d.ts +10 -0
  131. package/dist/src/parser/parseUseDirectives.d.ts +2 -0
  132. package/dist/src/parser/percent.d.ts +9 -0
  133. package/dist/src/parser/recursivelyParseGradientsXlink.d.ts +2 -0
  134. package/dist/src/parser/rotateMatrix.d.ts +2 -0
  135. package/dist/src/parser/scaleMatrix.d.ts +2 -0
  136. package/dist/src/parser/selectorMatches.d.ts +2 -0
  137. package/dist/src/parser/setStrokeFillOpacity.d.ts +6 -0
  138. package/dist/src/parser/skewMatrix.d.ts +2 -0
  139. package/dist/src/parser/translateMatrix.d.ts +2 -0
  140. package/dist/src/shapes/ActiveSelection.d.ts +66 -0
  141. package/dist/src/shapes/Circle.d.ts +80 -0
  142. package/dist/src/shapes/Ellipse.d.ts +74 -0
  143. package/dist/src/shapes/Group.d.ts +381 -0
  144. package/dist/src/shapes/IText/DraggableTextDelegate.d.ts +78 -0
  145. package/dist/src/shapes/IText/IText.d.ts +322 -0
  146. package/dist/src/shapes/IText/ITextBehavior.d.ts +285 -0
  147. package/dist/src/shapes/IText/ITextClickBehavior.d.ts +81 -0
  148. package/dist/src/shapes/IText/ITextKeyBehavior.d.ts +193 -0
  149. package/dist/src/shapes/IText/constants.d.ts +13 -0
  150. package/dist/src/shapes/Image.d.ts +283 -0
  151. package/dist/src/shapes/Line.d.ts +117 -0
  152. package/dist/src/shapes/Object/AnimatableObject.d.ts +33 -0
  153. package/dist/src/shapes/Object/FabricObject.d.ts +9 -0
  154. package/dist/src/shapes/Object/FabricObjectSVGExportMixin.d.ts +74 -0
  155. package/dist/src/shapes/Object/InteractiveObject.d.ts +282 -0
  156. package/dist/src/shapes/Object/Object.d.ts +906 -0
  157. package/dist/src/shapes/Object/ObjectGeometry.d.ts +343 -0
  158. package/dist/src/shapes/Object/ObjectOrigin.d.ts +178 -0
  159. package/dist/src/shapes/Object/StackedObject.d.ts +62 -0
  160. package/dist/src/shapes/Object/defaultValues.d.ts +77 -0
  161. package/dist/src/shapes/Path.d.ts +123 -0
  162. package/dist/src/shapes/Polygon.d.ts +7 -0
  163. package/dist/src/shapes/Polyline.d.ts +130 -0
  164. package/dist/src/shapes/Rect.d.ts +62 -0
  165. package/dist/src/shapes/Text/StyledText.d.ts +118 -0
  166. package/dist/src/shapes/Text/Text.d.ts +656 -0
  167. package/dist/src/shapes/Text/TextSVGExportMixin.d.ts +32 -0
  168. package/dist/src/shapes/Textbox.d.ts +170 -0
  169. package/dist/src/shapes/Triangle.d.ts +17 -0
  170. package/dist/src/typedefs.d.ts +93 -0
  171. package/dist/src/util/animation/AnimationBase.d.ts +54 -0
  172. package/dist/src/util/animation/AnimationFrameProvider.d.ts +8 -0
  173. package/dist/src/util/animation/AnimationRegistry.d.ts +29 -0
  174. package/dist/src/util/animation/ArrayAnimation.d.ts +10 -0
  175. package/dist/src/util/animation/ColorAnimation.d.ts +11 -0
  176. package/dist/src/util/animation/ValueAnimation.d.ts +10 -0
  177. package/dist/src/util/animation/animate.d.ts +37 -0
  178. package/dist/src/util/animation/easing.d.ts +130 -0
  179. package/dist/src/util/animation/types.d.ts +87 -0
  180. package/dist/src/util/applyMixins.d.ts +8 -0
  181. package/dist/src/util/class_registry.d.ts +14 -0
  182. package/dist/src/util/dom_event.d.ts +5 -0
  183. package/dist/src/util/dom_misc.d.ts +40 -0
  184. package/dist/src/util/dom_request.d.ts +14 -0
  185. package/dist/src/util/dom_style.d.ts +7 -0
  186. package/dist/src/util/fireEvent.d.ts +3 -0
  187. package/dist/src/util/internals/cloneDeep.d.ts +2 -0
  188. package/dist/src/util/internals/getRandomInt.d.ts +8 -0
  189. package/dist/src/util/internals/ifNaN.d.ts +8 -0
  190. package/dist/src/util/internals/index.d.ts +4 -0
  191. package/dist/src/util/internals/removeFromArray.d.ts +9 -0
  192. package/dist/src/util/internals/uid.d.ts +2 -0
  193. package/dist/src/util/lang_class.d.ts +12 -0
  194. package/dist/src/util/lang_string.d.ts +22 -0
  195. package/dist/src/util/misc/boundingBoxFromPoints.d.ts +9 -0
  196. package/dist/src/util/misc/capValue.d.ts +2 -0
  197. package/dist/src/util/misc/cos.d.ts +10 -0
  198. package/dist/src/util/misc/dom.d.ts +28 -0
  199. package/dist/src/util/misc/findScaleTo.d.ts +29 -0
  200. package/dist/src/util/misc/groupSVGElements.d.ts +9 -0
  201. package/dist/src/util/misc/isTransparent.d.ts +11 -0
  202. package/dist/src/util/misc/matrix.d.ts +92 -0
  203. package/dist/src/util/misc/mergeClipPaths.d.ts +23 -0
  204. package/dist/src/util/misc/objectEnlive.d.ts +56 -0
  205. package/dist/src/util/misc/objectTransforms.d.ts +68 -0
  206. package/dist/src/util/misc/pick.d.ts +8 -0
  207. package/dist/src/util/misc/planeChange.d.ts +84 -0
  208. package/dist/src/util/misc/projectStroke/StrokeLineCapProjections.d.ts +51 -0
  209. package/dist/src/util/misc/projectStroke/StrokeLineJoinProjections.d.ts +81 -0
  210. package/dist/src/util/misc/projectStroke/StrokeProjectionsBase.d.ts +25 -0
  211. package/dist/src/util/misc/projectStroke/index.d.ts +11 -0
  212. package/dist/src/util/misc/projectStroke/types.d.ts +23 -0
  213. package/dist/src/util/misc/radiansDegreesConversion.d.ts +14 -0
  214. package/dist/src/util/misc/resolveOrigin.d.ts +9 -0
  215. package/dist/src/util/misc/rotatePoint.d.ts +12 -0
  216. package/dist/src/util/misc/sin.d.ts +10 -0
  217. package/dist/src/util/misc/svgParsing.d.ts +53 -0
  218. package/dist/src/util/misc/textStyles.d.ts +32 -0
  219. package/dist/src/util/misc/toFixed.d.ts +8 -0
  220. package/dist/src/util/misc/vectors.d.ts +57 -0
  221. package/dist/src/util/path.d.ts +108 -0
  222. package/dist/src/util/transform_matrix_removal.d.ts +14 -0
  223. package/dist/src/util/types.d.ts +19 -0
  224. package/fabric.ts +427 -0
  225. package/index.node.ts +43 -0
  226. package/index.ts +1 -0
  227. package/package.json +142 -88
  228. package/publish.js +0 -26
  229. package/rollup.config.mjs +79 -0
  230. package/rollup.test.config.js +24 -0
  231. package/scripts/build.mjs +50 -0
  232. package/scripts/buildLock.mjs +115 -0
  233. package/scripts/buildReporter.mjs +15 -0
  234. package/scripts/buildStats.mjs +139 -0
  235. package/scripts/dirname.mjs +14 -0
  236. package/scripts/index.mjs +679 -0
  237. package/scripts/transform_files.mjs +504 -0
  238. package/src/Collection.ts +311 -0
  239. package/src/CommonMethods.ts +63 -0
  240. package/src/EventTypeDefs.ts +294 -0
  241. package/src/Intersection.ts +273 -0
  242. package/src/Observable.ts +175 -0
  243. package/src/Pattern.ts +211 -0
  244. package/src/Point.ts +388 -0
  245. package/src/Shadow.ts +215 -0
  246. package/src/brushes/{base_brush.class.js → BaseBrush.ts} +65 -42
  247. package/src/brushes/CircleBrush.ts +145 -0
  248. package/src/brushes/PatternBrush.ts +70 -0
  249. package/src/brushes/PencilBrush.ts +300 -0
  250. package/src/brushes/SprayBrush.ts +219 -0
  251. package/src/cache.ts +89 -0
  252. package/src/canvas/Canvas.ts +1672 -0
  253. package/src/canvas/SelectableCanvas.ts +1636 -0
  254. package/src/canvas/StaticCanvas.ts +1709 -0
  255. package/src/canvas/TextEditingManager.ts +48 -0
  256. package/src/canvas/canvas_gestures.mixin.ts +207 -0
  257. package/src/color/Color.ts +404 -0
  258. package/src/color/color_map.ts +154 -0
  259. package/src/color/constants.ts +26 -0
  260. package/src/color/util.ts +32 -0
  261. package/src/config.ts +159 -0
  262. package/src/constants.ts +19 -0
  263. package/src/controls/Control.ts +377 -0
  264. package/src/controls/changeWidth.ts +52 -0
  265. package/src/controls/controls.render.ts +138 -0
  266. package/src/controls/default_controls.ts +132 -0
  267. package/src/controls/drag.ts +31 -0
  268. package/src/controls/polyControl.ts +135 -0
  269. package/src/controls/rotate.ts +87 -0
  270. package/src/controls/scale.ts +277 -0
  271. package/src/controls/scaleSkew.ts +92 -0
  272. package/src/controls/skew.ts +242 -0
  273. package/src/controls/util.ts +154 -0
  274. package/src/controls/wrapWithFireEvent.ts +25 -0
  275. package/src/controls/wrapWithFixedAnchor.ts +20 -0
  276. package/src/env/browser.ts +28 -0
  277. package/src/env/index.ts +19 -0
  278. package/src/env/node.ts +52 -0
  279. package/src/env/types.ts +15 -0
  280. package/src/filters/{base_filter.class.js → BaseFilter.ts} +201 -149
  281. package/src/filters/BlendColor.ts +258 -0
  282. package/src/filters/BlendImage.ts +254 -0
  283. package/src/filters/Blur.ts +202 -0
  284. package/src/filters/Boilerplate.ts +91 -0
  285. package/src/filters/Brightness.ts +93 -0
  286. package/src/filters/Canvas2dFilterBackend.ts +65 -0
  287. package/src/filters/ColorMatrix.ts +156 -0
  288. package/src/filters/ColorMatrixFilters.ts +106 -0
  289. package/src/filters/Composed.ts +85 -0
  290. package/src/filters/Contrast.ts +94 -0
  291. package/src/filters/Convolute.ts +341 -0
  292. package/src/filters/FilterBackend.ts +32 -0
  293. package/src/filters/Gamma.ts +127 -0
  294. package/src/filters/Grayscale.ts +137 -0
  295. package/src/filters/HueRotation.ts +66 -0
  296. package/src/filters/Invert.ts +117 -0
  297. package/src/filters/Noise.ts +109 -0
  298. package/src/filters/Pixelate.ts +114 -0
  299. package/src/filters/RemoveColor.ts +148 -0
  300. package/src/filters/Resize.ts +540 -0
  301. package/src/filters/Saturation.ts +100 -0
  302. package/src/filters/Vibrance.ts +103 -0
  303. package/src/filters/WebGLFilterBackend.ts +430 -0
  304. package/src/filters/WebGLProbe.ts +62 -0
  305. package/src/filters/typedefs.ts +65 -0
  306. package/src/gradient/Gradient.ts +401 -0
  307. package/src/gradient/constants.ts +12 -0
  308. package/src/gradient/parser/index.ts +3 -0
  309. package/src/gradient/parser/misc.ts +13 -0
  310. package/src/gradient/parser/parseColorStops.ts +55 -0
  311. package/src/gradient/parser/parseCoords.ts +73 -0
  312. package/src/gradient/typedefs.ts +104 -0
  313. package/src/mixins/{eraser_brush.mixin.js → eraser_brush.mixin.ts} +350 -239
  314. package/src/mixins/stateful.mixin.ts +104 -0
  315. package/src/parkinglot/canvas_animation.mixin.ts +121 -0
  316. package/src/parkinglot/straighten.ts +58 -0
  317. package/src/parser/applyViewboxTransform.ts +162 -0
  318. package/src/parser/attributes.ts +25 -0
  319. package/src/parser/constants.ts +118 -0
  320. package/src/parser/doesSomeParentMatch.ts +19 -0
  321. package/src/parser/elementById.ts +23 -0
  322. package/src/parser/elementMatchesRule.ts +19 -0
  323. package/src/parser/elements_parser.ts +191 -0
  324. package/src/parser/getCSSRules.ts +62 -0
  325. package/src/parser/getGlobalStylesForElement.ts +19 -0
  326. package/src/parser/getGradientDefs.ts +32 -0
  327. package/src/parser/getMultipleNodes.ts +15 -0
  328. package/src/parser/getSvgRegex.ts +5 -0
  329. package/src/parser/hasAncestorWithNodeName.ts +14 -0
  330. package/src/parser/loadSVGFromString.ts +26 -0
  331. package/src/parser/loadSVGFromURL.ts +40 -0
  332. package/src/parser/normalizeAttr.ts +10 -0
  333. package/src/parser/normalizeValue.ts +63 -0
  334. package/src/parser/parseAttributes.ts +90 -0
  335. package/src/parser/parseElements.ts +28 -0
  336. package/src/parser/parseFontDeclaration.ts +44 -0
  337. package/src/parser/parsePointsAttribute.ts +36 -0
  338. package/src/parser/parseSVGDocument.ts +106 -0
  339. package/src/parser/parseStyleAttribute.ts +27 -0
  340. package/src/parser/parseStyleObject.ts +15 -0
  341. package/src/parser/parseStyleString.ts +16 -0
  342. package/src/parser/parseTransformAttribute.ts +155 -0
  343. package/src/parser/parseUseDirectives.ts +79 -0
  344. package/src/parser/percent.ts +27 -0
  345. package/src/parser/recursivelyParseGradientsXlink.ts +42 -0
  346. package/src/parser/rotateMatrix.ts +21 -0
  347. package/src/parser/scaleMatrix.ts +9 -0
  348. package/src/parser/selectorMatches.ts +25 -0
  349. package/src/parser/setStrokeFillOpacity.ts +40 -0
  350. package/src/parser/skewMatrix.ts +6 -0
  351. package/src/parser/translateMatrix.ts +8 -0
  352. package/src/shapes/ActiveSelection.ts +157 -0
  353. package/src/shapes/Circle.ts +205 -0
  354. package/src/shapes/Ellipse.ts +154 -0
  355. package/src/shapes/Group.ts +1053 -0
  356. package/src/shapes/IText/DraggableTextDelegate.ts +394 -0
  357. package/src/shapes/IText/IText.ts +666 -0
  358. package/src/shapes/IText/ITextBehavior.ts +1055 -0
  359. package/src/shapes/IText/ITextClickBehavior.ts +321 -0
  360. package/src/shapes/IText/ITextKeyBehavior.ts +683 -0
  361. package/src/shapes/IText/constants.ts +47 -0
  362. package/src/shapes/Image.ts +789 -0
  363. package/src/shapes/Line.ts +329 -0
  364. package/src/shapes/Object/AnimatableObject.ts +106 -0
  365. package/src/shapes/Object/FabricObject.ts +19 -0
  366. package/src/shapes/Object/FabricObjectSVGExportMixin.ts +277 -0
  367. package/src/shapes/Object/InteractiveObject.ts +645 -0
  368. package/src/shapes/Object/Object.ts +1896 -0
  369. package/src/shapes/Object/ObjectGeometry.ts +830 -0
  370. package/src/shapes/Object/ObjectOrigin.ts +354 -0
  371. package/src/shapes/Object/StackedObject.ts +191 -0
  372. package/src/shapes/Object/defaultValues.ts +112 -0
  373. package/src/shapes/Path.ts +395 -0
  374. package/src/shapes/Polygon.ts +19 -0
  375. package/src/shapes/Polyline.ts +333 -0
  376. package/src/shapes/Rect.ts +199 -0
  377. package/src/shapes/Text/StyledText.ts +319 -0
  378. package/src/shapes/Text/Text.ts +1948 -0
  379. package/src/shapes/Text/TextSVGExportMixin.ts +288 -0
  380. package/src/shapes/Textbox.ts +471 -0
  381. package/src/shapes/Triangle.ts +45 -0
  382. package/src/typedefs.ts +119 -0
  383. package/src/util/animation/AnimationBase.ts +166 -0
  384. package/src/util/animation/AnimationFrameProvider.ts +28 -0
  385. package/src/util/animation/AnimationRegistry.ts +58 -0
  386. package/src/util/animation/ArrayAnimation.ts +27 -0
  387. package/src/util/animation/ColorAnimation.ts +74 -0
  388. package/src/util/animation/ValueAnimation.ts +29 -0
  389. package/src/util/animation/animate.ts +74 -0
  390. package/src/util/animation/easing.ts +327 -0
  391. package/src/util/animation/types.ts +136 -0
  392. package/src/util/applyMixins.ts +22 -0
  393. package/src/util/class_registry.ts +54 -0
  394. package/src/util/dom_event.ts +28 -0
  395. package/src/util/dom_misc.ts +138 -0
  396. package/src/util/dom_request.ts +64 -0
  397. package/src/util/dom_style.ts +20 -0
  398. package/src/util/fireEvent.ts +15 -0
  399. package/src/util/internals/cloneDeep.ts +2 -0
  400. package/src/util/internals/getRandomInt.ts +8 -0
  401. package/src/util/internals/ifNaN.ts +9 -0
  402. package/src/util/internals/index.ts +3 -0
  403. package/src/util/internals/removeFromArray.ts +14 -0
  404. package/src/util/internals/uid.ts +3 -0
  405. package/src/util/lang_class.ts +90 -0
  406. package/src/util/lang_string.ts +79 -0
  407. package/src/util/misc/boundingBoxFromPoints.ts +37 -0
  408. package/src/util/misc/capValue.ts +2 -0
  409. package/src/util/misc/cos.ts +24 -0
  410. package/src/util/misc/dom.ts +50 -0
  411. package/src/util/misc/findScaleTo.ts +44 -0
  412. package/src/util/misc/groupSVGElements.ts +15 -0
  413. package/src/util/misc/isTransparent.ts +51 -0
  414. package/src/util/misc/matrix.ts +207 -0
  415. package/src/util/misc/mergeClipPaths.ts +40 -0
  416. package/src/util/misc/objectEnlive.ts +189 -0
  417. package/src/util/misc/objectTransforms.ts +129 -0
  418. package/src/util/misc/pick.ts +17 -0
  419. package/src/util/misc/planeChange.ts +136 -0
  420. package/src/util/misc/projectStroke/StrokeLineCapProjections.ts +112 -0
  421. package/src/util/misc/projectStroke/StrokeLineJoinProjections.ts +231 -0
  422. package/src/util/misc/projectStroke/StrokeProjectionsBase.ts +75 -0
  423. package/src/util/misc/projectStroke/index.ts +53 -0
  424. package/src/util/misc/projectStroke/types.ts +24 -0
  425. package/src/util/misc/radiansDegreesConversion.ts +18 -0
  426. package/src/util/misc/resolveOrigin.ts +22 -0
  427. package/src/util/misc/rotatePoint.ts +15 -0
  428. package/src/util/misc/sin.ts +26 -0
  429. package/src/util/misc/svgParsing.ts +181 -0
  430. package/src/util/misc/textStyles.ts +133 -0
  431. package/src/util/misc/toFixed.ts +8 -0
  432. package/src/util/misc/vectors.ts +82 -0
  433. package/src/util/path.ts +941 -0
  434. package/src/util/transform_matrix_removal.ts +60 -0
  435. package/src/util/types.ts +78 -0
  436. package/tsconfig.json +106 -0
  437. package/HEADER.js +0 -203
  438. package/build.js +0 -287
  439. package/dist/fabric.js +0 -31187
  440. package/dist/fabric.min.js +0 -1
  441. package/old-travis-reference.yml +0 -97
  442. package/src/brushes/circle_brush.class.js +0 -144
  443. package/src/brushes/pattern_brush.class.js +0 -61
  444. package/src/brushes/pencil_brush.class.js +0 -310
  445. package/src/brushes/spray_brush.class.js +0 -219
  446. package/src/canvas.class.js +0 -1312
  447. package/src/color.class.js +0 -636
  448. package/src/control.class.js +0 -339
  449. package/src/controls.actions.js +0 -740
  450. package/src/controls.render.js +0 -99
  451. package/src/elements_parser.js +0 -152
  452. package/src/filters/2d_backend.class.js +0 -65
  453. package/src/filters/blendcolor_filter.class.js +0 -251
  454. package/src/filters/blendimage_filter.class.js +0 -247
  455. package/src/filters/blur_filter.class.js +0 -217
  456. package/src/filters/brightness_filter.class.js +0 -113
  457. package/src/filters/colormatrix_filter.class.js +0 -159
  458. package/src/filters/composed_filter.class.js +0 -72
  459. package/src/filters/contrast_filter.class.js +0 -113
  460. package/src/filters/convolute_filter.class.js +0 -352
  461. package/src/filters/filter_boilerplate.js +0 -111
  462. package/src/filters/filter_generator.js +0 -85
  463. package/src/filters/gamma_filter.class.js +0 -136
  464. package/src/filters/grayscale_filter.class.js +0 -154
  465. package/src/filters/hue_rotation.class.js +0 -107
  466. package/src/filters/invert_filter.class.js +0 -111
  467. package/src/filters/noise_filter.class.js +0 -134
  468. package/src/filters/pixelate_filter.class.js +0 -137
  469. package/src/filters/removecolor_filter.class.js +0 -173
  470. package/src/filters/resize_filter.class.js +0 -490
  471. package/src/filters/saturate_filter.class.js +0 -119
  472. package/src/filters/vibrance_filter.class.js +0 -122
  473. package/src/filters/webgl_backend.class.js +0 -396
  474. package/src/globalFabric.js +0 -4
  475. package/src/gradient.class.js +0 -490
  476. package/src/intersection.class.js +0 -172
  477. package/src/log.js +0 -11
  478. package/src/mixins/animation.mixin.js +0 -231
  479. package/src/mixins/canvas_dataurl_exporter.mixin.js +0 -97
  480. package/src/mixins/canvas_events.mixin.js +0 -974
  481. package/src/mixins/canvas_gestures.mixin.js +0 -149
  482. package/src/mixins/canvas_grouping.mixin.js +0 -177
  483. package/src/mixins/canvas_serialization.mixin.js +0 -228
  484. package/src/mixins/collection.mixin.js +0 -170
  485. package/src/mixins/default_controls.js +0 -114
  486. package/src/mixins/itext.svg_export.js +0 -241
  487. package/src/mixins/itext_behavior.mixin.js +0 -940
  488. package/src/mixins/itext_click_behavior.mixin.js +0 -278
  489. package/src/mixins/itext_key_behavior.mixin.js +0 -694
  490. package/src/mixins/object.svg_export.js +0 -258
  491. package/src/mixins/object_geometry.mixin.js +0 -683
  492. package/src/mixins/object_interactivity.mixin.js +0 -314
  493. package/src/mixins/object_origin.mixin.js +0 -255
  494. package/src/mixins/object_stacking.mixin.js +0 -80
  495. package/src/mixins/object_straightening.mixin.js +0 -80
  496. package/src/mixins/observable.mixin.js +0 -141
  497. package/src/mixins/shared_methods.mixin.js +0 -94
  498. package/src/mixins/stateful.mixin.js +0 -107
  499. package/src/mixins/text_style.mixin.js +0 -324
  500. package/src/parser.js +0 -1090
  501. package/src/pattern.class.js +0 -189
  502. package/src/point.class.js +0 -337
  503. package/src/shadow.class.js +0 -195
  504. package/src/shapes/active_selection.class.js +0 -155
  505. package/src/shapes/circle.class.js +0 -210
  506. package/src/shapes/ellipse.class.js +0 -181
  507. package/src/shapes/group.class.js +0 -593
  508. package/src/shapes/image.class.js +0 -764
  509. package/src/shapes/itext.class.js +0 -526
  510. package/src/shapes/line.class.js +0 -324
  511. package/src/shapes/object.class.js +0 -2008
  512. package/src/shapes/path.class.js +0 -384
  513. package/src/shapes/polygon.class.js +0 -81
  514. package/src/shapes/polyline.class.js +0 -268
  515. package/src/shapes/rect.class.js +0 -187
  516. package/src/shapes/text.class.js +0 -1696
  517. package/src/shapes/textbox.class.js +0 -461
  518. package/src/shapes/triangle.class.js +0 -93
  519. package/src/static_canvas.class.js +0 -1881
  520. package/src/util/anim_ease.js +0 -398
  521. package/src/util/animate.js +0 -254
  522. package/src/util/animate_color.js +0 -74
  523. package/src/util/dom_event.js +0 -50
  524. package/src/util/dom_misc.js +0 -300
  525. package/src/util/dom_request.js +0 -54
  526. package/src/util/dom_style.js +0 -70
  527. package/src/util/lang_array.js +0 -94
  528. package/src/util/lang_class.js +0 -115
  529. package/src/util/lang_object.js +0 -75
  530. package/src/util/lang_string.js +0 -110
  531. package/src/util/misc.js +0 -1330
  532. package/src/util/named_accessors.mixin.js +0 -428
  533. package/src/util/path.js +0 -829
@@ -0,0 +1,1636 @@
1
+ import { getEnv } from '../env';
2
+ import { dragHandler } from '../controls/drag';
3
+ import { getActionFromCorner } from '../controls/util';
4
+ import { Point } from '../Point';
5
+ import { FabricObject } from '../shapes/Object/FabricObject';
6
+ import {
7
+ CanvasEvents,
8
+ ModifierKey,
9
+ TOptionalModifierKey,
10
+ TPointerEvent,
11
+ Transform,
12
+ } from '../EventTypeDefs';
13
+ import {
14
+ addTransformToObject,
15
+ saveObjectTransform,
16
+ } from '../util/misc/objectTransforms';
17
+ import { StaticCanvas, TCanvasSizeOptions } from './StaticCanvas';
18
+ import {
19
+ isActiveSelection,
20
+ isCollection,
21
+ isFabricObjectCached,
22
+ } from '../util/types';
23
+ import { invertTransform, transformPoint } from '../util/misc/matrix';
24
+ import { isTransparent } from '../util/misc/isTransparent';
25
+ import { TMat2D, TOriginX, TOriginY, TSize } from '../typedefs';
26
+ import { degreesToRadians } from '../util/misc/radiansDegreesConversion';
27
+ import { getPointer, isTouchEvent } from '../util/dom_event';
28
+ import type { IText } from '../shapes/IText/IText';
29
+ import {
30
+ cleanUpJsdomNode,
31
+ makeElementUnselectable,
32
+ wrapElement,
33
+ } from '../util/dom_misc';
34
+ import { setStyle } from '../util/dom_style';
35
+ import type { BaseBrush } from '../brushes/BaseBrush';
36
+ import { pick } from '../util/misc/pick';
37
+ import { TSVGReviver } from '../typedefs';
38
+ import { sendPointToPlane } from '../util/misc/planeChange';
39
+
40
+ type TDestroyedCanvas = Omit<
41
+ SelectableCanvas<CanvasEvents>,
42
+ | 'contextTop'
43
+ | 'contextCache'
44
+ | 'lowerCanvasEl'
45
+ | 'upperCanvasEl'
46
+ | 'cacheCanvasEl'
47
+ | 'wrapperEl'
48
+ > & {
49
+ wrapperEl?: HTMLDivElement;
50
+ cacheCanvasEl?: HTMLCanvasElement;
51
+ upperCanvasEl?: HTMLCanvasElement;
52
+ lowerCanvasEl?: HTMLCanvasElement;
53
+ contextCache?: CanvasRenderingContext2D | null;
54
+ contextTop?: CanvasRenderingContext2D | null;
55
+ };
56
+
57
+ /**
58
+ * Canvas class
59
+ * @class Canvas
60
+ * @extends StaticCanvas
61
+ * @tutorial {@link http://fabricjs.com/fabric-intro-part-1#canvas}
62
+ *
63
+ * @fires object:modified at the end of a transform
64
+ * @fires object:rotating while an object is being rotated from the control
65
+ * @fires object:scaling while an object is being scaled by controls
66
+ * @fires object:moving while an object is being dragged
67
+ * @fires object:skewing while an object is being skewed from the controls
68
+ *
69
+ * @fires before:transform before a transform is is started
70
+ * @fires before:selection:cleared
71
+ * @fires selection:cleared
72
+ * @fires selection:updated
73
+ * @fires selection:created
74
+ *
75
+ * @fires path:created after a drawing operation ends and the path is added
76
+ * @fires mouse:down
77
+ * @fires mouse:move
78
+ * @fires mouse:up
79
+ * @fires mouse:down:before on mouse down, before the inner fabric logic runs
80
+ * @fires mouse:move:before on mouse move, before the inner fabric logic runs
81
+ * @fires mouse:up:before on mouse up, before the inner fabric logic runs
82
+ * @fires mouse:over
83
+ * @fires mouse:out
84
+ * @fires mouse:dblclick whenever a native dbl click event fires on the canvas.
85
+ *
86
+ * @fires dragover
87
+ * @fires dragenter
88
+ * @fires dragleave
89
+ * @fires drag:enter object drag enter
90
+ * @fires drag:leave object drag leave
91
+ * @fires drop:before before drop event. Prepare for the drop event (same native event).
92
+ * @fires drop
93
+ * @fires drop:after after drop event. Run logic on canvas after event has been accepted/declined (same native event).
94
+ * @example
95
+ * let a: fabric.Object, b: fabric.Object;
96
+ * let flag = false;
97
+ * canvas.add(a, b);
98
+ * a.on('drop:before', opt => {
99
+ * // we want a to accept the drop even though it's below b in the stack
100
+ * flag = this.canDrop(opt.e);
101
+ * });
102
+ * b.canDrop = function(e) {
103
+ * !flag && this.draggableTextDelegate.canDrop(e);
104
+ * }
105
+ * b.on('dragover', opt => b.set('fill', opt.dropTarget === b ? 'pink' : 'black'));
106
+ * a.on('drop', opt => {
107
+ * opt.e.defaultPrevented // drop occurred
108
+ * opt.didDrop // drop occurred on canvas
109
+ * opt.target // drop target
110
+ * opt.target !== a && a.set('text', 'I lost');
111
+ * });
112
+ * canvas.on('drop:after', opt => {
113
+ * // inform user who won
114
+ * if(!opt.e.defaultPrevented) {
115
+ * // no winners
116
+ * }
117
+ * else if(!opt.didDrop) {
118
+ * // my objects didn't win, some other lucky object
119
+ * }
120
+ * else {
121
+ * // we have a winner it's opt.target!!
122
+ * }
123
+ * })
124
+ *
125
+ * @fires after:render at the end of the render process, receives the context in the callback
126
+ * @fires before:render at start the render process, receives the context in the callback
127
+ *
128
+ * @fires contextmenu:before
129
+ * @fires contextmenu
130
+ * @example
131
+ * let handler;
132
+ * targets.forEach(target => {
133
+ * target.on('contextmenu:before', opt => {
134
+ * // decide which target should handle the event before canvas hijacks it
135
+ * if (someCaseHappens && opt.targets.includes(target)) {
136
+ * handler = target;
137
+ * }
138
+ * });
139
+ * target.on('contextmenu', opt => {
140
+ * // do something fantastic
141
+ * });
142
+ * });
143
+ * canvas.on('contextmenu', opt => {
144
+ * if (!handler) {
145
+ * // no one takes responsibility, it's always left to me
146
+ * // let's show them how it's done!
147
+ * }
148
+ * });
149
+ *
150
+ */
151
+ export class SelectableCanvas<
152
+ EventSpec extends CanvasEvents = CanvasEvents
153
+ > extends StaticCanvas<EventSpec> {
154
+ declare _objects: FabricObject[];
155
+ /**
156
+ * When true, objects can be transformed by one side (unproportionally)
157
+ * when dragged on the corners that normally would not do that.
158
+ * @type Boolean
159
+ * @default
160
+ * @since fabric 4.0 // changed name and default value
161
+ */
162
+ declare uniformScaling: boolean;
163
+
164
+ /**
165
+ * Indicates which key switches uniform scaling.
166
+ * values: 'altKey', 'shiftKey', 'ctrlKey'.
167
+ * If `null` or 'none' or any other string that is not a modifier key
168
+ * feature is disabled.
169
+ * totally wrong named. this sounds like `uniform scaling`
170
+ * if Canvas.uniformScaling is true, pressing this will set it to false
171
+ * and viceversa.
172
+ * @since 1.6.2
173
+ * @type ModifierKey
174
+ * @default
175
+ */
176
+ declare uniScaleKey: TOptionalModifierKey;
177
+
178
+ /**
179
+ * When true, objects use center point as the origin of scale transformation.
180
+ * <b>Backwards incompatibility note:</b> This property replaces "centerTransform" (Boolean).
181
+ * @since 1.3.4
182
+ * @type Boolean
183
+ * @default
184
+ */
185
+ declare centeredScaling: boolean;
186
+
187
+ /**
188
+ * When true, objects use center point as the origin of rotate transformation.
189
+ * <b>Backwards incompatibility note:</b> This property replaces "centerTransform" (Boolean).
190
+ * @since 1.3.4
191
+ * @type Boolean
192
+ * @default
193
+ */
194
+ declare centeredRotation: boolean;
195
+
196
+ /**
197
+ * Indicates which key enable centered Transform
198
+ * values: 'altKey', 'shiftKey', 'ctrlKey'.
199
+ * If `null` or 'none' or any other string that is not a modifier key
200
+ * feature is disabled feature disabled.
201
+ * @since 1.6.2
202
+ * @type ModifierKey
203
+ * @default
204
+ */
205
+ declare centeredKey: TOptionalModifierKey;
206
+
207
+ /**
208
+ * Indicates which key enable alternate action on corner
209
+ * values: 'altKey', 'shiftKey', 'ctrlKey'.
210
+ * If `null` or 'none' or any other string that is not a modifier key
211
+ * feature is disabled feature disabled.
212
+ * @since 1.6.2
213
+ * @type ModifierKey
214
+ * @default
215
+ */
216
+ declare altActionKey: TOptionalModifierKey;
217
+
218
+ /**
219
+ * Indicates that canvas is interactive. This property should not be changed.
220
+ * @type Boolean
221
+ * @default
222
+ */
223
+ interactive = true;
224
+
225
+ /**
226
+ * Indicates whether group selection should be enabled
227
+ * @type Boolean
228
+ * @default
229
+ */
230
+ declare selection: boolean;
231
+
232
+ /**
233
+ * Indicates which key or keys enable multiple click selection
234
+ * Pass value as a string or array of strings
235
+ * values: 'altKey', 'shiftKey', 'ctrlKey'.
236
+ * If `null` or empty or containing any other string that is not a modifier key
237
+ * feature is disabled.
238
+ * @since 1.6.2
239
+ * @type ModifierKey|ModifierKey[]
240
+ * @default
241
+ */
242
+ declare selectionKey: TOptionalModifierKey | ModifierKey[];
243
+
244
+ /**
245
+ * Indicates which key enable alternative selection
246
+ * in case of target overlapping with active object
247
+ * values: 'altKey', 'shiftKey', 'ctrlKey'.
248
+ * For a series of reason that come from the general expectations on how
249
+ * things should work, this feature works only for preserveObjectStacking true.
250
+ * If `null` or 'none' or any other string that is not a modifier key
251
+ * feature is disabled.
252
+ * @since 1.6.5
253
+ * @type null|ModifierKey
254
+ * @default
255
+ */
256
+ declare altSelectionKey: TOptionalModifierKey;
257
+
258
+ /**
259
+ * Color of selection
260
+ * @type String
261
+ * @default
262
+ */
263
+ declare selectionColor: string;
264
+
265
+ /**
266
+ * Default dash array pattern
267
+ * If not empty the selection border is dashed
268
+ * @type Array
269
+ */
270
+ declare selectionDashArray: number[];
271
+
272
+ /**
273
+ * Color of the border of selection (usually slightly darker than color of selection itself)
274
+ * @type String
275
+ * @default
276
+ */
277
+ declare selectionBorderColor: string;
278
+
279
+ /**
280
+ * Width of a line used in object/group selection
281
+ * @type Number
282
+ * @default
283
+ */
284
+ declare selectionLineWidth: number;
285
+
286
+ /**
287
+ * Select only shapes that are fully contained in the dragged selection rectangle.
288
+ * @type Boolean
289
+ * @default
290
+ */
291
+ declare selectionFullyContained: boolean;
292
+
293
+ /**
294
+ * Default cursor value used when hovering over an object on canvas
295
+ * @type CSSStyleDeclaration['cursor']
296
+ * @default move
297
+ */
298
+ declare hoverCursor: CSSStyleDeclaration['cursor'];
299
+
300
+ /**
301
+ * Default cursor value used when moving an object on canvas
302
+ * @type CSSStyleDeclaration['cursor']
303
+ * @default move
304
+ */
305
+ declare moveCursor: CSSStyleDeclaration['cursor'];
306
+
307
+ /**
308
+ * Default cursor value used for the entire canvas
309
+ * @type String
310
+ * @default default
311
+ */
312
+ declare defaultCursor: CSSStyleDeclaration['cursor'];
313
+
314
+ /**
315
+ * Cursor value used during free drawing
316
+ * @type String
317
+ * @default crosshair
318
+ */
319
+ declare freeDrawingCursor: CSSStyleDeclaration['cursor'];
320
+
321
+ /**
322
+ * Cursor value used for disabled elements ( corners with disabled action )
323
+ * @type String
324
+ * @since 2.0.0
325
+ * @default not-allowed
326
+ */
327
+ declare notAllowedCursor: CSSStyleDeclaration['cursor'];
328
+
329
+ /**
330
+ * Default element class that's given to wrapper (div) element of canvas
331
+ * @type String
332
+ * @default
333
+ */
334
+ declare containerClass: string;
335
+
336
+ /**
337
+ * When true, object detection happens on per-pixel basis rather than on per-bounding-box
338
+ * @type Boolean
339
+ * @default
340
+ */
341
+ declare perPixelTargetFind: boolean;
342
+
343
+ /**
344
+ * Number of pixels around target pixel to tolerate (consider active) during object detection
345
+ * @type Number
346
+ * @default
347
+ */
348
+ declare targetFindTolerance: number;
349
+
350
+ /**
351
+ * When true, target detection is skipped. Target detection will return always undefined.
352
+ * click selection won't work anymore, events will fire with no targets.
353
+ * if something is selected before setting it to true, it will be deselected at the first click.
354
+ * area selection will still work. check the `selection` property too.
355
+ * if you deactivate both, you should look into staticCanvas.
356
+ * @type Boolean
357
+ * @default
358
+ */
359
+ declare skipTargetFind: boolean;
360
+
361
+ /**
362
+ * When true, mouse events on canvas (mousedown/mousemove/mouseup) result in free drawing.
363
+ * After mousedown, mousemove creates a shape,
364
+ * and then mouseup finalizes it and adds an instance of `fabric.Path` onto canvas.
365
+ * @tutorial {@link http://fabricjs.com/fabric-intro-part-4#free_drawing}
366
+ * @type Boolean
367
+ * @default
368
+ */
369
+ declare isDrawingMode: boolean;
370
+
371
+ /**
372
+ * Indicates whether objects should remain in current stack position when selected.
373
+ * When false objects are brought to top and rendered as part of the selection group
374
+ * @type Boolean
375
+ * @default
376
+ */
377
+ declare preserveObjectStacking: boolean;
378
+
379
+ /**
380
+ * Indicates if the right click on canvas can output the context menu or not
381
+ * @type Boolean
382
+ * @since 1.6.5
383
+ * @default
384
+ */
385
+ declare stopContextMenu: boolean;
386
+
387
+ /**
388
+ * Indicates if the canvas can fire right click events
389
+ * @type Boolean
390
+ * @since 1.6.5
391
+ * @default
392
+ */
393
+ declare fireRightClick: boolean;
394
+
395
+ /**
396
+ * Indicates if the canvas can fire middle click events
397
+ * @type Boolean
398
+ * @since 1.7.8
399
+ * @default
400
+ */
401
+ declare fireMiddleClick: boolean;
402
+
403
+ /**
404
+ * Keep track of the subTargets for Mouse Events
405
+ * @type FabricObject[]
406
+ */
407
+ targets: FabricObject[] = [];
408
+
409
+ /**
410
+ * Keep track of the hovered target
411
+ * @type FabricObject | null
412
+ * @private
413
+ */
414
+ declare _hoveredTarget?: FabricObject;
415
+
416
+ /**
417
+ * hold the list of nested targets hovered
418
+ * @type FabricObject[]
419
+ * @private
420
+ */
421
+ _hoveredTargets: FabricObject[] = [];
422
+
423
+ /**
424
+ * hold the list of objects to render
425
+ * @type FabricObject[]
426
+ * @private
427
+ */
428
+ _objectsToRender?: FabricObject[] = [];
429
+
430
+ /**
431
+ * hold a referenfce to a data structure that contains information
432
+ * on the current on going transform
433
+ * @type
434
+ * @private
435
+ */
436
+ _currentTransform: Transform | null = null;
437
+
438
+ /**
439
+ * hold a reference to a data structure used to track the selecion
440
+ * box on canvas drag
441
+ * on the current on going transform
442
+ * @type
443
+ * @private
444
+ */
445
+ _groupSelector: any = null;
446
+
447
+ /**
448
+ * internal flag used to understand if the context top requires a cleanup
449
+ * in case this is true, the contextTop will be cleared at the next render
450
+ * @type boolean
451
+ * @private
452
+ */
453
+ contextTopDirty = false;
454
+
455
+ /**
456
+ * a reference to the context of an additional canvas that is used for scratch operations
457
+ * @TODOL This is created automatically when needed, while it shouldn't. is probably not even often needed
458
+ * and is a memory waste. We should either have one that gets added/deleted
459
+ * @type CanvasRenderingContext2D
460
+ * @private
461
+ */
462
+ declare contextCache: CanvasRenderingContext2D;
463
+
464
+ /**
465
+ * During a mouse event we may need the pointer multiple times in multiple functions.
466
+ * _absolutePointer holds a reference to the pointer in fabricCanvas/design coordinates that is valid for the event
467
+ * lifespan. Every fabricJS mouse event create and delete the cache every time
468
+ * We do this because there are some HTML DOM inspection functions to get the actual pointer coordinates
469
+ * @type {Point}
470
+ */
471
+ protected declare _absolutePointer?: Point;
472
+
473
+ /**
474
+ * During a mouse event we may need the pointer multiple times in multiple functions.
475
+ * _pointer holds a reference to the pointer in html coordinates that is valid for the event
476
+ * lifespan. Every fabricJS mouse event create and delete the cache every time
477
+ * We do this because there are some HTML DOM inspection functions to get the actual pointer coordinates
478
+ * @type {Point}
479
+ */
480
+ protected declare _pointer?: Point;
481
+
482
+ /**
483
+ * During a mouse event we may need the target multiple times in multiple functions.
484
+ * _target holds a reference to the target that is valid for the event
485
+ * lifespan. Every fabricJS mouse event create and delete the cache every time
486
+ * @type {FabricObject}
487
+ */
488
+ protected declare _target?: FabricObject;
489
+
490
+ declare upperCanvasEl: HTMLCanvasElement;
491
+ declare contextTop: CanvasRenderingContext2D;
492
+ declare wrapperEl: HTMLDivElement;
493
+ declare cacheCanvasEl: HTMLCanvasElement;
494
+ protected declare _isCurrentlyDrawing: boolean;
495
+ declare freeDrawingBrush?: BaseBrush;
496
+ declare _activeObject?: FabricObject;
497
+
498
+ protected initElements(el: string | HTMLCanvasElement) {
499
+ super.initElements(el);
500
+ this._applyCanvasStyle(this.lowerCanvasEl);
501
+ this._initWrapperElement();
502
+ this._createUpperCanvas();
503
+ this._createCacheCanvas();
504
+ }
505
+
506
+ protected _initRetinaScaling() {
507
+ super._initRetinaScaling();
508
+ this.__initRetinaScaling(this.upperCanvasEl, this.contextTop);
509
+ }
510
+
511
+ /**
512
+ * @private
513
+ * @param {FabricObject} obj Object that was added
514
+ */
515
+ _onObjectAdded(obj: FabricObject) {
516
+ this._objectsToRender = undefined;
517
+ super._onObjectAdded(obj);
518
+ }
519
+
520
+ /**
521
+ * @private
522
+ * @param {FabricObject} obj Object that was removed
523
+ */
524
+ _onObjectRemoved(obj: FabricObject) {
525
+ this._objectsToRender = undefined;
526
+ // removing active object should fire "selection:cleared" events
527
+ if (obj === this._activeObject) {
528
+ this.fire('before:selection:cleared', { deselected: [obj] });
529
+ this._discardActiveObject();
530
+ this.fire('selection:cleared', { deselected: [obj] });
531
+ obj.fire('deselected', {
532
+ target: obj,
533
+ });
534
+ }
535
+ if (obj === this._hoveredTarget) {
536
+ this._hoveredTarget = undefined;
537
+ this._hoveredTargets = [];
538
+ }
539
+ super._onObjectRemoved(obj);
540
+ }
541
+
542
+ /**
543
+ * Divides objects in two groups, one to render immediately
544
+ * and one to render as activeGroup.
545
+ * @return {Array} objects to render immediately and pushes the other in the activeGroup.
546
+ */
547
+ _chooseObjectsToRender(): FabricObject[] {
548
+ const activeObjects = this.getActiveObjects();
549
+ let objsToRender, activeGroupObjects;
550
+
551
+ if (!this.preserveObjectStacking && activeObjects.length > 1) {
552
+ objsToRender = [];
553
+ activeGroupObjects = [];
554
+ for (let i = 0, length = this._objects.length; i < length; i++) {
555
+ const object = this._objects[i];
556
+ if (activeObjects.indexOf(object) === -1) {
557
+ objsToRender.push(object);
558
+ } else {
559
+ activeGroupObjects.push(object);
560
+ }
561
+ }
562
+ if (activeObjects.length > 1 && isCollection(this._activeObject)) {
563
+ this._activeObject._objects = activeGroupObjects;
564
+ }
565
+ objsToRender.push(...activeGroupObjects);
566
+ }
567
+ // in case a single object is selected render it's entire parent above the other objects
568
+ else if (!this.preserveObjectStacking && activeObjects.length === 1) {
569
+ const target = activeObjects[0],
570
+ ancestors = target.getAncestors(true);
571
+ const topAncestor = (
572
+ ancestors.length === 0 ? target : ancestors.pop()
573
+ ) as FabricObject;
574
+ objsToRender = this._objects.slice();
575
+ const index = objsToRender.indexOf(topAncestor);
576
+ index > -1 && objsToRender.splice(objsToRender.indexOf(topAncestor), 1);
577
+ objsToRender.push(topAncestor);
578
+ } else {
579
+ objsToRender = this._objects;
580
+ }
581
+ return objsToRender;
582
+ }
583
+
584
+ /**
585
+ * Renders both the top canvas and the secondary container canvas.
586
+ */
587
+ renderAll() {
588
+ this.cancelRequestedRender();
589
+ if (this.destroyed) {
590
+ return;
591
+ }
592
+ if (this.contextTopDirty && !this._groupSelector && !this.isDrawingMode) {
593
+ this.clearContext(this.contextTop);
594
+ this.contextTopDirty = false;
595
+ }
596
+ if (this.hasLostContext) {
597
+ this.renderTopLayer(this.contextTop);
598
+ this.hasLostContext = false;
599
+ }
600
+ !this._objectsToRender &&
601
+ (this._objectsToRender = this._chooseObjectsToRender());
602
+ this.renderCanvas(this.contextContainer, this._objectsToRender);
603
+ }
604
+
605
+ /**
606
+ * text selection is rendered by the active text instance during the rendering cycle
607
+ */
608
+ renderTopLayer(ctx: CanvasRenderingContext2D): void {
609
+ ctx.save();
610
+ if (this.isDrawingMode && this._isCurrentlyDrawing) {
611
+ this.freeDrawingBrush && this.freeDrawingBrush._render();
612
+ this.contextTopDirty = true;
613
+ }
614
+ // we render the top context - last object
615
+ if (this.selection && this._groupSelector) {
616
+ this._drawSelection(ctx);
617
+ this.contextTopDirty = true;
618
+ }
619
+ ctx.restore();
620
+ }
621
+
622
+ /**
623
+ * Method to render only the top canvas.
624
+ * Also used to render the group selection box.
625
+ * Does not render text selection.
626
+ */
627
+ renderTop() {
628
+ const ctx = this.contextTop;
629
+ this.clearContext(ctx);
630
+ this.renderTopLayer(ctx);
631
+ // todo: how do i know if the after:render is for the top or normal contex?
632
+ this.fire('after:render', { ctx });
633
+ }
634
+
635
+ /**
636
+ * Given a pointer on the canvas with a viewport applied,
637
+ * find out the opinter in
638
+ * @private
639
+ */
640
+ _normalizePointer(object: FabricObject, pointer: Point): Point {
641
+ return transformPoint(
642
+ this.restorePointerVpt(pointer),
643
+ invertTransform(object.calcTransformMatrix())
644
+ );
645
+ }
646
+
647
+ /**
648
+ * Returns true if object is transparent at a certain location
649
+ * Clarification: this is `is target transparent at location X or are controls there`
650
+ * @TODO this seems dumb that we treat controls with transparency. we can find controls
651
+ * programmatically without painting them, the cache canvas optimization is always valid
652
+ * @param {FabricObject} target Object to check
653
+ * @param {Number} x Left coordinate
654
+ * @param {Number} y Top coordinate
655
+ * @return {Boolean}
656
+ */
657
+ isTargetTransparent(target: FabricObject, x: number, y: number): boolean {
658
+ // in case the target is the activeObject, we cannot execute this optimization
659
+ // because we need to draw controls too.
660
+ if (isFabricObjectCached(target) && target !== this._activeObject) {
661
+ // optimizatio: we can reuse the cache
662
+ const normalizedPointer = this._normalizePointer(target, new Point(x, y)),
663
+ targetRelativeX = Math.max(
664
+ target.cacheTranslationX + normalizedPointer.x * target.zoomX,
665
+ 0
666
+ ),
667
+ targetRelativeY = Math.max(
668
+ target.cacheTranslationY + normalizedPointer.y * target.zoomY,
669
+ 0
670
+ );
671
+
672
+ return isTransparent(
673
+ target._cacheContext,
674
+ Math.round(targetRelativeX),
675
+ Math.round(targetRelativeY),
676
+ this.targetFindTolerance
677
+ );
678
+ }
679
+
680
+ const ctx = this.contextCache,
681
+ originalColor = target.selectionBackgroundColor,
682
+ v = this.viewportTransform;
683
+
684
+ target.selectionBackgroundColor = '';
685
+
686
+ this.clearContext(ctx);
687
+
688
+ ctx.save();
689
+ ctx.transform(v[0], v[1], v[2], v[3], v[4], v[5]);
690
+ target.render(ctx);
691
+ ctx.restore();
692
+
693
+ target.selectionBackgroundColor = originalColor;
694
+
695
+ return isTransparent(ctx, x, y, this.targetFindTolerance);
696
+ }
697
+
698
+ /**
699
+ * takes an event and determines if selection key has been pressed
700
+ * @private
701
+ * @param {TPointerEvent} e Event object
702
+ */
703
+ _isSelectionKeyPressed(e: TPointerEvent): boolean {
704
+ const sKey = this.selectionKey;
705
+ if (!sKey) {
706
+ return false;
707
+ }
708
+ if (Array.isArray(sKey)) {
709
+ return !!sKey.find((key) => !!key && e[key] === true);
710
+ } else {
711
+ return e[sKey];
712
+ }
713
+ }
714
+
715
+ /**
716
+ * @private
717
+ * @param {TPointerEvent} e Event object
718
+ * @param {FabricObject} target
719
+ */
720
+ _shouldClearSelection(e: TPointerEvent, target?: FabricObject): boolean {
721
+ const activeObjects = this.getActiveObjects(),
722
+ activeObject = this._activeObject;
723
+
724
+ return !!(
725
+ !target ||
726
+ (target &&
727
+ activeObject &&
728
+ activeObjects.length > 1 &&
729
+ activeObjects.indexOf(target) === -1 &&
730
+ activeObject !== target &&
731
+ !this._isSelectionKeyPressed(e)) ||
732
+ (target && !target.evented) ||
733
+ (target && !target.selectable && activeObject && activeObject !== target)
734
+ );
735
+ }
736
+
737
+ /**
738
+ * This method will take in consideration a modifier key pressed and the control we are
739
+ * about to drag, and try to guess the anchor point ( origin ) of the transormation.
740
+ * This should be really in the realm of controls, and we should remove specific code for legacy
741
+ * embedded actions.
742
+ * @TODO this probably deserve discussion/rediscovery and change/refactor
743
+ * @private
744
+ * @deprecated
745
+ * @param {FabricObject} target
746
+ * @param {string} action
747
+ * @param {boolean} altKey
748
+ * @returns {boolean} true if the transformation should be centered
749
+ */
750
+ private _shouldCenterTransform(
751
+ target: FabricObject,
752
+ action: string,
753
+ modifierKeyPressed: boolean
754
+ ) {
755
+ if (!target) {
756
+ return;
757
+ }
758
+
759
+ let centerTransform;
760
+
761
+ if (
762
+ action === 'scale' ||
763
+ action === 'scaleX' ||
764
+ action === 'scaleY' ||
765
+ action === 'resizing'
766
+ ) {
767
+ centerTransform = this.centeredScaling || target.centeredScaling;
768
+ } else if (action === 'rotate') {
769
+ centerTransform = this.centeredRotation || target.centeredRotation;
770
+ }
771
+
772
+ return centerTransform ? !modifierKeyPressed : modifierKeyPressed;
773
+ }
774
+
775
+ /**
776
+ * Given the control clicked, determine the origin of the transform.
777
+ * This is bad because controls can totally have custom names
778
+ * should disappear before release 4.0
779
+ * @private
780
+ * @deprecated
781
+ */
782
+ _getOriginFromCorner(
783
+ target: FabricObject,
784
+ controlName: string
785
+ ): { x: TOriginX; y: TOriginY } {
786
+ const origin = {
787
+ x: target.originX,
788
+ y: target.originY,
789
+ };
790
+ // is a left control ?
791
+ if (['ml', 'tl', 'bl'].includes(controlName)) {
792
+ origin.x = 'right';
793
+ // is a right control ?
794
+ } else if (['mr', 'tr', 'br'].includes(controlName)) {
795
+ origin.x = 'left';
796
+ }
797
+ // is a top control ?
798
+ if (['tl', 'mt', 'tr'].includes(controlName)) {
799
+ origin.y = 'bottom';
800
+ // is a bottom control ?
801
+ } else if (['bl', 'mb', 'br'].includes(controlName)) {
802
+ origin.y = 'top';
803
+ }
804
+ return origin;
805
+ }
806
+
807
+ /**
808
+ * @private
809
+ * @param {Event} e Event object
810
+ * @param {FaricObject} target
811
+ */
812
+ _setupCurrentTransform(
813
+ e: TPointerEvent,
814
+ target: FabricObject,
815
+ alreadySelected: boolean
816
+ ): void {
817
+ if (!target) {
818
+ return;
819
+ }
820
+ const pointer = target.group
821
+ ? // transform pointer to target's containing coordinate plane
822
+ sendPointToPlane(
823
+ this.getPointer(e),
824
+ undefined,
825
+ target.group.calcTransformMatrix()
826
+ )
827
+ : this.getPointer(e);
828
+ const corner = target.__corner || '',
829
+ control = !!corner && target.controls[corner],
830
+ actionHandler =
831
+ alreadySelected && control
832
+ ? control.getActionHandler(e, target, control)
833
+ : dragHandler,
834
+ action = getActionFromCorner(alreadySelected, corner, e, target),
835
+ origin = this._getOriginFromCorner(target, corner),
836
+ altKey = e[this.centeredKey as ModifierKey],
837
+ /**
838
+ * relative to target's containing coordinate plane
839
+ * both agree on every point
840
+ **/
841
+ transform: Transform = {
842
+ target: target,
843
+ action: action,
844
+ actionHandler,
845
+ actionPerformed: false,
846
+ corner,
847
+ scaleX: target.scaleX,
848
+ scaleY: target.scaleY,
849
+ skewX: target.skewX,
850
+ skewY: target.skewY,
851
+ offsetX: pointer.x - target.left,
852
+ offsetY: pointer.y - target.top,
853
+ originX: origin.x,
854
+ originY: origin.y,
855
+ ex: pointer.x,
856
+ ey: pointer.y,
857
+ lastX: pointer.x,
858
+ lastY: pointer.y,
859
+ theta: degreesToRadians(target.angle),
860
+ width: target.width,
861
+ height: target.height,
862
+ shiftKey: e.shiftKey,
863
+ altKey: altKey,
864
+ original: {
865
+ ...saveObjectTransform(target),
866
+ originX: origin.x,
867
+ originY: origin.y,
868
+ },
869
+ };
870
+
871
+ if (this._shouldCenterTransform(target, action, altKey)) {
872
+ transform.originX = 'center';
873
+ transform.originY = 'center';
874
+ }
875
+ this._currentTransform = transform;
876
+ // @ts-ignore
877
+ this._beforeTransform(e);
878
+ }
879
+
880
+ /**
881
+ * Set the cursor type of the canvas element
882
+ * @param {String} value Cursor type of the canvas element.
883
+ * @see http://www.w3.org/TR/css3-ui/#cursor
884
+ */
885
+ setCursor(value: CSSStyleDeclaration['cursor']): void {
886
+ this.upperCanvasEl.style.cursor = value;
887
+ }
888
+
889
+ /**
890
+ * @private
891
+ * @param {CanvasRenderingContext2D} ctx to draw the selection on
892
+ */
893
+ _drawSelection(ctx: CanvasRenderingContext2D): void {
894
+ const { ex, ey, left, top } = this._groupSelector,
895
+ start = new Point(ex, ey).transform(this.viewportTransform),
896
+ extent = new Point(ex + left, ey + top).transform(this.viewportTransform),
897
+ strokeOffset = this.selectionLineWidth / 2;
898
+ let minX = Math.min(start.x, extent.x),
899
+ minY = Math.min(start.y, extent.y),
900
+ maxX = Math.max(start.x, extent.x),
901
+ maxY = Math.max(start.y, extent.y);
902
+
903
+ if (this.selectionColor) {
904
+ ctx.fillStyle = this.selectionColor;
905
+ ctx.fillRect(minX, minY, maxX - minX, maxY - minY);
906
+ }
907
+
908
+ if (!this.selectionLineWidth || !this.selectionBorderColor) {
909
+ return;
910
+ }
911
+ ctx.lineWidth = this.selectionLineWidth;
912
+ ctx.strokeStyle = this.selectionBorderColor;
913
+
914
+ minX += strokeOffset;
915
+ minY += strokeOffset;
916
+ maxX -= strokeOffset;
917
+ maxY -= strokeOffset;
918
+ // selection border
919
+ // @TODO: is _setLineDash still necessary on modern canvas?
920
+ FabricObject.prototype._setLineDash.call(
921
+ this,
922
+ ctx,
923
+ this.selectionDashArray
924
+ );
925
+ ctx.strokeRect(minX, minY, maxX - minX, maxY - minY);
926
+ }
927
+
928
+ /**
929
+ * Method that determines what object we are clicking on
930
+ * the skipGroup parameter is for internal use, is needed for shift+click action
931
+ * 11/09/2018 TODO: would be cool if findTarget could discern between being a full target
932
+ * or the outside part of the corner.
933
+ * @param {Event} e mouse event
934
+ * @param {Boolean} skipGroup when true, activeGroup is skipped and only objects are traversed through
935
+ * @return {FabricObject | null} the target found
936
+ */
937
+ findTarget(e: TPointerEvent, skipGroup = false): FabricObject | undefined {
938
+ if (this.skipTargetFind) {
939
+ return undefined;
940
+ }
941
+
942
+ const pointer = this.getPointer(e, true),
943
+ activeObject = this._activeObject,
944
+ aObjects = this.getActiveObjects(),
945
+ isTouch = isTouchEvent(e),
946
+ shouldLookForActive =
947
+ (aObjects.length > 1 && !skipGroup) || aObjects.length === 1;
948
+
949
+ // first check current group (if one exists)
950
+ // active group does not check sub targets like normal groups.
951
+ // if active group just exits.
952
+ this.targets = [];
953
+
954
+ // if we hit the corner of an activeObject, let's return that.
955
+ if (
956
+ // ts doesn't get that if shouldLookForActive is true, activeObject exists
957
+ activeObject &&
958
+ shouldLookForActive &&
959
+ activeObject._findTargetCorner(pointer, isTouch)
960
+ ) {
961
+ return activeObject;
962
+ }
963
+ if (
964
+ aObjects.length > 1 &&
965
+ isActiveSelection(activeObject) &&
966
+ !skipGroup &&
967
+ this.searchPossibleTargets([activeObject], pointer)
968
+ ) {
969
+ return activeObject;
970
+ }
971
+
972
+ let activeTarget;
973
+ let activeTargetSubs: FabricObject[] = [];
974
+ if (
975
+ // ts doesn't get that if aObjects has one object, activeObject exists
976
+ activeObject &&
977
+ aObjects.length === 1 &&
978
+ activeObject === this.searchPossibleTargets([activeObject], pointer)
979
+ ) {
980
+ if (!this.preserveObjectStacking) {
981
+ return activeObject;
982
+ } else {
983
+ activeTarget = activeObject;
984
+ activeTargetSubs = this.targets;
985
+ this.targets = [];
986
+ }
987
+ }
988
+ const target = this.searchPossibleTargets(this._objects, pointer);
989
+ if (
990
+ e[this.altSelectionKey as ModifierKey] &&
991
+ target &&
992
+ activeTarget &&
993
+ target !== activeTarget
994
+ ) {
995
+ this.targets = activeTargetSubs;
996
+ return activeTarget;
997
+ }
998
+ return target;
999
+ }
1000
+
1001
+ /**
1002
+ * Checks point is inside the object.
1003
+ * @param {Object} [pointer] x,y object of point coordinates we want to check.
1004
+ * @param {FabricObject} obj Object to test against
1005
+ * @param {Object} [globalPointer] x,y object of point coordinates relative to canvas used to search per pixel target.
1006
+ * @return {Boolean} true if point is contained within an area of given object
1007
+ * @private
1008
+ */
1009
+ _checkTarget(
1010
+ pointer: Point,
1011
+ obj: FabricObject,
1012
+ globalPointer: Point
1013
+ ): boolean {
1014
+ if (
1015
+ obj &&
1016
+ obj.visible &&
1017
+ obj.evented &&
1018
+ // http://www.geog.ubc.ca/courses/klink/gis.notes/ncgia/u32.html
1019
+ // http://idav.ucdavis.edu/~okreylos/TAship/Spring2000/PointInPolygon.html
1020
+ obj.containsPoint(pointer)
1021
+ ) {
1022
+ if (
1023
+ (this.perPixelTargetFind || obj.perPixelTargetFind) &&
1024
+ !(obj as unknown as IText).isEditing
1025
+ ) {
1026
+ if (!this.isTargetTransparent(obj, globalPointer.x, globalPointer.y)) {
1027
+ return true;
1028
+ }
1029
+ } else {
1030
+ return true;
1031
+ }
1032
+ }
1033
+ return false;
1034
+ }
1035
+
1036
+ /**
1037
+ * Internal Function used to search inside objects an object that contains pointer in bounding box or that contains pointerOnCanvas when painted
1038
+ * @param {Array} [objects] objects array to look into
1039
+ * @param {Object} [pointer] x,y object of point coordinates we want to check.
1040
+ * @return {FabricObject} **top most object from given `objects`** that contains pointer
1041
+ * @private
1042
+ */
1043
+ _searchPossibleTargets(
1044
+ objects: FabricObject[],
1045
+ pointer: Point
1046
+ ): FabricObject | undefined {
1047
+ // Cache all targets where their bounding box contains point.
1048
+ let target,
1049
+ i = objects.length;
1050
+ // Do not check for currently grouped objects, since we check the parent group itself.
1051
+ // until we call this function specifically to search inside the activeGroup
1052
+ while (i--) {
1053
+ const objToCheck = objects[i];
1054
+ const pointerToUse = objToCheck.group
1055
+ ? this._normalizePointer(objToCheck.group, pointer)
1056
+ : pointer;
1057
+ if (this._checkTarget(pointerToUse, objToCheck, pointer)) {
1058
+ target = objects[i];
1059
+ if (isCollection(target) && target.subTargetCheck) {
1060
+ const subTarget = this._searchPossibleTargets(
1061
+ target._objects as FabricObject[],
1062
+ pointer
1063
+ );
1064
+ subTarget && this.targets.push(subTarget);
1065
+ }
1066
+ break;
1067
+ }
1068
+ }
1069
+ return target;
1070
+ }
1071
+
1072
+ /**
1073
+ * Function used to search inside objects an object that contains pointer in bounding box or that contains pointerOnCanvas when painted
1074
+ * @see {@link fabric.Canvas#_searchPossibleTargets}
1075
+ * @param {FabricObject[]} [objects] objects array to look into
1076
+ * @param {Object} [pointer] x,y object of point coordinates we want to check.
1077
+ * @return {FabricObject} **top most object on screen** that contains pointer
1078
+ */
1079
+ searchPossibleTargets(
1080
+ objects: FabricObject[],
1081
+ pointer: Point
1082
+ ): FabricObject | undefined {
1083
+ const target = this._searchPossibleTargets(objects, pointer);
1084
+ // if we found something in this.targets, and the group is interactive, return that subTarget
1085
+ // TODO: reverify why interactive. the target should be returned always, but selected only
1086
+ // if interactive.
1087
+ return target &&
1088
+ isCollection(target) &&
1089
+ target.interactive &&
1090
+ this.targets[0]
1091
+ ? this.targets[0]
1092
+ : target;
1093
+ }
1094
+
1095
+ /**
1096
+ * Returns pointer coordinates without the effect of the viewport
1097
+ * @param {Object} pointer with "x" and "y" number values in canvas HTML coordinates
1098
+ * @return {Object} object with "x" and "y" number values in fabricCanvas coordinates
1099
+ */
1100
+ restorePointerVpt(pointer: Point): Point {
1101
+ return pointer.transform(invertTransform(this.viewportTransform));
1102
+ }
1103
+
1104
+ /**
1105
+ * Returns pointer coordinates relative to canvas.
1106
+ * Can return coordinates with or without viewportTransform.
1107
+ * ignoreVpt false gives back coordinates that represent
1108
+ * the point clicked on canvas element.
1109
+ * ignoreVpt true gives back coordinates after being processed
1110
+ * by the viewportTransform ( sort of coordinates of what is displayed
1111
+ * on the canvas where you are clicking.
1112
+ * ignoreVpt true = HTMLElement coordinates relative to top,left
1113
+ * ignoreVpt false, default = fabric space coordinates, the same used for shape position
1114
+ * To interact with your shapes top and left you want to use ignoreVpt true
1115
+ * most of the time, while ignoreVpt false will give you coordinates
1116
+ * compatible with the object.oCoords system.
1117
+ * of the time.
1118
+ * @param {Event} e
1119
+ * @param {Boolean} ignoreVpt
1120
+ * @return {Point}
1121
+ */
1122
+ getPointer(e: TPointerEvent, ignoreVpt = false): Point {
1123
+ // return cached values if we are in the event processing chain
1124
+ if (this._absolutePointer && !ignoreVpt) {
1125
+ return this._absolutePointer;
1126
+ }
1127
+ if (this._pointer && ignoreVpt) {
1128
+ return this._pointer;
1129
+ }
1130
+
1131
+ const upperCanvasEl = this.upperCanvasEl,
1132
+ bounds = upperCanvasEl.getBoundingClientRect();
1133
+ let pointer = getPointer(e),
1134
+ boundsWidth = bounds.width || 0,
1135
+ boundsHeight = bounds.height || 0;
1136
+
1137
+ if (!boundsWidth || !boundsHeight) {
1138
+ if ('top' in bounds && 'bottom' in bounds) {
1139
+ boundsHeight = Math.abs(bounds.top - bounds.bottom);
1140
+ }
1141
+ if ('right' in bounds && 'left' in bounds) {
1142
+ boundsWidth = Math.abs(bounds.right - bounds.left);
1143
+ }
1144
+ }
1145
+
1146
+ this.calcOffset();
1147
+ pointer.x = pointer.x - this._offset.left;
1148
+ pointer.y = pointer.y - this._offset.top;
1149
+ if (!ignoreVpt) {
1150
+ pointer = this.restorePointerVpt(pointer);
1151
+ }
1152
+
1153
+ const retinaScaling = this.getRetinaScaling();
1154
+ if (retinaScaling !== 1) {
1155
+ pointer.x /= retinaScaling;
1156
+ pointer.y /= retinaScaling;
1157
+ }
1158
+
1159
+ // If bounds are not available (i.e. not visible), do not apply scale.
1160
+ const cssScale =
1161
+ boundsWidth === 0 || boundsHeight === 0
1162
+ ? new Point(1, 1)
1163
+ : new Point(
1164
+ upperCanvasEl.width / boundsWidth,
1165
+ upperCanvasEl.height / boundsHeight
1166
+ );
1167
+
1168
+ return pointer.multiply(cssScale);
1169
+ }
1170
+
1171
+ /**
1172
+ * Internal use only
1173
+ * @protected
1174
+ */
1175
+ protected _setDimensionsImpl(
1176
+ dimensions: TSize,
1177
+ options?: TCanvasSizeOptions
1178
+ ) {
1179
+ // @ts-ignore
1180
+ this._resetTransformEventData();
1181
+ super._setDimensionsImpl(dimensions, options);
1182
+ if (this._isCurrentlyDrawing) {
1183
+ this.freeDrawingBrush &&
1184
+ this.freeDrawingBrush._setBrushStyles(this.contextTop);
1185
+ }
1186
+ }
1187
+
1188
+ /**
1189
+ * Helper for setting width/height
1190
+ * @private
1191
+ * @param {String} prop property (width|height)
1192
+ * @param {Number} value value to set property to
1193
+ */
1194
+ _setBackstoreDimension(prop: keyof TSize, value: number) {
1195
+ super._setBackstoreDimension(prop, value);
1196
+ this.upperCanvasEl[prop] = value;
1197
+ this.cacheCanvasEl[prop] = value;
1198
+ }
1199
+
1200
+ /**
1201
+ * Helper for setting css width/height
1202
+ * @private
1203
+ * @param {String} prop property (width|height)
1204
+ * @param {String} value value to set property to
1205
+ */
1206
+ _setCssDimension(prop: keyof TSize, value: string) {
1207
+ super._setCssDimension(prop, value);
1208
+ this.upperCanvasEl.style[prop] = value;
1209
+ this.wrapperEl.style[prop] = value;
1210
+ }
1211
+
1212
+ /**
1213
+ * @private
1214
+ * @throws {CANVAS_INIT_ERROR} If canvas can not be initialized
1215
+ */
1216
+ protected _createUpperCanvas() {
1217
+ const lowerCanvasEl = this.lowerCanvasEl;
1218
+
1219
+ // if there is no upperCanvas (most common case) we create one.
1220
+ if (!this.upperCanvasEl) {
1221
+ this.upperCanvasEl = this._createCanvasElement();
1222
+ }
1223
+ const upperCanvasEl = this.upperCanvasEl;
1224
+ // we assign the same classname of the lowerCanvas
1225
+ upperCanvasEl.className = lowerCanvasEl.className;
1226
+ // but then we remove the lower-canvas specific className
1227
+ upperCanvasEl.classList.remove('lower-canvas');
1228
+ // we add the specific upper-canvas class
1229
+ upperCanvasEl.classList.add('upper-canvas');
1230
+ upperCanvasEl.setAttribute('data-fabric', 'top');
1231
+ this.wrapperEl.appendChild(upperCanvasEl);
1232
+ upperCanvasEl.style.cssText = lowerCanvasEl.style.cssText;
1233
+ this._applyCanvasStyle(upperCanvasEl);
1234
+ upperCanvasEl.setAttribute('draggable', 'true');
1235
+ this.contextTop = upperCanvasEl.getContext('2d')!;
1236
+ }
1237
+
1238
+ protected _createCacheCanvas() {
1239
+ this.cacheCanvasEl = this._createCanvasElement();
1240
+ this.contextCache = this.cacheCanvasEl.getContext('2d')!;
1241
+ }
1242
+
1243
+ protected _initWrapperElement() {
1244
+ const container = getEnv().document.createElement('div');
1245
+ container.classList.add(this.containerClass);
1246
+ this.wrapperEl = wrapElement(this.lowerCanvasEl, container);
1247
+ this.wrapperEl.setAttribute('data-fabric', 'wrapper');
1248
+ setStyle(this.wrapperEl, {
1249
+ width: `${this.width}px`,
1250
+ height: `${this.height}px`,
1251
+ position: 'relative',
1252
+ });
1253
+ makeElementUnselectable(this.wrapperEl);
1254
+ }
1255
+
1256
+ /**
1257
+ * @private
1258
+ * @param {HTMLCanvasElement} element canvas element to apply styles on
1259
+ */
1260
+ protected _applyCanvasStyle(element: HTMLCanvasElement) {
1261
+ const width = this.width || element.width,
1262
+ height = this.height || element.height;
1263
+
1264
+ setStyle(element, {
1265
+ position: 'absolute',
1266
+ width: width + 'px',
1267
+ height: height + 'px',
1268
+ left: 0,
1269
+ top: 0,
1270
+ 'touch-action': this.allowTouchScrolling ? 'manipulation' : 'none',
1271
+ '-ms-touch-action': this.allowTouchScrolling ? 'manipulation' : 'none',
1272
+ });
1273
+ element.width = width;
1274
+ element.height = height;
1275
+ makeElementUnselectable(element);
1276
+ }
1277
+
1278
+ /**
1279
+ * Returns context of top canvas where interactions are drawn
1280
+ * @returns {CanvasRenderingContext2D}
1281
+ */
1282
+ getTopContext(): CanvasRenderingContext2D {
1283
+ return this.contextTop;
1284
+ }
1285
+
1286
+ /**
1287
+ * Returns context of canvas where object selection is drawn
1288
+ * @alias
1289
+ * @return {CanvasRenderingContext2D}
1290
+ */
1291
+ getSelectionContext(): CanvasRenderingContext2D {
1292
+ return this.contextTop;
1293
+ }
1294
+
1295
+ /**
1296
+ * Returns &lt;canvas> element on which object selection is drawn
1297
+ * @return {HTMLCanvasElement}
1298
+ */
1299
+ getSelectionElement(): HTMLCanvasElement {
1300
+ return this.upperCanvasEl;
1301
+ }
1302
+
1303
+ /**
1304
+ * Returns currently active object
1305
+ * @return {FabricObject | null} active object
1306
+ */
1307
+ getActiveObject(): FabricObject | undefined {
1308
+ return this._activeObject;
1309
+ }
1310
+
1311
+ /**
1312
+ * Returns an array with the current selected objects
1313
+ * @return {FabricObject[]} active objects array
1314
+ */
1315
+ getActiveObjects(): FabricObject[] {
1316
+ const active = this._activeObject;
1317
+ if (active) {
1318
+ if (isActiveSelection(active)) {
1319
+ return [...active._objects];
1320
+ } else {
1321
+ return [active];
1322
+ }
1323
+ }
1324
+ return [];
1325
+ }
1326
+
1327
+ /**
1328
+ * @private
1329
+ * Compares the old activeObject with the current one and fires correct events
1330
+ * @param {FabricObject[]} oldObjects old activeObject
1331
+ * @param {TPointerEvent} e mouse event triggering the selection events
1332
+ */
1333
+ _fireSelectionEvents(oldObjects: FabricObject[], e?: TPointerEvent) {
1334
+ let somethingChanged = false,
1335
+ invalidate = false;
1336
+ const objects = this.getActiveObjects(),
1337
+ added: FabricObject[] = [],
1338
+ removed: FabricObject[] = [];
1339
+
1340
+ oldObjects.forEach((target) => {
1341
+ if (!objects.includes(target)) {
1342
+ somethingChanged = true;
1343
+ target.fire('deselected', {
1344
+ e,
1345
+ target,
1346
+ });
1347
+ removed.push(target);
1348
+ }
1349
+ });
1350
+
1351
+ objects.forEach((target) => {
1352
+ if (!oldObjects.includes(target)) {
1353
+ somethingChanged = true;
1354
+ target.fire('selected', {
1355
+ e,
1356
+ target,
1357
+ });
1358
+ added.push(target);
1359
+ }
1360
+ });
1361
+
1362
+ if (oldObjects.length > 0 && objects.length > 0) {
1363
+ invalidate = true;
1364
+ somethingChanged &&
1365
+ this.fire('selection:updated', {
1366
+ e,
1367
+ selected: added,
1368
+ deselected: removed,
1369
+ });
1370
+ } else if (objects.length > 0) {
1371
+ invalidate = true;
1372
+ this.fire('selection:created', {
1373
+ e,
1374
+ selected: added,
1375
+ });
1376
+ } else if (oldObjects.length > 0) {
1377
+ invalidate = true;
1378
+ this.fire('selection:cleared', {
1379
+ e,
1380
+ deselected: removed,
1381
+ });
1382
+ }
1383
+ invalidate && (this._objectsToRender = undefined);
1384
+ }
1385
+
1386
+ /**
1387
+ * Sets given object as the only active object on canvas
1388
+ * @param {FabricObject} object Object to set as an active one
1389
+ * @param {TPointerEvent} [e] Event (passed along when firing "object:selected")
1390
+ * @chainable
1391
+ */
1392
+ setActiveObject(object: FabricObject, e?: TPointerEvent) {
1393
+ // we can't inline this, since _setActiveObject will change what getActiveObjects returns
1394
+ const currentActives = this.getActiveObjects();
1395
+ this._setActiveObject(object, e);
1396
+ this._fireSelectionEvents(currentActives, e);
1397
+ }
1398
+
1399
+ /**
1400
+ * This is a private method for now.
1401
+ * This is supposed to be equivalent to setActiveObject but without firing
1402
+ * any event. There is commitment to have this stay this way.
1403
+ * This is the functional part of setActiveObject.
1404
+ * @private
1405
+ * @param {Object} object to set as active
1406
+ * @param {Event} [e] Event (passed along when firing "object:selected")
1407
+ * @return {Boolean} true if the selection happened
1408
+ */
1409
+ _setActiveObject(object: FabricObject, e?: TPointerEvent) {
1410
+ if (this._activeObject === object) {
1411
+ return false;
1412
+ }
1413
+ if (!this._discardActiveObject(e, object)) {
1414
+ return false;
1415
+ }
1416
+ if (object.onSelect({ e })) {
1417
+ return false;
1418
+ }
1419
+ this._activeObject = object;
1420
+ return true;
1421
+ }
1422
+
1423
+ /**
1424
+ * This is a private method for now.
1425
+ * This is supposed to be equivalent to discardActiveObject but without firing
1426
+ * any selection events ( can still fire object transformation events ). There is commitment to have this stay this way.
1427
+ * This is the functional part of discardActiveObject.
1428
+ * @param {Event} [e] Event (passed along when firing "object:deselected")
1429
+ * @param {Object} object the next object to set as active, reason why we are discarding this
1430
+ * @return {Boolean} true if the selection happened
1431
+ * @private
1432
+ */
1433
+ _discardActiveObject(e?: TPointerEvent, object?: FabricObject) {
1434
+ const obj = this._activeObject;
1435
+ if (obj) {
1436
+ // onDeselect return TRUE to cancel selection;
1437
+ if (obj.onDeselect({ e, object })) {
1438
+ return false;
1439
+ }
1440
+ if (this._currentTransform && this._currentTransform.target === obj) {
1441
+ // @ts-ignore
1442
+ this.endCurrentTransform(e);
1443
+ }
1444
+ this._activeObject = undefined;
1445
+ }
1446
+ return true;
1447
+ }
1448
+
1449
+ /**
1450
+ * Discards currently active object and fire events. If the function is called by fabric
1451
+ * as a consequence of a mouse event, the event is passed as a parameter and
1452
+ * sent to the fire function for the custom events. When used as a method the
1453
+ * e param does not have any application.
1454
+ * @param {event} e
1455
+ * @chainable
1456
+ */
1457
+ discardActiveObject(e?: TPointerEvent) {
1458
+ const currentActives = this.getActiveObjects(),
1459
+ activeObject = this.getActiveObject();
1460
+ if (currentActives.length) {
1461
+ this.fire('before:selection:cleared', {
1462
+ e,
1463
+ deselected: [activeObject!],
1464
+ });
1465
+ }
1466
+ this._discardActiveObject(e);
1467
+ this._fireSelectionEvents(currentActives, e);
1468
+ }
1469
+
1470
+ /**
1471
+ * Sets viewport transformation of this canvas instance
1472
+ * @param {Array} vpt a Canvas 2D API transform matrix
1473
+ */
1474
+ setViewportTransform(vpt: TMat2D) {
1475
+ super.setViewportTransform(vpt);
1476
+ const activeObject = this._activeObject;
1477
+ if (activeObject) {
1478
+ activeObject.setCoords();
1479
+ }
1480
+ }
1481
+
1482
+ /**
1483
+ * Clears the canvas element, disposes objects, removes all event listeners and frees resources
1484
+ *
1485
+ * **CAUTION**:
1486
+ *
1487
+ * This method is **UNSAFE**.
1488
+ * You may encounter a race condition using it if there's a requested render.
1489
+ * Call this method only if you are sure rendering has settled.
1490
+ * Consider using {@link dispose} as it is **SAFE**
1491
+ *
1492
+ * @private
1493
+ */
1494
+ destroy(this: TDestroyedCanvas) {
1495
+ const wrapperEl = this.wrapperEl as HTMLDivElement,
1496
+ lowerCanvasEl = this.lowerCanvasEl!,
1497
+ upperCanvasEl = this.upperCanvasEl!,
1498
+ cacheCanvasEl = this.cacheCanvasEl!;
1499
+ // @ts-ignore
1500
+ this.removeListeners();
1501
+ super.destroy();
1502
+ wrapperEl.removeChild(upperCanvasEl);
1503
+ wrapperEl.removeChild(lowerCanvasEl);
1504
+ this.contextCache = null;
1505
+ this.contextTop = null;
1506
+ // TODO: interactive canvas should NOT be used in node, therefore there is no reason to cleanup node canvas
1507
+ cleanUpJsdomNode(upperCanvasEl);
1508
+ this.upperCanvasEl = undefined;
1509
+ cleanUpJsdomNode(cacheCanvasEl);
1510
+ this.cacheCanvasEl = undefined;
1511
+ if (wrapperEl.parentNode) {
1512
+ wrapperEl.parentNode.replaceChild(lowerCanvasEl, wrapperEl);
1513
+ }
1514
+ this.wrapperEl = undefined;
1515
+ }
1516
+
1517
+ /**
1518
+ * Clears all contexts (background, main, top) of an instance
1519
+ */
1520
+ clear() {
1521
+ // this.discardActiveGroup();
1522
+ this.discardActiveObject();
1523
+ this.clearContext(this.contextTop);
1524
+ super.clear();
1525
+ }
1526
+
1527
+ /**
1528
+ * Draws objects' controls (borders/controls)
1529
+ * @param {CanvasRenderingContext2D} ctx Context to render controls on
1530
+ */
1531
+ drawControls(ctx: CanvasRenderingContext2D) {
1532
+ const activeObject = this._activeObject;
1533
+
1534
+ if (activeObject) {
1535
+ activeObject._renderControls(ctx);
1536
+ }
1537
+ }
1538
+
1539
+ /**
1540
+ * @private
1541
+ */
1542
+ _toObject(
1543
+ instance: FabricObject,
1544
+ methodName: 'toObject' | 'toDatalessObject',
1545
+ propertiesToInclude: string[]
1546
+ ): Record<string, any> {
1547
+ // If the object is part of the current selection group, it should
1548
+ // be transformed appropriately
1549
+ // i.e. it should be serialised as it would appear if the selection group
1550
+ // were to be destroyed.
1551
+ const originalProperties = this._realizeGroupTransformOnObject(instance),
1552
+ object = super._toObject(instance, methodName, propertiesToInclude);
1553
+ //Undo the damage we did by changing all of its properties
1554
+ instance.set(originalProperties);
1555
+ return object;
1556
+ }
1557
+
1558
+ /**
1559
+ * Realises an object's group transformation on it
1560
+ * @private
1561
+ * @param {FabricObject} [instance] the object to transform (gets mutated)
1562
+ * @returns the original values of instance which were changed
1563
+ */
1564
+ _realizeGroupTransformOnObject(
1565
+ instance: FabricObject
1566
+ ): Partial<typeof instance> {
1567
+ if (
1568
+ instance.group &&
1569
+ isActiveSelection(instance.group) &&
1570
+ this._activeObject === instance.group
1571
+ ) {
1572
+ const layoutProps = [
1573
+ 'angle',
1574
+ 'flipX',
1575
+ 'flipY',
1576
+ 'left',
1577
+ 'scaleX',
1578
+ 'scaleY',
1579
+ 'skewX',
1580
+ 'skewY',
1581
+ 'top',
1582
+ ] as (keyof typeof instance)[];
1583
+ const originalValues = pick<typeof instance>(instance, layoutProps);
1584
+ addTransformToObject(instance, this._activeObject.calcOwnMatrix());
1585
+ return originalValues;
1586
+ } else {
1587
+ return {};
1588
+ }
1589
+ }
1590
+
1591
+ /**
1592
+ * @private
1593
+ */
1594
+ _setSVGObject(
1595
+ markup: string[],
1596
+ instance: FabricObject,
1597
+ reviver: TSVGReviver
1598
+ ) {
1599
+ // If the object is in a selection group, simulate what would happen to that
1600
+ // object when the group is deselected
1601
+ const originalProperties = this._realizeGroupTransformOnObject(instance);
1602
+ super._setSVGObject(markup, instance, reviver);
1603
+ instance.set(originalProperties);
1604
+ }
1605
+ }
1606
+
1607
+ Object.assign(SelectableCanvas.prototype, {
1608
+ uniformScaling: true,
1609
+ uniScaleKey: 'shiftKey',
1610
+ centeredScaling: false,
1611
+ centeredRotation: false,
1612
+ centeredKey: 'altKey',
1613
+ altActionKey: 'shiftKey',
1614
+ selection: true,
1615
+ selectionKey: 'shiftKey',
1616
+ altSelectionKey: null,
1617
+ selectionColor: 'rgba(100, 100, 255, 0.3)', // blue
1618
+ selectionDashArray: [],
1619
+ selectionBorderColor: 'rgba(255, 255, 255, 0.3)',
1620
+ selectionLineWidth: 1,
1621
+ selectionFullyContained: false,
1622
+ hoverCursor: 'move',
1623
+ moveCursor: 'move',
1624
+ defaultCursor: 'default',
1625
+ freeDrawingCursor: 'crosshair',
1626
+ notAllowedCursor: 'not-allowed',
1627
+ containerClass: 'canvas-container',
1628
+ perPixelTargetFind: false,
1629
+ targetFindTolerance: 0,
1630
+ skipTargetFind: false,
1631
+ preserveObjectStacking: false,
1632
+ stopContextMenu: false,
1633
+ fireRightClick: false,
1634
+ fireMiddleClick: false,
1635
+ enablePointerEvents: false,
1636
+ });