ui module

Entry points to customize Substance 3D Painter UI.

substance_painter.ui.

show_main_window

show_main_window()

Show Substance 3D Painter main window in the windowing system and give it the focus.

Raises

ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

get_main_window

get_main_window() → PySide2.QtWidgets.QMainWindow

Get access to Substance 3D Painter main window.

Returns

The application main window.

Return type

PySide2.QtWidgets.QMainWindow

Raises

ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

get_layout

get_layout(mode: UIMode) → bytes

Get Substance 3D Painter layout state for the given UI mode.

Parameters

mode (UIMode) – Selected UI mode.

Returns

The layout state.

Return type

bytes

Raises

ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

get_layout_mode

get_layout_mode(layout: bytes) → UIMode

Get the Substance 3D Painter UI layout mode of a given state.

Parameters

layout (bytes) – The layout state, obtained with get_layout().

Returns

The state associated UI mode.

Return type

UIMode

Raises

• RuntimeError – In case of incorrect layout data.
• ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

set_layout

set_layout(layout: bytes) → UIMode

Restore a Substance 3D Painter layout state optained with get_layout().

Parameters

layout (bytes) – The layout state to be restored.

Returns

The restored UI mode.

Return type

UIMode

Raises

• RuntimeError – In case of incorrect layout data.
• ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

reset_layout

reset_layout(mode: UIMode)

Reset Substance 3D Painter layout to default for a selected UI mode.

Parameters

mode (UIMode) – Selected UI mode.

Raises

ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

add_dock_widget

add_dock_widget(widget: PySide2.QtWidgets.QWidget, ui_modes: int = UIMode.Edition) → PySide2.QtWidgets.QDockWidget

Add a widget as a QDockWidget to the main window.

If the widget has a windowIcon, it will be used as a quick button to easily reopen the QDockWidget when closed. If the widget has a unique objectName it will be used to properly save and restore the dock widget location and geometry.

Parameters

• widget (PySide2.QtWidgets.QWidget) – The widget to be added as a dock widget.
• ui_modes (int, optional) – A combination of UIMode flags.

Returns

The corresponding dock widget.

Return type

PySide2.QtWidgets.QDockWidget

Raises

ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

add_plugins_toolbar_widget

add_plugins_toolbar_widget(widget: PySide2.QtWidgets.QWidget)

Add a widget to the plugins toolbar.

Parameters

widget (PySide2.QtWidgets.QWidget) – The widget to be added.

Raises

ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

add_menu

add_menu(menu: PySide2.QtWidgets.QMenu)

Add the given menu to the application main window.

Parameters

menu (PySide2.QtWidgets.QMenu) – The menu to be added.

Raises

ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

add_toolbar

add_toolbar(title: str, object_name: str, ui_modes: int = UIMode.Edition) → PySide2.QtWidgets.QToolBar

Create and add a toolbar to the application main window.

Parameters

• title (str) – The title of the toolbar.
• object_name (str) – The toolbar object name. A unique object name is mandatory for proper save and restore of the UI layout.
• ui_modes (int) – A combination of UIMode flags.

Returns

The newly created toolbar.

Return type

PySide2.QtWidgets.QToolBar

Raises

ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

add_action

add_action(menu: ApplicationMenu, action: PySide2.QtWidgets.QAction)

Add the given action to the given application menu.

This will clear the action tooltip.

Parameters

• menu (ApplicationMenu) – One of the predefined ApplicationMenu.
• action (PySide2.QtWidgets.QAction) – The action to be added.

Raises

ServiceNotFoundError – If Substance 3D Painter has not started its UI service.

substance_painter.ui.

delete_ui_element

delete_ui_element(element: PySide2.QtWidgets.QWidget)

Delete a UI element.

The element passed as parameter is deleted. After that, any attempt to call a method on element will throw an exception.

Parameters

element – The UI element to delete.