跳至主要內容

Maya工具箱安装器模板

Megestus2024年10月21日MayaPythonMayaPythontool

这个模板提供了一个通用的Maya工具箱安装器，可以轻松地为你的Maya插件创建安装和卸载功能。

文件目录放在maya能访问的任意位置，不需要进行多余的拷贝工作，只需要将安装文件拖拽到maya视图即可。

说明

文件结构

└─ YourToolbox/
  │
  ├── Install.mel
  ├── Install.py
  │
  ├── Scripts/
  │ └── YourToolmain.py
  │
  └── Icons/      (可选)
    └── MainUI.png

使用步骤

  1. 复制install.mel和install.py模板文件到你的工具箱目录。

  2. 在install.mel中：

    • 将$gToolboxName这个全局变量的 YourToolboxName 改为你的工具箱名称，例如BinTool。

  3. 在install.py中：

    • 修改TOOLBOX_NAME为你的工具箱名称。
    • 修改TOOLBOX_VERSION为你的工具箱版本。
    • 修改TOOLBOX_ICON为你的工具箱图标名称。
    • 修改TOOLBOX_MAIN_MODULE为你的工具箱主模块名称。
    • 修改TOOLBOX_HELP_URL为你的工具箱帮助文档URL。 （QTUI模板）

  4. 确保你的主脚本（如YourToolmain.py）位于Scripts文件夹中。

  5. 如果你有自定义图标，将其放在Icons文件夹中，并命名为MainUI.png。

示例：


# 工具箱配置
TOOLBOX_NAME = "BinTool"                  # 工具箱名称
TOOLBOX_VERSION = "1.0"                   # 工具箱版本
TOOLBOX_ICON = "MainUI.png"               # 工具箱主图标
TOOLBOX_MAIN_MODULE = "BinTool_main"      # 工具箱主模块名称
TOOLBOX_HELP_URL = "https://github.com/"  # 工具箱帮助文档URL   （QTUI模板）

安装过程

  1. 下载工具包放在任意可访问位置
  2. 将Install.mel拖拽到Maya视图中。
  3. MEL脚本会自动执行并调用Python脚本。
  4. Python脚本创建安装对话框，用户可以选择安装或卸载。
  5. 安装过程会：
    • 创建.mod文件
    • 创建Maya架子（shelf）和按钮

自定义

你可以根据需要修改install.py中的以下部分：

  • create_mod_file(): 自定义.mod文件的内容
  • install_toolbox(): 添加额外的安装步骤
  • uninstall_toolbox(): 添加额外的卸载步骤
  • InstallDialog: 自定义安装对话框的外观和行为

注意事项

  • 确保所有路径使用正斜杠（/）而不是反斜杠（\）。
  • 测试安装和卸载过程，确保它们在不同的Maya版本中都能正常工作。
  • 考虑添加错误处理和日志记录，以便于调试。

示例使用

  1. 将模板文件复制到你的工具箱目录。
  2. 按照上述步骤进行必要的修改。
  3. 将修改后的Install.mel拖拽到Maya中以启动安装过程。

这个模板提供了一个良好的起点，你可以根据你的具体需求进行进一步的定制和扩展。

脚本功能概述

这个脚本的主要功能包括：

  1. 创建.mod文件，使Maya能够识别和加载插件。
  2. 设置必要的路径和环境。
  3. 在Maya中创建一个新的架子（shelf）和按钮，用于启动工具箱。
  4. 提供安装和卸载功能。
  5. 创建一个用户界面，让用户可以选择安装或卸载。

特殊Maya相关函数说明

一些可能看起来奇怪的部分包括：

  • mel.eval('$tmpVar=$gShelfTopLevel'):
    这是使用MEL（Maya嵌入式语言）来获取顶级架子布局的引用。

  • 使用f-string创建的command字符串：
    这是一个多行字符串，包含了在Maya中执行工具箱的Python代码。

  • cmds.shelfButton():
    这个函数用于在Maya的架子上创建一个新按钮。

这些部分可能看起来有些奇怪，但它们是与Maya API交互所必需的。

安装器模板代码

以下是安装器的核心代码模板。这些模板提供了基本的安装、卸载和用户界面功能。您可以根据自己的需求进行修改和扩展。

提供了两种风格的安装窗口

install.mel
// UTF-8
// Encoding: UTF-8

// 全局变量定义工具名称
global string $gToolboxName = "HUGTools";
global string $gInstallProcName;

global proc string getInstallProcName()
{
    global string $gToolboxName;
    return "install" + $gToolboxName;
}

global proc installHUGTools()
{
    global string $gInstallProcName;
    $gInstallProcName = getInstallProcName();
    string $scriptPath = `whatIs $gInstallProcName`;
    string $dirPath = `substring $scriptPath 25 (size($scriptPath))`;
    $dirPath = `dirname $dirPath`;
    string $pythonPath = $dirPath + "/install.py";
    $pythonPath = substituteAllString($pythonPath, "\\", "/");
    
    python("import os, sys; sys.path.append(os.path.dirname(r'" + $pythonPath + "')); exec(open(r'" + $pythonPath + "', encoding='utf-8').read())");
}

// 设置安装过程名称
$gInstallProcName = getInstallProcName();

// 使用全局变量调用函数
eval($gInstallProcName + "()");

 

如何添加新工具

创建新工具文件

要添加新工具，请按照以下步骤操作：

比如你有一个新工具，这个工具名称叫 NewTool.py ，并且在scripts文件夹下，文件结构如下：

└─YourToolbox/
  │
  ├── Install.mel
  ├── Install.py
  │
  ├── Scripts/
  │ └── NewTool/
  │   └── NewTool.py
  │ └── more/     (可选)
  │   └── xxxxx.py 
  │ └── YourToolmain.py
  │
  └── Icons/      (可选)
    └── MainUI.png

准备新工具的UI类

NewTool.py 文件内容如下:

使用QT api创建的UI

NewTool.py
# 导入api
import maya.cmds as cmds
from PySide2 import QtWidgets, QtCore, QtGui


# =============== NewTool-UI ===============
class NewToolUI(QtWidgets.QWidget):
    def __init__(self, parent=None):
        super(NewToolUI, self).__init__(parent)

        #按钮
        self.btn = QtWidgets.QPushButton("按钮")

        #布局-实际显示的按钮布局
        layout = QtWidgets.QVBoxLayout(self)
        layout.addWidget(self.btn)

        #函数与按钮的连接
        self.btn.clicked.connect(self.btn_click)

    #功能函数
    def btn_click(self):
        print("按钮被点击了")

# UI函数
def show():
    global tool_window_ui
    try:
        tool_window_ui.close()
        tool_window_ui.deleteLater()
    except:
        pass
    tool_window_ui = NewToolUI()
    tool_window_ui.show()

if __name__ == "__main__":
    show()

在主窗口中集成新工具

以下是一个简化的主窗口示例，展示了一个基本的工具窗口：

YourToolmain.py
import importlib
import maya.cmds as cmds
from PySide2 import QtWidgets, QtCore, QtGui

# 在文件顶部导入新工具模块如果有文件夹则在前方加文件夹路径如下
import Scripts.NewTool as NewTool   #导入上文创建的NewTool.py

# =============== MainWindow - UI===============
class MainWindow(QtWidgets.QWidget):
    def __init__(self, parent=None):
        super(MainWindow, self).__init__(parent)
        self.setWindowTitle("工具箱")
        self.setMinimumWidth(200)
        
        # 创建按钮
        self.tool1_btn = QtWidgets.QPushButton("工具1")
        self.tool2_btn = QtWidgets.QPushButton("工具2")
        
        # 创建布局
        layout = QtWidgets.QVBoxLayout(self)
        layout.addWidget(self.tool1_btn)
        layout.addWidget(self.tool2_btn)
        
        # 连接信号
        self.tool1_btn.clicked.connect(self.open_tool1)
        self.tool2_btn.clicked.connect(self.open_tool2)
    
    # 创建的函数来打开新工具
    def open_tool1(self):
        importlib.reload(NewTool) # 重新加载NewTool新工具模块
        NewTool.show()            # 调用文件顶部导入的NewTool.py新工具的show函数.  格式为 名称+show()函数
    
    def open_tool2(self):
        print("打开工具2")

def show():
    global main_window  # 声明全局变量以管理主窗口实例
    try:
        main_window.close()  # 尝试关闭已存在的窗口
        main_window.deleteLater()  # 删除旧的窗口实例，释放资源
    except:
        pass  # 如果窗口不存在，则忽略错误
    main_window = MainWindow()  # 创建新的主窗口实例
    main_window.show()  # 显示新创建的主窗口

if __name__ == "__main__":
    show()  # 如果直接运行此脚本，则显示主窗口

故障排除和常见问题

  • 问题：安装后无法在Maya中看到工具架

    • 解决方案：
      • 确保Maya的脚本路径正确设置
      • 重启Maya

  • 问题：安装过程中出现权限错误

    • 解决方案：
      • 以管理员身份运行Maya
      • 检查文件夹权限设置

  • 问题：工具在某些Maya版本中不工作

    • 解决方案：
      • 检查代码兼容性
      • 针对不同版本进行代码调整

  • 问题：卸载后仍有残留文件

    • 解决方案：
      • 手动检查并删除.mod文件
      • 清理Maya用户目录中的相关文件

如遇到其他问题，请检查Maya的脚本编辑器输出，可能会提供有用的错误信息。

冰冻三尺，非一日之寒。
Copyright © 2024 Megestus