file_path stringlengths 5 44 | content stringlengths 75 400k |
|---|---|
omni.ui.ShadowFlag.md | ShadowFlag — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ShadowFlag
# ShadowFlag
class omni.ui.ShadowFlag
Bases: pybind11_object
Members:
NONE
CUT_OUT_SHAPE_BACKGROUND
Methods
__init__(self, value)
Attributes
CUT_OUT_SHAPE_BACKGROUND
NONE
name... |
omni.ui.VectorImageProvider.md | VectorImageProvider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
VectorImageProvider
# VectorImageProvider
class omni.ui.VectorImageProvider
Bases: ImageProvider
doc
Methods
__init__(self[, source_url])
doc
Attributes
max_mip_levels
Maximum numbe... |
Kind.md | Kind module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Kind module
# Kind module
Summary: The Kind library provides a runtime-extensible taxonomy known as “kinds”. Useful for classifying scenegraph objects.
Python bindings for libKind
Classes:
Registry
A singleton that holds known kinds and in... |
omni.ui.FocusPolicy.md | FocusPolicy — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FocusPolicy
# FocusPolicy
class omni.ui.FocusPolicy
Bases: pybind11_object
Members:
DEFAULT
FOCUS_ON_LEFT_MOUSE_DOWN
FOCUS_ON_ANY_MOUSE_DOWN
FOCUS_ON_HOVER
Methods
__init__(self, value)
Attr... |
omni.ui.UIntDrag.md | UIntDrag — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
UIntDrag
# UIntDrag
class omni.ui.UIntDrag
Bases: UIntSlider
Methods
__init__(self[, model])
Constructs UIntDrag.
Attributes
step
This property controls the steping speed on the drag, its floa... |
omni.ui.Triangle.md | Triangle — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Triangle
# Triangle
class omni.ui.Triangle
Bases: Shape
The Triangle widget provides a colored triangle to display.
Methods
__init__(self, **kwargs)
Constructs Triangle.
Attributes
alignment
T... |
omni.ui.color_utils.AbstractShade.md | AbstractShade — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.color_utils »
omni.ui.color_utils Classes »
AbstractShade
# AbstractShade
class omni.ui.color_utils.AbstractShade
Bases: object
The implementation of shades for custom style param... |
omni.ui.SimpleIntModel.md | SimpleIntModel — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
SimpleIntModel
# SimpleIntModel
class omni.ui.SimpleIntModel
Bases: AbstractValueModel
A very simple Int model.
Methods
__init__(self[, default_value])
get_max(self)
get_min(self)
set_m... |
omni.ui.FloatSlider.md | FloatSlider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FloatSlider
# FloatSlider
class omni.ui.FloatSlider
Bases: AbstractSlider
The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizo... |
omni.ui.StringField.md | StringField — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
StringField
# StringField
class omni.ui.StringField
Bases: AbstractField
The StringField widget is a one-line text editor with a string model.
Methods
__init__(self[, model])
Constructs Strin... |
1_4_0.md | 1.4.0 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.4.0
# 1.4.0
Release Date: Nov 2022
## Changed
Added retries for downloading EULA and GDPR agreements.
## Fixed
Fixed an issue with scrolling the left menu on the exchange tab.
Fixed an issue where ... |
omni.ui.DockSpace.md | DockSpace — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
DockSpace
# DockSpace
class omni.ui.DockSpace
Bases: pybind11_object
The DockSpace class represents Dock Space for the OS Window.
Methods
__init__(self, arg0, **kwargs)
Construct the main windo... |
omni.ui.ComboBox.md | ComboBox — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ComboBox
# ComboBox
class omni.ui.ComboBox
Bases: Widget, ItemModelHelper
The ComboBox widget is a combined button and a drop-down list.
A combo box is a selection widget that displays the curren... |
omni.ui.Fraction.md | Fraction — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Fraction
# Fraction
class omni.ui.Fraction
Bases: Length
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 bo... |
UsdRi.md | UsdRi module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
UsdRi module
# UsdRi module
Summary: The UsdRi module provides schemas and utilities for authoring USD that encodes Renderman-specific information, and USD/RI data conversions.
Classes:
MaterialAPI
Deprecated
SplineAPI
Deprecated
Statem... |
omni.ui.DockPreference.md | DockPreference — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
DockPreference
# DockPreference
class omni.ui.DockPreference
Bases: pybind11_object
Members:
DISABLED
MAIN
RIGHT
LEFT
RIGHT_TOP
RIGHT_BOTTOM
LEFT_BOTTOM
Methods
__init__(self, value)
Attr... |
1_3_3.md | 1.3.3 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.3.3
# 1.3.3
Release Date: Oct 2021
## Added
Added the OS version to com.nvidia.omniverse.launcher.session telemetry event.
Added the locale to com.nvidia.omniverse.launcher.session telemetry event.
Ad... |
omni.ui.StringStore.md | StringStore — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
StringStore
# StringStore
class omni.ui.StringStore
Bases: pybind11_object
A singleton that stores all the UI Style string properties of omni.ui.
Methods
__init__(*args, **kwargs)
find(name)... |
UsdUtils.md | UsdUtils module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
UsdUtils module
# UsdUtils module
Summary: The UsdUtils module contains utility classes and functions for managing, inspecting, editing, and creating USD Assets.
Classes:
CoalescingDiagnosticDelegate
A class which collects warnings and... |
omni.ui.FreeRectangle.md | FreeRectangle — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FreeRectangle
# FreeRectangle
class omni.ui.FreeRectangle
Bases: Rectangle
The Rectangle widget provides a colored rectangle to display.
The free widget is the widget that is independent of ... |
1_9_11.md | 1.9.11 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.9.11
# 1.9.11
Release Date: April 2024
# Fixed
Fixed an issue where Launcher was minimized to the system tray instead of exiting when users clicked on Exit option in user settings menu.
Fixed a race ... |
using_pip_packages.md | Using Python pip Packages — kit-manual 105.1 documentation
kit-manual
»
Using Python pip Packages
# Using Python pip Packages
There are 2 ways to use python pip packages in extensions:
Install them at runtime and use them right away.
Install them at build-time and pre-package into another extension.
## Runti... |
omni.ui.Placer.md | Placer — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Placer
# Placer
class omni.ui.Placer
Bases: Container
The Placer class place a single widget to a particular position based on the offet.
Methods
__init__(self, **kwargs)
Construct Placer.
invali... |
omni.ui.MultiFloatField.md | MultiFloatField — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
MultiFloatField
# MultiFloatField
class omni.ui.MultiFloatField
Bases: AbstractMultiField
MultiFloatField is the widget that has a sub widget (FloatField) per model item.
It’s handy to use... |
omni.ui.constant_utils.AbstractShade.md | AbstractShade — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.constant_utils »
omni.ui.constant_utils Classes »
AbstractShade
# AbstractShade
class omni.ui.constant_utils.AbstractShade
Bases: object
The implementation of shades for custom st... |
omni.ui.ValueModelHelper.md | ValueModelHelper — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ValueModelHelper
# ValueModelHelper
class omni.ui.ValueModelHelper
Bases: pybind11_object
The ValueModelHelper class provides the basic functionality for value widget classes. ValueModelH... |
omni.ui.AbstractValueModel.md | AbstractValueModel — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
AbstractValueModel
# AbstractValueModel
class omni.ui.AbstractValueModel
Bases: pybind11_object
Methods
__init__(self)
Constructs AbstractValueModel.
add_begin_edit_fn(self, arg0)
Add... |
omni.ui.MenuItem.md | MenuItem — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
MenuItem
# MenuItem
class omni.ui.MenuItem
Bases: Widget, MenuHelper
A MenuItem represents the items the Menu consists of.
MenuItem can be inserted only once in the menu.
Methods
__init__(self, ... |
omni.ui.Line.md | Line — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Line
# Line
class omni.ui.Line
Bases: Shape, ArrowHelper, ShapeAnchorHelper
The Line widget provides a colored line to display.
Methods
__init__(self, **kwargs)
Constructs Line.
Attributes
alignme... |
omni.ui.ScrollBarPolicy.md | ScrollBarPolicy — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ScrollBarPolicy
# ScrollBarPolicy
class omni.ui.ScrollBarPolicy
Bases: pybind11_object
Members:
SCROLLBAR_AS_NEEDED
SCROLLBAR_ALWAYS_OFF
SCROLLBAR_ALWAYS_ON
Methods
__init__(self, value... |
installing_launcher.md | Installing Launcher — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Installing Launcher
# Installing Launcher
Please watch the following video for instructions on installing Omniverse Launcher.
## Administrator Rights
Local Admin Rights on the installed computer is recomm... |
documenting_exts.md | Documenting Extensions — kit-manual 105.1 documentation
kit-manual
»
Documenting Extensions
# Documenting Extensions
This guide is for developers who write API documentation. To build the documentation, run:
repo.{sh|bat} docs
Add the -o flag to automatically open the resulting docs in the browser. If multiple... |
Vt.md | Vt module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Vt module
# Vt module
Summary: The Vt (Value Types) module defines classes that provide for type abstraction, enhanced array types, and value type manipulation.
Vt Value Types library
This package defines classes for creating objects that beh... |
omni.ui.RadioButton.md | RadioButton — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
RadioButton
# RadioButton
class omni.ui.RadioButton
Bases: Button
RadioButton is the widget that allows the user to choose only one of a predefined set of mutually exclusive options.
RadioButt... |
1_5_7.md | 1.5.7 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.5.7
# 1.5.7
Release Date: May 2023
## Added
Added new controls for changing the current language on the login screen.
Added the Extensions content type in the Exchange.
## Fixed
Fixed an issue wher... |
UsdLux.md | UsdLux module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
UsdLux module
# UsdLux module
Summary: The UsdLux module provides a representation for lights and related components that are common to many graphics environments.
Classes:
BoundableLightBase
Base class for intrinsic lights that are boun... |
omni.ui.ArrowType.md | ArrowType — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ArrowType
# ArrowType
class omni.ui.ArrowType
Bases: pybind11_object
Members:
NONE
ARROW
Methods
__init__(self, value)
Attributes
ARROW
NONE
name
value
__init__(self: omni.ui._ui.ArrowT... |
Gf.md | Gf module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Gf module
# Gf module
Summary: The Gf (Graphics Foundations) library contains classes and functions for working with basic mathematical aspects of graphics.
Graphics Foundation
This package defines classes for fundamental graphics types and o... |
omni.ui.MultiIntField.md | MultiIntField — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
MultiIntField
# MultiIntField
class omni.ui.MultiIntField
Bases: AbstractMultiField
MultiIntField is the widget that has a sub widget (IntField) per model item.
It’s handy to use it for mult... |
omni.ui.AbstractSlider.md | AbstractSlider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
AbstractSlider
# AbstractSlider
class omni.ui.AbstractSlider
Bases: Widget, ValueModelHelper
The abstract widget that is base for drags and sliders.
Methods
__init__(*args, **kwargs)
Attr... |
dictionary_settings.md | Dictionaries and Settings — kit-manual 105.1 documentation
kit-manual
»
Dictionaries and Settings
# Dictionaries and Settings
Settings is a generalized subsystem designed to provide a simple to use interface to Kit’s various subsystems, which can be automated, enumerated, serialized and so on. It is accessible... |
Work.md | Work module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Work module
# Work module
Summary: The Work library is intended to simplify the use of multithreading in the context of our software ecosystem.
Work
Allows for configuration of the system’s multithreading subsystem.
Functions:
GetConcurren... |
develop.md | Develop a Project — Omniverse Developer Guide latest documentation
Omniverse Developer Guide
»
Omniverse Developer Guide »
Develop a Project
# Develop a Project
After creating a new Project, the development phase begins. In this phase, you configure and use an assortment of tools and extensions, along with aut... |
omni.ui.FillPolicy.md | FillPolicy — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FillPolicy
# FillPolicy
class omni.ui.FillPolicy
Bases: pybind11_object
Members:
STRETCH
PRESERVE_ASPECT_FIT
PRESERVE_ASPECT_CROP
Methods
__init__(self, value)
Attributes
PRESERVE_ASPECT_C... |
1_1_2.md | 1.1.2 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.1.2
# 1.1.2
Release Date: March 2021
## Spotlight Features
New “Learn Tab” available in launcher lets you get quick and immediate “in-launcher” access to our video learning portal. From Introductory ... |
publish.md | Publish a Package — Omniverse Developer Guide latest documentation
Omniverse Developer Guide
»
Omniverse Developer Guide »
Publish a Package
# Publish a Package
The ultimate goal is to transform your hard work into a product that others can realize value from. The publishing process helps you to achieve this b... |
omni.ui.Widget.md | Widget — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Widget
# Widget
class omni.ui.Widget
Bases: pybind11_object
The Widget class is the base class of all user interface objects.
The widget is the atom of the user interface: it receives mouse, keyboa... |
omni.ui.add_to_namespace.md | add_to_namespace — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Functions »
add_to_namespace
# add_to_namespace
omni.ui.add_to_namespace(module=None, module_locals={'AbstractField': <class 'omni.ui._ui.AbstractField'>, 'AbstractItem': <class 'omni.ui._ui.Abstrac... |
profiling.md | Profiling — kit-manual 105.1 documentation
kit-manual
»
Profiling
# Profiling
Kit-based applications come bundled with a profiler interface to instrument your code, for both C++ and Python. Multiple profiler backend implementations are supported:
NVTX
ChromeTrace
Tracy
## Easy Start
Enable the omni.kit.pro... |
omni.ui.VStack.md | VStack — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
VStack
# VStack
class omni.ui.VStack
Bases: Stack
Shortcut for Stack{eTopToBottom}. The widgets are placed in a column, with suitable sizes.
Methods
__init__(self, **kwargs)
Construct a stack with... |
Tf.md | Tf module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Tf module
# Tf module
Summary: The Tf (Tools Foundations) module.
Tf – Tools Foundation
Exceptions:
CppException
ErrorException(*args)
Classes:
CallContext
Debug
DiagnosticType
Enum
Error
MallocTag
NamedTemporaryFile([suffix, prefix... |
debug.md | Debug a Build — Omniverse Developer Guide latest documentation
Omniverse Developer Guide
»
Omniverse Developer Guide »
Debug a Build
# Debug a Build
Recognizing the critical role of debugging in development, Omniverse offers tools and automation to streamline and simplify debugging workflows. In combination wi... |
omni.ui.workspace_utils.handle_exception.md | handle_exception — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.workspace_utils »
omni.ui.workspace_utils Functions »
handle_exception
# handle_exception
omni.ui.workspace_utils.handle_exception(func)
Decorator to print exception in async f... |
cli.md | Omni Asset Validator (CLI) — asset-validator 0.6.2 documentation
asset-validator
»
Omni Asset Validator (CLI)
# Omni Asset Validator (CLI)
## Command Line Interface
Utility for USD validation to ensure layers run smoothly across all Omniverse
products. Validation is based on the USD ComplianceChecker (i.e. t... |
PhysicsSchemaTools.md | PhysicsSchemaTools module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
PhysicsSchemaTools module
# PhysicsSchemaTools module
Summary: Omniverse-specific: The Physics Schema Tools provides tools for the representation of physics properties and behaviors in a 3D scene, such as gravity, collisions, a... |
omni.ui.SimpleFloatModel.md | SimpleFloatModel — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
SimpleFloatModel
# SimpleFloatModel
class omni.ui.SimpleFloatModel
Bases: AbstractValueModel
A very simple double model.
Methods
__init__(self[, default_value])
get_max(self)
get_min(s... |
1_0_50.md | 1.0.50 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.0.50
# 1.0.50
Release Date: March 2021
## Fixed
Catch unexpected Starfleet responses and return the error that tells users to log in.
Fixed licenses link not working on Linux.
## Removed
Remove de... |
UsdAppUtils.md | UsdAppUtils module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
UsdAppUtils module
# UsdAppUtils module
Summary: The UsdAppUtils module contains a number of utilities and common functionality for applications that view and/or record images of USD stages.
Classes:
FrameRecorder
A utility class fo... |
omni.ui.WindowHandle.md | WindowHandle — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
WindowHandle
# WindowHandle
class omni.ui.WindowHandle
Bases: pybind11_object
WindowHandle is a handle object to control any of the windows in Kit. It can be created any time, and if it’s des... |
workstation-install.md | Workstation Install Guide — Omniverse Install Guide latest documentation
Omniverse Install Guide
»
Omniverse Install Guide »
Workstation Install Guide
# Workstation Install Guide
## Workstation Setup
Workstation is ideal for individuals and small teams. It’s deployment and configuration is simple thanks to t... |
omni.ui.InvisibleButton.md | InvisibleButton — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
InvisibleButton
# InvisibleButton
class omni.ui.InvisibleButton
Bases: Widget
The InvisibleButton widget provides a transparent command button.
Methods
__init__(self, **kwargs)
Constructo... |
1_7_1.md | 1.7.1 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.7.1
# 1.7.1
Release Date: Dec 2022
## Added
Renamed Enterprise Launcher to IT Managed Launcher.
Added new UI elements on Exchange cards to filter releases by release channel. A release is classified a... |
omni.ui.Length.md | Length — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Length
# Length
class omni.ui.Length
Bases: pybind11_object
OMNI.UI has several different units for expressing a length.
Many widget properties take “Length” values, such as width, height, minWidth... |
omni.ui.Separator.md | Separator — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Separator
# Separator
class omni.ui.Separator
Bases: Widget, MenuHelper
The Separator class provides blank space.
Normally, it’s used to create separator line in the UI elements
Methods
__init_... |
faq.md | Frequently Asked Questions — kit-manual 105.1 documentation
kit-manual
»
Frequently Asked Questions
# Frequently Asked Questions
## Where can I find the core Kit config file?
It is kit-core.json located close to the Kit executable.
## Can I debug python extensions and scripts?
Yes! Use VS Code for that.
... |
omni.ui.constant_utils.Singleton.md | Singleton — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.constant_utils »
omni.ui.constant_utils Functions »
Singleton
# Singleton
omni.ui.constant_utils.Singleton(class_)
A singleton decorator
© Copyright 2019-2024, NVIDIA.
Last upd... |
omni.ui.CheckBox.md | CheckBox — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
CheckBox
# CheckBox
class omni.ui.CheckBox
Bases: Widget, ValueModelHelper
A CheckBox is an option button that can be switched on (checked) or off (unchecked). Checkboxes are typically used to re... |
omni.ui.constant_utils.FloatShade.md | FloatShade — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.constant_utils »
omni.ui.constant_utils Functions »
FloatShade
# FloatShade
omni.ui.constant_utils.FloatShade(*args, **kwargs)
© Copyright 2019-2024, NVIDIA.
Last updated on M... |
omni.ui.SimpleBoolModel.md | SimpleBoolModel — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
SimpleBoolModel
# SimpleBoolModel
class omni.ui.SimpleBoolModel
Bases: AbstractValueModel
A very simple bool model.
Methods
__init__(self[, default_value])
get_max(self)
get_min(self)
... |
omni.ui.Image.md | Image — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Image
# Image
class omni.ui.Image
Bases: Widget
The Image widget displays an image.
The source of the image is specified as a URL using the source property. By default, specifying the width and heig... |
omni.ui.ColorWidget.md | ColorWidget — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ColorWidget
# ColorWidget
class omni.ui.ColorWidget
Bases: Widget, ItemModelHelper
The ColorWidget widget is a button that displays the color from the item model and can open a picker window t... |
omni.ui.DockPosition.md | DockPosition — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
DockPosition
# DockPosition
class omni.ui.DockPosition
Bases: pybind11_object
Members:
RIGHT
LEFT
TOP
BOTTOM
SAME
Methods
__init__(self, value)
Attributes
BOTTOM
LEFT
RIGHT
SAME
TOP
n... |
omni.ui.url_utils.StringShade.md | StringShade — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.url_utils »
omni.ui.url_utils Functions »
StringShade
# StringShade
omni.ui.url_utils.StringShade(*args, **kwargs)
© Copyright 2019-2024, NVIDIA.
Last updated on Mar 25, 2024... |
omni.ui.FloatStore.md | FloatStore — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FloatStore
# FloatStore
class omni.ui.FloatStore
Bases: pybind11_object
A singleton that stores all the UI Style float properties of omni.ui.
Methods
__init__(*args, **kwargs)
find(name)
Retu... |
omni.ui.DynamicTextureProvider.md | DynamicTextureProvider — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
DynamicTextureProvider
# DynamicTextureProvider
class omni.ui.DynamicTextureProvider
Bases: ByteImageProvider
doc
Methods
__init__(self, arg0)
doc
Attributes
__init__(self: omni.... |
omni.ui.RadioCollection.md | RadioCollection — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
RadioCollection
# RadioCollection
class omni.ui.RadioCollection
Bases: ValueModelHelper
Radio Collection is a class that groups RadioButtons and coordinates their state.
It makes sure that... |
UsdVol.md | UsdVol module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
UsdVol module
# UsdVol module
Summary: The UsdVol module provides schemas for representing volumes (smoke, fire, etc).
Classes:
Field3DAsset
Field3D field primitive.
FieldAsset
Base class for field primitives defined by an external file... |
test.md | Test a Build — Omniverse Developer Guide latest documentation
Omniverse Developer Guide
»
Omniverse Developer Guide »
Test a Build
# Test a Build
Omniverse provides tooling and automation making testing easier and more efficient. Use the system’s built-in methods to generate UNIT TESTS for extensions, run auto... |
omni.ui.Grid.md | Grid — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Grid
# Grid
class omni.ui.Grid
Bases: Stack
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 mo... |
omni.ui.color_utils.Singleton.md | Singleton — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.color_utils »
omni.ui.color_utils Functions »
Singleton
# Singleton
omni.ui.color_utils.Singleton(class_)
A singleton decorator
© Copyright 2019-2024, NVIDIA.
Last updated on M... |
Usd.md | Usd module — pxr-usd-api 105.1 documentation
pxr-usd-api
»
Modules »
Usd module
# Usd module
Summary: The core client-facing module for authoring, compositing, and reading Universal Scene Description.
Classes:
APISchemaBase
The base class for all API schemas.
AssetInfoKeys
Attribute
Scenegraph object for a... |
.gitattributes | *.7z filter=lfs diff=lfs merge=lfs -text
*.arrow filter=lfs diff=lfs merge=lfs -text
*.bin filter=lfs diff=lfs merge=lfs -text
*.bz2 filter=lfs diff=lfs merge=lfs -text
*.ckpt filter=lfs diff=lfs merge=lfs -text
*.ftz filter=lfs diff=lfs merge=lfs -text
*.gz filter=lfs diff=lfs merge=lfs -text
*.h5 filter=lfs diff=lfs ... |
1_6_1.md | 1.6.10 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.6.10
# 1.6.10
Release Date: Sept 2022
## Added
Integrated Navigator filesystem directly into the Nucleus tab.
Added “Show in folder” option for downloaded files in Navigator.
Extension installation.
... |
testing_exts_python.md | Testing Extensions with Python — kit-manual 105.1 documentation
kit-manual
»
Testing Extensions with Python
# Testing Extensions with Python
This guide covers the practical part of testing extensions with Python. Both for extensions developed in the kit repo and outside.
For information on testing extensions w... |
omni.ui.ItemModelHelper.md | ItemModelHelper — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ItemModelHelper
# ItemModelHelper
class omni.ui.ItemModelHelper
Bases: pybind11_object
The ItemModelHelper class provides the basic functionality for item widget classes.
Methods
__init__... |
omni.ui.FloatDrag.md | FloatDrag — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FloatDrag
# FloatDrag
class omni.ui.FloatDrag
Bases: FloatSlider
The drag widget that looks like a field but it’s possible to change the value with dragging.
Methods
__init__(self[, model])
Con... |
omni.ui.FloatField.md | FloatField — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
FloatField
# FloatField
class omni.ui.FloatField
Bases: AbstractField
The FloatField widget is a one-line text editor with a string model.
Methods
__init__(self[, model])
Construct FloatField.... |
omni.ui.workspace_utils.compare_workspace.md | compare_workspace — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Submodules »
omni.ui.workspace_utils »
omni.ui.workspace_utils Functions »
compare_workspace
# compare_workspace
omni.ui.workspace_utils.compare_workspace(workspace_dump: ~typing.List[~typing.Any],... |
omni.ui.Inspector.md | Inspector — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Inspector
# Inspector
class omni.ui.Inspector
Bases: pybind11_object
Inspector is the helper to check the internal state of the widget. It’s not recommended to use it for the routine UI.
Methods... |
publishing_exts.md | Publishing Extensions — kit-manual 105.1 documentation
kit-manual
»
Publishing Extensions
# Publishing Extensions
Extensions are published to the registry to be used by downstream apps and extensions.
Kit documentation: Publishing covers how to do it manually with the command line or UI. However, we suggest au... |
1_8_2.md | 1.8.2 — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Release Notes »
1.8.2
# 1.8.2
Release Date: Dec 2022
## Added
Added new UI elements on Exchange cards to filter releases by release channel. A release is classified as Alpha, Beta, Release, or Enterprise, depending on ... |
omni.ui.ToolButton.md | ToolButton — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ToolButton
# ToolButton
class omni.ui.ToolButton
Bases: Button, ValueModelHelper
ToolButton is functionally similar to Button, but provides a model that determines if the button is checked. Thi... |
omni.ui.Spacer.md | Spacer — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
Spacer
# Spacer
class omni.ui.Spacer
Bases: Widget
The Spacer class provides blank space.
Normally, it’s used to place other widgets correctly in a layout.
Methods
__init__(self, **kwargs)
Constru... |
omni.ui.ProgressBar.md | ProgressBar — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ProgressBar
# ProgressBar
class omni.ui.ProgressBar
Bases: Widget, ValueModelHelper
A progressbar is a classic widget for showing the progress of an operation.
Methods
__init__(self[, model])... |
http-api.md | HTTP API — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
HTTP API
# HTTP API
Launcher uses port 33480 to provide the HTTP API that can be used by other programs to retrieve information
about the current session or get the list of installed apps.
This document describes all a... |
omni.ui.UIPreferencesExtension.md | UIPreferencesExtension — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
UIPreferencesExtension
# UIPreferencesExtension
class omni.ui.UIPreferencesExtension
Bases: IExt
Methods
on_shutdown()
on_startup(ext_id)
__init__(self: omni.ext._extensions.IExt... |
uninstall_apps.md | Uninstalling Apps (Win & Linux) — Omniverse Launcher latest documentation
Omniverse Launcher
»
Omniverse Launcher »
Installation Guide »
Uninstalling Apps (Win & Linux)
# Uninstalling Apps (Win & Linux)
Uninstalling Applications Guide for Windows & Linux
There are two methods to uninstall Omniverse application... |
omni.ui.ColorStore.md | ColorStore — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
ColorStore
# ColorStore
class omni.ui.ColorStore
Bases: pybind11_object
A singleton that stores all the UI Style color properties of omni.ui.
Methods
__init__(*args, **kwargs)
find(name)
Retu... |
logging.md | Logging — kit-manual 105.1 documentation
kit-manual
»
Logging
# Logging
For logging Carbonite is used.
By default info level logging is written to a file. Path to log file is written to stdout among the first lines when Kit starts.
At runtime path to a log file can be found in setting: /log/file or using ${log... |
omni.ui.MainWindow.md | MainWindow — Omniverse Kit 2.25.9 documentation
Omniverse Kit
»
API (python) »
Modules »
omni.ui »
omni.ui Classes »
MainWindow
# MainWindow
class omni.ui.MainWindow
Bases: pybind11_object
The MainWindow class represents Main Window for the Application, draw optional MainMenuBar and StatusBar.
Methods
__init... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.