Maya Python UI Button to Toggle Group Visibility

Quick Answer

\n

You can add a button that toggles the visibility of a Maya group using the Python API; the example creates a dialog with a Toggle button that switches the myGroup.visibility attribute between 0 (hidden) and 1 (visible).

\n\n

How it works

\n

Maya's Python API exposes UI commands via maya.cmds and Qt classes via maya.ui. The callback reads the current visibility attribute, flips it, and updates the scene. All UI construction must occur on Maya's main UI thread to avoid crashes.

\n\n

Worked configuration

\n

import maya.cmds as cmds
from maya import OpenMayaUI
from PySide2 import QtWidgets
import maya.utils
\ndef toggle_grp_visibility():
    visible = cmds.getAttr('myGroup.visibility') == 0
    cmds.setAttr('myGroup.visibility', 1 if visible else 0)\n\ndef create_tool():
    def build():
        win = QtWidgets.QDialog()
        win.setWindowTitle('MyGroup Toggle')
        btn = QtWidgets.QPushButton('Toggle MyGroup')
        btn.clicked.connect(toggle_grp_visibility)
        btn.clicked.connect(win.accept)
        win.show()
    maya.utils.executeInMainThread(build)\ncreate_tool()

\n\n

Verification steps

\n

\n
1. Run the script in Maya's Script Editor; a new window should appear titled MyGroup Toggle.
\n
2. Click the button; the Outliner eye icon for myGroup should toggle.
\n
3. Run the script again; no duplicate window should appear, confirming the function wraps UI creation.
\n
4. Check the Script Editor for errors; none indicate the UI thread was respected.
\n

\n\n

Limits and performance considerations

\n

The API runs on Maya's UI thread, so long-running Python loops will freeze the interface. For heavy work, use background threads and schedule UI updates with maya.utils.executeInMainThread. Rapid visibility toggling on large groups may impact performance; consider hardware-accelerated display settings for frequent changes.

\n\n

Common mistakes

\n

\n
• Defining UI code outside a function, causing duplicate windows on repeated runs.
\n
• Relying on global variables that persist across sessions, leading to unexpected state.
\n
• Failing to clean up dialogs, which can cause memory leaks.
\n
• Creating Qt widgets in a background thread; this can crash Maya because UI objects are not thread-safe.
\n