Buttons in Nvidia Omniverse (ui.Button)

Learn how to add buttons to your Omniverse application with omni.ui

ui.Button Tutorial

Introduction

The ui.Button is used to create interactive buttons in omni.ui. This tutorial will show you how to create buttons and handle button click events.

Check out the full Quantyverse´s Omniverse Guide at Quantyverse Tutorials

Prerequisites

• Basic understanding of Python.

• Nvidia Omniverse environment setup.

Creating a Basic Button

To create a button, you use the ui.Button class. Below is an example of how to create a basic button and handle a click event.

import omni.ui as ui

# Create a window
window = ui.Window("Button Example", width=300, height=200)

# Create a button inside the window
with window.frame:
    def on_button_click():
        print("Button clicked!")
    
    ui.Button("Click Me", clicked_fn=on_button_click)

Customizing a Button

You can customize a button by setting its text, icon, and other properties. Below is an example of how to create a button with a custom icon and text.

import omni.ui as ui
from omni.ui import color as cl

window = ui.Window("Customized Button", width=300, height=200)
with window.frame:
    def on_button_click():
        print("Styled button clicked!")
    
    ui.Button(
        "Styled Button",
        clicked_fn=on_button_click,
        style={"background_color": cl.('#097eff')}
    )

Summary

In this tutorial, we learned how to create and handle button click events in omni.ui. We covered the basics of creating a button and handling click events. Buttons are essential for creating interactive UI applications in Nvidia Omniverse, and mastering them will help you create more sophisticated and user-friendly interfaces.

AI-Assisted Learning

To enhance your learning experience, we're integrating our knowledge base into AI assistants across different platforms. Choose your preferred platform and start learning:

• CustomGPT: Quanty Omniverse Tutorials

• Poe: Quanty Omniverse Bot

Please note that both our knowledge base and AI assistants are continuously evolving. The AI's responses are based on the information we've provided, which means they may occasionally make mistakes or have gaps in their knowledge.

Thank you and I hope the Tutorial was helpful.

Thomas
Chief of Dreams and Omniverse Enthusiast, Quantyverse