MetaFusion/docs/dna_viewer_api_build_rig.md
2025-01-06 23:33:41 +08:00

43 lines
1.4 KiB
Markdown

# 构建骨骼 ([`build_rig`](../dna_viewer/api.py#L9))
构建骨骼 API 用于从给定的 DNA 文件路径在 Maya 场景中轻松组装角色骨骼。
## 创建 RigConfig 实例([`RigConfig`](../dna_viewer/builder/config.py#35))
创建一个将在骨骼构建过程中使用的配置对象。
```
from dna_viewer import RigConfig
```
以下是 `RigConfig` 类的一些属性:
- `gui_path: str` - GUI 文件路径。
- `analog_gui_path: str` - 模拟 GUI 文件路径。
- `aas_path: str` - 附加组装脚本路径。
- `aas_method: str` - 应从附加组装脚本调用的方法名称。
- `add_ctrl_attributes_on_root_joint: bool` - 表示是否应在根关节上添加属性的标志,默认为 `True`
- `add_key_frames: bool` - 表示是否应添加关键帧的标志,默认为 `True`
## 示例
**重要**: 运行此示例之前需要执行上述[环境设置](dna_viewer_api.md#environment-setup)。
```
from dna_viewer import DNA, RigConfig, build_rig
# if you use Maya, use absolute path
ROOT_DIR = f"{ospath.dirname(ospath.abspath(__file__))}/..".replace("\\", "/")
# Sets the values that will used
DNA_PATH_ADA = f"{ROOT_DIR}/data/dna_files/Ada.dna"
dna_ada = DNA(DNA_PATH_ADA)
config = RigConfig(
gui_path=f"{ROOT_DIR}/data/gui.ma",
analog_gui_path=f"{ROOT_DIR}/data/analog_gui.ma",
aas_path=f"{ROOT_DIR}/data/additional_assemble_script.py",
)
# Creates the rig
build_rig(dna=dna_ada, config=config)
```