GMartigny/pencilJS

View on GitHub
src/modules/linear-gradient/linear-gradient.js

Summary

Maintainability
A
50 mins
Test Coverage
import Position from "@pencil.js/position";

/**
 * @module LinearGradient
 */

/**
 * Linear-gradient class
 * <br><img src="./media/examples/linear-gradient.png" alt="linear-gradient demo"/>
 * @class
 */
export default class LinearGradient {
    /**
     * Linear-gradient constructor
     * @param {PositionDefinition} fromPosition - Starting position of the gradient
     * @param {PositionDefinition} toPosition - Ending position of the gradient
     * @param {Object} colorStops - Set of colors to go through (key is position [from 0 to 1], value is the color)
     * @example new LinearGradient(from, to, { 0: "red", 1: "green" });
     */
    constructor (fromPosition, toPosition, colorStops) {
        this.from = Position.from(fromPosition);
        this.to = Position.from(toPosition);
        this.colorStops = colorStops;
    }

    /**
     * Return a drawing context compatible gradient
     * @param {CanvasRenderingContext2D} ctx - Drawing context
     * @return {CanvasGradient}
     */
    toString (ctx) {
        const from = Position.from(this.from);
        const to = Position.from(this.to);
        const gradient = ctx.createLinearGradient(from.x, from.y, to.x, to.y);
        Object.keys(this.colorStops).forEach(key => gradient.addColorStop(key, this.colorStops[key].toString()));
        return gradient;
    }
}