1
0
Fork 0
freesewing/sites/dev/docs/tutorials/pattern-design/part2/adding-measurements/readme.mdx

69 lines
2.2 KiB
Text
Raw Normal View History

---
title: Adding measurements
2023-09-30 14:04:18 +02:00
order: 30
---
FreeSewing is all about _bespoke_ sewing patterns -- or *parametric
2023-09-28 09:11:06 +02:00
design* to use a more generic term.
That means that when drafting our pattern, I will take the measurements provided
by the user into account.
Which begs the question, which measurements?
2023-09-28 09:11:06 +02:00
As the pattern designers, you get to decide which measurements are used
to draft the pattern. For this bib, I am going to use the
_head circumference_.
So let's add it as a required measurement.
## Adding required measurements
2023-09-30 14:04:18 +02:00
In our `src/bib.mjs` file, we will add a `measurements` property to the `bib` object.
2023-09-28 09:11:06 +02:00
This property will be an Array (a list) holding all required measurements for this part.
I am using [*the official name* of the measurement](/reference/measurements) here. For head
circumference, that name is `head`.
:::note [FIXME]
2024-03-16 21:06:19 +00:00
The `design/src/bib.mjs` "language" title on the code snippets is out of date. It is used in the tutorial from this point forward to maintain syntax-highlight not yet available for the `src/bib.mjs` title, but should be replaced with `src/bib.mjs`.
:::
```design/src/bib.mjs
function draftBib({ part }) {
return part
}
export const bib = {
2023-09-30 14:04:18 +02:00
name: 'fromscratch.bib',
2023-08-08 13:20:46 -05:00
draft: draftBib,
// highlight-start
2023-09-28 09:11:06 +02:00
measurements: [ 'head' ],
// highlight-end
}
```
2023-09-28 09:11:06 +02:00
From now on, this part requires the `head` measurement.
2023-09-28 09:11:06 +02:00
This change will also get picked up by the development environment, which will now complain that it is missing some measurements.
Since it's just one measurement, I will simply enter a value by hand.
For example `38` as 38 cm is a realistic head circumference measurement for a baby.
:::tip
2023-09-28 09:11:06 +02:00
##### Why using standard measurements names matters
2023-09-28 09:11:06 +02:00
In principle, I can use any name I want for our measurements.
The FreeSewing core library does not care.
However, if everybody uses their own (names for) measurements, then people
aren't able to re-use their measurements across designs.
So if you have any intention at all to play nice with the FreeSewing ecosystem,
please make sure to re-use the names of existing measurements, rather than
invent your own.
See the [best practices](/guides/best-practices#reuse-measurements) on this
topic for details.
2023-09-28 09:11:06 +02:00
:::