ZBrush Python SDK inital commit.

Author: mxn-ferdinand

LICENSE

@@ -0,0 +1,60 @@
+Creative Commons Attribution-NoDerivatives 4.0 International
+
+The license can also be found under https://creativecommons.org/licenses/by-nd/4.0.
+
+By exercising the Licensed Rights (defined below), you accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NoDerivatives 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, you are granted the Licensed Rights in consideration of your acceptance of these terms and conditions, and the Licensor grants you such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
+
+Section 1 – Definitions
+
+Adapted Material: Material subject to copyright and similar rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the copyright and similar rights held by the Licensor.
+Copyright and Similar Rights: Copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights.
+Effective Technological Measures: Measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
+Exceptions and Limitations: Fair use, fair dealing, and/or any other exception or limitation to copyright and similar rights that applies to your use of the Licensed Material.
+Licensed Material: The artistic or literary work, database, or other material to which the Licensor applied this Public License.
+Licensed Rights: The rights granted to you subject to the terms and conditions of this Public License, which are limited to all copyright and similar rights that apply to your use of the Licensed Material and that the Licensor has authority to license.
+Licensor: The individual(s) or entity(ies) granting rights under this Public License.
+Share: To provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation.
+Sui Generis Database Rights: Rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
+You: The individual or entity exercising the Licensed Rights under this Public License. "Your" has a corresponding meaning.
+
+
+Section 2 – Scope
+
+License grant: Subject to the terms and conditions of this Public License, the Licensor hereby grants you a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to reproduce and share the Licensed Material, in whole or in part; and produce and reproduce, but not share, Adapted Material.
+Exceptions and Limitations: Where exceptions and limitations apply to your use, this Public License does not apply, and you do not need to comply with its terms and conditions.
+Term: The term of this Public License is specified in Section 6(a).
+Media and formats; technical modifications allowed: The Licensor authorizes you to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so.
+Downstream recipients: Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. You may not offer or impose any additional or different terms or conditions on, or apply any effective technological measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
+No endorsement: Nothing in this Public License constitutes or may be construed as permission to assert or imply that you are, or that your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution.
+Other rights: Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow you to exercise the Licensed Rights, but not otherwise. Patent and trademark rights are not licensed under this Public License. To the extent possible, the Licensor waives any right to collect royalties from you for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
+
+
+Section 3 – License Conditions
+
+Your exercise of the Licensed Rights is expressly made subject to the following conditions.
+Attribution: If you share the Licensed Material, you must retain the following if it is supplied by the Licensor with the Licensed Material: identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); a copyright notice; a notice that refers to this Public License; a notice that refers to the disclaimer of warranties; a URI or hyperlink to the Licensed Material to the extent reasonably practicable. Indicate if you modified the Licensed Material and retain an indication of any previous modifications; and indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. For the avoidance of doubt, you do not have permission under this Public License to share Adapted Material.
+
+
+Section 4 – Sui Generis Database Rights
+
+Where the Licensed Rights include Sui Generis Database Rights that apply to your use of the Licensed Material: Section 2(a)(1) grants you the right to extract, reuse, reproduce, and share all or a substantial portion of the contents of the database, provided you do not share Adapted Material; if you include all or a substantial portion of the database contents in a database in which you have Sui Generis Database Rights, then the database in which you have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and you must comply with the conditions in Section 3(a) if you share all or a substantial portion of the contents of the database. This Section 4 supplements and does not replace your obligations under this Public License where the Licensed Rights include other copyright and similar rights.
+
+
+Section 5 – Disclaimer of Warranties and Limitation of Liability
+
+Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to you. To the extent possible, in no event will the Licensor be liable to you on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to you. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
+
+
+Section 6 – Term and Termination
+
+This Public License applies for the term of the copyright and similar rights licensed here. However, if you fail to comply with this Public License, then your rights under this Public License terminate automatically. Where your right to use the Licensed Material has terminated under Section 6(a), it reinstates automatically as of the date the violation is cured, provided it is cured within 30 days of your discovery of the violation; or upon express reinstatement by the Licensor. This Section 6(b) does not affect any right the Licensor may have to seek remedies for your violations of this Public License. The Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
+
+
+Section 7 – Other Terms and Conditions
+
+The Licensor shall not be bound by any additional or different terms or conditions communicated by you unless expressly agreed. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
+
+
+Section 8 – Interpretation
+
+This Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or you, including from the legal processes of any jurisdiction or authority.

ex_hello_world.png

@@ -0,0 +1,37 @@
+"""Demonstrates how to write a basic script to create an editable cube in the center of the canvas 
+and sets up the view.
+"""
+
+import zbrush.commands as zbc
+
+def main() -> None:
+    """Runs when Zbrush executes this script.
+    """
+    # We set ZBrush into its 2026 configuration state, to start with a known UI state.
+    zbc.config(2026)
+
+    # We select the Cube 3D tool and convert it to a polymesh.
+    zbc.press("Tool:Cube3D")
+    zbc.press("Tool:Make PolyMesh3D")
+
+    # We draw a stroke on the canvas to place the cube. This string is a pre-recorded brush stroke.
+    stroke: zbc.Stroke = zbc.Stroke(
+        "(ZObjStrokeV03n27%p2377BA8p191C7ACPnA63An234Fn-BF76s100672Cs100672Cs100672Cz-7E6B=H231V219H230"
+        "V216H22FV214h22E55v210AAH22Ev20C40h22D40v203C0H22Dv1F980H22DV1EEH22DV1E2h22D40v1D5C0h22DC0v1C9"
+        "80h22E40v1BD40h22EC0v1B040H22Fv1A280H22Fv19380h22EC0v18480h22DC0v17640h22C40v16980h22A80v15F40"
+        "h228C0v15740h227C0v15240h22740v14F40h226C0v14D80h22680v14C80h22640v14B80H226v14A80H226v149C0)")
+    zbc.canvas_stroke(stroke)
+    
+    # Now we enable edit mode to edit the cube.
+    zbc.press("Transform: Edit")
+
+    # And finally, we rotate the camera into a 45°, 45° angle to get a better view on the cube, and
+    # then frame the object in the view.
+    zbc.set_transform(x_rotate=45, y_rotate=45, z_rotate=0)
+    zbc.press("Transform:Fit Mesh To View")
+
+
+# This code, the "if _name__ ..." is called the main guard and ensures that the main() function
+# is only executed when this script is run directly, not when it is imported as a module.
+if __name__ == "__main__":
+    main()

ex_hello_world.py

@@ -0,0 +1,148 @@
+"""Contains a tool to extract code examples embedded in modules.
+"""
+import ast
+import os
+import typing
+import re
+
+HEADER: str = '''"""Code fragment for {}.
+"""
+__author__ = "Ferdinand Hoppe"
+__date__ = "16/10/2025"
+__copyright__ = "Maxon Computer"
+'''
+
+PATH_PREFIX: str = "/../../examples/fragments"
+
+class PyExampleParser:
+    """A parser for extracting examples from Python code."""
+
+    def __init__(self, file: str, output_dir: str, prefix: str) -> None:
+        """Initializes the parser with the given Python file.
+        """
+        self.file: str = str(file)
+        self.output_dir: str = str(output_dir)
+        self.prefix: str = str(prefix)
+        if not os.path.isfile(self.file):
+            raise FileNotFoundError(f"File not found: {self.file}")
+        
+        if not os.path.isdir(self.output_dir):
+            os.makedirs(self.output_dir)
+        
+        with open(self.file, "r", encoding="utf-8") as f:
+            self.code: str = self.preprocess_file(f.read())
+        
+        self.out_file: str = self.file.replace(".py", "_parsed.py")
+        self.tree: ast.Module = ast.parse(self.code)
+        self.new_code: str = self.code
+        self.lines: list[str] = self.code.splitlines()
+        self.max_index: int = len(self.lines)
+        
+    def preprocess_file(self, content: str) -> str:
+        """Preprocesses the file by removing leading/trailing empty lines in doc strings.
+        """
+        return re.sub(r'"""\s*(?!\s*(?:def|class|\.\.\.))', r'"""', content)
+
+    def iter_items(self) -> typing.Iterator[tuple[str, str, ast.AST]]:
+        """Yields all relevant descriptions found in the AST with their entity names and nodes.
+        """
+        node: ast.AST
+        visited: set[ast.AST] = set()
+        for node in ast.walk(self.tree):
+            if node in visited:
+                continue
+
+            visited.add(node)
+            if isinstance(node, ast.ClassDef):
+                for child in (c for c in node.body if isinstance(c, ast.FunctionDef)):
+                    visited.add(child)
+                    yield f"{node.name}.{child.name}", ast.get_docstring(child) or "", child
+            elif isinstance(node, ast.FunctionDef):
+                yield node.name, ast.get_docstring(node) or "", node
+
+    def process_description(self, entity_name: str, description: str, node: ast.AST) -> None:
+        """Processes a single description, potentially modifying it."""
+        if not description:
+            return
+        
+        def find_example_ranges(index: int) -> typing.Iterator[tuple[int, int]]:
+            """Finds the scope of the example in the description.
+            """
+            count: int = 0
+            indent: int = 0
+            start: int = -1
+
+            while index < self.max_index:
+                line: str = self.lines[index].lower()
+                line_strip: str = line.strip()
+                if len(line_strip) == 0:
+                    index += 1
+                    continue
+
+                cur_indent: int = len(line) - len(line_strip)
+                isCodeBlock: bool = line_strip.startswith(".. code-block:: python")
+                isCommentEnd: bool = line_strip == '"""'
+
+                if isCodeBlock:
+                    start = index
+                    indent = cur_indent
+
+                if start != -1 and index != start and (cur_indent <= indent):
+                    yield count, start, index
+                    count += 1
+                    start = -1
+                    
+                if isCommentEnd:
+                    return
+                
+                index += 1
+        
+        def save_example(start: int, end: int, entity_name: str, count: int) -> None:
+            """Saves the example code to a separate file and modifies the original description.
+            """
+            lines: list[str] = self.lines[start + 1:end]
+            min_indent: int = min((len(line) - len(line.lstrip()) 
+                                   for line in lines if line.strip()), default=0)
+            entity_name: str = f"{self.prefix}.{entity_name}"
+            header: str = HEADER.format(entity_name)
+            code: str = header + "\n".join(line[min_indent:] if line else line for line in lines)
+
+            name: str = f"{entity_name}.{count}.py".lower()
+            file: str = os.path.join(self.output_dir, name)
+            if os.path.exists(file):
+                raise FileExistsError(f"File already exists: {file}")
+            
+            with open(file, "w", encoding="utf-8") as f:
+                f.write(code)
+            
+            indent: str = " " * (max(min_indent - 4, 0))
+            old : str = "\n".join(self.lines[start:end])
+            new: str = (f"{indent}.. literalinclude:: {PATH_PREFIX}/{name}\n{indent}    :language: "
+                        f"python\n{indent}    :lines: 7-\n")
+            self.new_code = self.new_code.replace(old, new)
+        
+        index: int = node.lineno
+        for i, start, end in find_example_ranges(index):
+            save_example(start, end, entity_name, i)
+    
+    def run(self):
+        """Run the parser and print extracted information.
+        """
+        for name, description, node in self.iter_items():
+            self.process_description(name, description, node)
+
+        with open(self.out_file, "w", encoding="utf-8") as f:
+            f.write(self.new_code)
+    
+if __name__ == "__main__":
+    # Delete all existing fragments first.
+    for f in os.listdir("/Users/f_hoppe/git/zbrush-sdk/examples/fragments/"):
+        os.remove(os.path.join("/Users/f_hoppe/git/zbrush-sdk/examples/fragments/", f))
+
+    # Process all relevant files.
+    for path, domain in [
+        ("/Users/f_hoppe/git/zbrush-sdk/api/zbrush/commands.py", "zbrush.commands"),
+        ("/Users/f_hoppe/git/zbrush-sdk/api/zbrush/utils.py", "zbrush.utils"),
+        ("/Users/f_hoppe/git/zbrush-sdk/api/zbrush/zscript_compatibility.py", "zbrush.zscript_compatibility")]:
+        parser = PyExampleParser(path, "/Users/f_hoppe/git/zbrush-sdk/examples/fragments/", domain)
+        parser.run()

fragments/_example_parser.py

@@ -0,0 +1,22 @@
+"""Code fragment for zbrush.commands.add_button.
+"""
+__author__ = "Ferdinand Hoppe"
+__date__ = "16/10/2025"
+__copyright__ = "Maxon Computer"
+
+from zbrush import commands as zbc
+
+# A callback functions for multiple buttons which checks the item path of the raised item.
+def on_button_pressed(sender: str) -> None:
+    if str(sender).endswith("Bar"):
+        print("A button named 'Bar' was pressed.")
+    else:
+        print(f"Button pressed: {sender = }")
+
+# Add a 'Foo' subpalette to the 'ZScript' palette if it doesn't exist.
+if not zbc.exists("ZScript:Foo"):
+    zbc.add_subpalette("ZScript:Foo")
+
+# Adds a button labeled 'Bar' to the 'ZScript:Foo' subpalette with the tooltip "Hello World!" 
+# which invokes the callback #on_button_pressed when clicked.
+zbc.add_button("ZScript:Foo:Bar", "Hello World!", on_button_pressed)