@freesewing/plugin-annotations/src/grainline.mjs

A FreeSewing plugin that provides pattern annotations

/*
 * Defaults for the grainline macro
 */
const macroDefaults = {
  classes: {
    line: 'note',
    text: 'center fill-note',
  },
  id: 'grainline',
  margin: 0.05,
  text: 'plugin-annotations:grainline',
}

// Export defs
export const grainlineDefs = [
  {
    name: 'grainlineFrom',
    def: (scale) => `
<marker orient="auto" refY="0" refX="0" id="grainlineFrom" style="overflow:visible;" markerWidth="12" markerHeight="8">
	<path class="note fill-note" d="M -10,0 L 2,-4 C 0,-2 0,2  2,4 z" transform="scale(${scale})"/>
</marker>`,
  },
  {
    name: 'grainlineTo',
    def: (scale) => `
<marker orient="auto" refY="0" refX="0" id="grainlineTo" style="overflow:visible;" markerWidth="12" markerHeight="8">
	<path class="note fill-note" d="M 10,0 L -2,-4 C 0,-2 -2,2  -2,4 z" transform="scale(${scale})"/>
</marker>`,
  },
]

/*
 * The rmgrainline macro
 */
const rmgrainline = (id = macroDefaults.id, { store, part }) => {
  if (store.cutlist.getGrainOrigin() === 'grainline') store.cutlist.removeGrain()

  return store.removeMacroNodes(id, 'grainline', part)
}

/*
 * The grainline macro
 */
const grainline = function (config = {}, { paths, Path, Point, complete, store, log }) {
  /*
   * Don't add a cutonfold indicator when complete is false, unless force is true
   */
  if (!complete && !config.force) return

  /*
   * Merge macro defaults with user-provided config to create the macro config (mc)
   */
  const mc = {
    ...macroDefaults,
    ...config,
    classes: macroDefaults.classes,
  }
  if (config.classes) mc.classes = { ...mc.classes, ...config.classes }

  /*
   * Make sure mc.from and mc.to are Point instances
   */
  if (!mc.from || typeof mc.from.attr !== 'function') {
    log.warn(`Grainline macro called without a valid from point. Using (0,0) for from.`)
    mc.from = new Point(0, 0)
  }
  if (!mc.to || typeof mc.to.attr !== 'function') {
    log.warn(`Grainline macro called without a valid to point. Using (666,666) for to.`)
    mc.to = new Point(666, 666)
  }

  /*
   * Store angle for use in cutlist
   */
  store.cutlist.setGrain(mc.from.angle(mc.to), 'grainline')

  /*
   * Get the list of IDs
   */
  const ids = store.generateMacroIds(['line'], mc.id)

  /*
   * Draw the path
   */
  const from = mc.from.shiftFractionTowards(mc.to, 0.05)
  const to = mc.to.shiftFractionTowards(mc.from, 0.05)
  paths[ids.line] = new Path()
    .move(from)
    .line(to)
    .attr('class', mc.classes.line)
    .attr('marker-start', 'url(#grainlineFrom)')
    .attr('marker-end', 'url(#grainlineTo)')
    .addText(mc.text, mc.classes.text)

  /*
   * Store all IDs in the store so we can remove this macro with rmgrainline
   */
  store.storeMacroIds(mc.id, { paths: ids })

  /*
   * Returning ids is a best practice for FreeSewing macros
   */
  return store.getMacroIds(mc.id)
}

// Export macros
export const grainlineMacros = { grainline, rmgrainline }