Fragment `zbrush.commands.add_note_button`¶

Code fragment for zbrush.commands.add_note_button.

zbrush.commands.add_note_button

Adds a clickable button to the next note dialog which is shown.

Code¶

"""Code fragment for zbrush.commands.add_note_button.
"""
__author__ = "Ferdinand Hoppe"
__date__ = "16/10/2025"
__copyright__ = "Maxon Computer"

from zbrush import commands as zbc

# The IDs of the buttons we are going to add to our note. ZBrush assigns implicitly IDs starting with 
# 1 in the order the buttons are added.
ID_BTN_COLOR: int = 2
ID_BTN_CLOSE: int = 3

def run_note(title: str) -> str:
    '''Runs a simple note interface and returns a message when the user made a choice.
    '''
    # Notes are a bit weird in that they do not really have numeric inputs apart from switches. The
    # common workflow is to use buttons and then either use them as checks which switch out their
    # text for the empty string or an "x" or to cycle through a set of strings to emulate a value 
    # range.

    # The states of a dropdown/cycle we want to emulate.
    states: list[str] = ["Red", "Green", "Blue"]
    # The currently selected state.
    current_state: int = states[0]

    # Now comes the big trick, notes are often implemented in a loop to emulate interactivity, 
    # because out of the box, note controls do not have callback functions. So, we build a note,
    # poll its output, loop around, and build it again with the new state.
    while True:
        # Add three buttons to the note which is opened next. The first button is just a label
        # emulated by a disabled button. The second button shows the current state and the third 
        # button is a close button.
        zbc.add_note_button(name="Color:", initially_disabled=True, bg_opacity=0) # ID: 1
        zbc.add_note_button(name=str(current_state))                              # ID: 2
        zbc.add_note_button(name="Close")                                         # ID: 3

        # Now show the note which will return the ID of the first control clicked by the user, i.e.,
        # the next line runs from the note being opened until the user clicks something.
        result: int = zbc.show_note(title)

        # Bases on the clicked element, we either cycle the state or close the dialog. When we close
        # the dialog, we return the current state and with that exit the loop. Otherwise, we loop
        # around, rebuild the dialog with the new state, and show it again. Inputs smaller than one
        # are keyboard events like ESC or Enter, we also treat them as close events.
        if result == ID_BTN_COLOR:
            current_index: int = states.index(current_state)
            next_index: int = (current_index + 1) % len(states)
            current_state = states[next_index]
        elif result == ID_BTN_CLOSE or result <= 0: 
            return current_state

if __name__ == "__main__":
    result: str = run_note("Hello World!")
    zbc.message_ok(f"The chosen color is: {result}")

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.

Fragment zbrush.commands.add_note_button¶

Code¶

Search

Fragment `zbrush.commands.add_note_button`¶