Examples¶

Browse the code examples and fragments of the SDK.

Code Examples¶

Code examples cover a complete task or workflow and are bound to a subject area. Only few code examples exist but they are usually longer and more complex than code fragments.

Name	Description
Example hello_world	Demonstrates how to write a basic script to create an editable cube in the center of the canvas and sets up the view.
Gui
Example gui_notebar	Demonstrates how to show a progress indicator with a message when running a long task.
Example gui_notes	Demonstrates how to build and run a modal dialog (a note).
Example gui_palette	Demonstrates how to build and run a non-modal dialog (a pallette).
Example gui_zscript_port	Provides an example for a very literal port of a ZScript script to Python.
Modeling
Example mod_curve_lightning	Demonstrates how to construct curves in a tool.
Example mod_subtool_array	Demonstrates how to construct an array of sub tools within a tool.
Example mod_subtool_export	Demonstrates how to batch export all sub-tools in a ZBrush file to OBJ format.
Example lib_zb_math	Contains a basic math library used by some of the modeling examples.
System
Example sys_timeline_camera	Demonstrates how to create a turntable animation for the current tool in ZBrush.
Example sys_timeline_colors	Demonstrates how to add and delete keyframes in the timeline of ZBrush.

Code Fragments¶

Code fragments demonstrate a specific API feature such as a class or function in a brief manner. They are not as comprehensive as full code examples but much more numerous. Fragments are also directly embedded into the entities they cover in the API Index; and it is therefore often easier to browse the API to explore them.

Name	Description
Fragment zbrush.commands.add_button	Code fragment for zbrush.commands.add_button.
Fragment zbrush.commands.add_curve_point	Code fragment for zbrush.commands.add_curve_point.
Fragment zbrush.commands.add_new_curve	Code fragment for zbrush.commands.add_new_curve.
Fragment zbrush.commands.add_note_button	Code fragment for zbrush.commands.add_note_button.
Fragment zbrush.commands.add_note_switch	Code fragment for zbrush.commands.add_note_switch.
Fragment zbrush.commands.add_palette	Code fragment for zbrush.commands.add_palette.
Fragment zbrush.commands.add_slider	Code fragment for zbrush.commands.add_slider.
Fragment zbrush.commands.add_subpalette	Code fragment for zbrush.commands.add_subpalette.
Fragment zbrush.commands.add_switch	Code fragment for zbrush.commands.add_switch.
Fragment zbrush.commands.add_zsphere	Code fragment for zbrush.commands.add_zsphere.
Fragment zbrush.commands.ask_filename	Code fragment for zbrush.commands.ask_filename.
Fragment zbrush.commands.ask_string	Code fragment for zbrush.commands.ask_string.
Fragment zbrush.commands.canvas_click	Code fragment for zbrush.commands.canvas_click.
Fragment zbrush.commands.canvas_stroke	Code fragment for zbrush.commands.canvas_stroke.
Fragment zbrush.commands.canvas_strokes	Code fragment for zbrush.commands.canvas_strokes.
Fragment zbrush.commands.click	Code fragment for zbrush.commands.click.
Fragment zbrush.commands.close	Code fragment for zbrush.commands.close.
Fragment zbrush.commands.config	Code fragment for zbrush.commands.config.
Fragment zbrush.commands.create_displacement_map	Code fragment for zbrush.commands.create_displacement_map.
Fragment zbrush.commands.create_mesh_from_curves	Code fragment for zbrush.commands.create_mesh_from_curves.
Fragment zbrush.commands.create_normal_map	Code fragment for zbrush.commands.create_normal_map.
Fragment zbrush.commands.curves_to_ui	Code fragment for zbrush.commands.curves_to_ui.
Fragment zbrush.commands.delete_curves	Code fragment for zbrush.commands.delete_curves.
Fragment zbrush.commands.delete_interface_item	Code fragment for zbrush.commands.delete_interface_item.
Fragment zbrush.commands.delete_keyframe	Code fragment for zbrush.commands.delete_keyframe.
Fragment zbrush.commands.delete_zsphere	Code fragment for zbrush.commands.delete_zsphere.
Fragment zbrush.commands.edit_zsphere	Code fragment for zbrush.commands.edit_zsphere.
Fragment zbrush.commands.exists	Code fragment for zbrush.commands.exists.
Fragment zbrush.commands.freeze	Code fragment for zbrush.commands.freeze.
Fragment zbrush.commands.get	Code fragment for zbrush.commands.get.
Fragment zbrush.commands.get_active_subtool_index	Code fragment for zbrush.commands.get_active_subtool_index.
Fragment zbrush.commands.get_active_tool_index	Code fragment for zbrush.commands.get_active_tool_index.
Fragment zbrush.commands.get_active_tool_path	Code fragment for zbrush.commands.get_active_tool_path.
Fragment zbrush.commands.get_active_track_index	Code fragment for zbrush.commands.get_active_track_index.
Fragment zbrush.commands.get_canvas_pan	Code fragment for zbrush.commands.get_canvas_pan.
Fragment zbrush.commands.get_canvas_zoom	Code fragment for zbrush.commands.get_canvas_zoom.
Fragment zbrush.commands.get_flags	Code fragment for zbrush.commands.get_flags.
Fragment zbrush.commands.get_from_note	Code fragment for zbrush.commands.get_from_note.
Fragment zbrush.commands.get_height	Code fragment for zbrush.commands.get_height.
Fragment zbrush.commands.get_hotkey	Code fragment for zbrush.commands.get_hotkey.
Fragment zbrush.commands.get_id	Code fragment for zbrush.commands.get_id.
Fragment zbrush.commands.get_info	Code fragment for zbrush.commands.get_info.
Fragment zbrush.commands.get_keyframe_time	Code fragment for zbrush.commands.get_keyframe_time.
Fragment zbrush.commands.get_keyframes_count	Code fragment for zbrush.commands.get_keyframes_count.
Fragment zbrush.commands.get_last_stroke	Code fragment for zbrush.commands.get_last_stroke.
Fragment zbrush.commands.get_last_typed_filename	Code fragment for zbrush.commands.get_last_typed_filename.
Fragment zbrush.commands.get_last_used_filename	Code fragment for zbrush.commands.get_last_used_filename.
Fragment zbrush.commands.get_left_mouse_button_state	Code fragment for zbrush.commands.get_left_mouse_button_state.
Fragment zbrush.commands.get_max	Code fragment for zbrush.commands.get_max.
Fragment zbrush.commands.get_min	Code fragment for zbrush.commands.get_min.
Fragment zbrush.commands.get_mod	Code fragment for zbrush.commands.get_mod.
Fragment zbrush.commands.get_mouse_pos	Code fragment for zbrush.commands.get_mouse_pos.
Fragment zbrush.commands.get_next_filename	Code fragment for zbrush.commands.get_next_filename.
Fragment zbrush.commands.get_pos	Code fragment for zbrush.commands.get_pos.
Fragment zbrush.commands.get_secondary	Code fragment for zbrush.commands.get_secondary.
Fragment zbrush.commands.get_status	Code fragment for zbrush.commands.get_status.
Fragment zbrush.commands.get_subtool_count	Code fragment for zbrush.commands.get_subtool_count.
Fragment zbrush.commands.get_subtool_folder_index	Code fragment for zbrush.commands.get_subtool_folder_index.
Fragment zbrush.commands.get_subtool_folder_name	Code fragment for zbrush.commands.get_subtool_folder_name.
Fragment zbrush.commands.get_subtool_id	Code fragment for zbrush.commands.get_subtool_id.
Fragment zbrush.commands.get_subtool_status	Code fragment for zbrush.commands.get_subtool_status.
Fragment zbrush.commands.get_timeline_time	Code fragment for zbrush.commands.get_timeline_time.
Fragment zbrush.commands.get_title	Code fragment for zbrush.commands.get_title.
Fragment zbrush.commands.get_tool_count	Code fragment for zbrush.commands.get_tool_count.
Fragment zbrush.commands.get_tool_path	Code fragment for zbrush.commands.get_tool_path.
Fragment zbrush.commands.get_transform	Code fragment for zbrush.commands.get_transform.
Fragment zbrush.commands.get_transpose	Code fragment for zbrush.commands.get_transpose.
Fragment zbrush.commands.get_width	Code fragment for zbrush.commands.get_width.
Fragment zbrush.commands.get_zsphere	Code fragment for zbrush.commands.get_zsphere.
Fragment zbrush.commands.has_next_filename	Code fragment for zbrush.commands.has_next_filename.
Fragment zbrush.commands.hide	Code fragment for zbrush.commands.hide.
Fragment zbrush.commands.is_disabled	Code fragment for zbrush.commands.is_disabled.
Fragment zbrush.commands.is_enabled	Code fragment for zbrush.commands.is_enabled.
Fragment zbrush.commands.is_locked	Code fragment for zbrush.commands.is_locked.
Fragment zbrush.commands.is_unlocked	Code fragment for zbrush.commands.is_unlocked.
Fragment zbrush.commands.load_stroke	Code fragment for zbrush.commands.load_stroke.
Fragment zbrush.commands.load_strokes	Code fragment for zbrush.commands.load_strokes.
Fragment zbrush.commands.locate_subtool	Code fragment for zbrush.commands.locate_subtool.
Fragment zbrush.commands.locate_subtool_by_name	Code fragment for zbrush.commands.locate_subtool_by_name.
Fragment zbrush.commands.lock	Code fragment for zbrush.commands.lock.
Fragment zbrush.commands.maximize	Code fragment for zbrush.commands.maximize.
Fragment zbrush.commands.merge_undo	Code fragment for zbrush.commands.merge_undo.
Fragment zbrush.commands.message_ok	Code fragment for zbrush.commands.message_ok.
Fragment zbrush.commands.message_ok_cancel	Code fragment for zbrush.commands.message_ok_cancel.
Fragment zbrush.commands.message_yes_no	Code fragment for zbrush.commands.message_yes_no.
Fragment zbrush.commands.message_yes_no_cancel	Code fragment for zbrush.commands.message_yes_no_cancel.
Fragment zbrush.commands.minimize	Code fragment for zbrush.commands.minimize.
Fragment zbrush.commands.modify	Code fragment for zbrush.commands.modify.
Fragment zbrush.commands.new_curves	Code fragment for zbrush.commands.new_curves.
Fragment zbrush.commands.new_keyframe	Code fragment for zbrush.commands.new_keyframe.
Fragment zbrush.commands.pixol_pick	Code fragment for zbrush.commands.pixol_pick.
Fragment zbrush.commands.press	Code fragment for zbrush.commands.press.
Fragment zbrush.commands.press_key	Code fragment for zbrush.commands.press_key.
Fragment zbrush.commands.query_mesh3d	Code fragment for zbrush.commands.query_mesh3d.
Fragment zbrush.commands.randomize	Code fragment for zbrush.commands.randomize.
Fragment zbrush.commands.reset	Code fragment for zbrush.commands.reset.
Fragment zbrush.commands.resolve_path	Code fragment for zbrush.commands.resolve_path.
Fragment zbrush.commands.rgb	Code fragment for zbrush.commands.rgb.
Fragment zbrush.commands.select_subtool	Code fragment for zbrush.commands.select_subtool.
Fragment zbrush.commands.select_tool	Code fragment for zbrush.commands.select_tool.
Fragment zbrush.commands.set	Code fragment for zbrush.commands.set.
Fragment zbrush.commands.set_active_track_index	Code fragment for zbrush.commands.set_active_track_index.
Fragment zbrush.commands.set_canvas_pan	Code fragment for zbrush.commands.set_canvas_pan.
Fragment zbrush.commands.set_canvas_zoom	Code fragment for zbrush.commands.set_canvas_zoom.
Fragment zbrush.commands.set_color	Code fragment for zbrush.commands.set_color.
Fragment zbrush.commands.set_hotkey	Code fragment for zbrush.commands.set_hotkey.
Fragment zbrush.commands.set_keyframe_time	Code fragment for zbrush.commands.set_keyframe_time.
Fragment zbrush.commands.set_max	Code fragment for zbrush.commands.set_max.
Fragment zbrush.commands.set_min	Code fragment for zbrush.commands.set_min.
Fragment zbrush.commands.set_mod	Code fragment for zbrush.commands.set_mod.
Fragment zbrush.commands.set_next_filename	Code fragment for zbrush.commands.set_next_filename.
Fragment zbrush.commands.set_status	Code fragment for zbrush.commands.set_status.
Fragment zbrush.commands.set_subtool_status	Code fragment for zbrush.commands.set_subtool_status.
Fragment zbrush.commands.set_timeline_time	Code fragment for zbrush.commands.set_timeline_time.
Fragment zbrush.commands.set_timeline_to_keyframe_time	Code fragment for zbrush.commands.set_timeline_to_keyframe_time.
Fragment zbrush.commands.set_tool_path	Code fragment for zbrush.commands.set_tool_path.
Fragment zbrush.commands.set_transform	Code fragment for zbrush.commands.set_transform.
Fragment zbrush.commands.set_transpose	Code fragment for zbrush.commands.set_transpose.
Fragment zbrush.commands.set_zsphere	Code fragment for zbrush.commands.set_zsphere.
Fragment zbrush.commands.show	Code fragment for zbrush.commands.show.
Fragment zbrush.commands.show_actions	Code fragment for zbrush.commands.show_actions.
Fragment zbrush.commands.show_note	Code fragment for zbrush.commands.show_note.
Fragment zbrush.commands.stroke	Code fragment for zbrush.commands.stroke.
Fragment zbrush.commands.stroke.__init__	Code fragment for zbrush.commands.Stroke.__init__.
Fragment zbrush.commands.system_info	Code fragment for zbrush.commands.system_info.
Fragment zbrush.commands.toggle	Code fragment for zbrush.commands.toggle.
Fragment zbrush.commands.un_press	Code fragment for zbrush.commands.un_press.
Fragment zbrush.commands.unlock	Code fragment for zbrush.commands.unlock.
Fragment zbrush.commands.update	Code fragment for zbrush.commands.update.
Fragment zbrush.commands.zbrush_info	Code fragment for zbrush.commands.zbrush_info.
Fragment zbrush.utils.clear_output	Code fragment for zbrush.utils.clear_output.
Fragment zbrush.utils.run_path	Code fragment for zbrush.utils.run_path.
Fragment zbrush.utils.run_script	Code fragment for zbrush.utils.run_script.
Fragment zbrush.zscript_compatibility.rand	Code fragment for zbrush.zscript_compatibility.rand.
Fragment zbrush.zscript_compatibility.rand_int	Code fragment for zbrush.zscript_compatibility.rand_int.

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.

Examples¶

Code Examples¶

Code Fragments¶

Search