chore(plugin-annotations): Consolidating plugins

plugins/plugin-annotations/src/banner.mjs

@@ -0,0 +1,19 @@
+// Export macros
+export const bannerMacros = {
+  banner: function (so) {
+    // Mix defaults with settings object
+    so = {
+      text: '',
+      dy: -1,
+      spaces: 12,
+      repeat: 10,
+      className: '',
+      ...so,
+    }
+    so.path.attr('data-text-dy', so.dy).attr('data-text-class', `${so.className} center`)
+    const spacer = ' '.repeat(so.spaces)
+    let banner = spacer
+    for (let i = 0; i < so.repeat; i++) banner += so.text + '&#160;'.repeat(so.spaces)
+    so.path.attr('data-text', banner)
+  },
+}

plugins/plugin-annotations/src/bannerbox.mjs

@@ -0,0 +1,35 @@
+// Export macros
+export const bannerboxMacros = {
+  bannerbox: function (so, { points, Point, paths, Path, getId, macro }) {
+    // Spread so settings into defaults
+    so = {
+      topLeft: new Point(0, 0),
+      bottomRight: new Point(100, 100),
+      title: 'No title for this bannerbox',
+      margin: 15,
+      className: 'text-xs fill-note',
+      dy: 4,
+      spaces: 12,
+      repeat: 10,
+      ...so,
+    }
+    const offset = Math.sqrt(2 * Math.pow(so.margin, 2))
+
+    const id = getId()
+    paths[id] = new Path()
+      .move(so.topLeft.shift(135, offset))
+      .line(new Point(so.bottomRight.x, so.topLeft.y).shift(45, offset))
+      .line(so.bottomRight.shift(315, offset))
+      .line(new Point(so.topLeft.x, so.bottomRight.y).shift(225, offset))
+      .line(so.topLeft.shift(135, offset))
+      .close()
+
+    macro('banner', {
+      path: paths[id],
+      text: so.title,
+      className: 'text-xs fill-note',
+      repeat: 99,
+      dy: 4,
+    })
+  },
+}

plugins/plugin-annotations/src/dimensions.mjs

@@ -0,0 +1,157 @@
+const markers = `
+<marker orient="auto" refY="4.0" refX="0.0" id="dimensionFrom" style="overflow:visible;" markerWidth="12" markerHeight="8">
+	<path class="mark fill-mark" d="M 0,4 L 12,0 C 10,2 10,6  12,8 z" />
+</marker>
+<marker orient="auto" refY="4.0" refX="12.0" id="dimensionTo" style="overflow:visible;" markerWidth="12" markerHeight="8">
+	<path class="mark fill-mark" d="M 12,4 L 0,0 C 2,2 2,6  0,8 z" />
+</marker>
+`
+const prefix = '__paperless'
+
+function drawDimension(from, to, so, { Path, units }) {
+  const dimension = new Path()
+    .move(from)
+    .line(to)
+    .attr('class', 'mark')
+    .attr('data-text', so.text || units(from.dist(to)))
+    .attr('data-text-class', 'fill-mark center')
+  if (!so.noStartMarker) dimension.attributes.set('marker-start', 'url(#dimensionFrom)')
+  if (!so.noEndMarker) dimension.attributes.set('marker-end', 'url(#dimensionTo)')
+
+  return dimension
+}
+
+function drawLeader({ paths, Path }, from, to, id) {
+  paths[id] = new Path().move(from).line(to).attr('class', 'mark dotted')
+}
+
+function hleader(so, type, props, id) {
+  const { Point } = props
+  let point
+  if (typeof so.y === 'undefined' || so[type].y === so.y) {
+    point = so[type]
+  } else {
+    point = new Point(so[type].x, so.y)
+    drawLeader(props, so[type], point, id)
+  }
+
+  return point
+}
+
+function vleader(so, type, props, id) {
+  const { Point } = props
+  let point
+  if (typeof so.x === 'undefined' || so[type].x === so.x) {
+    point = so[type]
+  } else {
+    point = new Point(so.x, so[type].y)
+    drawLeader(props, so[type], point, id)
+  }
+
+  return point
+}
+
+function lleader(so, type, props, id) {
+  let point, rot, other
+  if (type === 'from') {
+    rot = 1
+    other = 'to'
+  } else {
+    rot = -1
+    other = 'from'
+  }
+  if (typeof so.d === 'undefined') {
+    point = so[type]
+  } else {
+    point = so[type].shiftTowards(so[other], so.d).rotate(90 * rot, so[type])
+    drawLeader(props, so[type], point, id)
+  }
+
+  return point
+}
+
+// Export hooks and macros
+export const dimensionsHooks = {
+  preRender: [
+    function (svg) {
+      if (svg.defs.indexOf(markers) === -1) svg.defs += markers
+    },
+  ],
+}
+export const dimensionsMacros = {
+  // horizontal
+  hd: function (so, props) {
+    const { getId, paths } = props
+    const id = so.id || getId(prefix)
+    paths[id] = drawDimension(
+      hleader(so, 'from', props, id + '_ls'),
+      hleader(so, 'to', props, id + '_le'),
+      so,
+      props
+    )
+  },
+  // vertical
+  vd: function (so, props) {
+    const { getId, paths } = props
+    const id = so.id || getId(prefix)
+    paths[id] = drawDimension(
+      vleader(so, 'from', props, id + '_ls'),
+      vleader(so, 'to', props, id + '_le'),
+      so,
+      props
+    )
+  },
+  // linear
+  ld: function (so, props) {
+    const { getId, paths } = props
+    const id = so.id || getId(prefix)
+    paths[id] = drawDimension(
+      lleader(so, 'from', props, id + '_ls'),
+      lleader(so, 'to', props, id + '_le'),
+      so,
+      props
+    )
+  },
+  // path
+  pd: function (so, props) {
+    const { getId, paths, scale, units } = props
+    const id = so.id || getId(prefix)
+    if (typeof so.d === 'undefined') so.d = 10 * scale
+    const dimension = so.path
+      .offset(so.d)
+      .attr('class', 'mark')
+      .attr('data-text', so.text || units(so.path.length()))
+      .attr('data-text-class', 'fill-mark center')
+    if (!so.noStartMarker) dimension.attributes.set('marker-start', 'url(#dimensionFrom)')
+    if (!so.noEndMarker) dimension.attributes.set('marker-end', 'url(#dimensionTo)')
+    paths[id] = dimension
+    drawLeader(props, so.path.start(), dimension.start(), id + '_ls')
+    drawLeader(props, so.path.end(), dimension.end(), id + '_le')
+  },
+  // Remove dimension
+  rmd: function (so, props) {
+    const { paths } = props
+    if (paths[so.id]) delete this.paths[so.id]
+    if (paths[`${so.id}_ls`]) delete paths[`${so.id}_ls`]
+    if (paths[`${so.id}_le`]) delete paths[`${so.id}_le`]
+    if (Array.isArray(so.ids)) {
+      for (const id of so.ids) {
+        if (paths[id]) delete paths[id]
+        if (paths[`${id}_ls`]) delete paths[`${id}_ls`]
+        if (paths[`${id}_le`]) delete paths[`${id}_le`]
+      }
+    }
+  },
+  // Remove all dimensions (with standard prefix)
+  rmad: function (params, props) {
+    const toRemove = {
+      points: props.point,
+      paths: props.paths,
+    }
+    for (let type in toRemove) {
+      for (let id in props[type]) {
+        if (id.slice(0, prefix.length) === prefix) delete props[type][id]
+      }
+    }
+  },
+}

plugins/plugin-annotations/src/index.mjs

@@ -4,11 +4,14 @@ import { buttonsHooks } from './buttons.mjs'
 import { logoHooks } from './logo.mjs'
 import { notchesHooks } from './notches.mjs'
 // Macros only
+import { bannerMacros } from './banner.mjs'
+import { bannerboxMacros } from './bannerbox.mjs'
 import { bartackMacros } from './bartack.mjs'
 import { crossboxMacros } from './crossbox.mjs'
 import { scaleboxMacros } from './scalebox.mjs'
 // Hooks and Macros
 import { cutonfoldMacros, cutonfoldHooks } from './cutonfold.mjs'
+import { dimensionsMacros, dimensionsHooks } from './dimensions.mjs'
 import { grainlineMacros, grainlineHooks } from './grainline.mjs'
 import { pleatMacros, pleatHooks } from './pleat.mjs'
 import { sewtogetherMacros, sewtogetherHooks } from './sewtogether.mjs'
@@ -22,16 +25,20 @@ export const plugin = {
       ...logoHooks.preRender,
       ...notchesHooks.preRender,
       ...cutonfoldHooks.preRender,
+      ...dimensionsHooks.preRender,
       ...grainlineHooks.preRender,
       ...pleatHooks.preRender,
       ...sewtogetherHooks.preRender,
     ],
   },
   macros: {
+    ...bannerMacros,
+    ...bannerboxMacros,
     ...bartackMacros,
     ...crossboxMacros,
     ...scaleboxMacros,
     ...cutonfoldMacros,
+    ...dimensionsMacros,
     ...grainlineMacros,
     ...pleatMacros,
     ...sewtogetherMacros,