toolgui 0.0.10

Modular event-driven GUI system for quickly building tools with Python and pyimgui.

toolgui

Modular event-driven GUI system for quickly building tools with Python and pyimgui.

Installation

pip install toolgui

Usage

Window

Create a window that can be opened from the menu bar.

import imgui
import toolgui

@toolgui.window("Example/Hello World")
def hello_example():
    imgui.text("Hello!")

toolgui.set_app_name("Hello World Example")
toolgui.start_toolgui_app()

Settings

Persist state across sessions. Data is saved to the toolgui.ini file.

import imgui
import toolgui

@toolgui.settings("Number Picker")
class Settings:
    my_number = 0

@toolgui.window("Example/Number Picker")
def number_picker():
    Settings.my_number = imgui.input_int("My Number", Settings.my_number, 1)[1]

toolgui.set_app_name("Number Picker Example")
toolgui.start_toolgui_app()

Menu Item

Call a static function from the menu bar.

@toolgui.menu_item("Example/Reset")
def reset():
    Settings.my_number = 0

Events

Event functions are executed by toolgui with these decorators.

Application Start

Executed when the application starts.

@toolgui.on_app_start()
def on_app_start():
    print("Application started")

Application Quit

Executed when the application quits.

@toolgui.on_app_quit()
def on_app_quit():
    print("Application quit")

Update

Executed every frame.

@toolgui.on_update()
def on_update():
    # do_something()