Maya多Light Rig参考切换脚本故障排查求助

问题说明 #

编写Maya脚本实现同一窗口内不同Light Rig的引用加载、切换与清理功能，但切换功能逻辑故障，无法正常替换已加载的引用。

原始测试代码 #

import maya.cmds as cmds

class ReferenceUI(object):
    def __init__(self):
        self.window_name = "template"
        self.file_paths = ["D:\\Estudos\\Cenas\\fred\\fred.0001.mb", "D:\\Estudos\\Cenas\\fred\\fred.0002.mb", "D:\\Estudos\\Cenas\\fred\\fred.0003.mb"]
        self.ref_name = "template"
        self.current_file = self.file_paths[0]

    def create(self):
        if cmds.window(self.window_name, exists=True):
            cmds.deleteUI(self.window_name)

        self.window = cmds.window(self.window_name, title=self.window_name)

        self.main_layout = cmds.columnLayout()
        self.file_path_selector = cmds.optionMenuGrp(label="File Path")
        for file_path in self.file_paths:
            cmds.menuItem(label=file_path)

        self.reference_button = cmds.button(label="Add Reference", 
                            command=lambda x: self.add_reference())

        self.switch_button = cmds.button(label="Switch Reference",
                            command=lambda x: self.switch_reference())

        self.clean_button = cmds.button(label="Clean All References",
                            command=lambda x: self.clean_references())

        cmds.showWindow(self.window)

    def add_reference(self):
        file_path = cmds.optionMenuGrp(self.file_path_selector, query=True, value=True)
        cmds.file(file_path, reference=True, namespace=self.ref_name)
        self.current_file = file_path

    def switch_reference(self):
        file_path = cmds.optionMenuGrp(self.file_path_selector, query=True, value=True)
        if file_path != self.current_file:
            cmds.file(file_path, edit=True, force=True, options="v=0;", loadReferenceDepth="all", namespace=self.ref_name)
            self.current_file = file_path
        else:
            cmds.warning("The selected file is already loaded")

    def clean_references(self):
        references = cmds.ls(references=True)
        for ref in references:
            cmds.file(removeReference=True, referenceNode=ref, type='mayaAscii')

reference_manager = ReferenceUI()
reference_manager.create()

故障原因与修复方案 #

核心问题分析 #

1. 切换功能参数错误：switch_reference中使用cmds.file编辑引用时，未指定正确的替换参数，且用命名空间而非引用节点定位目标，不符合Maya引用替换的API规范。
2. 清理方法格式限制：type='mayaAscii'会过滤掉.mb格式的引用，导致无法清理二进制灯光Rig文件。
3. 重复引用风险：add_reference未检查同名引用是否已存在，多次点击会生成冗余命名空间（如template1），导致切换逻辑混乱。

修复后完整代码 #

import maya.cmds as cmds

class ReferenceUI(object):
    def __init__(self):
        self.window_name = "template"
        self.file_paths = ["D:\\Estudos\\Cenas\\fred\\fred.0001.mb", "D:\\Estudos\\Cenas\\fred\\fred.0002.mb", "D:\\Estudos\\Cenas\\fred\\fred.0003.mb"]
        self.ref_namespace = "template"
        self.current_file = self.file_paths[0]
        self.ref_node = None  # 缓存引用节点，避免重复查询

    def create(self):
        if cmds.window(self.window_name, exists=True):
            cmds.deleteUI(self.window_name)

        self.window = cmds.window(self.window_name, title="灯光Rig引用管理器")

        self.main_layout = cmds.columnLayout(adjustableColumn=True, rowSpacing=10)
        self.file_path_selector = cmds.optionMenuGrp(label="选择灯光Rig文件", columnWidth=[(1, 150)])
        for file_path in self.file_paths:
            cmds.menuItem(label=file_path)

        self.reference_button = cmds.button(label="加载选中引用", 
                            command=lambda x: self.add_reference())

        self.switch_button = cmds.button(label="切换到选中引用",
                            command=lambda x: self.switch_reference())

        self.clean_button = cmds.button(label="清理所有引用",
                            command=lambda x: self.clean_references())

        cmds.showWindow(self.window)

    def get_existing_ref_node(self):
        """查询当前命名空间对应的引用节点"""
        refs = cmds.ls(references=True)
        for ref in refs:
            if cmds.referenceQuery(ref, namespace=True) == self.ref_namespace:
                return ref
        return None

    def add_reference(self):
        file_path = cmds.optionMenuGrp(self.file_path_selector, query=True, value=True)
        # 检查是否已存在同名引用，存在则直接切换
        self.ref_node = self.get_existing_ref_node()
        if self.ref_node:
            cmds.warning(f"命名空间 {self.ref_namespace} 已存在引用，自动切换")
            self.switch_reference()
            return
        # 新建引用并缓存节点
        self.ref_node = cmds.file(file_path, reference=True, namespace=self.ref_namespace, returnNewNodes=False)
        self.current_file = file_path

    def switch_reference(self):
        file_path = cmds.optionMenuGrp(self.file_path_selector, query=True, value=True)
        if file_path == self.current_file:
            cmds.warning("当前已加载该灯光Rig")
            return
        
        # 确认引用节点存在
        self.ref_node = self.get_existing_ref_node()
        if not self.ref_node:
            cmds.warning("未找到可切换的引用，请先加载引用")
            return
        
        # 使用replaceReference参数替换引用
        cmds.file(file_path, edit=True, replaceReference=self.ref_node, force=True)
        self.current_file = file_path
        cmds.inViewMessage(amg=f"已切换到灯光Rig: <hl>{file_path}</hl>", pos="midCenter", fade=True)

    def clean_references(self):
        references = cmds.ls(references=True)
        if not references:
            cmds.warning("当前无引用可清理")
            return
        for ref in references:
            try:
                cmds.file(removeReference=True, referenceNode=ref, force=True)
            except Exception as e:
                cmds.warning(f"清理引用 {ref} 失败: {str(e)}")
        # 重置状态与选项菜单选中项
        self.current_file = self.file_paths[0]
        self.ref_node = None
        cmds.optionMenuGrp(self.file_path_selector, edit=True, value=self.current_file)

reference_manager = ReferenceUI()
reference_manager.create()

关键优化点 #

• 新增get_existing_ref_node方法，精准定位目标引用节点
• 切换引用时使用replaceReference参数，符合Maya API规范
• 移除清理方法的格式限制，支持所有格式的引用文件
• 添加重复引用检查，避免生成冗余命名空间
• 增加状态提示与错误处理，提升操作体验

内容的提问来源于stack exchange，提问作者Pedro C