file_path
stringlengths 5
148
| content
stringlengths 0
526k
|
|---|---|
omni.kit.viewport.docs.window.ViewportDocsWindow.md | # ViewportDocsWindow
## Arguments
- `title: str`
### Attributes
### Methods
- `__init__(title: str, **kwargs)`
- ### Arguments
- `title: str`
<dl>
<dt>
<p>
The title of the window.
</p>
</dt>
<dt>
`filenames: List[str]`
</dt>
<dt>
`show_catalog: bool`
</dt>
</dl> |
omni.kit.viewport.legacy_gizmos.md | # omni.kit.viewport.legacy_gizmos
## Module Overview
### omni.kit.viewport.legacy_gizmos
#### Description
This module provides functionalities related to legacy gizmos in the viewport.
#### Documentation Links
- [API (python)](API.html)
- [Modules](Modules.html)
#### Navigation
- [Home](https://docs.omniverse.nvidia.com/kit/docs)
- [Changelog](CHANGELOG.html) (Next)
- [Modules](Modules.html) (Previous)
#### Search
- [Search docs](search.html)
#### Footer
- [Index](genindex.html)
- [Search](search.html) |
omni.kit.viewport.menubar.display.Classes.md | # omni.kit.viewport.menubar.display Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| [ViewportDisplayMenuBarExtension](omni.kit.viewport.menubar.display/omni.kit.viewport.menubar.display.ViewportDisplayMenuBarExtension.html) | The Entry Point for the Display Settings in Viewport Menu Bar | |
omni.kit.viewport.menubar.display.display_menu_container.Classes.md | # omni.kit.viewport.menubar.display.display_menu_container Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| DisplayMenuContainer | The menu with the visibility settings | |
omni.kit.viewport.menubar.display.display_menu_container.DisplayMenuContainer.md | # DisplayMenuContainer
## DisplayMenuContainer
```
The menu with the visibility settings
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self)` | |
| `build_fn(viewport_context)` | Reimplement it to have own customized item |
| `deregister_custom_category_item(category, item)` | |
| `deregister_custom_setting(text)` | |
| `destroy()` | |
| `register_custom_category_item(category, ...)` | |
```code
register_custom_setting
```
(text, setting_path)
<p>
</p>
### Attributes
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.display_menu_container.DisplayMenuContainer.__init__">
```code
__init__
```
(
<em>
<span>
self
</span>
<span>
:
</span>
<span>
</span>
<span>
omni.ui._ui.AbstractItem
</span>
</em>
)
→
```code
None
```
</dt>
<dd>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.display_menu_container.DisplayMenuContainer.build_fn">
```code
build_fn
```
(
<em>
<span>
viewport_context
</span>
<span>
:
</span>
<span>
</span>
<span>
dict
</span>
</em>
)
</dt>
<dd>
<p>
Reimplement it to have own customized item
</p>
</dd>
</dl>
```
---
<footer>
<hr/>
</footer> |
omni.kit.viewport.menubar.display.display_menu_container.md | # omni.kit.viewport.menubar.display.display_menu_container
## Classes Summary:
| Class | Description |
|-------|-------------|
| [DisplayMenuContainer](omni.kit.viewport.menubar.display.display_menu_container/omni.kit.viewport.menubar.display.display_menu_container.DisplayMenuContainer.html) | The menu with the visibility settings | |
omni.kit.viewport.menubar.display.extension.Classes.md | # omni.kit.viewport.menubar.display.extension Classes
## Classes Summary
- **ViewportDisplayMenuBarExtension**
- The Entry Point for the Display Settings in Viewport Menu Bar |
omni.kit.viewport.menubar.display.extension.Functions.md | # omni.kit.viewport.menubar.display.extension Functions
## Functions Summary
- [get_instance](omni.kit.viewport.menubar.display.extension/omni.kit.viewport.menubar.display.extension.get_instance.html) |
omni.kit.viewport.menubar.display.extension.get_instance.md | # get_instance
## get_instance |
omni.kit.viewport.menubar.display.extension.ViewportDisplayMenuBarExtension.md | # ViewportDisplayMenuBarExtension
The Entry Point for the Display Settings in Viewport Menu Bar
## Methods
- `deregister_custom_category_item(category, item)`
- Deregister custom display setting in category.
- `deregister_custom_setting(text)`
- Deregister custom display setting.
- `on_shutdown()`
- `on_startup(ext_id)`
- `register_custom_category_item(category, item)`
- Register custom display setting in category.
| Method | Description |
| --- | --- |
| `register_custom_setting(text, setting_path)` | Register custom display setting. |
| `__init__(self: omni.ext._extensions.IExt) -> None` | Initialize the extension. |
| `deregister_custom_category_item(category: str, item: BaseCategoryItem)` | Deregister custom display setting in category. |
| `deregister_custom_setting(text: str)` | Deregister custom display setting. |
| `register_custom_category_item(category: str, item: BaseCategoryItem, section: str = 'default')` | Register custom display setting in category. |
<section name="omni.kit.viewport.menubar.display.extension.ViewportDisplayMenuBarExtension">
<dl class="tableblock frame-all grid-all">
<dt class="tableblock halign-left valign-top">
<em class="sig sig-object docutils container">
<span class="pre">
def
</span>
<span class="w">
register_custom_setting
</span>
<span class="sig-paren">
(
</span>
<span class="n">
<span class="pre">
text
</span>
</span>
<span class="sig-paren">
:
</span>
<span class="n">
<span class="pre">
str
</span>
</span>
<span class="sig-paren">
)
</span>
</em>
</dt>
<dd>
<p>
Register custom display setting.
:param text: Text shown in menu item.
:type text: str
:param setting_path: Setting path for custom display setting (bool value).
:type setting_path: str
</p>
</dd>
</dl>
</section> |
omni.kit.viewport.menubar.display.Functions.md | # omni.kit.viewport.menubar.display Functions
## Functions Summary:
- [get_instance](omni.kit.viewport.menubar.display/omni.kit.viewport.menubar.display.get_instance.html) |
omni.kit.viewport.menubar.display.get_instance.md | # get_instance
## get_instance
```python
omni.kit.viewport.menubar.display.get_instance()
```
``` |
omni.kit.viewport.menubar.display.md | # omni.kit.viewport.menubar.display
## Submodules
Summary:
| Module | Description |
| --- | --- |
| omni.kit.viewport.menubar.display.display_menu_container | No submodule docstring provided |
| omni.kit.viewport.menubar.display.extension | No submodule docstring provided |
| omni.kit.viewport.menubar.display.style | No submodule docstring provided |
## Classes
Summary:
| Class | Description |
| --- | --- |
| ViewportDisplayMenuBarExtension | The Entry Point for the Display Settings in Viewport Menu Bar |
## Functions
Summary:
| Function | Description |
| --- | --- |
| get_instance | | |
omni.kit.viewport.menubar.display.style.Classes.md | # omni.kit.viewport.menubar.display.style Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| [Path](omni.kit.viewport.menubar.display.style/omni.kit.viewport.menubar.display.style.Path.html) | PurePath subclass that can make system calls. | |
omni.kit.viewport.menubar.display.style.md | # omni.kit.viewport.menubar.display.style
## Classes Summary:
- **Path**
- PurePath subclass that can make system calls. |
omni.kit.viewport.menubar.display.style.Path.md | # Path
## Path
### omni.kit.viewport.menubar.display.style.Path(*args, **kwargs)
Bases: `PurePath`
PurePath subclass that can make system calls.
Path represents a filesystem path but unlike PurePath, also offers methods to do system calls on path objects. Depending on your system, instantiating a Path will return either a PosixPath or a WindowsPath object. You can also instantiate a PosixPath or WindowsPath directly, but cannot instantiate a WindowsPath on a POSIX system or vice versa.
#### Methods
- **absolute()**
- Return an absolute version of this path.
- **chmod(mode, [, follow_symlinks])**
- Change the permissions of the path, like os.chmod().
- **cwd()**
- Return a new path pointing to the current working directory (as returned by os.getcwd()).
- **exists**()
- Whether this path exists.
- **expanduser**()
- Return a new path with expanded ~ and ~user constructs (as returned by os.path.expanduser).
- **glob**(pattern)
- Iterate over this subtree and yield all existing files (of any kind, including directories) matching the given relative pattern.
- **group**()
- Return the group name of the file gid.
- **hardlink_to**(target)
- Make this path a hard link pointing to the same file as `target`.
- **home**()
- Return a new path pointing to the user's home directory (as returned by os.path.expanduser('~')).
- **is_block_device**()
- Whether this path is a block device.
- **is_char_device**()
- Whether this path is a character device.
- **is_dir**()
- Whether this path is a directory.
- **is_fifo**()
- Whether this path is a FIFO.
- **is_file**()
- Whether this path is a regular file (also True for symlinks pointing to regular files).
- **is_mount**()
- Check if this path is a POSIX mount point.
- **is_socket**()
- Whether this path is a socket.
- **is_symlink**()
- Whether this path is a symbolic link.
- **iterdir**()
- Iterate over the files in this directory.
- `lchmod` (mode)
- Like chmod(), except if the path points to a symlink, the symlink's permissions are changed, rather than its target's.
- `link_to` (target)
- Make the target path a hard link pointing to this path.
- `lstat` ()
- Like stat(), except if the path points to a symlink, the symlink's status information is returned, rather than its target's.
- `mkdir` ([mode, parents, exist_ok])
- Create a new directory at this given path.
- `open` ([mode, buffering, encoding, errors, ...])
- Open the file pointed by this path and return a file object, as the built-in open() function does.
- `owner` ()
- Return the login name of the file owner.
- `read_bytes` ()
- Open the file in bytes mode, read it, and close the file.
- `read_text` ([encoding, errors])
- Open the file in text mode, read it, and close the file.
- `readlink` ()
- Return the path to which the symbolic link points.
- `rename` (target)
- Rename this path to the target path.
- `replace` (target)
- Rename this path to the target path, overwriting if that path exists.
- `resolve` ([strict])
- Make the path absolute, resolving all symlinks on the way and also normalizing it (for example turning slashes into backslashes under Windows).
- `rglob` (pattern)
- Recursively yield all existing files (of any kind, including directories) matching the given relative pattern, anywhere in this subtree.
- `rmdir` ()
- Remove this directory.
- `samefile` ()
- (Description not provided in the HTML snippet)
| Method | Description |
|--------|-------------|
| samefile | Return whether other_path is the same or not as this file (as returned by os.path.samefile()). |
| stat (*[, follow_symlinks]) | Return the result of the stat() system call on this path, like os.stat() does. |
| symlink_to (target[, target_is_directory]) | Make this path a symlink pointing to the target path. |
| touch ([mode, exist_ok]) | Create this file with the given access mode, if it doesn't exist. |
| unlink ([missing_ok]) | Remove this file or link. |
| write_bytes (data) | Open the file in bytes mode, write to it, and close the file. |
| write_text (data[, encoding, errors, newline]) | Open the file in text mode, write to it, and close the file. |
### Attributes
#### `__init__()`
#### `absolute()`
Return an absolute version of this path. This function works even if the path doesn’t point to anything.
No normalization is done, i.e. all ‘.’ and ‘..’ will be kept along. Use resolve() to get the canonical path to a file.
#### `chmod(mode, *[, follow_symlinks=True])`
Change the permissions of the path, like os.chmod().
#### `cwd()`
classmethod
Return a new path pointing to the current working directory (as returned by os.getcwd()).
#### `exists()`
Check if the path exists.
## Methods
### expanduser
```python
expanduser()
```
Return a new path with expanded ~ and ~user constructs (as returned by os.path.expanduser)
### glob
```python
glob(pattern)
```
Iterate over this subtree and yield all existing files (of any kind, including directories) matching the given relative pattern.
### group
```python
group()
```
Return the group name of the file gid.
### hardlink_to
```python
hardlink_to(target)
```
Make this path a hard link pointing to the same file as `target`.
Note the order of arguments (self, target) is the reverse of os.link’s.
### home
```python
home()
```
Return a new path pointing to the user’s home directory (as returned by os.path.expanduser(‘~’)).
### is_block_device
```python
is_block_device()
```
Whether this path is a block device.
### is_char_device
```python
is_char_device()
```
Whether this path is a character device.
### is_dir
```python
is_dir()
```
Whether this path is a directory.
### is_fifo
```python
is_fifo()
```
Whether this path is a FIFO.
### is_file
```python
is_file()
```
Whether this path is a regular file (also True for symlinks pointing to regular files).
### is_mount
```python
is_mount()
```
Check if this path is a POSIX mount point
### is_socket
```python
is_socket()
```
Whether this path is a socket.
### is_socket
Whether this path is a socket.
### is_symlink
Whether this path is a symbolic link.
### iterdir
Iterate over the files in this directory. Does not yield any result for the special paths ‘.’ and ‘..’.
### lchmod
Like chmod(), except if the path points to a symlink, the symlink’s permissions are changed, rather than its target’s.
### link_to
Make the target path a hard link pointing to this path.
Note this function does not make this path a hard link to target, despite the implication of the function and argument names. The order of arguments (target, link) is the reverse of Path.symlink_to, but matches that of os.link.
Deprecated since Python 3.10 and scheduled for removal in Python 3.12. Use `hardlink_to()` instead.
### lstat
Like stat(), except if the path points to a symlink, the symlink’s status information is returned, rather than its target’s.
### mkdir
Create a new directory at this given path.
### open
Open this path for reading or writing.
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.open">
<span class="sig-name descname">
<span class="pre">
open
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Open the file pointed by this path and return a file object, as the built-in open() function does.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.owner">
<span class="sig-name descname">
<span class="pre">
owner
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Return the login name of the file owner.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.read_bytes">
<span class="sig-name descname">
<span class="pre">
read_bytes
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Open the file in bytes mode, read it, and close the file.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.read_text">
<span class="sig-name descname">
<span class="pre">
read_text
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
encoding
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
errors
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
</span>
</dt>
<dd>
<p>
Open the file in text mode, read it, and close the file.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.readlink">
<span class="sig-name descname">
<span class="pre">
readlink
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Return the path to which the symbolic link points.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.rename">
<span class="sig-name descname">
<span class="pre">
rename
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
target
</span>
</span>
</em>
</span>
</dt>
<dd>
<p>
Rename this path to the target path.
</p>
<p>
The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the Path object.
</p>
<p>
Returns the new Path instance pointing to the target path.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.replace">
<span class="sig-name descname">
<span class="pre">
replace
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
target
</span>
</span>
</em>
</span>
</dt>
<dd>
<p>
Rename this path to the target path, overwriting if that path exists.
</p>
<p>
The target path may be absolute or relative. Relative paths are interpreted relative to the current working directory, not the directory of the Path object.
</p>
<p>
Returns the new Path instance pointing to the target path.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.resolve">
<span class="sig-name descname">
<span class="pre">
resolve
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
strict
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
False
</span>
</span>
</em>
</span>
</dt>
<dd>
<p>
Make the path absolute, resolving all symlinks on the way and also normalizing it (for example turning slashes into backslashes under Windows).
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.rglob">
<span class="sig-name descname">
<span class="pre">
rglob
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
pattern
</span>
</span>
</em>
</span>
</dt>
<dd>
<p>
Recursively yield all existing files (of any kind, including directories) matching the given relative pattern, anywhere in this subtree.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.viewport.menubar.display.style.Path.rmdir">
<span class="sig-name descname">
<span class="pre">
rmdir
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Remove the directory at this path.
</p>
</dd>
</dl>
### Remove this directory. The directory must be empty.
### Return whether other_path is the same or not as this file (as returned by os.path.samefile()).
### Return the result of the stat() system call on this path, like os.stat() does.
### Make this path a symlink pointing to the target path. Note the order of arguments (link, target) is the reverse of os.symlink.
### Create this file with the given access mode, if it doesn’t exist.
### Remove this file or link. If the path is a directory, use rmdir() instead.
### Open the file in bytes mode, write to it, and close the file.
### Open the file in text mode, write to it, and close the file.
Open the file in text mode, write to it, and close the file. |
omni.kit.viewport.menubar.display.Submodules.md | # omni.kit.viewport.menubar.display Submodules
## Submodules Summary
- **omni.kit.viewport.menubar.display.display_menu_container**
- No submodule docstring provided
- **omni.kit.viewport.menubar.display.extension**
- No submodule docstring provided
- **omni.kit.viewport.menubar.display.style**
- No submodule docstring provided |
omni.kit.viewport.menubar.display.ViewportDisplayMenuBarExtension.md | # ViewportDisplayMenuBarExtension
## Class: omni.kit.viewport.menubar.display.ViewportDisplayMenuBarExtension
**Bases:** `IExt`
**Description:**
The Entry Point for the Display Settings in Viewport Menu Bar
### Methods
- **deregister_custom_category_item(category, item)**
- Deregister custom display setting in category.
- **deregister_custom_setting(text)**
- Deregister custom display setting.
- **on_shutdown()**
- (No description provided)
- **on_startup(ext_id)**
- (No description provided)
- **register_custom_category_item(category, item)**
- Register custom display setting in category.
- **register_custom_setting(text)**
- Register custom display setting.
| Method Name | Description |
|-------------|-------------|
| (text, setting_path) | Register custom display setting. |
### __init__(self: omni.ext._extensions.IExt) -> None
- Initializes the ViewportDisplayMenuBarExtension.
### deregister_custom_category_item(category: str, item: BaseCategoryItem)
- Deregister custom display setting in category.
- :param category: Category to remove menu item. Can be an existing category e.g. “Heads Up Display” or a new one.
- :type category: str
- :param item (item: BaseCategoryItem): Item to remove.
### deregister_custom_setting(text: str)
- Deregister custom display setting.
- :param text: Text shown in menu item.
- :type text: str
### register_custom_category_item(category: str, item: BaseCategoryItem, section: str = 'default')
- Register custom display setting in category.
- :param category: Category to add menu item. Can be an existing category e.g. “Heads Up Display” or a new one.
- :type category: str
- :param item (item: BaseCategoryItem): Item to append.
- :param section: Optional section to organise category, default no section.
- :type section: str
### register_custom_setting(text: str, setting_path: str)
- Register custom display setting.
- :param text: Text shown in menu item.
- :type text: str
- :param setting_path: Path to the setting.
- :type setting_path: str
## Register custom display setting.
:param text: Text shown in menu item.
:type text: str
:param setting_path: Setting path for custom display setting (bool value).
:type setting_path: str |
omni.kit.viewport.ready.Classes.md | # omni.kit.viewport.ready Classes
## Classes Summary:
- **ViewportReadyExtension**
``` |
omni.kit.viewport.ready.extension.Classes.md | # omni.kit.viewport.ready.extension Classes
## Classes Summary
- **ViewportReadyExtension** |
omni.kit.viewport.ready.extension.ViewportReadyExtension.md | # ViewportReadyExtension
## ViewportReadyExtension
```python
class omni.kit.viewport.ready.extension.ViewportReadyExtension
```
Bases: `IExt`
### Methods
| Method | Description |
|---------------|-------------|
| `on_shutdown()` | |
| `on_startup(ext_id)` | |
```python
def __init__(self: omni.ext._extensions.IExt) -> None:
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
``` |
omni.kit.viewport.ready.md | # omni.kit.viewport.ready
## Submodules Summary:
- [omni.kit.viewport.ready.extension](omni.kit.viewport.ready.extension.html)
- No submodule docstring provided
## Classes Summary:
- [ViewportReadyExtension](omni.kit.viewport.ready/omni.kit.viewport.ready.ViewportReadyExtension.html) |
omni.kit.viewport.ready.Submodules.md | # omni.kit.viewport.ready Submodules
## Submodules Summary
- [omni.kit.viewport.ready.extension](omni.kit.viewport.ready.extension.html)
- No submodule docstring provided |
omni.kit.viewport.ready.ViewportReadyExtension.md | # ViewportReadyExtension
## ViewportReadyExtension
Bases: `IExt`
### Methods
| Method | Description |
|--------------|-------------|
| `on_shutdown`() | |
| `on_startup`(ext_id) | |
### `__init__`
```python
__init__(self: omni.ext._extensions.IExt) -> None
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
``` |
omni.kit.viewport.registry.Classes.md | # omni.kit.viewport.registry Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| RegisterScene | A class to manage the registration and deregistration of viewport factories. |
| RegisterViewportLayer | A class to manage the registration and deregistration of viewport factories. | |
omni.kit.viewport.registry.md | # omni.kit.viewport.registry
## Classes Summary
- **RegisterScene**
- A class to manage the registration and deregistration of viewport factories.
- **RegisterViewportLayer**
- A class to manage the registration and deregistration of viewport factories. |
omni.kit.viewport.registry.RegisterScene.md | # RegisterScene
## RegisterScene
### omni.kit.viewport.registry.RegisterScene
alias of `_Registry` |
omni.kit.viewport.registry.RegisterViewportLayer.md | # RegisterViewportLayer
## RegisterViewportLayer
### omni.kit.viewport.registry.RegisterViewportLayer
- alias of `_Registry` |
omni.kit.viewport.utility.capture_viewport_to_buffer.md | # capture_viewport_to_buffer
## capture_viewport_to_buffer
Captures the current viewport and sends the image to a callback function.
### Parameters
- **viewport_api** (`ViewportAPI`) – The viewport API instance to capture.
- **on_capture_fn** (`Callable`) – The callback function that will receive the image.
- **is_hdr** (`bool`, optional) – If True, captures the HDR buffer; otherwise, captures the LDR buffer. Defaults to False.
### Returns
A future-like object that can be awaited to ensure the capture completes. |
omni.kit.viewport.utility.capture_viewport_to_file.md | # capture_viewport_to_file
## capture_viewport_to_file
```
```python
def capture_viewport_to_file(viewport_api, file_path: Optional[str] = None, is_hdr: bool = False, render_product_path: Optional[str] = None, format_desc: Optional[dict] = None):
"""
Capture the provided viewport to a file.
"""
## Parameters
- **viewport_api** (`ViewportAPI`) – The viewport API instance to capture.
- **file_path** (`str`, optional) – The file path where the captured image will be saved. If not specified, a default path is used.
- **is_hdr** (`bool`, optional) – If True, captures the HDR buffer; otherwise, captures the LDR buffer. Defaults to False.
- **render_product_path** (`str`, optional) – Render product path to use for capturing. Defaults to None.
- **format_desc** (`dict`, optional) – A dictionary describing the format in which to save the captured image. Defaults to None.
## Returns
A future-like object that can be awaited to ensure the capture completes. |
omni.kit.viewport.utility.create_drop_helper.md | # create_drop_helper
## create_drop_helper
```python
omni.kit.viewport.utility.create_drop_helper(*args, **kwargs)
```
Creates a helper object to handle drag-and-drop operations in a viewport.
### Parameters
- **\*args** – Variable length argument list.
- **\*\*kwargs** – Arbitrary keyword arguments.
### Returns
The drop helper object that can be used to manage drag-and-drop events.
### Return type
Any |
omni.kit.viewport.utility.disable_selection.md | # disable_selection
## disable_selection
Disables selection for a given viewport.
Disable selection rect and possible the single click selection on a Viewport or ViewportWindow.
Returns an object that resets selection when it goes out of scope.
### Parameters
- **viewport_or_window** – The viewport API instance or viewport window to which the selection disabling will be applied.
- **disable_click** (bool, optional) – If set to True, disables single click selection. Defaults to True.
### Returns
An object that, upon deletion, will reset the selection capability to its original state.
### Return type
object |
omni.kit.viewport.utility.frame_viewport_prims.md | # frame_viewport_prims
Frames the view of the viewport to include the specified prims.
## Parameters
- **viewport_api** (`ViewportAPI`, optional) – The viewport API instance to operate on. If not provided, the active viewport is used.
- **prims** (`List[str]`, optional) – A list of USD prim paths to frame in the viewport. If not provided or empty, no action is taken.
## Returns
- True if the operation was successful, False otherwise.
## Return type
- bool |
omni.kit.viewport.utility.frame_viewport_selection.md | # frame_viewport_selection
## frame_viewport_selection
Frames the camera in the viewport to include the current selection.
This function adjusts the camera in the viewport to frame the currently selected objects. If no objects are selected, it adjusts the camera to show the entire scene.
### Parameters
- **viewport_api** (`ViewportAPI`, optional) – The viewport API instance to operate on. If not provided, the active viewport is used.
- **force_legacy_api** (`bool`, optional) – If set to True, forces the use of the legacy viewport API. Defaults to False.
### Returns
- True if the operation was successful, False otherwise.
### Return type
- `bool` |
omni.kit.viewport.utility.Functions.md | # omni.kit.viewport.utility Functions
## Functions Summary:
- **capture_viewport_to_buffer**: Captures the current viewport and sends the image to a callback function.
- **capture_viewport_to_file**: Capture the provided viewport to a file.
- **create_drop_helper**: Creates a helper object to handle drag-and-drop operations in a viewport.
- **disable_selection**: Disables selection for a given viewport.
- **frame_viewport_prims**: Frames the view of the viewport to include the specified prims.
- **frame_viewport_selection**: Frames the camera in the viewport to include the current selection.
- **get_active_viewport**: Retrieves the active viewport API instance for a given USD context.
- **get_active_viewport_and_window**: Retrieves the active viewport and its window for a given USD context and window name.
- **get_active_viewport_camera_path**: Retrieves the camera Sdf.Path for the active viewport within a specified USD context.
- **get_active_viewport_camera_string**: Retrieves the camera path string for the active viewport within a specified USD context.
| 奇数行 | 偶数行 |
| --- | --- |
| get_ground_plane_info | Retrieves the ground plane information including its normal and the planes it occupies. |
| get_num_viewports | Returns the number of active viewports within an optional USD context. |
| get_viewport_from_window_name | Retrieves the first viewport API instance from a specified window name. |
| get_viewport_window_camera_path | Retrieves the camera path for the viewport in the specified window. |
| get_viewport_window_camera_string | Retrieves the camera path string for the viewport in the specified window. |
| post_viewport_message | Posts a message as a toast notification to the viewport or viewport window. |
| toggle_global_visibility | Deprecated since version 1.0.15. | |
omni.kit.viewport.utility.get_active_viewport.md | # get_active_viewport
## get_active_viewport
Retrieves the active viewport API instance for a given USD context.
If no USD context name is provided, the current USD context is used.
### Parameters
**usd_context_name** (str, optional) – The name of the USD context to query. Defaults to an empty string, which indicates the current USD context.
### Returns
The active viewport API instance, or None if not found.
### Return type
Optional[ViewportAPI] |
omni.kit.viewport.utility.get_active_viewport_and_window.md | # get_active_viewport_and_window
## Function
```python
omni.kit.viewport.utility.get_active_viewport_and_window(usd_context_name: str = '', wrap_legacy: bool = True, window_name: Optional[str] = None)
```
### Description
Retrieves the active viewport and its window for a given USD context and window name.
### Parameters
- **usd_context_name** (str, optional) – The name of the USD context to query. If empty, the current USD context is used.
- **wrap_legacy** (bool, optional) – Flag to determine if a legacy viewport should be wrapped.
- **window_name** (str, optional) – The name of the window to query. If none is provided, defaults to the viewport window name from settings.
## Returns
A tuple containing the active viewport API instance and the corresponding window instance, or (None, None) if not found.
## Return type
Tuple[Optional[ViewportAPI], Optional[Window]] |
omni.kit.viewport.utility.get_active_viewport_camera_path.md | # get_active_viewport_camera_path
Retrieves the camera Sdf.Path for the active viewport within a specified USD context.
## Parameters
- **usd_context_name** (str, optional) – The name of the USD context to query. If empty, the current USD context is used. Defaults to an empty string.
## Returns
- The SDF path to the camera used by the active viewport, or None if no active viewport is found.
## Return type
- Sdf.Path |
omni.kit.viewport.utility.get_active_viewport_camera_string.md | # get_active_viewport_camera_string
## get_active_viewport_camera_string
Retrieves the camera path string for the active viewport within a specified USD context.
### Parameters
- **usd_context_name** (str, optional) – The name of the USD context to query. If empty, the current USD context is used. Defaults to an empty string.
### Returns
- The camera path string for the active viewport, or an empty string if no active viewport is found.
### Return type
- str |
omni.kit.viewport.utility.get_ground_plane_info.md | # get_ground_plane_info
## get_ground_plane_info
Retrieves the ground plane information including its normal and the planes it occupies.
### Parameters
- **viewport** (`ViewportAPI`) – The viewport API instance for which to get the ground plane information.
- **ortho_special** (`bool`, optional) – If True, uses an alternate ground plane for orthographic cameras that are looking down a single axis. Defaults to True.
### Returns
A tuple containing the ground plane normal vector and a list of plane axes it occupies (e.g., ['x', 'z']).
### Return type
Tuple[Gf.Vec3d, List[str]] |
omni.kit.viewport.utility.get_num_viewports.md | # get_num_viewports
## get_num_viewports
Returns the number of active viewports within an optional USD context.
### Parameters
- **usd_context_name** (str, optional) – The name of the USD context for which to count the viewports. If None, all viewports across all USD contexts are counted. Defaults to None.
### Returns
- The number of active viewports.
### Return type
- int |
omni.kit.viewport.utility.get_viewport_from_window_name.md | # get_viewport_from_window_name
## get_viewport_from_window_name
Retrieves the first viewport API instance from a specified window name.
If a window name is not provided or is None, it defaults to the viewport window name defined in the settings ('/exts/omni.kit.viewport.window/startup/windowName') or 'Viewport'.
### Parameters
- **window_name** (str, optional) – The name of the window from which to retrieve the viewport API.
### Returns
- An instance of the viewport API or None if no viewport was found.
### Return type
- Optional[ViewportAPI] |
omni.kit.viewport.utility.get_viewport_window_camera_path.md | # get_viewport_window_camera_path
## get_viewport_window_camera_path
Retrieves the camera path for the viewport in the specified window.
If the window name is not provided, the default viewport window is used.
### Parameters
- **window_name** (str, optional) – The name of the window from which to retrieve the camera path.
### Returns
- The SDF path to the camera used by the viewport, or None if the viewport is not found.
### Return type
- Sdf.Path |
omni.kit.viewport.utility.get_viewport_window_camera_string.md | # get_viewport_window_camera_string
Retrieves the camera path string for the viewport in the specified window.
If the window name is not provided, the default viewport window is used.
## Parameters
- **window_name** (`str`, optional) – The name of the window from which to retrieve the camera path string.
## Returns
- The camera path string for the viewport, or None if the viewport is not found.
## Return type
- str |
omni.kit.viewport.utility.post_viewport_message.md | # post_viewport_message
## post_viewport_message
```python
omni.kit.viewport.utility.post_viewport_message(viewport_api_or_window, message: str, message_id: Optional[str] = None)
```
Posts a message as a toast notification to the viewport or viewport window.
### Parameters
- **viewport_api_or_window** – The viewport API instance or viewport window to which the message will be posted.
- **message** (str) – The content of the message to post.
- **message_id** (str, optional) – A unique identifier for the message. Defaults to None. |
omni.kit.viewport.utility.toggle_global_visibility.md | # toggle_global_visibility
## toggle_global_visibility
```python
omni.kit.viewport.utility.toggle_global_visibility(force_legacy_api: bool = False)
```
Deprecated since version 1.0.15: use omni.kit.viewport.actions.toggle_global_visibility instead.
Toggles the global visibility of all viewport layers.
This function is used to toggle the visibility of all the viewport layers, such as the grid, axis, and stage lights. It can be useful when you want to declutter the viewport or focus on specific elements.
### Parameters
- **force_legacy_api** (bool, optional) – If True, forces the use of the legacy viewport API. Defaults to False. |
omni.kit.viewport.window.Classes.md | # omni.kit.viewport.window Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| ViewportWindow | The Window class represents a window in the underlying windowing system. | |
omni.kit.viewport.window.Functions.md | # omni.kit.viewport.window Functions
## Functions Summary
| Function | Description |
|----------|-------------|
| get_viewport_window_instances | Get all known ViewportWindow instances, optionally filtering with a UsdContext name. |
| set_viewport_window_default_style | Set the default style for all ViewportWindows, optionally filtering based on the UsdContext the ViewportWindow | |
omni.kit.viewport.window.get_viewport_window_instances.md | # get_viewport_window_instances
## get_viewport_window_instances
```python
omni.kit.viewport.window.get_viewport_window_instances(usd_context_name: str | None = '')
```
Get all known ViewportWindow instances, optionally filtering with a UsdContext name.
**Parameters**
- **usd_context_name** (str, None) – An optional argument to limit enumeration to ViewportWindows attached to a specific UsdContext.
**Returns**
- An iterable object for enumerating all found ViewportWindow instances. |
omni.kit.viewport.window.md | # omni.kit.viewport.window
## Classes Summary
- **ViewportWindow**
- The Window class represents a window in the underlying windowing system.
## Functions Summary
- **get_viewport_window_instances**
- Get all known ViewportWindow instances, optionally filtering with a UsdContext name.
- **set_viewport_window_default_style**
- Set the default style for all ViewportWindows, optionally filtering based on the UsdContext the ViewportWindow |
omni.kit.viewport.window.set_viewport_window_default_style.md | # set_viewport_window_default_style
## set_viewport_window_default_style
```python
omni.kit.viewport.window.set_viewport_window_default_style(style: dict, overwrite: bool = False, usd_context_name: str | None = '', apply: bool = True)
```
Set the default style for all ViewportWindows, optionally filtering based on the UsdContext the ViewportWindow is attached to.
### Parameters
- **style** (dict) – An omni.ui style dictionary
- **overwrite** (bool) – Whether to overwrite any existing style or augment it.
- **usd_context_name** (str, optional) – The name of the UsdContext. Default is an empty string.
- **apply** (bool, optional) – Whether to apply the style immediately. Default is True.
## 方法参数说明
### 参数列表
- **viewportWindows** (`None`<em>) – An optional argument to limit application to ViewportWindows attached to a specific UsdContext.</em>
- **apply** (`bool`<em>) – Whether to apply the style to existing ViewportWindows, or not.</em> |
omni.kit.viewport.window.ViewportWindow.md | # ViewportWindow
## ViewportWindow
[int] = None,
style: Optional[dict] = None,
usd_drop_support: bool = True,
hydra_engine_options: Optional[dict] = None,
*ui_args,
**ui_kw_args
)
Bases:
Window
Methods
-------
- __init__(name, usd_context_name, width, ...)
- ViewportWindow constructor
- add_external_drag_drop_support(callback_fn)
- Add a callback for an external drag-drop event onto the ViewportWindow
- destroy()
- Destroy the ViewportWindow instance
- get_frame(name)
- Add a unique `omni.ui.Frame` into the view hierarchy.
- get_instances(usd_context_name)
- remove_external_drag_drop_support()
- Disable external drag-drop into the ViewportWindow
- set_default_style(style, [overwrite, ...])
- set_style(style)
- Set the style of the ViewportWindow
| Style | Description |
|-------|-------------|
| (style) | Set the style for the ViewportWindow |
| The Viewport Window, simple window holding a ViewportLayers widget |
## Attributes
| Attribute | Description |
|-----------|-------------|
| active_window | The Viewport Window, simple window holding a ViewportLayers widget |
| name | Return the name of the ViewportWindow |
| viewport_api | Return the active ViewportAPI for the ViewportWindow |
| viewport_widget | Return the active omni.kit.widget.viewport.ViewportWidget for the ViewportWindow |
| visible | This property holds whether the window is visible. |
## Methods
### `__init__(name: Optional[str] = None, usd_context_name: str = '', width: Optional[int] = None, height: Optional[int] = None, flags: Optional[int] = None)`
- `name`: Optional name, default is None.
- `usd_context_name`: USD context name, default is an empty string.
- `width`: Optional width, default is None.
- `height`: Optional height, default is None.
- `flags`: Optional flags, default is None.
ViewportWindow constructor
Parameters:
- **name** (str) – The name of the Window.
- **usd_context_name** (str) – The name of a UsdContext this ViewportWindow will be viewing.
- **width** (int) – The width of the Window.
- **height** (int) – The height of the Window.
- **flags** (int) – omni.ui.WINDOW flags to use for the Window.
- **style** (dict) – Optional style overrides to apply to the Window’s frame.
- **usd_drop_support** (bool) – Enable Usd drop support (requires {py:mod}`omni.kit.window.drop_support`)
- **hydra_engine_options** (dict, None) – Optional dictionary to use in creation of the HydraEngine
- **\*args** – Additional arguments to pass to omni.ui.Window
- **\*\*kwargs** – Additional keyword arguments to pass to omni.ui.Window
add_external_drag_drop_support(callback_fn: Optional[Callable] = None)
Add a callback for an external drag-drop event onto the ViewportWindow
Parameters
==========
- **callback_fn** (`Callable`) – Object to be invoked when the item is dragged or dropped over the ViewportWindow
destroy
=======
- `destroy()` – Destroy the ViewportWindow instance
get_frame
=========
- `get_frame(name: str) -> Frame` – Add a unique {py:class}`omni.ui.Frame` into the view hierarchy. This will return a newly created {py:class}`omni.ui.Frame` on the first call for a unique name, or return a previously created {py:class}`omni.ui.Frame` for the same unique name.
Parameters
----------
- **name** (`str`) – A unique identifier for the frame.
Returns
-------
- {py:class}`omni.ui.Frame`.
Return type
-----------
- An {py:class}`omni.ui.Frame`.
remove_external_drag_drop_support
================================
- `remove_external_drag_drop_support()` – Disable external drag-drop into the ViewportWindow
set_style
=========
- `set_style(style)` – Set the style for the ViewportWindow
Parameters
----------
- **style** – The omni.ui style object to apply.
active_window
=============
- `active_window: Optional[weakproxy] = None` – The Viewport Window, simple window holding a ViewportLayers widget
name
====
- `property name` – Return the name of the ViewportWindow
viewport_api
============
- `property viewport_api` – Return the active ViewportAPI for the ViewportWindow
viewport_widget
===============
- `property viewport_widget` – Return the viewport widget for the ViewportWindow
## ViewportWindow Properties
### ViewportWidget
- **Description:** Return the active omni.kit.widget.viewport.ViewportWidget for the ViewportWindow
### visible
- **Type:** property
- **Description:** This property holds whether the window is visible. |
omni.kit.widget.context_menu.add_menu.md | # add_menu
## add_menu
```python
omni.kit.widget.context_menu.add_menu(menu_dict, index: str = 'MENU', extension_id: str = '')
```
Add custom menu to any context_menu
### Examples
```python
menu = {"name": "Open in Material Editor", "onclick_fn": open_material}
# add to all context menus
self._my_custom_menu = omni.kit.context_menu.add_menu(menu, "MENU", "")
# add to omni.kit.widget.stage context menu
self._my_custom_menu = omni.kit.context_menu.add_menu(menu, "MENU", "omni.kit.widget.stage")
```
### Parameters
- **menu_dict** – a dictionary containing menu settings. See ContextMenuExtension docs for information on values
- **index** – name of the menu EG. “MENU”
- **extension_id** – name of the target EG. “” or “omni.kit.widget.stage”
### NOTE
index and extension_id are extension arbitrary values. `add_menu(menu, "MENU", "omni.kit.widget.stage")` works as `omni.kit.widget.stage` retrieves custom context_menus with `get_menu_dict("MENU", "omni.kit.widget.stage")`. Adding a menu to an extension that doesn’t support context_menus would have no effect.
### Returns
- A MenuSubscription, keep a copy of this as the custom menu will be removed when `release()` is explicitly called or this is garbage collected.
- Return type: (MenuSubscription)
# 标题
这是一个段落，这里有一个链接。
```
```
这是一段代码。 |
omni.kit.widget.context_menu.Classes.md | # omni.kit.widget.context_menu Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| ContextMenuEventType | Event sent when menus are added or removed |
| ContextMenuWidgetExtension | Context menu core functionality |
| DefaultMenuDelegate | Icon Menu Delegate class. | |
omni.kit.widget.context_menu.close_menu.md | # close_menu
## close_menu
### omni.kit.widget.context_menu.close_menu
#### close_menu()
Close currently open context menu. Used by tests not to leave context menu in bad state. |
omni.kit.widget.context_menu.ContextMenuEventType.md | # ContextMenuEventType
## ContextMenuEventType
Event sent when menus are added or removed
### Methods
### Attributes
| Attribute | Description |
|-----------|-------------|
| `ADDED` | New menu entry is added |
| `REMOVED` | Menu entry is removed |
### `__init__()`
### `ADDED`
New menu entry is added
### `REMOVED`
Menu entry is removed
## ContextMenuEventType.REMOVED
Menu entry is removed |
omni.kit.widget.context_menu.ContextMenuWidgetExtension.md | # ContextMenuWidgetExtension
## ContextMenuWidgetExtension
- **Bases:** `IExt`
- **Description:** Context menu core functionality
### Methods
- **`__init__()`**
- **Description:** ContextMenuWidgetExtension init function.
- **`close_menu()`**
- **Description:** Close currently open context menu.
- **`get_context_menu()`**
- **Description:** Gets current context_menu.
- **`menu(name[, delegate, glyph, submenu, tearable])`**
- **Description:** Creates a menu.
- **`menu_item(name[, triggered_fn, enabled, ...])`**
- **Description:** Creates a menu item.
- **`on_shutdown()`**
- **Description:**
| Method | Description |
| ------ | ----------- |
| on_shutdown() | ContextMenuWidgetExtension shutdown function. |
| on_startup(ext_id) | ContextMenuWidgetExtension startup function. |
| separator([name]) | Creates a menu separator. |
| show_context_menu(menu_name, objects, menu_list) | Build context menu from menu_list. |
### Attributes
| Attribute | Description |
| --------- | ----------- |
| name | Name of current context menu. |
### Methods
#### __init__()
ContextMenuWidgetExtension init function.
#### close_menu()
Close currently open context menu. Used by tests not to leave context menu in bad state.
#### get_context_menu()
Gets current context_menu.
- Returns: Current context_menu.
- Return type: (str)
#### menu(name: str, delegate=None, glyph='', submenu=False, tearable=False, **kwargs)
Creates a menu.
- Parameters:
- name: str
- delegate: Optional[Any]
- glyph: str
- submenu: bool
- tearable: bool
- kwargs: Additional keyword arguments
- **name** (`str`) – Name of the menu.
- **delegate** (`ui.MenuDelegate`) – Specify the delegate to create a custom menu. Optional.
- **glyph** (`str`) – Path of the glyph image to show before the menu name. Optional.
- **submenu** (`bool`) – Enables the submenu marker. Optional.
- **tearable** (`bool`) – The ability to tear the window off. Optional.
**Returns**
- Menu item created.
**Return type**
- `uiMenu`
**menu_item** (`str`, `Optional[Callable]` = None, `bool` = True, `bool` = False, `bool` = False, `bool` = False, `None` = None, `None` = None, `str` = '')
- Creates a menu item.
**Parameters**
- **name** (`str`) – Name of the menu item.
- **triggered_fn** (`Callable`) – Function to call when menu item is clicked. Optional.
### Parameters
- **enabled** (`bool`) – Enable the menu item. Optional.
- **checkable** (`bool`) – This property holds whether this menu item is checkable. A checkable item is one which has an on/off state. Optional.
- **checked** (`bool`) – This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked. Optional.
- **is_async_func** (`bool`) – Optional.
- **delegate** (`ui.MenuDelegate`) – Specify the delegate to create a custom menu. Optional.
- **additional_kwargs** (`dict`) – Additional keyword arguments to pass to ui.MenuItem. Optional.
- **glyph** (`str`) – Path of the glyph image to show before the menu name. Optional.
### Returns
- Menu item created.
### Return type
- `uiMenuItem`
### on_shutdown
- ContextMenuWidgetExtension shutdown function.
### on_startup
- ContextMenuWidgetExtension startup function.
- **Parameters**
- **ext_id** (`str`) – Extension identifier.
### separator
- Creates a menu separator.
- **Parameters**
- **name** (`str`) – Name of the menu separator. Optional.
### show_context_menu
- Shows a context menu.
- **Parameters**
- **menu_name** (`str`)
- **objects** (`dict`)
- **menu_list** (`List[dict]`)
### show_context_menu
```python
min_menu_entries: int = 1
delegate: None = None
```
build context menu from menu_list
#### Parameters
- **menu_name** (str) – menu name
- **objects** (dict) – context_menu data
- **menu_list** (list) – list of dictionaries containing context menu values
- **min_menu_entries** (int) – minimal number of menu needed for menu to be visible
### name
```python
property name: str
```
Name of current context menu.
#### Returns
- Name of current context menu.
#### Return type
- (str)
``` |
omni.kit.widget.context_menu.context_menu.Classes.md | # omni.kit.widget.context_menu.context_menu Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| [ContextMenuWidgetExtension](omni.kit.widget.context_menu.context_menu/omni.kit.widget.context_menu.context_menu.ContextMenuWidgetExtension.html) | Context menu core functionality |
| [DefaultMenuDelegate](omni.kit.widget.context_menu.context_menu/omni.kit.widget.context_menu.context_menu.DefaultMenuDelegate.html) | Icon Menu Delegate class. | |
omni.kit.widget.context_menu.context_menu.ContextMenuWidgetExtension.md | # ContextMenuWidgetExtension
## ContextMenuWidgetExtension
```python
class omni.kit.widget.context_menu.context_menu.ContextMenuWidgetExtension
```
Bases: `IExt`
Context menu core functionality
### Methods
- `__init__()`
- ContextMenuWidgetExtension init function.
- `close_menu()`
- Close currently open context menu.
- `get_context_menu()`
- Gets current context_menu.
- `menu(name[, delegate, glyph, submenu, tearable])`
- Creates a menu.
- `menu_item(name[, triggered_fn, enabled, ...])`
-
| Method | Description |
|--------|-------------|
| `on_shutdown()` | ContextMenuWidgetExtension shutdown function. |
| `on_startup(ext_id)` | ContextMenuWidgetExtension startup function. |
| `separator([name])` | Creates a menu separator. |
| `show_context_menu(menu_name, objects, menu_list)` | build context menu from menu_list |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `name` | Name of current context menu. |
### Methods
#### `__init__()`
ContextMenuWidgetExtension init function.
#### `close_menu()`
Close currently open context menu. Used by tests not to leave context menu in bad state.
#### `get_context_menu()`
Gets current context_menu.
- **Returns**: Current context_menu.
- **Return type**: (str)
#### `menu(name: str, delegate=None, glyph='', submenu=False, tearable=False)`
### ContextMenuWidgetExtension.menu
Creates a menu.
#### Parameters
- **name** (str) – Name of the menu.
- **delegate** (ui.MenuDelegate) – Specify the delegate to create a custom menu. Optional.
- **glyph** (str) – Path of the glyph image to show before the menu name. Optional.
- **submenu** (bool) – Enables the submenu marker. Optional.
- **tearable** (bool) – The ability to tear the window off. Optional.
#### Returns
- Menu item created.
#### Return type
- (uiMenu)
### ContextMenuWidgetExtension.menu_item
Creates a menu item.
#### Parameters
- **name** (str)
- **triggered_fn** (Optional[Callable]) = None
- **enabled** (bool) = True
- **checkable** (bool) = False
- **checked** (bool) = False
- **is_async_func** = False
- **delegate** = None
- **additional_kwargs** = None
- **glyph** = ''
Parameters
----------
- **name** (`str`) – Name of the menu item.
- **triggered_fn** (`Callable`) – Function to call when menu item is clicked. Optional.
- **enabled** (`bool`) – Enable the menu item. Optional.
- **checkable** (`bool`) – This property holds whether this menu item is checkable. A checkable item is one which has an on/off state. Optional.
- **checked** (`bool`) – This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked. Optional.
- **is_async_func** (`bool`) – Optional.
- **delegate** (`ui.MenuDelegate`) – Specify the delegate to create a custom menu. Optional.
- **additional_kwargs** (`dict`) – Additional keyword arguments to pass to ui.MenuItem. Optional.
- **glyph** (`str`) – Path of the glyph image to show before the menu name. Optional.
Returns
-------
Menu item created.
Return type
------------
(uiMenuItem)
on_shutdown
-----------
ContextMenuWidgetExtension shutdown function.
on_startup
----------
ContextMenuWidgetExtension startup function.
Parameters
----------
- **ext_id** (`str`) – Extension identifier.
separator
---------
Creates a menu separator.
Parameters
----------
- **name** (`str`) – Name of the menu separator. Optional.
show_context_menu
-----------------
(Function description not provided in the HTML snippet)
Parameters
----------
- **menu_name** (`str`)
- **objects** (`dict`)
</em>,
<em class="sig-param">
<span class="n">
<span class="pre">
menu_list
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
List
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
dict
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
</em>,
<em class="sig-param">
<span class="n">
<span class="pre">
min_menu_entries
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
1
</span>
</span>
</em>,
<em class="sig-param">
<span class="n">
<span class="pre">
delegate
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
None
</span>
</span>
</span>
<dd>
<p>
build context menu from menu_list
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
menu_name
</strong>
(
<em>
str
</em>
) – menu name
</p>
</li>
<li>
<p>
<strong>
objects
</strong>
(
<em>
dict
</em>
) – context_menu data
</p>
</li>
<li>
<p>
<strong>
menu_list
</strong>
(
<em>
list
</em>
) – list of dictionaries containing context menu values
</p>
</li>
<li>
<p>
<strong>
min_menu_entries
</strong>
(
<em>
int
</em>
) – minimal number of menu needed for menu to be visible
</p>
</li>
</ul>
</dd>
</dl>
</dd>
<dl class="py property">
<dt class="sig sig-object py" id="omni.kit.widget.context_menu.context_menu.ContextMenuWidgetExtension.name">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
name
</span>
</span>
<em class="property">
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="pre">
str
</span>
</em>
<dd>
<p>
Name of current context menu.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Returns
</dt>
<dd class="field-odd">
<p>
Name of current context menu.
</p>
</dd>
<dt class="field-even">
Return type
</dt>
<dd class="field-even">
<p>
(str)
</p>
</dd>
</dl>
</dd>
</dl> |
omni.kit.widget.context_menu.context_menu.DefaultMenuDelegate.md | # DefaultMenuDelegate
## DefaultMenuDelegate
```python
class omni.kit.widget.context_menu.context_menu.DefaultMenuDelegate(**kwargs)
```
Bases: `IconMenuBaseDelegate`
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self, **kwargs)` | Constructor. |
### Attributes
| Attribute | Description |
|-----------|-------------|
```
### __init__
```python
def __init__(self, omni.ui._ui.MenuDelegate, **kwargs) -> None
```
Constructor.
```
> ### Keyword Arguments:
>
> - `on_build_item`
> - Called to create a new item.
> - `on_build_title`
> - Called to create a new title.
> - `on_build_status`
> - Called to create a new widget on the bottom of the window.
> - `propagate`
> - Determine if Menu children should use this delegate when they don’t have the own one. |
omni.kit.widget.context_menu.context_menu.Functions.md | # omni.kit.widget.context_menu.context_menu Functions
## Functions Summary
| Function | Description |
|----------|-------------|
| `close_menu` | Close currently open context menu. Used by tests not to leave context menu in bad state. |
| `get_instance` | Get instance of context menu class |
| `reorder_menu_dict` | Reorder menus using “appear_after” value in menu | |
omni.kit.widget.context_menu.context_menu.get_instance.md | # get_instance
## get_instance
Get instance of context menu class
Returns:
- Instance of class.
Return type:
- (ContextMenuWidgetExtension) |
omni.kit.widget.context_menu.context_menu.md | # omni.kit.widget.context_menu.context_menu
## Classes Summary:
- **ContextMenuWidgetExtension**
Context menu core functionality
- **DefaultMenuDelegate**
Icon Menu Delegate class.
## Functions Summary:
- **close_menu**
Close currently open context menu. Used by tests not to leave context menu in bad state.
- **get_instance**
Get instance of context menu class
- **reorder_menu_dict**
Reorder menus using “appear_after” value in menu |
omni.kit.widget.context_menu.custom_menu_dict.Classes.md | # omni.kit.widget.context_menu.custom_menu_dict Classes
## Classes Summary
- **ContextMenuEventType**
- Event sent when menus are added or removed
- **_CustomMenuDict**
- (No description provided) |
omni.kit.widget.context_menu.custom_menu_dict.ContextMenuEventType.md | # ContextMenuEventType
## ContextMenuEventType
```python
class omni.kit.widget.context_menu.custom_menu_dict.ContextMenuEventType
```
Event sent when menus are added or removed
### Methods
### Attributes
```python
ADDED = 0
```
New menu entry is added
```python
REMOVED = 1
```
Menu entry is removed
```python
def __init__():
```
```python
ADDED
```
New menu entry is added
```python
REMOVED
```
Menu entry is removed
### REMOVED
= 1
Menu entry is removed |
omni.kit.widget.context_menu.custom_menu_dict.Functions.md | # omni.kit.widget.context_menu.custom_menu_dict Functions
## Functions Summary
| Function | Description |
|----------|-------------|
| Singleton | A singleton decorator |
| add_menu | Add custom menu to any context_menu |
| get_menu_dict | Get custom menus |
| get_menu_event_stream | Gets menu event stream. |
| merge_menus | Merge custom menus | |
omni.kit.widget.context_menu.custom_menu_dict.get_menu_dict.md | # get_menu_dict
## get_menu_dict
Get custom menus
see add_menu for dictionary info
### Parameters
- **index** (str) – name of the menu
- **extension_id** (str) – name of the target
### Returns
- a list of dictionaries containing custom menu settings. See ContextMenuExtension docs for information on values
### Return type
- (list) |
omni.kit.widget.context_menu.custom_menu_dict.md | # omni.kit.widget.context_menu.custom_menu_dict
## Classes Summary:
- **ContextMenuEventType**
- Event sent when menus are added or removed
- **_CustomMenuDict**
## Functions Summary:
- **Singleton**
- A singleton decorator
- **add_menu**
- Add custom menu to any context_menu
- **get_menu_dict**
- Get custom menus
- **get_menu_event_stream**
- Gets menu event stream.
- **merge_menus**
- Merge custom menus |
omni.kit.widget.context_menu.custom_menu_dict.merge_menus.md | # merge_menus
## merge_menus
```python
omni.kit.widget.context_menu.custom_menu_dict.merge_menus(menu_list: list) -> List[dict]
```
Merge custom menus
**Parameters:**
- **menu_list** (list) – list of dictionaries
**Returns:**
- a list of dictionaries containing custom menu settings. See ContextMenuExtension docs for information on values
**Return type:**
- (list)
``` |
omni.kit.widget.context_menu.custom_menu_dict.Singleton.md | # Singleton
A singleton decorator
## Singleton |
omni.kit.widget.context_menu.custom_menu_dict._CustomMenuDict.md | # _CustomMenuDict
## _CustomMenuDict
- alias of `getinstance` |
omni.kit.widget.context_menu.DefaultMenuDelegate.md | # DefaultMenuDelegate
## DefaultMenuDelegate
```python
class omni.kit.widget.context_menu.DefaultMenuDelegate(**kwargs)
```
Bases: `IconMenuBaseDelegate`
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self, **kwargs)` | Constructor. |
### Attributes
| Attribute | Description |
|-----------|-------------|
```
### __init__
```python
def __init__(self, **kwargs) -> None
```
Constructor.
#### Keyword Arguments:
| Argument | Description |
|----------|-------------|
| `on_build_item` | See below |
```
<dl>
<dt>
`on_build_item
<span class="classifier">
`
</span>
</dt>
<dd>
<p>
Called to create a new item.
</p>
</dd>
<dt>
`on_build_title
<span class="classifier">
`
</span>
</dt>
<dd>
<p>
Called to create a new title.
</p>
</dd>
<dt>
`on_build_status
<span class="classifier">
`
</span>
</dt>
<dd>
<p>
Called to create a new widget on the bottom of the window.
</p>
</dd>
<dt>
`propagate
<span class="classifier">
`
</span>
</dt>
<dd>
<p>
Determine if Menu children should use this delegate when they don’t have the own one.
</p>
</dd>
</dl> |
omni.kit.widget.context_menu.Functions.md | # omni.kit.widget.context_menu Functions
## Functions Summary
| Function | Description |
|----------|-------------|
| add_menu | Add custom menu to any context_menu |
| close_menu | Close currently open context menu. Used by tests not to leave context menu in bad state. |
| get_instance | Get instance of context menu class |
| get_menu_dict | Get custom menus |
| get_menu_event_stream | Gets menu event stream. |
| merge_menus | Merge custom menus |
| reorder_menu_dict | Reorder menus using “appear_after” value in menu | |
omni.kit.widget.context_menu.get_menu_event_stream.md | # get_menu_event_stream
## get_menu_event_stream
```python
omni.kit.widget.context_menu.get_menu_event_stream()
```
Gets menu event stream.
**Returns:**
Event stream.
**Return type:**
(IEventStream)
``` |
omni.kit.widget.context_menu.md | # omni.kit.widget.context_menu
## Submodules
Summary:
- **omni.kit.widget.context_menu.context_menu**
- Context menu core functionality
- **omni.kit.widget.context_menu.custom_menu_dict**
- No submodule docstring provided
## Classes
Summary:
- **ContextMenuEventType**
- Event sent when menus are added or removed
- **ContextMenuWidgetExtension**
- Context menu core functionality
- **DefaultMenuDelegate**
- Icon Menu Delegate class.
## Functions
Summary:
- **add_menu**
- Add custom menu to any context_menu
- **close_menu**
- Close currently open context menu. Used by tests not to leave context menu in bad state.
- **get_instance**
- Get instance of context menu class
- **get_menu_dict**
- Get custom menus
- **get_menu_event_stream**
- Get event stream for menu changes
## Table of Contents
### Functions
| Function | Description |
|----------|-------------|
| get_menu_event_stream | Gets menu event stream. |
| merge_menus | Merge custom menus |
| reorder_menu_dict | Reorder menus using “appear_after” value in menu | |
omni.kit.widget.context_menu.Submodules.md | # omni.kit.widget.context_menu Submodules
## Submodules Summary:
| Module Name | Description |
|--------------------------------------|----------------------------|
| omni.kit.widget.context_menu.context_menu | Context menu core functionality |
| omni.kit.widget.context_menu.custom_menu_dict | No submodule docstring provided | |
omni.kit.widget.filebrowser.AbstractColumnDelegate.md | # AbstractColumnDelegate
## AbstractColumnDelegate
An abstract object that is used to put the widget to the file browser asynchronously.
### Methods
- **build_header**()
- Build the header
- **build_widget**(item)
- Build the widget for the given path.
### Attributes
- **initial_width**
- The width of the column
### `__init__`
### `build_header`
Build the header
### AbstractColumnDelegate.build_widget
**Abstract async build_widget(item: ColumnItem)**
Build the widget for the given path. Works inside Frame in async mode. Once the widget is created, it will replace the content of the frame. It allows to await something for a while and create the widget when the result is available.
### AbstractColumnDelegate.initial_width
**Property initial_width**
The width of the column |
omni.kit.widget.filebrowser.abstract_column_delegate.AbstractColumnDelegate.md | # AbstractColumnDelegate
## AbstractColumnDelegate
An abstract object that is used to put the widget to the file browser asynchronously.
### Methods
| Method | Description |
|--------|-------------|
| `build_header()` | Build the header |
| `build_widget(item)` | Build the widget for the given path. |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `initial_width` | The width of the column |
### build_header
Build the header
### build_widget
abstract async build_widget(item: ColumnItem)
Build the widget for the given path. Works inside Frame in async mode. Once the widget is created, it will replace the content of the frame. It allow to await something for a while and create the widget when the result is available.
### initial_width
property initial_width
The width of the column |
omni.kit.widget.filebrowser.abstract_column_delegate.Classes.md | # omni.kit.widget.filebrowser.abstract_column_delegate Classes
## Classes Summary
- **AbstractColumnDelegate**
- An abstract object that is used to put the widget to the file browser asynchronously.
- [AbstractColumnDelegate Documentation](#)
- **ColumnItem**
- Column Item class to be used with FileBrowserTreeView.
- [ColumnItem Documentation](#) |
omni.kit.widget.filebrowser.abstract_column_delegate.ColumnItem.md | # ColumnItem
## ColumnItem
```python
class omni.kit.widget.filebrowser.abstract_column_delegate.ColumnItem(path)
```
**Bases:** `object`
Column Item class to be used with FileBrowserTreeView.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(path)` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `path` | Path of the item. |
```python
def __init__(path):
```
```python
@property
def path:
```
# Item
## Description
Path of the item. |
omni.kit.widget.filebrowser.card.Classes.md | # omni.kit.widget.filebrowser.card Classes
## Classes Summary
| Class Name | Description |
|------------|-------------|
| [FileBrowserItemCard](omni.kit.widget.filebrowser.card/omni.kit.widget.filebrowser.card.FileBrowserItemCard.html) | Widget used by FileBrowserGridView to build the browser item. | |
omni.kit.widget.filebrowser.card.FileBrowserItemCard.md | # FileBrowserItemCard
## FileBrowserItemCard
```
class omni.kit.widget.filebrowser.card.FileBrowserItemCard(item: FileBrowserItem, **kwargs)
```
Bases: `Widget`
Widget used by FileBrowserGridView to build the browser item.
### Parameters
- **item** (`FileBrowserItem`) – Item to build the widget with.
### Keyword Arguments
- **width** (`int`) – width of the widget, defaults to 60.
- **height** (`int`) – height of the widget, defaults to 60.
- **mouse_pressed_fn** (`Callable`) – Function called on mouse press. Function signature: void mouse_pressed_fn(pane: int, button: int, key_mode: int, item: `FileBrowserItem`)
- **mouse_double_clicked_fn** (`Callable`) – Function called on mouse double click. Function signature: void mouse_double_clicked_fn(pane: int, button: int, key_mode: int, item: `FileBrowserItem`)
- **mouse_released_fn** (`Callable`) – Function called on mouse release. Function signature: void mouse_released_fn(pane: int, button: int, key_mode: int, item: `FileBrowserItem`)
```
### Methods
- `__init__(self, **kwargs)`
- `apply_cut_style()` - Apply cut style to the widget.
- `destroy()` - Destructor
- `draw_badges()` - Draw badges if get_badgets_fn is provided in the constructor.
- `draw_thumbnail(thumbnail)` - Asynchronously redraw thumbnail with the given file.
- `on_drag([thumbnail])` - Default drag handler, create a thumbnail at the given path in the current widget container.
- `refresh_thumbnail_async(thumbnail)` - Asynchronously redraw thumbnail with the given file.
- `remove_cut_style()` - Remove cut style from the widget.
### Attributes
- `item` - Return the item associated with the widget.
```
### Properties
- `mouse_pressed_fn(Callable) – Function called on mouse release. Function signature: void mouse_pressed_fn(pane: int, button: int, key_mode: int, item: FileBrowserItem)`
- `drop_fn(Callable) – Function called to handle drag-n-drops. Function signature: void drop_fn(dst_item: FileBrowserItem, event: ui.WidgetMouseDropEvent)`
- `get_thumbnail_fn(Callable) – Function called to get the thumbnail from the item. Function signature: str badges_provider(item: FileBrowserItem)`
- `get_badges_fn(Callable) – Function called to get badges from the item. Function signature: List[str] badges_provider(item: FileBrowserItem)`
- `custom_thumbnail(str) – Thumbnail to override the default one.`
- `drag_fn(Callable) – Function called to handle dragging thumbnails. Function signature: void drag_fn(thumbnail: str)`
| selected |
|----------|
| Return True when selected. |
__init__(self: omni.ui._ui.Widget, **kwargs) -> None
apply_cut_style()
- Apply cut style to the widget.
destroy()
- Destructor
draw_badges()
- Draw badges if get_badgets_fn is provided in the constructor.
draw_thumbnail(thumbnail: str)
- Asynchronously redraw thumbnail with the given file.
- Parameters
- thumbnail (str) – thumbnail path.
on_drag(thumbnail: Optional[str] = None)
- Default drag handler, create a thumbnail at the given path in the current widget container.
- Parameters
- thumbnail (str) – thumbnail path.
- Returns
- The current item path.
refresh_thumbnail_async(thumbnail: str)
- Asynchronously refresh thumbnail.
- Parameters
- thumbnail (str) – thumbnail path.
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.widget.filebrowser.card.FileBrowserItemCard.refresh_thumbnail_async">
<span class="sig-name descname">
<span class="pre">
refresh_thumbnail_async
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#omni.kit.widget.filebrowser.card.FileBrowserItemCard.refresh_thumbnail_async" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Asynchronously redraw thumbnail with the given file.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<p>
<strong>
thumbnail
</strong>
(
<em>
str
</em>
) – thumbnail path.
</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.widget.filebrowser.card.FileBrowserItemCard.remove_cut_style">
<span class="sig-name descname">
<span class="pre">
remove_cut_style
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#omni.kit.widget.filebrowser.card.FileBrowserItemCard.remove_cut_style" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Remove cut style from the widget.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.kit.widget.filebrowser.card.FileBrowserItemCard.item">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
item
</span>
</span>
<em class="property">
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="pre">
FileBrowserItem
</span>
</em>
</dt>
<dd>
<p>
Return the item associated with the widget.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.kit.widget.filebrowser.card.FileBrowserItemCard.selected">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
selected
</span>
</span>
<em class="property">
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="pre">
bool
</span>
</em>
</dt>
<dd>
<p>
Return True when selected.
</p>
</dd>
</dl> |
omni.kit.widget.filebrowser.Classes.md | # omni.kit.widget.filebrowser Classes
## Classes Summary
| Class Name | Description |
|------------|-------------|
| [AbstractColumnDelegate](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.AbstractColumnDelegate.html) | An abstract object that is used to put the widget to the file browser asynchronously. |
| [ColumnItem](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.ColumnItem.html) | Column Item class to be used with FileBrowserTreeView. |
| [FileBrowserItem](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.FileBrowserItem.html) | Base class for the Filebrowser view Item. |
| [FileBrowserItemCard](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.FileBrowserItemCard.html) | Widget used by FileBrowserGridView to build the browser item. |
| [FileBrowserItemFactory](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.FileBrowserItemFactory.html) | Factory to create :obj:`FileBrowserItem` instances. |
| [FileBrowserModel](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.FileBrowserModel.html) | Base class for the Filebrowser view Model. |
| [FileBrowserUdimItem](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.FileBrowserUdimItem.html) | A Filebrowser UDIM item class for navigating a the local filesystem in a Filebrowser view. |
| [FileBrowserWidget](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.FileBrowserWidget.html) | The basic UI widget for navigating a filesystem as a tree or grid view. |
| [FileSystemItem](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.FileSystemItem.html) | A Filebrowser item class for navigating a the local filesystem in a Filebrowser view. |
| [FileSystemModel](omni.kit.widget.filebrowser/omni.kit.widget.filebrowser.FileSystemModel.html) | A Filebrowser model class for navigating a the local filesystem in a Filebrowser view. |
| NucleusConnectionItem | NucleusItem that represents a nucleus connection. |
| --- | --- |
| NucleusItem | A Filebrowser item class for navigating a Nucleus server in a Filebrowser view. |
| NucleusModel | A Filebrowser model class for navigating a Nucleus server in a Filebrowser view. |
| ColumnDelegateRegistry | | |
omni.kit.widget.filebrowser.clear_clipboard.md | # clear_clipboard
## clear_clipboard |
omni.kit.widget.filebrowser.clipboard.Classes.md | # omni.kit.widget.filebrowser.clipboard Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| [FileBrowserItem](omni.kit.widget.filebrowser.clipboard/omni.kit.widget.filebrowser.clipboard.FileBrowserItem.html) | Base class for the Filebrowser view Item. | |
omni.kit.widget.filebrowser.clipboard.FileBrowserItem.md | # FileBrowserItem
## FileBrowserItem
```python
class omni.kit.widget.filebrowser.clipboard.FileBrowserItem(path: str, fields: FileBrowserItemFields, is_folder: bool = False, is_deleted: bool = False)
```
Bases: `AbstractItem`
Base class for the Filebrowser view Item.
Should be sub-classed to implement specific filesystem behavior. The Constructor should not be
called directly. Instead there are factory methods available for creating instances when needed.
### Parameters
- **path** (str) – Path of the item.
- **fields** (FileBrowserItemFields) – Fields of the item.
- **is_folder** (`bool`) – Set to True if the item is a folder.
- **is_deleted** (`bool`) – Set to True if the item is deleted.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self)` | |
| `add_child(item)` | Add item as child. |
| `datetime_as_string(value)` | Convert datatime to string. |
| `del_child(item_name)` | Delete child item by name. |
| `get_custom_thumbnails_for_folder_async()` | Return the thumbnail dictionary for this (folder) item. |
| `get_subitem_model(index)` | Return ith column of this item. |
| `has_mouse_pressed_fn()` | Check if the item has a mouse pressed callback assigned. |
| `mouse_pressed_fn()` | Mouse pressed callback. |
| `on_list_change_event(event, entry)` | Virtual method to be implemented by sub-class. |
| `on_populated_async([result, children, callback])` | async callback after finish populating the item. |
| `populate_async([callback_async, timeout])` | Populate current item asynchronously if not already. |
| `populate_with_callback(callback[, timeout])` | Populate this item if not already populated. |
| `size_as_string()` | |
| Attributes | Description |
| --- | --- |
| alert | Get/set alert level and message. |
| children | Children of this item. |
| context_menu | Optionally provide a context menu to be shown when this item is right-clicked. |
| enable_sorting | True if item's children are sortable. |
| expandable | whether this FileBrowserItem is expandable. |
| fields | A subset of the item's stats stored as a string tuple. |
| hideable | whether this FileBrowserItem is hideable. |
| icon | Get/set path to icon file. |
| is_deleted | True if this item is a deleted folder/file. |
| is_folder | True if this item is a folder. |
| is_udim_file | Get/Set item udim_file state. |
| item_changed | True if this item is has been restore/delete already. |
| models | The columns of this item. |
| name | Item name. |
<p>
Parent of this item.
</p>
<p>
Full path name.
</p>
<p>
Get/Set item populated state.
</p>
<p>
True if the item is readable.
</p>
<p>
True if the item is writeable.
</p>
<dl>
<dt>
<span class="pre">
__init__
</span>
(
<em>
<span class="pre">
self
</span>
:
<span class="pre">
omni.ui._ui.AbstractItem
</span>
</em>
)
<span class="sig-return">
→
<span class="pre">
None
</span>
</span>
</dt>
</dl>
<dl>
<dt>
<span class="pre">
add_child
</span>
(
<em>
<span class="pre">
item
</span>
:
<span class="pre">
object
</span>
</em>
)
</dt>
<dd>
<p>
Add item as child.
</p>
<dl>
<dt>
Parameters
</dt>
<dd>
<p>
<strong>
item
</strong>
(
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
FileBrowserItem
</span>
</code>
) – Child item.
</p>
</dd>
</dl>
</dd>
</dl>
<dl>
<dt>
<em>
<span class="pre">
static
</span>
</em>
<span class="pre">
datetime_as_string
</span>
(
<em>
<span class="pre">
value
</span>
:
<span class="pre">
datetime
</span>
</em>
)
<span class="sig-return">
→
<span class="pre">
str
</span>
</span>
</dt>
<dd>
<p>
Convert datatime to string.
</p>
</dd>
</dl>
<dl>
<dt>
<span class="pre">
del_child
</span>
(
<em>
<span class="pre">
item_name
</span>
:
<span class="pre">
str
</span>
</em>
)
</dt>
<dd>
<p>
Delete child item by name.
</p>
</dd>
</dl>
(str) – Name of child item.
### get_custom_thumbnails_for_folder_async
Return the thumbnail dictionary for this (folder) item.
#### Returns
With children url’s as keys, and url’s to thumbnail files as values.
#### Return type
Dict
### get_subitem_model
Return ith column of this item.
#### Returns
AbstractValueModel
### has_mouse_pressed_fn
Check if the item has a mouse pressed callback assigned.
### mouse_pressed_fn
Mouse pressed callback.
### on_list_change_event
Virtual method to be implemented by sub-class. When called with a ListEvent, should update this item’s children list with the corresponding ListEntry.
#### Parameters
- event (omni.client.ListEvent) – One of of {UNKNOWN, CREATED, UPDATED, DELETED, METADATA, LOCKED, UNLOCKED}.
- entry (omni.client.ListEntry) – Updated entry as defined by omni.client.
### omni.kit.widget.filebrowser.clipboard.FileBrowserItem.on_populated_async
async def on_populated_async(
self,
result: Optional[Any] = None,
children: Optional[Dict[str, Optional[Dict[str, FileBrowserItem]]]] = None,
callback: Optional[Callable[[Dict[str, FileBrowserItem], None], None]] = None
):
# async callback after finish populating the item.
#### Parameters
- **result** (Any) – result from populate async.
- **children** (Dict[str, FileBrowserItem]) – dictionary of children items to pass to the callback.
- **callback** (Callable) – function to call. Function signature: callback(result: Any, children: Dict[str, FileBrowserItem]) -> None
### omni.kit.widget.filebrowser.clipboard.FileBrowserItem.populate_async
async def populate_async(
self,
callback_async: Optional[Callable] = None,
timeout: float = None
):
# async method to populate the item
### populate_async
Populate current item asynchronously if not already. Override this method to customize for specific file systems.
#### Parameters
- **callback_async** (`Callable`) – Function signature is void callback(result, children: Dict[str, FileBrowserItem]), where result is an Exception type upon error.
- **timeout** (`float`) – Time out duration on failed server connections. Default 10.0.
#### Returns
Result of executing callback.
#### Return type
Any
### populate_with_callback
Populate this item if not already populated. When done, executes callback.
#### Parameters
- **callback** (`Callable`) – Function signature is void callback(children: [FileBrowserItem]).
- **timeout** (`float`) – Time out duration on failed server connections. Default 10.0.
### size_as_string
Convert data size in bytes to a human readable string.
### alert
Get/set alert level and message.
### children
Get/set children.
Children of this item. Does not populate the item if not already populated.
Type
----
dict[FileBrowserItem]
Optionally provide a context menu to be show when this item is right-clicked.
True if item’s children are sortable.
Type
----
bool
whether this FileBrowserItem is expandable. Override to change behavior
A subset of the item’s stats stored as a string tuple.
Type
----
FileBrowserItemFields
whether this FileBrowserItem is hideable. Override to change behavior
Get/set path to icon file.
Type
----
str
### is_deleted
**Type:** bool
True if this item is a deleted folder/file.
### is_folder
**Type:** bool
True if this item is a folder.
### is_udim_file
**Type:** bool
Get/Set item udim_file state.
### item_changed
**Type:** bool
True if this item is has been restore/delete already.
### models
**Type:** Tuple[ui.AbstractValueModel]
The columns of this item.
### name
**Type:** str
Item name.
### parent
**Type:** object
Parent of this item.
<dl class="py property">
<dt class="sig sig-object py" id="omni.kit.widget.filebrowser.clipboard.FileBrowserItem.path">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
path
</span>
</span>
<em class="property">
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="pre">
str
</span>
</em>
</dt>
<dd>
<p>
Full path name.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Type
</dt>
<dd class="field-odd">
<p>
str
</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.kit.widget.filebrowser.clipboard.FileBrowserItem.populated">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
populated
</span>
</span>
<em class="property">
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="pre">
bool
</span>
</em>
</dt>
<dd>
<p>
Get/Set item populated state.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Type
</dt>
<dd class="field-odd">
<p>
bool
</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.kit.widget.filebrowser.clipboard.FileBrowserItem.readable">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
readable
</span>
</span>
<em class="property">
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="pre">
bool
</span>
</em>
</dt>
<dd>
<p>
True if the item is readable.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.kit.widget.filebrowser.clipboard.FileBrowserItem.writeable">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
writeable
</span>
</span>
<em class="property">
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="pre">
bool
</span>
</em>
</dt>
<dd>
<p>
True if the item is writeable.
</p>
</dd>
</dl> |
omni.kit.widget.filebrowser.clipboard.Functions.md | # omni.kit.widget.filebrowser.clipboard Functions
## Functions Summary
| Function Name | Description |
|---------------|-------------|
| clear_clipboard | Clear the clipboard. |
| get_clipboard_items | Get browser items. |
| is_clipboard_cut | Return True if items in the clipboard are cut from other items. |
| is_path_cut | Return True if the path are cut from other items or clipboard. |
| save_items_to_clipboard | Save browser items to clipboard. | |
omni.kit.widget.filebrowser.clipboard.get_clipboard_items.md | # get_clipboard_items
## get_clipboard_items
```python
omni.kit.widget.filebrowser.clipboard.get_clipboard_items()
```
→ List[FileBrowserItem]
Get browser items.
``` |
omni.kit.widget.filebrowser.clipboard.is_clipboard_cut.md | # is_clipboard_cut
## is_clipboard_cut
```python
omni.kit.widget.filebrowser.clipboard.is_clipboard_cut() -> bool
```
Return True if items in the clipboard are cut from other items.
```
``` |
omni.kit.widget.filebrowser.clipboard.is_path_cut.md | # is_path_cut
## is_path_cut
```python
omni.kit.widget.filebrowser.clipboard.is_path_cut(path: str) -> bool
```
Return True if the path are cut from other items or clipboard.
**Parameters**
- **path** (str) – path to check.
``` |
omni.kit.widget.filebrowser.clipboard.md | # omni.kit.widget.filebrowser.clipboard
## Classes Summary
- **FileBrowserItem**
- Base class for the Filebrowser view Item.
## Functions Summary
- **clear_clipboard**
- Clear the clipboard.
- **get_clipboard_items**
- Get browser items.
- **is_clipboard_cut**
- Return True if items in the clipboard are cut from other items.
- **is_path_cut**
- Return True if the path are cut from other items or clipboard.
- **save_items_to_clipboard**
- Save browser items to clipboard. |
omni.kit.widget.filebrowser.clipboard.save_items_to_clipboard.md | # save_items_to_clipboard
## save_items_to_clipboard
```python
omni.kit.widget.filebrowser.clipboard.save_items_to_clipboard(items: List[FileBrowserItem], is_cut: bool = False)
```
Save browser items to clipboard.
### Parameters
- **items** (List[FileBrowserItem]) – List of browser items.
- **is_cut** (bool) – Specify if items are cut from other items or clipboard, defaults to False.
``` |
omni.kit.widget.filebrowser.ColumnDelegateRegistry.md | # ColumnDelegateRegistry
## ColumnDelegateRegistry
- **alias of**: `getinstance` |
omni.kit.widget.filebrowser.ColumnItem.md | # ColumnItem
## ColumnItem
```python
class omni.kit.widget.filebrowser.ColumnItem(path)
```
Bases: `object`
Column Item class to be used with FileBrowserTreeView.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(path)` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `path` | Path of the item. |
#### `__init__(path)`
#### `path`
Path of the item.
``` |
omni.kit.widget.filebrowser.column_delegate_registry.Classes.md | # omni.kit.widget.filebrowser.column_delegate_registry Classes
## Classes Summary
- **ColumnDelegateRegistry** |
omni.kit.widget.filebrowser.column_delegate_registry.md | # omni.kit.widget.filebrowser.column_delegate_registry
## Classes Summary
- **ColumnDelegateRegistry**
Description: ColumnDelegateRegistry |
omni.kit.widget.filebrowser.date_format_menu.Classes.md | # omni.kit.widget.filebrowser.date_format_menu Classes
## Classes Summary
| Class Name | Description |
|------------|-------------|
| [DatetimeFormatMenu](omni.kit.widget.filebrowser.date_format_menu/omni.kit.widget.filebrowser.date_format_menu.DatetimeFormatMenu.html) | Menu to set datetime format. | |
omni.kit.widget.filebrowser.date_format_menu.DatetimeFormatMenu.md | # DatetimeFormatMenu
## DatetimeFormatMenu
### Class: omni.kit.widget.filebrowser.date_format_menu.DatetimeFormatMenu
#### Parameters
- **value_changed_fn** (*Callable*): function to call when datetime format changed. Function Signature: void value_changed_fn()
#### Methods
- **__init__** ([value_changed_fn])
- **destroy**
| Method | Description |
|--------|-------------|
| `destroy()` | Destructor |
| `show_at(x: float, y: float)` | Show the menu at the given position. |
## Attributes
| Attribute | Description |
|-----------|-------------|
| `visible` | Return True if the menu is visible. |
## Methods
### `__init__(value_changed_fn: Optional[Callable[[], None]] = None)`
### `destroy()`
Destructor
### `show_at(x: float, y: float)`
Show the menu at the given position.
### `visible`
Return True if the menu is visible. |
omni.kit.widget.filebrowser.FileBrowserItemCard.md | # FileBrowserItemCard
## FileBrowserItemCard
```
class omni.kit.widget.filebrowser.FileBrowserItemCard(item: FileBrowserItem, **kwargs)
```
Bases: `Widget`
Widget used by FileBrowserGridView to build the browser item.
### Parameters
- **item** (`FileBrowserItem`) – Item to build the widget with.
### Keyword Arguments
- **width** (int) – width of the widget, defaults to 60.
- **height** (int) – height of the widget, defaults to 60.
- **mouse_pressed_fn** (`Callable`) – Function called on mouse press. Function signature: void mouse_pressed_fn(pane: int, button: int, key_mode: int, item: FileBrowserItem)
- **mouse_double_clicked_fn** (`Callable`) – Function called on mouse double click. Function signature: void mouse_double_clicked_fn(pane: int, button: int, key_mode: int, item: FileBrowserItem)
```
### Methods
- `__init__(self, **kwargs)`
- `apply_cut_style()` - Apply cut style to the widget.
- `destroy()` - Destructor
- `draw_badges()` - Draw badges if get_badgets_fn is provided in the constructor.
- `draw_thumbnail(thumbnail)` - Asynchronously redraw thumbnail with the given file.
- `on_drag([thumbnail])` - Default drag handler, create a thumbnail at the given path in the current widget container.
- `refresh_thumbnail_async(thumbnail)` - Asynchronously redraw thumbnail with the given file.
- `remove_cut_style()` - Remove cut style from the widget.
### Attributes
| item | Return the item associated with the widget. |
| --- | --- |
| selected | Return True when selected. |
### __init__(self: omni.ui._ui.Widget, **kwargs) -> None
- Initialize the widget.
### apply_cut_style()
- Apply cut style to the widget.
### destroy()
- Destructor
### draw_badges()
- Draw badges if get_badgets_fn is provided in the constructor.
### draw_thumbnail(thumbnail: str)
- Asynchronously redraw thumbnail with the given file.
- **Parameters**
- **thumbnail** (str) – thumbnail path.
### on_drag(thumbnail: Optional[str] = None)
- Default drag handler, create a thumbnail at the given path in the current widget container.
- **Parameters**
- **thumbnail** (str) – thumbnail path.
- **Returns**
- The current item path.
## Methods
### refresh_thumbnail_async
```python
async refresh_thumbnail_async(thumbnail: str)
```
Asynchronously redraw thumbnail with the given file.
**Parameters**
- **thumbnail** (`str`) – thumbnail path.
### remove_cut_style
```python
remove_cut_style()
```
Remove cut style from the widget.
## Properties
### item
```python
property item: FileBrowserItem
```
Return the item associated with the widget.
### selected
```python
property selected: bool
```
Return True when selected. |
omni.kit.widget.filebrowser.FileBrowserItemFactory.md | # FileBrowserItemFactory
Factory to create [FileBrowserItem](omni.kit.widget.filebrowser.FileBrowserItem.html#omni.kit.widget.filebrowser.FileBrowserItem) instances.
## Methods
| Method | Description |
|---------------------------------|--------------------------------------|
| `create_dummy_item(name, path)` | Create a dummy item at the given path. |
| `create_group_item(name, path)` | Create a folder item at the given path. |
| `create_udim_item(name, path, range_start, ...)` | Create a UDIM item. |
### create_dummy_item
**Parameters**
- **name** (str) – name of the item.
- **path** (str) – path of the item.
Create a dummy item at the given path.
### create_group_item
**Parameters**
- **name** (str) – name of the item.
- **path** (str) – path of the item.
Create a folder item at the given path.
### create_udim_item
**Parameters**
- **name** (str) – name of the item.
- **path** (str) – path of the item.
- **range_start** (int) –
- **range_end** (int) –
- **repr_frame** (int) –
Create a UDIM item.
- **name** (`str`) – name of the item.
- **path** (`str`) – path of the item.
- **range_start** (`int`) – Starting index of UDIM sequence.
- **range_end** (`int`) – End index of UDIM sequence.
- **repr_frame** (`int`) – Index in UDIM sequence. |
Subsets and Splits