|
a |
|
b/Docs/bm_config/bm_plugin.md |
|
|
1 |
# Body Model Plugin (BM-Plugin) |
|
|
2 |
|
|
|
3 |
The Body Model Plugin is a piece of software meant to be used as a |
|
|
4 |
high level interface on top of AnyScript, particularly for setting |
|
|
5 |
BM statements. |
|
|
6 |
|
|
|
7 |
The example below configures a model with no arms and sets the |
|
|
8 |
"TLEM Leg v2" legs model. |
|
|
9 |
|
|
|
10 |
```{image} /_static/bm_plugin_1.png |
|
|
11 |
:align: center |
|
|
12 |
:width: 500 |
|
|
13 |
``` |
|
|
14 |
|
|
|
15 |
The BM-Plugin is available with models that make use of the |
|
|
16 |
Human Model: |
|
|
17 |
|
|
|
18 |
```AnyScriptDoc |
|
|
19 |
// Include the HumanModel to configure it using BM-Plugin |
|
|
20 |
#include "<ANYBODY_PATH_BODY>\HumanModel.any" |
|
|
21 |
``` |
|
|
22 |
|
|
|
23 |
To start BM-Plugin, a button comes available in AMS in order to |
|
|
24 |
launch it: |
|
|
25 |
|
|
|
26 |
```{image} /_static/bm_plugin_2.png |
|
|
27 |
:align: center |
|
|
28 |
:width: 700 |
|
|
29 |
``` |
|
|
30 |
|
|
|
31 |
The BM statements are classified in five tabs which are providing |
|
|
32 |
instantaneous visual feedback: `Body`, `Legs`, `Arms`, |
|
|
33 |
`Trunk`, `Mannequin Drivers`. |
|
|
34 |
|
|
|
35 |
The complete configurable list of BM statements can be found in the |
|
|
36 |
`Advanced` tab: |
|
|
37 |
|
|
|
38 |
```{image} /_static/bm_plugin_3.PNG |
|
|
39 |
:align: center |
|
|
40 |
:width: 500 |
|
|
41 |
``` |
|
|
42 |
|
|
|
43 |
The BM statements are stored in a dedicated file located in the |
|
|
44 |
`Model` folder next to the `.main.any` file of the model. |
|
|
45 |
For the BM statements set in this file to take effect, the file |
|
|
46 |
needs to be included in the model: |
|
|
47 |
|
|
|
48 |
```AnyScriptDoc |
|
|
49 |
// Include the file containing the BM statements. |
|
|
50 |
#include "Model/BodyModelConfiguration.any" |
|
|
51 |
``` |
|
|
52 |
|
|
|
53 |
This structure of for the model's files is encouraged regardless |
|
|
54 |
if the BM-Plugin is used or not. The content of the configuration |
|
|
55 |
file can be seen in the `Script File` tab of the plugin: |
|
|
56 |
|
|
|
57 |
```{image} /_static/bm_plugin_4.PNG |
|
|
58 |
:align: center |
|
|
59 |
:width: 500 |
|
|
60 |
``` |