Example `mod_subtool_export`¶

Demonstrates how to batch export all sub-tools in a ZBrush file to OBJ format.

Code¶

"""Demonstrates how to batch export all sub-tools in a ZBrush file to OBJ format.

This script is meant to be used with as a command line argument of ZBrush. Its invocation 
syntax is:

    $ZBRUSH_BIN -script <path_to_this_script> <path_to_output_dir> <path_to_zbrush_file_to_load>

For example:

    "/Applications/Maxon ZBrush 2026.1/ZBrush.app/Contents/MacOS/ZBrush" \
        -script \ "/Users/alice/Downloads/zbrush-sdk/examples/modeling/ex_mod_subtool_export.py" \
        "/Users/alice/Documents/temp/sub_tools" \
        "/Applications/Maxon ZBrush 2026.1/Lightbox/Projects/DemoSoldier.ZPR" 
"""
__author__ = "Javier Edo"
__date__ = "21/08/2025"
__copyright__ = "Maxon Computer"

import os
import sys
import zbrush.commands as zbc

def export_subtools(export_directory=""):
    if not os.path.isdir(export_directory):
        print(f"Invalid export directory specified: {export_directory}")
        return False

    # Get the number of SubTools in the current tool
    subtool_count = zbc.get_subtool_count()
    if subtool_count == 0:
        print("No SubTools found to export.")
        return False

    exported_files = 0
    # Loop through all SubTools
    for i in range(subtool_count):
        # Set the active SubTool
        zbc.select_subtool(i)
        
        # Check if the SubTool is visible (status flag 0x01 means visible)
        status = zbc.get_subtool_status()
        if status & 0x01:
            # Get the full path of the active tool, which includes the SubTool name
            full_tool_path = zbc.get_active_tool_path()
            subtool_name = full_tool_path.rsplit('/')[-1] # Extract name after the last slash

            # Create the final output path for the OBJ file
            output_path = os.path.join(export_directory, f"{subtool_name}.obj")

            # Set this as the next file name for ZBrush's exporter
            zbc.set_next_filename(output_path)
            
            # Press the "Export" button in the Tool palette
            zbc.press("Tool:Export")
            print(f"Exported SubTool '{subtool_name}' to {output_path}")
            exported_files += 1

    return exported_files


def export_subtools_with_ui(export_directory=""):
    if not os.path.isdir(export_directory):
        save_path = zbc.ask_filename("*.obj", "Select a folder and enter a dummy file name", 
                                     "Choose Export Directory")
        if not save_path:
            zbc.message_ok("Export cancelled by user.")
            return False
        export_directory = os.path.dirname(save_path)

    exported_files = export_subtools(export_directory)
    if exported_files > 0:
        zbc.message_ok(f"Export complete! {exported_files} SubTools were saved to:\n{export_directory}")
    else:
        zbc.message_ok("No SubTools were exported.")


if __name__ == '__main__':
    if "-script" not in sys.argv or (sys.argv.index("-script") + 1)>= len(sys.argv):
        print("This script requires the -script flag followed by the args to the script.")
        sys.exit(1)

    # args to actual script (put after the -script "/path/to/script.py" args)
    script_args = sys.argv[sys.argv.index("-script") + 2:]
    export_directory = script_args[0] if script_args else ""

    ret_code = not export_subtools(export_directory)
    sys.exit(ret_code)

Category	Option	Description
Query		The search does not support special search operators. Terms are joined by default with OR unless the AND join mode is enabled. Queries can contain search literals denoted by double quotes. E.g., `foo bar` would search for documents that contain `foo` and/or `bar` (depending on the selected join option). But `"foo bar"` would search for the exact phrase "foo bar". The search is case-insensitive. Note that search literals will always implicitly enable strict search mode, even when the user has selected fuzzy mode.
	/	Toggles the visibility of the facet selection panel.
	/	Toggles the visibility of this help panel.
	OR / AND	Toggles between joining search terms with a logical OR or AND. In OR mode, the search will return results that match any of the search terms, while in AND mode, it will only return results that match all of the search terms.
	/	Toggles between fuzzy and strict mode when searching. In fuzzy mode, the search is more lenient and may return more results, while in strict mode, the search is more exacting. Switching modes may affect the relevance of the results.
	/	Toggles between detailed and compact result views. The detailed view shows more information per search hit.
	/	Toggles sorting the search results by relevance only or by a combination of classification and relevance. When sorting by classification and relevance, results are grouped by their type (e.g., pages, classes, methods) and then sorted by relevance within each group.
Facets		Facets restrict the search to specific content types. You must have at least one facet enabled per facet group to see any results. Domain is the largest facet group, enabling or disabling whole groups of content types. Entities are the next level down, allowing you to search within specific types of content such as generic pages or a function definition. Contexts are the most granular level, allowing you to search within specific contexts of the selected entity such as a code block ot the name of an entity.
Domain	API	Enable matches within API documentation pages.
	Manuals	Enable matches within general documentation pages.
	Examples	Enable matches within example pages.
Entity	Page	Enable matches within a page body that are not one of the following entities.
	Classes	Enable matches within class definitions.
	Methods	Enable matches within class method definitions.
	Functions	Enable matches within module function definitions.
	Attributes	Enable matches within class or module attribute definitions.
Context	Paragraphs	Enable matches within normal text paragraphs of a page.
	Headings	Enable matches within the headings of a page.
	Code	Enable matches within code blocks of a page (e.g., in the Examples domain or code blocks embed elsewhere).
	Names	Enable matches within the names of API entities. This searches the plain names (`func`), not the qualified names (`foo.bar.func`).
	Signatures	Enable matches within the signatures of API entities. The signature is what is shown on top of the entity description, e.g., `foo.bar.func(a: int, b: str = "Hello") -> bool`. When you want to search for fully qualified names, you should enable this option and disable the "Names" option.
	Metadata	Enable matches within the metadata of entities.

Example mod_subtool_export¶

Code¶

Search

Example `mod_subtool_export`¶