CozyBlanket 网络 API
了解 CozyBlanket 的网络功能如何协同运作,简化您的工作流程。
CozyBlanket 网络功能
CozyBlanket 的远程网络功能可让桌面 DCC 软件、服务器和流程工具控制 CozyBlanket,从而与现有软件集成。
请确保已在 CozyBlanket 中启用网络功能。网络功能仅包含在 Standard 许可证中。
包内包含:
- ✓ 带 CLI 的 Python 模块
- ✓ Blender 插件(Windows、Mac、Linux)
- ✓ ZBrush 插件(Windows) 实验性
软件集成
命令行界面
通过 CLI,您可以从终端或脚本快速操作 CozyBlanket。
python cli.py --help # List all supported commands
python -m cozyblanket.cli --help # If installed via pip Blender 插件
Blender 插件可在重拓扑工作流程中与 CozyBlanket 无缝集成。
需要 Blender 3.0 或更高版本。
安装
前往 Edit > Preferences > Add-ons > Install,选择 cozyblanket_remote_blender.zip 文件以安装插件。
功能
- 向 CozyBlanket 推送一个或多个目标对象
- 向 CozyBlanket 推送一个或多个目标对象及一个 EditMesh
- 将当前 CozyBlanket EditMesh 拉取到活动对象
- 将 EditMesh 和 CozyBlanket 摄像机位置实时同步到 Blender
插件操作可在 N Panel 中找到。
ZBrush 插件(实验性)
实验性 ZBrush 插件可在雕刻工作流程中与 CozyBlanket 集成。
需要在 Windows 上运行 Maxon ZBrush 2022。
安装
将提供的 ZBrush 文件夹中的内容复制到:C:/Program Files/Maxon/ZBrush2022/ZStartup/ZPlugs64。
功能
- 将当前 SubTool 推送到 CozyBlanket
- 将 CozyBlanket EditMesh 拉取到当前 SubTool
这些工具位于 ZPlugins > CozyBlanket 菜单中。
Python 模块集成
附带的 Python 模块提供了 CozyBlanket 网络 API 的参考实现,还包含在编写流程脚本时直接导入 .obj 文件的实用函数。
pip 安装命令: pip install cozyblanket
使用示例
from cozyblanket import CozyBlanketConnection
# Connect to a running instance
CB = CozyBlanketConnection() # Optional device_id argument
CB.connect()
# Close current document and clear scene
CB.document_close()
CB.scene_clear()
# Push new retopology target from OBJ
CB.target_push_obj("target.obj", "named_target")
CB.target_load("named_target")
# Save current mesh to OBJ
CB.editmesh_pull_obj("editmesh.obj")
# Add remote action button
CB.remote_actions_add(
"Example Button",
lambda: print("The user pressed the button!")
)
# Process remote actions
while True:
CB.remote_actions_process()
# Cleanup connection
CB.disconnect() 注意:客户端应用程序需要定期调用 remote_actions_process() 方法来处理传入事件。
*CozyBlanket 需要通过应用内购买激活。CozyBlanket 提供两个版本。请在 CozyBlanket 应用内查看当地价格。