omni.ui

Submodules Summary:

omni.ui.abstract_shade	No submodule docstring provided
omni.ui.color_utils	No submodule docstring provided
omni.ui.constant_utils	No submodule docstring provided
omni.ui.singleton	No submodule docstring provided
omni.ui.style_utils	No submodule docstring provided
omni.ui.url_utils	No submodule docstring provided
omni.ui.workspace_utils	The utilities to capture and restore layout

Classes Summary:

AbstractField	The abstract widget that is base for any field, which is a one-line text editor.
AbstractItem	The object that is associated with the data entity of the AbstractItemModel.
AbstractItemDelegate	AbstractItemDelegate is used to generate widgets that display and edit data items from a model.
AbstractItemModel	The central component of the item widget. It is the application’s dynamic data structure, independent of the user interface, and it directly manages the nested data. It follows closely model-view pattern. It’s abstract, and it defines the standard interface to be able to interoperate with the components of the model-view architecture. It is not supposed to be instantiated directly. Instead, the user should subclass it to create a new model.
AbstractMultiField	AbstractMultiField is the abstract class that has everything to create a custom widget per model item.
AbstractSlider	The abstract widget that is base for drags and sliders.
AbstractValueModel
Alignment	Members:
ArrowHelper	The ArrowHelper widget provides a colored rectangle to display.
ArrowType	Members:
Axis	Members:
BezierCurve	Smooth curve that can be scaled infinitely.
Button	The Button widget provides a command button.
ByteImageProvider	doc
CanvasFrame	CanvasFrame is the widget that allows the user to pan and zoom its children with a mouse. It has the layout that can be infinitely moved in any direction.
CheckBox	A CheckBox is an option button that can be switched on (checked) or off (unchecked). Checkboxes are typically used to represent features in an application that can be enabled or disabled without affecting others.
Circle	The Circle widget provides a colored circle to display.
CircleSizePolicy	Define what happens when the source image has a different size than the item.
CollapsableFrame	CollapsableFrame is a frame widget that can hide or show its content. It has two states expanded and collapsed. When it’s collapsed, it looks like a button. If it’s expanded, it looks like a button and a frame with the content. It’s handy to group properties, and temporarily hide them to get more space for something else.
ColorStore	A singleton that stores all the UI Style color properties of omni.ui.
ColorWidget	The ColorWidget widget is a button that displays the color from the item model and can open a picker window to change the color.
ComboBox	The ComboBox widget is a combined button and a drop-down list.
Container	Base class for all UI containers. Container can hold one or many other :class:`omni.ui.Widget` s
CornerFlag	Members:
Direction	Members:
DockPolicy	Members:
DockPosition	Members:
DockPreference	Members:
DockSpace	The DockSpace class represents Dock Space for the OS Window.
DynamicTextureProvider	doc
Ellipse	Constructs Ellipse.
FillPolicy	Members:
FloatDrag	The drag widget that looks like a field but it’s possible to change the value with dragging.
FloatField	The FloatField widget is a one-line text editor with a string model.
FloatSlider	The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal groove and translates the handle’s position into a float value within the legal range.
FloatStore	A singleton that stores all the UI Style float properties of omni.ui.
FocusPolicy	Members:
FontStyle	Supported font styles.
Fraction	Fraction length is made to take the space of the parent widget, divides it up into a row of boxes, and makes each child widget fill one box.
Frame	The Frame is a widget that can hold one child widget.
FreeBezierCurve	Smooth curve that can be scaled infinitely.
FreeCircle	The Circle widget provides a colored circle to display.
FreeEllipse	The Ellipse widget provides a colored ellipse to display.
FreeLine	The Line widget provides a colored line to display.
FreeRectangle	The Rectangle widget provides a colored rectangle to display.
FreeTriangle	The Triangle widget provides a colored triangle to display.
Grid	Grid is a container that arranges its child views in a grid. The grid vertical/horizontal direction is the direction the grid size growing with creating more children.
HGrid	Shortcut for Grid{eLeftToRight}. The grid grows from left to right with the widgets placed.
HStack	Shortcut for Stack{eLeftToRight}. The widgets are placed in a row, with suitable sizes.
Image	The Image widget displays an image.
ImageProvider	ImageProvider class, the goal of this class is to provide ImGui reference for the image to be rendered.
ImageWithProvider	The Image widget displays an image.
Inspector	Inspector is the helper to check the internal state of the widget. It’s not recommended to use it for the routine UI.
IntDrag	The drag widget that looks like a field but it’s possible to change the value with dragging.
IntField	The IntField widget is a one-line text editor with a string model.
IntSlider	The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal groove and translates the handle’s position into an integer value within the legal range.
InvisibleButton	The InvisibleButton widget provides a transparent command button.
ItemModelHelper	The ItemModelHelper class provides the basic functionality for item widget classes.
IwpFillPolicy	Members:
Label	The Label widget provides a text to display.
Length	OMNI.UI has several different units for expressing a length.
Line	The Line widget provides a colored line to display.
MainWindow	The MainWindow class represents Main Window for the Application, draw optional MainMenuBar and StatusBar.
Menu	The Menu class provides a menu widget for use in menu bars, context menus, and other popup menus.
MenuBar	The MenuBar class provides a MenuBar at the top of the Window, could also be the MainMenuBar of the MainWindow.
MenuDelegate	MenuDelegate is used to generate widgets that represent the menu item.
MenuHelper	The helper class for the menu that draws the menu line.
MenuItem	A MenuItem represents the items the Menu consists of.
MenuItemCollection	The MenuItemCollection is the menu that unchecks children when one of them is checked.
MultiFloatDragField	MultiFloatDragField is the widget that has a sub widget (FloatDrag) per model item.
MultiFloatField	MultiFloatField is the widget that has a sub widget (FloatField) per model item.
MultiIntDragField	MultiIntDragField is the widget that has a sub widget (IntDrag) per model item.
MultiIntField	MultiIntField is the widget that has a sub widget (IntField) per model item.
MultiStringField	MultiStringField is the widget that has a sub widget (StringField) per model item.
OffsetLine	The free widget is the widget that is independent of the layout. It draws the line stuck to the bounds of other widgets.
Percent	Percent is the length in percents from the parent widget.
Pixel	Pixel length is exact length in pixels.
Placer	The Placer class place a single widget to a particular position based on the offet.
Plot	The Plot widget provides a line/histogram to display.
ProgressBar	A progressbar is a classic widget for showing the progress of an operation.
RadioButton	RadioButton is the widget that allows the user to choose only one of a predefined set of mutually exclusive options.
RadioCollection	Radio Collection is a class that groups RadioButtons and coordinates their state.
RasterImageProvider	doc
RasterPolicy	Used to set the rasterization behaviour.
Rectangle	The Rectangle widget provides a colored rectangle to display.
ScrollBarPolicy	Members:
ScrollingFrame	The ScrollingFrame class provides the ability to scroll onto another widget.
Separator	The Separator class provides blank space.
ShadowFlag	Members:
Shape	The Shape widget provides a base class for all the Shape Widget. Currently implemented are Rectangle, Circle, Triangle, Line, Ellipse and BezierCurve.
ShapeAnchorHelper	The ShapeAnchorHelper provides common functionality for Shape Anchors.
SimpleBoolModel	A very simple bool model.
SimpleFloatModel	A very simple double model.
SimpleIntModel	A very simple Int model.
SimpleStringModel	A very simple value model that holds a single string.
SliderDrawMode	Members:
Spacer	The Spacer class provides blank space.
Stack	The Stack class lines up child widgets horizontally, vertically or sorted in a Z-order.
StringField	The StringField widget is a one-line text editor with a string model.
StringStore	A singleton that stores all the UI Style string properties of omni.ui.
Style	A singleton that controls the global style of the session.
TextureFormat	Members:
ToolBar	The ToolBar class represents a window in the underlying windowing system that as some fixed size property.
ToolBarAxis	Members:
ToolButton	ToolButton is functionally similar to Button, but provides a model that determines if the button is checked. This button toggles between checked (on) and unchecked (off) when the user clicks it.
TreeView	TreeView is a widget that presents a hierarchical view of information. Each item can have a number of subitems. An indentation often visualizes this in a list. An item can be expanded to reveal subitems, if any exist, and collapsed to hide subitems.
Triangle	The Triangle widget provides a colored triangle to display.
Type	Members:
UIntDrag
UIntSlider	The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal groove and translates the handle’s position into an integer value within the legal range.
UnitType	Unit types.
VGrid	Shortcut for Grid{eTopToBottom}. The grid grows from top to bottom with the widgets placed.
VStack	Shortcut for Stack{eTopToBottom}. The widgets are placed in a column, with suitable sizes.
ValueModelHelper	The ValueModelHelper class provides the basic functionality for value widget classes. ValueModelHelper class is the base class for every standard widget that uses a AbstractValueModel. ValueModelHelper is an abstract class and itself cannot be instantiated. It provides a standard interface for interoperating with models.
VectorImageProvider	doc
Widget	The Widget class is the base class of all user interface objects.
WidgetMouseDropEvent	Holds the data which is sent when a drag and drop action is completed.
Window	The Window class represents a window in the underlying windowing system.
WindowHandle	WindowHandle is a handle object to control any of the windows in Kit. It can be created any time, and if it’s destroyed, the source window doesn’t disappear.
Workspace	Workspace object provides access to the windows in Kit.
ZStack	Shortcut for Stack{eBackToFront}. The widgets are placed sorted in a Z-order in top right corner with suitable sizes.

Functions Summary:

add_to_namespace
set_menu_delegate	Set the default delegate to use it when the item doesn’t have a
set_shade
dock_window_in_window	dock_window_in_window(arg0: str, arg1: str, arg2: omni.ui._ui.DockPosition, arg3: float) -> bool
get_custom_glyph_code	get_custom_glyph_code(file_path: str, font_style: omni.ui._ui.FontStyle = <FontStyle.NORMAL: 1>) -> str
get_main_window_height	get_main_window_height() -> float
get_main_window_width	get_main_window_width() -> float