Ninja Programmers Mindmeld

    @freesewing/macro-dimension

    0.3.0 • Public • Published

    Freesewing logo

     freesewing
    a library for made-to-measure sewing patterns

    plugin-dimension

    A freesewing plugin to add dimensions to your (paperless) patterns.

    Install

    Install this plugin from NPM:

    npm install @freesewing/plugins-dimension --save

    Loading the plugin

    To load this plugin, add it to your instantiated pattern:

    import pattern from '@freesewing/pattern-brian'
    import theme from '@freesewing/plugin-theme'
    import dimension from '@freesewing/plugin-dimension'
    
    pattern.with(theme).with(dimension);

    You now have the following macros available:

    Name Description
    hd Adds a horizontal dimension
    vd Adds a vertical dimension
    ld Adds a linear dimension
    pd Adds a dimension that follows a path

    You can use them as such:

    macro('<name>', {<options>});

    Parameters

    As all freesewing plugins, all options needs to be passed as a single object.

    hd

    part.macro('hd', {
      from: points.cbNeck
    , to: points.cbHips,
      y: points.cbHips + 15
    });
    • from : A point object
    • to : A point object
    • y : The y-value at which to place the dimension

    vd

    part.macro('vd', {
      from: points.cbNeck
    , to: points.cbHips,
      x: points.cbHips + 15
    });
    • from : A point object
    • to : A point object
    • x : The x-value at which to place the dimension

    As all freesewing macros, bundle these parameters into a single object.

    ld

    part.macro('ld', {
      from: points.cbNeck
    , to: points.cbHips,
      d: 15
    });
    • from : A point object
    • to : A point object
    • d : The distance by which to offset the dimension from the line between from and to

    As all freesewing macros, bundle these parameters into a single object.

    pd

    part.macro('pd', {
      path: new path().move(points.cbNeck).curve(points.cbNeckCp1, points.cbNeckCp2,  points.cbHips),
      d: 15
    });
    • path : A path object
    • d : The distance by which to offset the dimension from the path

    As all freesewing macros, bundle these parameters into a single object.

    Example

    Below is an example of different dimensions.

    Example of the dimension plugin

    Where to get help

    Questions? Stuck? The freesewing chat room on Gitter is the best place to ask for help.

    Install

    npm i @freesewing/macro-dimension

    DownloadsWeekly Downloads

    3

    Version

    0.3.0

    License

    MIT

    Unpacked Size

    183 kB

    Total Files

    7

    Last publish

    Collaborators

    • joostdecock