MetaFusion/docs/dna_viewer_API.md

54 lines
1.6 KiB
Markdown
Raw Normal View History

2025-01-06 23:33:41 +08:00
# 环境设置
为了能够从 dna_viewer 导入,需要设置环境。这可以通过在下面提到的任何示例开头添加以下代码来完成:
```
from sys import path as syspath, platform
from os import environ, path as ospath
ROOT_DIR = fr"{ospath.dirname(ospath.abspath(__file__))}/..".replace("\\", "/") # 如果使用 Maya,请使用绝对路径
ROOT_LIB_DIR = fr"{ROOT_DIR}/lib"
if platform == "win32":
LIB_DIR = f"{ROOT_LIB_DIR}/windows"
elif platform == "linux":
LIB_DIR = f"{ROOT_LIB_DIR}/linux"
else:
raise OSError("不支持的操作系统,请编译依赖项并添加 LIB_DIR 值")
if "MAYA_PLUG_IN_PATH" in environ:
separator = ":" if platform == "linux" else ";"
environ["MAYA_PLUG_IN_PATH"] = separator.join([environ["MAYA_PLUG_IN_PATH"], LIB_DIR])
else:
environ["MAYA_PLUG_IN_PATH"] = LIB_DIR
syspath.append(ROOT_DIR)
syspath.append(LIB_DIR)
```
从 Maya 运行时,应将 `ROOT_DIR` 设置为仓库根目录的绝对路径。
# DNA
## 加载 DNA
加载 DNA 并返回一个 [`DNA`](../dna_viewer/dnalib/dnalib.py#L13) 对象。
```
from dna_viewer import DNA
dna_ada = DNA(DNA_PATH_ADA)
dna_taro = DNA(DNA_PATH_TARO)
```
这使用以下参数:
- `dna_path: str` - 要使用的 DNA 文件的路径。
- `layers: Optional[List[Layer]]` - 要加载的 DNA 部分列表。如果未传递任何内容,将加载整个 DNA。等同于传递 Layer.all。
## 构建网格
构建网格 API 说明位于[此处](/docs/dna_viewer_api_build_meshes.md)。
## 构建骨骼
构建骨骼 API 说明位于[此处](/docs/dna_viewer_api_build_rig.md)。