1
0
Fork 0
freesewing/packages/plugin-designer/README.md
2019-04-19 08:21:36 +02:00

2.2 KiB

Freesewing logo

 freesewing
a library for made-to-measure sewing patterns

plugin-designer

A freesewing plugin to facilitate pattern design.

This plugin will add markers to your pattern for all points, it will illustrate Bezier curve handlers, and inject JavaScript to log information about points to the browser console when your hover over them.

In addition, it will log the entire pattern object to the console so you can inspect it.

If you want to design patterns, you may want to use this plugin while doing so.

Usage

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

On node.js:

import pattern from '@freesewing/pattern-brian'
import theme from '@freesewing/plugin-theme'
import designer from '@freesewing/plugin-designer'

pattern.with(theme).with(designer);

In the browser, this plugin will register as freesewing.plugins.designer:

<script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/pattern-brian"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-theme"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-designer"></script>

<script>
var pattern = freesewing.patterns.brian
  .with(freesewing.plugins.theme)
  .with(freesewing.plugins.designer);
</script>

Example

Below is a screenshot of a part of the pattern and the browser console.

You can see the extra markers on the pattern, and the info in the console.

Example of the designer plugin

Install

To install, run:

npm install @freesewing/plugin-designer

Build

To build this plugin, run:

npm run build

License: MIT

See the license file for details.