1
0
Fork 0
freesewing/markdown/dev/reference/api/pattern/samplemodels/en.md

71 lines
1.8 KiB
Markdown
Raw Normal View History

---
title: Pattern.sampleModels()
---
2022-02-20 14:35:50 +01:00
A pattern's `sampleModels()` method will _sample_ a pattern for a list of
2021-09-25 17:05:18 +02:00
models you pass to it. It will draft different iterations of the pattern,
using the measurements for each model you pass to it.
2021-09-25 17:05:18 +02:00
<Tip>
The goal of model sampling is to verify that a pattern grades correctly up and down as sizes change.
2021-09-25 17:05:18 +02:00
</Tip>
2021-09-25 17:05:18 +02:00
<Note>This method is chainable as it returns the Pattern object</Note>
<Tip>
###### Anchor your samples
2021-09-25 17:05:18 +02:00
If you add a point named `anchor` to your pattern part, the different samples
will be anchored on this point.
In other words, for each sample, the anchor point will be kept in the same location.
</Tip>
2021-09-25 17:05:18 +02:00
## Pattern.sampleModels() signature
```js
Pattern pattern.sampleModels(object models, string focus)
2022-02-19 08:04:25 +01:00
```
2021-09-25 17:05:18 +02:00
The models object you pass as the first parameter should be structured as such:
2021-09-25 17:05:18 +02:00
```js
{
modelName1: {
measurement1: valueInMm,
measurement2: valueInMm,
// ...
},
modelName2: {
measurement1: valueInMm,
measurement2: valueInMm,
// ...
},
// ...
}
```
2022-02-19 08:04:25 +01:00
The (optional) string you can pass as the second parameter should hold the
2021-09-25 17:05:18 +02:00
key of one of the models in the first parameter. In our example above, it
could hold `modelName2` for example.
2022-02-20 14:35:50 +01:00
By passing this second parameter, you can put the _focus_ on one of the models,
2022-02-19 08:04:25 +01:00
which will influence the render style, and make it
easier to see a comparison between a given set of measrurements, and the rest.
2021-09-25 17:05:18 +02:00
Alternatively, you can use the `Pattern.sample()` method and set `settings.sample.focus` to the key
identifying your model in the models object.
2021-09-25 17:05:18 +02:00
## Pattern.sampleModels() example
```js
import Aaron from "@freesewing/aaron"
import models from "@freesewing/models"
const Aaron = new Aaron()
const svg = aaron.sampleModels(models, "manSize38").render()
2022-02-19 08:04:25 +01:00
```