swing-ui 0.1.25 → 1.0.1

package/classes/Stroke.js

@@ -0,0 +1,115 @@
+
+/**
+ * Stroke (border) of any Shape (objects that extend {@link Shape} class).
+ * @class
+ * @global
+ * @see Shape
+ */
+export class Stroke
+{
+	/**
+	 * Static enum for stroke cap styles.
+	 * Defines how the ends of open subpaths are drawn.
+	 *
+	 * @readonly
+	 * @enum {number}
+	 * @property {number} Butt - Flat end, no extension beyond the end point.
+	 * @property {number} Round - Rounded end with a half-circle extension.
+	 * @property {number} Square - Flat end extended by half the line width.
+	 * @example
+	 * Stroke.Cap.Round
+	 */
+	static Cap = Object.freeze({
+		Butt: 0,
+		Round: 1,
+		Square: 2
+	});
+	
+	/**
+	 * Static enum for stroke join styles.
+	 * Defines how two connected line segments are joined.
+	 *
+	 * @readonly
+	 * @enum {number}
+	 * @property {number} Miter - Sharp corner with extended outer edges.
+	 * @property {number} Round - Rounded corner with a circular arc.
+	 * @property {number} Bevel - Flattened corner with a straight cut.
+	 * @example
+	 * Stroke.Join.Bevel
+	 */
+	static Join = Object.freeze({
+		Miter: 0,
+		Round: 1,
+		Bevel: 2
+	});
+	
+	/**
+	 * Static enum for stroke alignment.
+	 * Defines how the stroke is positioned relative to the shape’s outline.
+	 *
+	 * @readonly
+	 * @enum {number}
+	 * @property {number} Inside - Stroke fully inside the shape path.
+	 * @property {number} Center - Stroke centered on the shape path.
+	 * @property {number} Outside - Stroke fully outside the shape path.
+	 * @example
+	 * Stroke.Alignment.Outside
+	 */
+	static Alignment = Object.freeze({
+		Inside: -1,
+		Center: 0,
+		Outside: 1
+	});
+	
+	#prop = {};
+	
+	/**
+	 * Create an instance of a Stroke object.
+	 *
+	 * @param {number} [width=1] - Specifies the thickness of the line. Default is 1 pixel thick.
+	 * @param {string} [background] - Stroke color. e.g. #008800. Setting gradients and a background image will be also possible in future.
+	 * @param {Stroke.Alignment} [alignment] - Where stroke line is drawn: outside of shape, on the edge, or inside. Default is Center. Valid values: Stroke.Alignment.Outside, Stroke.Alignment.Center, Stroke.Alignment.Inside.
+	 * @param {Stroke.Cap} [cap] - Defines the end cap style of the line. Default is Square. Valid values: Stroke.Cap.Square, Stroke.Cap.Butt, Stroke.Cap.Round.
+	 * @param {Stroke.Join} [join] - Specifies the line join style. Default is Miter. Valid values: Stroke.Join.Miter, Stroke.Join.Bevel, Stroke.Join.Round.
+	 * @param {number} [miterLimit] - Applicable when join is set to JOIN_MITER. It controls the maximum miter length. If the miter length exceeds this limit, the join is beveled instead.
+	 * @param {number} [dashSize] - Size of a dash in a dash pattern,
+	 * @param {number} [dashGapSize] - Size of gaps between dashes in dash pattern
+	 * @param {number} [dashPhase] - Specifies the starting point of the dash pattern. It determines where in the dash pattern the line starts. A positive value shifts the pattern to the right, and a negative value shifts it to the left.
+	 */
+	constructor(width = 1, background = "#000000", alignment = Stroke.Alignment.Center, cap = Stroke.Cap.Square, join = Stroke.Join.Miter, miterLimit = 10, dashSize = null, dashGapSize = null, dashPhase = 0)
+	{
+		this.#prop.width = parseFloat(width);
+		
+		this.#prop.background = background;
+		this.#prop.alignment = alignment;
+		this.#prop.cap = parseInt(cap);
+		this.#prop.join = parseInt(join);
+		this.#prop.miterLimit = parseFloat(miterLimit);
+		if(dashSize !== null) this.#prop.dashSize = parseFloat(dashSize);
+		if(dashGapSize !== null) this.#prop.dashGapSize = parseFloat(dashGapSize);
+		if(dashPhase > 0 || dashPhase < 0) this.#prop.dashPhase = parseFloat(dashPhase);
+	}
+	
+	/**
+	 * Convert Stroke to JSON Object to be able to store it or modify it and convert back to the Stroke object using Stroke.fromObject(stroke).
+	 *
+	 * @return {object} Returns an object holding all properties of this Stroke object.
+	 */
+	toObject()
+	{
+		return {...this.#prop};
+	}
+	
+	/**
+	 * Restore Stroke from JSON object that represents all properties of the Stroke object.
+	 *
+	 * @param {object} stroke - JSON object that holds properties of a Stroke object. It can be generated by stroke.toObject().
+	 * @return {Stroke} Returns an instance of a new Stroke object.
+	 */
+	static fromObject(stroke)
+	{
+		if(stroke === null || stroke === undefined) return undefined;
+		
+		return new Stroke(stroke.width ?? 0, stroke.background ?? "#000000", stroke.alignment ?? Stroke.Alignment.Center, stroke.cap ?? Stroke.Cap.Square, stroke.join ?? Stroke.Join.Miter, stroke.miterLimit ?? 10, stroke.dashSize ?? null, stroke.dashGapSize ?? null, stroke.dashPhase ?? 0);
+	}
+}