import { classRegistry } from './ClassRegistry'; import { Color } from './color/Color'; import { config } from './config'; import { reNum } from './parser/constants'; import { Point } from './Point'; import type { FabricObject } from './shapes/Object/FabricObject'; import type { TClassProperties } from './typedefs'; import { uid } from './util/internals/uid'; import { pickBy } from './util/misc/pick'; import { degreesToRadians } from './util/misc/radiansDegreesConversion'; import { toFixed } from './util/misc/toFixed'; import { rotateVector } from './util/misc/vectors'; /** * Regex matching shadow offsetX, offsetY and blur (ex: "2px 2px 10px rgba(0,0,0,0.2)", "rgb(0,255,0) 2px 2px") * - (?:\s|^): This part captures either a whitespace character (\s) or the beginning of a line (^). It's non-capturing (due to (?:...)), meaning it doesn't create a capturing group. * - (-?\d+(?:\.\d*)?(?:px)?(?:\s?|$))?: This captures the first component of the shadow, which is the horizontal offset. Breaking it down: * - (-?\d+): Captures an optional minus sign followed by one or more digits (integer part of the number). * - (?:\.\d*)?: Optionally captures a decimal point followed by zero or more digits (decimal part of the number). * - (?:px)?: Optionally captures the "px" unit. * - (?:\s?|$): Captures either an optional whitespace or the end of the line. This whole part is wrapped in a non-capturing group and marked as optional with ?. * - (-?\d+(?:\.\d*)?(?:px)?(?:\s?|$))?: Similar to the previous step, this captures the vertical offset. (\d+(?:\.\d*)?(?:px)?)?: This captures the blur radius. It's similar to the horizontal offset but without the optional minus sign. (?:\s+(-?\d+(?:\.\d*)?(?:px)?(?:\s?|$))?){0,1}: This captures an optional part for the color. It allows for whitespace followed by a component with an optional minus sign, digits, decimal point, and "px" unit. (?:$|\s): This captures either the end of the line or a whitespace character. It ensures that the match ends either at the end of the string or with a whitespace character. */ // eslint-disable-next-line max-len const shadowOffsetRegex = '(-?\\d+(?:\\.\\d*)?(?:px)?(?:\\s?|$))?'; const reOffsetsAndBlur = new RegExp( '(?:\\s|^)' + shadowOffsetRegex + shadowOffsetRegex + '(' + reNum + '?(?:px)?)?(?:\\s?|$)(?:$|\\s)', ); export const shadowDefaultValues: Partial> = { color: 'rgb(0,0,0)', blur: 0, offsetX: 0, offsetY: 0, affectStroke: false, includeDefaultValues: true, nonScaling: false, }; export type SerializedShadowOptions = { color: string; blur: number; offsetX: number; offsetY: number; affectStroke: boolean; nonScaling: boolean; type: string; }; export class Shadow { /** * Shadow color * @type String * @default */ declare color: string; /** * Shadow blur * @type Number */ declare blur: number; /** * Shadow horizontal offset * @type Number * @default */ declare offsetX: number; /** * Shadow vertical offset * @type Number * @default */ declare offsetY: number; /** * Whether the shadow should affect stroke operations * @type Boolean * @default */ declare affectStroke: boolean; /** * Indicates whether toObject should include default values * @type Boolean * @default */ declare includeDefaultValues: boolean; /** * When `false`, the shadow will scale with the object. * When `true`, the shadow's offsetX, offsetY, and blur will not be affected by the object's scale. * default to false * @type Boolean * @default */ declare nonScaling: boolean; declare id: number; static ownDefaults = shadowDefaultValues; static type = 'shadow'; /** * @see {@link http://fabricjs.com/shadows|Shadow demo} * @param {Object|String} [options] Options object with any of color, blur, offsetX, offsetY properties or string (e.g. "rgba(0,0,0,0.2) 2px 2px 10px") */ constructor(options: Partial>); constructor(svgAttribute: string); constructor(arg0: string | Partial>) { const options: Partial> = typeof arg0 === 'string' ? Shadow.parseShadow(arg0) : arg0; Object.assign(this, Shadow.ownDefaults, options); this.id = uid(); } /** * @param {String} value Shadow value to parse * @return {Object} Shadow object with color, offsetX, offsetY and blur */ static parseShadow(value: string) { const shadowStr = value.trim(), [, offsetX = 0, offsetY = 0, blur = 0] = ( reOffsetsAndBlur.exec(shadowStr) || [] ).map((value) => parseFloat(value) || 0), color = (shadowStr.replace(reOffsetsAndBlur, '') || 'rgb(0,0,0)').trim(); return { color, offsetX, offsetY, blur, }; } /** * Returns a string representation of an instance * @see http://www.w3.org/TR/css-text-decor-3/#text-shadow * @return {String} Returns CSS3 text-shadow declaration */ toString() { return [this.offsetX, this.offsetY, this.blur, this.color].join('px '); } /** * Returns SVG representation of a shadow * @param {FabricObject} object * @return {String} SVG representation of a shadow */ toSVG(object: FabricObject) { const offset = rotateVector( new Point(this.offsetX, this.offsetY), degreesToRadians(-object.angle), ), BLUR_BOX = 20, color = new Color(this.color); let fBoxX = 40, fBoxY = 40; if (object.width && object.height) { //http://www.w3.org/TR/SVG/filters.html#FilterEffectsRegion // we add some extra space to filter box to contain the blur ( 20 ) fBoxX = toFixed( (Math.abs(offset.x) + this.blur) / object.width, config.NUM_FRACTION_DIGITS, ) * 100 + BLUR_BOX; fBoxY = toFixed( (Math.abs(offset.y) + this.blur) / object.height, config.NUM_FRACTION_DIGITS, ) * 100 + BLUR_BOX; } if (object.flipX) { offset.x *= -1; } if (object.flipY) { offset.y *= -1; } return `\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\n\n`; } /** * Returns object representation of a shadow * @return {Object} Object representation of a shadow instance */ toObject() { const data: SerializedShadowOptions = { color: this.color, blur: this.blur, offsetX: this.offsetX, offsetY: this.offsetY, affectStroke: this.affectStroke, nonScaling: this.nonScaling, type: (this.constructor as typeof Shadow).type, }; const defaults = Shadow.ownDefaults as SerializedShadowOptions; return !this.includeDefaultValues ? pickBy(data, (value, key) => value !== defaults[key]) : data; } static async fromObject(options: Partial>) { return new this(options); } } classRegistry.setClass(Shadow, 'shadow');