Overview

The omni.kit.widget.filter extension provides a user interface component in the form of a filter button with an associated popup menu. The button allows users to control filter options within an application, and the popup menu presents a list of filter options that can be toggled on or off. It is designed to be used within the Omniverse Kit SDK environment.

Important API List

FilterButton: A UI component that displays a button and manages a popup menu for filter options.

General Use Case

The extension is generally used to add filtering capabilities to an application’s UI. Developers can integrate the FilterButton into their interfaces, allowing users to access and toggle a set of predefined filter options presented in a dropdown menu. The button reflects the state of the filters, such as when there are unsaved changes, and provides callbacks for mouse interactions, making it interactive and responsive to user input. For examples of how to use the APIs, please consult the Python usage pages.

Overview

Important API List

General Use Case

User Guide