import { macroName, debugStyle, round } from "./utils"; import Part from "./part"; import Point from "./point"; import Path from "./path"; import Snippet from "./snippet"; import Svg from "./svg"; import Hooks from "./hooks"; import pack from "bin-pack"; import Store from "./store"; import * as hooklib from "hooks"; export default function Pattern(config = false) { // width and height properties this.width = false; this.height = false; // Hooks and Svg instance for (let k in hooklib) this[k] = hooklib[k]; this.hooks = new Hooks(); Svg.prototype.hooks = this.hooks; // Data containers this.settings = { mode: "draft", idPrefix: "fs-", locale: "en", units: "metric", margin: 2 }; this.options = {}; this.store = new Store(); this.parts = {}; // Merge config with defaults let defaults = { measurements: {}, options: {} }; this.config = { ...defaults, ...config }; for (let i in config.options) { let option = config.options[i]; if (typeof option === "object") { if (typeof option.pct !== "undefined") this.options[i] = option.pct / 100; else if (typeof option.mm !== "undefined") this.options[i] = option.mm; else if (typeof option.deg !== "undefined") this.options[i] = option.deg; else if (typeof option.dflt !== "undefined") this.options[i] = option.dflt; else throw "Unknown option type"; } else { this.options[i] = option; } } // Constructors this.Part = Part; this.Point = Point; this.Path = Path; this.Snippet = Snippet; // Context object to inject in part prototype this.context = { parts: this.parts, config: this.config, settings: this.settings, options: this.options, store: this.store }; this.Part.prototype.context = this.context; this.Part.prototype.macros = {}; this.Part.prototype.hooks = this.hooks; } /** * @throws Will throw an error when called */ Pattern.prototype.draft = function() { throw Error( "You have to implement the draft() method in your Pattern instance." ); }; /** * Handles pattern sampling */ Pattern.prototype.sample = function() { if (this.settings.sample.type === "option") { return this.sampleOption(this.settings.sample.option); } else if (this.settings.sample.type === "measurement") { return this.sampleMeasurement(this.settings.sample.measurement); } else if (this.settings.sample.type === "models") { return this.sampleModels( this.settings.sample.models, this.settings.sample.focus || false ); } }; Pattern.prototype.sampleParts = function() { let parts = {}; this.settings.mode = "sample"; this.settings.paperless = false; this.draft(); for (let i in this.parts) { parts[i] = new Part(); parts[i].render = this.parts[i].render; } return parts; }; Pattern.prototype.sampleRun = function(parts, anchors, l, extraClass = false) { this.draft(); for (let i in this.parts) { let anchor = false; let dx = 0; let dy = 0; if (this.parts[i].points.anchor) { if (typeof anchors[i] === "undefined") anchors[i] = this.parts[i].points.anchor; else { if (!anchors[i].sitsOn(this.parts[i].points.anchor)) { dx = this.parts[i].points.anchor.dx(anchors[i]); dy = this.parts[i].points.anchor.dy(anchors[i]); } } } for (let j in this.parts[i].paths) { parts[i].paths[j + "_" + l] = this.parts[i].paths[j] .clone() .attr("class", "sample sample-" + l, true); if (this.parts[i].points.anchor) parts[i].paths[j + "_" + l] = parts[i].paths[j + "_" + l].translate( dx, dy ); if (extraClass !== false) parts[i].paths[j + "_" + l].attributes.add("class", extraClass); } } }; /** * Handles option sampling */ Pattern.prototype.sampleOption = function(optionName) { let step, val; let factor = 1; let anchors = {}; let parts = this.sampleParts(); let option = this.config.options[optionName]; if (typeof option.min === "undefined" || typeof option.max === "undefined") { let min = option * 0.9; let max = option * 1.1; option = { min, max }; } if (typeof option.pct !== "undefined") factor = 100; val = option.min / factor; step = (option.max / factor - val) / 9; for (let l = 1; l < 11; l++) { this.options[optionName] = val; this.debug( debugStyle("info", "🔬 Sample run"), `Sampling option ${optionName} with value ${round(val)}` ); this.sampleRun(parts, anchors, l); val += step; } this.parts = parts; return this; }; /** * Handles measurement sampling */ Pattern.prototype.sampleMeasurement = function(measurementName) { let anchors = {}; let parts = this.sampleParts(); let val = this.settings.measurements[measurementName]; if (val === undefined) throw "Cannot sample a measurement that is undefined"; let step = val / 50; val = val * 0.9; for (let l = 1; l < 11; l++) { this.settings.measurements[measurementName] = val; this.debug( debugStyle("info", "🔬 Sample run"), `Sampling measurement ${measurementName} with value ${round(val)}` ); this.sampleRun(parts, anchors, l); val += step; } this.parts = parts; return this; }; /** * Handles models sampling */ Pattern.prototype.sampleModels = function(models, focus = false) { let anchors = {}; let parts = this.sampleParts(); let count = 0; for (let l in models) { count++; this.settings.measurements = models[l]; this.debug(debugStyle("info", "🔬 Sample run"), `Sampling model ${l}`); let className = l === focus ? "sample-focus" : ""; this.sampleRun(parts, anchors, count, className); } this.parts = parts; return this; }; /** Debug method, exposes debug hook */ Pattern.prototype.debug = function(data) {}; Pattern.prototype.render = function() { this.svg = new Svg(this); return this.pack().svg.render(this); }; Pattern.prototype.on = function(hook, method) { if (typeof this.hooks._hooks[hook] === "undefined") { this.hooks._hooks[hook] = []; } this.hooks._hooks[hook].push(method); // Pattern object hooks need to be attached on load let localHooks = [ "preDraft", "postDraft", "preSample", "postSample", "debug" ]; if (localHooks.includes(hook)) { let self = this; this.hooks.attach(hook, self); } }; Pattern.prototype.with = function(plugin) { this.debug( debugStyle("success", "🔌 Plugin loaded"), `${plugin.name} v${plugin.version}` ); if (plugin.hooks) this.loadPluginHooks(plugin); if (plugin.macros) this.loadPluginMacros(plugin); return this; }; Pattern.prototype.loadPluginHooks = function(plugin) { for (let hook of this.hooks.all) { if (typeof plugin.hooks[hook] === "function") { this.on(hook, plugin.hooks[hook]); } else if (typeof plugin.hooks[hook] === "object") { for (let method of plugin.hooks[hook]) { this.on(hook, method); } } } }; Pattern.prototype.loadPluginMacros = function(plugin) { for (let macro in plugin.macros) { if (typeof plugin.macros[macro] === "function") { this.macro(macro, plugin.macros[macro]); } } }; Pattern.prototype.macro = function(key, method) { this.Part.prototype[macroName(key)] = method; }; /** Packs parts in a 2D space and sets pattern size */ Pattern.prototype.pack = function() { let bins = []; for (let key in this.parts) { let part = this.parts[key]; // Avoid multiple render calls to cause stacking of transforms part.attributes.set("transform", ""); if (part.render && this.needs(key)) { part.stack(); bins.push({ id: key, width: part.bottomRight.x - part.topLeft.x, height: part.bottomRight.y - part.topLeft.y }); } } let size = pack(bins, { inPlace: true }); for (let bin of bins) { let part = this.parts[bin.id]; if (bin.x !== 0 || bin.y !== 0) part.attr("transform", `translate (${bin.x}, ${bin.y})`); } this.width = size.width; this.height = size.height; return this; }; /** Determines whether a part is needed * This depends on the 'only' setting. People can pass * the name of a part, or an array of parts * The absence of only means all parts are needed. * * If partName is an array of names, any name needed * will cause this to return true */ Pattern.prototype.needs = function(partName, strict = false) { if (typeof partName !== "string") { for (let part of partName) { if (this.needs(part, strict)) return true; } return false; } if (typeof this.settings.only === "undefined") { if (strict) return false; else return true; } else if (this.settings.only === partName) return true; else if ( typeof this.settings.only === "object" && this.settings.only.indexOf(partName) !== -1 ) { return true; } else return false; };