file_path
stringlengths 5
148
| content
stringlengths 150
498k
| size
int64 150
498k
|
|---|---|---|
omni.kit.menu.utils.scripts.layout.md | # omni.kit.menu.utils.scripts.layout
## Classes Summary
- **LayoutSourceSearch**
- Controls how layouts search for the menu item paths, either everywhere or just in the local menu group
- **MenuItemDescription**
- Class for creation of menu items
- **MenuLayout**
- Layout implementation class. See “Layouts and & Hooks” section
- **PrebuiltItemOrder**
- Internal flags used by layout for item ordering
## Functions Summary
- **create_prebuild_entry**
- internal function that creates a entry in prebuilt_menus dictionary
- **get_action_path**
- converts menu path into internal path | 599 |
omni.kit.menu.utils.scripts.LayoutSourceSearch.md | # LayoutSourceSearch
## LayoutSourceSearch
Bases: `object`
Controls how layouts search for the menu item paths, either everywhere or just in the local menu group
### Methods
### Attributes
| Attribute | Description |
|-----------|-------------|
| `EVERYWHERE` | |
| `LOCAL_ONLY` | |
### `__init__()` | 308 |
omni.kit.menu.utils.scripts.MenuHelperExtensionFull.md | # MenuHelperExtensionFull
## MenuHelperExtensionFull
**Bases:** `object`
Advanced helper class for adding/removing “Window” menu to your extension & controlling ui.Window creation/show/hide. Only thing required is function to create ui_window
### Methods
- **`__init__()`**
- **`menu_shutdown()`**
- **`menu_startup(create_window_fn, window_name, ...)`**
- **`show_window(menu, value)`**
--- | 397 |
omni.kit.menu.utils.scripts.MenuItemOrder.md | # MenuItemOrder
## MenuItemOrder
Bases: `object`
“appear_after” values. FIRST will be top of list and LAST will be bottom of list.
### Methods
### Attributes
| Attribute | Description |
|-----------|-------------|
| `FIRST` | |
| `LAST` | |
### `__init__()` | 293 |
omni.kit.menu.utils.scripts.MenuLayout.md | # MenuLayout
## MenuLayout
### Class: omni.kit.menu.utils.scripts.MenuLayout(debuglog=False)
**Bases:** `object`
Layout implementation class. See “Layouts and & Hooks” section
#### Methods
- **__init__(debuglog)**
- **add_layout(layout)**
- **apply_layout(prebuilt_menus)**
- **destroy()**
- **find_menu_item(menu_items, menu_items_root, ...)**
- **get_layout()**
- **menus_created()**
| 方法名 | 参数 |
|----------------------|---------------|
| `process_layout` | (prebuilt_menus, menu_layout, ...) |
| `remove_layout` | (layout) |
### __init__
- 参数: `debuglog = False` | 614 |
omni.kit.menu.utils.scripts.MenuState.md | # MenuState
## MenuState
### Attributes
- **Invalid**
- **Created**
Internal state. Invalid is before EVENT_APP_READY event received and Created is after.
### __init__ | 171 |
omni.kit.menu.utils.scripts.MenuUtilsDebugExtension.md | # MenuUtilsDebugExtension
## MenuUtilsDebugExtension
Bases: `IExt`
Menu debug window. Press “SHIFT+CONTROL+ALT+M” to open.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self)` | |
| `on_shutdown()` | |
| `on_startup()` | |
| `show_menu_debug_debug_window()` | |
#### `__init__(self)`
→ `None`
```
SphinxRtdTheme.Navigation.enable(true); | 375 |
omni.kit.menu.utils.scripts.set_default_menu_proirity.md | # set_default_menu_proirity
## set_default_menu_proirity
```python
omni.kit.menu.utils.scripts.set_default_menu_proirity(name, menu_index)
```
set default menu priority
``` | 173 |
omni.kit.menu.utils.scripts.Submodules.md | # omni.kit.menu.utils.scripts Submodules
## Submodules Summary
| Module | Description |
|--------|-------------|
| [omni.kit.menu.utils.scripts.actions](omni.kit.menu.utils.scripts.actions.html) | Actions Omniverse Kit API (deprecated) |
| [omni.kit.menu.utils.scripts.app_menu](omni.kit.menu.utils.scripts.app_menu.html) | ui.Menu and ui.MenuItem menu libraries |
| [omni.kit.menu.utils.scripts.builder_utils](omni.kit.menu.utils.scripts.builder_utils.html) | Definition of MenuItemDescription and other menu classes |
| [omni.kit.menu.utils.scripts.debug_window](omni.kit.menu.utils.scripts.debug_window.html) | Menu debug window. Press “SHIFT+CONTROL+ALT+M” to open. |
| [omni.kit.menu.utils.scripts.extension_window_helper](omni.kit.menu.utils.scripts.extension_window_helper.html) | Simple helper class for adding/removing “Window” menu to your extension. ui.Window creation/show/hide is still down to user to provide functionally. |
| [omni.kit.menu.utils.scripts.extension_window_helper_full](omni.kit.menu.utils.scripts.extension_window_helper_full.html) | Advanced helper class for adding/removing “Window” menu to your extension & controlling ui.Window creation/show/hide. Only thing required is function to create ui_window |
| [omni.kit.menu.utils.scripts.layout](omni.kit.menu.utils.scripts.layout.html) | Layout implementation class. See “Layouts and & Hooks” section |
| [omni.kit.menu.utils.scripts.utils](omni.kit.menu.utils.scripts.utils.html) | Menu implementation class. | | 1,494 |
omni.kit.menu.utils.scripts.utils.Functions.md | # omni.kit.menu.utils.scripts.utils Functions
## Functions Summary
- [add_action_to_menu](#add_action_to_menu) - Add action to menu path. (deprecated)
- [add_hook](#add_hook) - add a menu modification callback hook
- [add_layout](#add_layout) - add a menu layout.
- [add_menu_items](#add_menu_items) - add a list of menus items to menu.
- [build_submenu_dict](#build_submenu_dict) - builds a dictionary of List[MenuItemDescription] with sub_menus from List[MenuItemDescription] with full paths. EG: “/Window/Viewport/Viewport 1”
- [get_action_path](#get_action_path) - converts menu path into internal path
- [get_debug_stats](#get_debug_stats) - gets debug stats as dictionary, info on what functions called and how many times.
- [get_instance](#get_instance) - get MenuUtilsExtension class ptr
- [get_menu_layout](#get_menu_layout) - get menu layouts.
### add_action_to_menu
Add action to menu path. (deprecated)
### add_hook
add a menu modification callback hook
### add_layout
add a menu layout.
### add_menu_items
add a list of menus items to menu.
### build_submenu_dict
builds a dictionary of List[MenuItemDescription] with sub_menus from List[MenuItemDescription] with full paths. EG: “/Window/Viewport/Viewport 1”
### get_action_path
converts menu path into internal path
### get_debug_stats
gets debug stats as dictionary, info on what functions called and how many times.
### get_instance
get MenuUtilsExtension class ptr
### get_menu_layout
get menu layouts.
| 功能 | 描述 |
| --- | --- |
| get_merged_menus | get combined menus as dictionary |
| rebuild_menus | force menus to rebuild, triggering hooks |
| refresh_menu_items | update menus enabled state |
| remove_hook | remove a menu modification callback hook |
| remove_layout | remove a menu layout. |
| remove_menu_items | remove a list of menus items to menu. |
| replace_menu_items | replace a existing list of menus items to menu. |
| set_default_menu_proirity | set default menu priority | | 1,970 |
omni.kit.notification_manager.Classes.md | # omni.kit.notification_manager Classes
## Classes Summary
- **NotificationButtonInfo**
- Represent a button in notification.
- **NotificationStatus**
- Notification status. | 180 |
omni.kit.notification_manager.md | # omni.kit.notification_manager
## Classes Summary
- **NotificationButtonInfo**
- Represent a button in notification.
- **NotificationStatus**
- Notification status.
## Functions Summary
- **post_notification**
- Post notification. | 239 |
omni.kit.notification_manager.NotificationButtonInfo.md | # NotificationButtonInfo
## NotificationButtonInfo
```
```markdown
Bases: `object`
Represent a button in notification.
### Parameters
- **text** (str) – The button text.
### Keyword Arguments
- **on_complete** (Callable[[None], None]) – The button handler when clicked.
```
```markdown
Methods
```
```markdown
- `__init__`
## Attributes
| Attribute | Description |
|-----------|-------------|
| `handler` | Button handler when clicked |
| `text` | Button text |
### `__init__(text, on_complete=None)`
- `text`: The text of the button.
- `on_complete`: Optional callable that is executed when the button action is completed. Default is `None`.
### `property handler`
- Button handler when clicked
### `property text`
- Button text | 743 |
omni.kit.notification_manager.NotificationStatus.md | # NotificationStatus
## NotificationStatus
```python
class omni.kit.notification_manager.NotificationStatus:
"""
Bases: object
Notification status.
Different status has different icon and background color.
Could be:
- NotificationStatus.INFO
- NotificationStatus.WARNING
Methods
-------
__init__()
Attributes
----------
INFO
Information Notification.
WARNING
Warning Notification.
"""
```
### Attributes
| Attribute | Description |
|-----------|-------------|
| `INFO` | Information Notification. |
| `WARNING` | Warning Notification. |
```
### `__init__()`
```python
def __init__(self):
pass
```
### `INFO`
```python
INFO = 1
```
### `WARNING`
```python
WARNING = 2
```
WARNING = 0
Warning Notification. | 799 |
omni.kit.notification_manager.post_notification.md | # post_notification
## post_notification
```python
omni.kit.notification_manager.post_notification(text, hide_after_timeout=True, duration=3, status=1, button_infos=[])
```
Post notification.
If viewport is visible, it will be docked to the right-bottom of viewport.
Otherwise, it will be docked to main window.
### Parameters
- **text** (str) – The notification text.
### Keyword Arguments
- **hide_after_timeout** (bool) – If the notification will hide after duration.
If it’s False, and button_details are not provided, it will display a default dismiss button.
- **duration** (int) – The duration (in seconds) after which the notification will be hidden.
This duration only works if hide_after_timeout is True.
- **status** (NotificationStatus) – The notification type. By default, NotificationStatus.INFO as information.
- **button_infos** ([NotificationButtonInfo]) – The details of buttons to be displayed with the notification.
* `buttons` – Array of buttons.
### Returns
Notification handler.
### Examples
```python
import omni.kit.notification_manager as nm
ok_button = nm.NotificationButtonInfo("OK", on_complete=None)
cancel_button = nm.NotificationButtonInfo("CANCEL", on_complete=None)
notification = nm.post_notification(
"Notification Example",
hide_after_timeout=False,
duration=0,
status=nm.NotificationStatus.WARNING,
button_infos=[ok_button, cancel_button]
)
``` | 1,414 |
omni.kit.pipapi.add_archive_directory.md | # add_archive_directory
## add_archive_directory
```python
omni.kit.pipapi.add_archive_directory(path: str, root: Optional[str] = None)
```
Add pip additional dirs/links (for pip install –find-links).
``` | 206 |
omni.kit.pipapi.call_pip.md | # call_pip
## call_pip
```python
omni.kit.pipapi.call_pip(args, surpress_output=False)
```
Call pip with given arguments.
### Parameters
- **args** (list) – list of arguments to pass to pip
- **surpress_output** (bool) – if True, surpress pip output
### Returns
- return code of pip call
### Return type
- int
``` | 318 |
omni.kit.pipapi.ExtensionManagerPip.md | # ExtensionManagerPip
## ExtensionManagerPip
```
class omni.kit.pipapi.ExtensionManagerPip
```
**Bases:**
```
IExt
```
### Methods
| Method | Description |
|--------|-------------|
| `on_before_ext_enabled(ext_id, _)` | |
| `on_startup(ext_id)` | |
```python
def __init__(self: omni.ext._extensions.IExt) -> None:
```
``` | 329 |
omni.kit.pipapi.Functions.md | # omni.kit.pipapi Functions
## Functions Summary:
| Function Name | Description |
|---------------|-------------|
| add_archive_directory | Add pip additional dirs/links (for pip install –find-links). |
| call_pip | Call pip with given arguments. |
| install | Install package using pip into user specified env path. Install calls for particular package name persistently cache |
| remove_archive_directory | Remove pip additional dirs/links. | | 446 |
omni.kit.pipapi.install.md | # install
## install
### Function Signature
```python
def install(
package: str,
module: str = ...,
ignore_import_check: bool = False,
ignore_cache: bool = False,
version: str = ...,
use_online_index: bool = False,
surpress_output: bool = False,
extra_args: List[str] = None
) -> bool:
```
### Description
Install package using pip into user specified env path. Install calls for particular package name persistently cache to avoid overhead for future calls when package is already installed. Cache is stored in the `.install_cache.json` file in the user specified env path folder.
### Parameters
- **package** (str) – Package name to install. It is basically a command to pip install, it can include version and other flags.
- **module** (str) – Module name to import, by default module assumed to be equal to package.
- **ignore_import_check** (bool, optional) – If `True` ignore attempt to import module and call to `pip` anyway - can be slow.
- **ignore_cache** (bool, optional) – If `True` ignore caching and call to `pip` anyway - can be slow.
- **version** (str, optional) – Package version.
- **use_online_index** (bool, optional) – If `True` and package can’t be found in any of archive directories try to use default pip index.
- **surpress_output** (bool, optional) – If `True` pip process output to stdout and stderr will be surpressed, as well as warning when install failed.
- **extra_args** (List[str], optional) – a list of extra arguments to pass to the Pip process
### Returns
`True` if installation was successful.
``` | 1,573 |
omni.kit.pipapi.md | # omni.kit.pipapi
## Submodules
Summary:
- [omni.kit.pipapi.pipapi](omni.kit.pipapi.pipapi.html) - Pip Omniverse Kit API
## Classes
Summary:
- [ExtensionManagerPip](omni.kit.pipapi/omni.kit.pipapi.ExtensionManagerPip.html)
## Functions
Summary:
- [add_archive_directory](omni.kit.pipapi/omni.kit.pipapi.add_archive_directory.html) - Add pip additional dirs/links (for pip install –find-links).
- [call_pip](omni.kit.pipapi/omni.kit.pipapi.call_pip.html) - Call pip with given arguments.
- [install](omni.kit.pipapi/omni.kit.pipapi.install.html) - Install package using pip into user specified env path. Install calls for particular package name persistently cache
- [remove_archive_directory](omni.kit.pipapi/omni.kit.pipapi.remove_archive_directory.html) - Remove pip additional dirs/links. | 794 |
omni.kit.pipapi.pipapi.Classes.md | # omni.kit.pipapi.pipapi Classes
## Classes Summary
- [ExtensionManagerPip](./omni.kit.pipapi.pipapi/omni.kit.pipapi.pipapi.ExtensionManagerPip.html) | 151 |
omni.kit.pipapi.pipapi.md | # omni.kit.pipapi.pipapi
## Classes Summary
- **ExtensionManagerPip**
## Functions Summary
- **add_archive_directory**
- Add pip additional dirs/links (for pip install –find-links).
- **call_pip**
- Call pip with given arguments.
- **install**
- Install package using pip into user specified env path. Install calls for particular package name persistently cache.
- **remove_archive_directory**
- Remove pip additional dirs/links. | 440 |
omni.kit.pipapi.pipapi.remove_archive_directory.md | # remove_archive_directory
## remove_archive_directory
```python
omni.kit.pipapi.pipapi.remove_archive_directory(path: str)
```
Remove pip additional dirs/links.
``` | 168 |
omni.kit.raycast.query.acquire_raycast_query_interface.md | # acquire_raycast_query_interface
## acquire_raycast_query_interface
```python
omni.kit.raycast.query.acquire_raycast_query_interface(plugin_name: str = None, library_path: str = None) -> omni::kit::raycastquery::IRaycastQuery
```
This function returns the RaycastQuery interface object to use.
**Returns:**
obj: IRaycastQuery: RaycastQuery interface object. | 361 |
omni.kit.raycast.query.Classes.md | # omni.kit.raycast.query Classes
## Classes Summary
- **IRaycastQuery**
- **Ray**
- Ray represents a ray in 3D space.
- **RayQueryResult**
- **Result**
- Result stat code for raycast query. | 195 |
omni.kit.raycast.query.Functions.md | # omni.kit.raycast.query Functions
## Functions Summary
| Function Name | Description |
|---------------|-------------|
| acquire_raycast_query_interface | acquire_raycast_query_interface(plugin_name: str = None, library_path: str = None) -> omni::kit::raycastquery::IRaycastQuery | | 284 |
omni.kit.raycast.query.IRaycastQuery.md | # IRaycastQuery
## Methods
- `__init__(*args, **kwargs)`
- `add_raycast_sequence(self)`
- Add a sequence of raycast queries that maintains last valid value
- `get_latest_result_from_raycast_sequence(...)`
- Get latest result from a sequence of raycasts.
- `remove_raycast_sequence(self, arg0)`
- Remove a sequence of raycasts.
- `set_raycast_sequence_array_size(self, arg0, arg1)`
- Set the size of the raycast sequence.
- `submit_ray_to_raycast_sequence(self, arg0, arg1)`
- Submit a ray to a raycast sequence.
## Functions and Methods
### submit_raycast_query
- **Description**: This function adds a raycast query operation in the current scene.
### __init__
- **Parameters**:
- `*args`
- `**kwargs`
### add_raycast_sequence
- **Description**: Add a sequence of raycast queries that maintains last valid value and will execute raycast on current scene.
- **Returns**: Sequence id in raycast sequence for added.
- **Return type**: int
### get_latest_result_from_raycast_sequence
- **Parameters**:
- `arg0` (int): Sequence id returned by addRaycastSequence.
- **Returns**: obj:'Ray', :obj:'Result': Latest ray that was resolved and result of the ray request.
- **Return type**: Tuple([omni.kit.raycast.query._omni_kit_raycast_query.Ray, omni.kit.raycast.query._omni_kit_raycast_query.RayQueryResult])
### remove_raycast_sequence
- **Description**: Remove a sequence of raycast queries.
### IRaycastQuery.remove_raycast_sequence
Remove a sequence of raycasts.
#### Parameters
- **sequenceId** (int) – Sequence id to removed from RaycastSequence.
#### Returns
- obj:'Result': Error code if function failed.
### IRaycastQuery.set_raycast_sequence_array_size
Set the size of the raycast sequence.
#### Parameters
- **sequenceId** (int) – Sequence id returned by addRaycastSequence.
- **size** (int) – Number of ray casts in sequence.
#### Returns
- obj:'Result': Error code if function failed.
### IRaycastQuery.submit_ray_to_raycast_sequence
Submit a new ray request to a sequence of raycasts.
#### Parameters
- **sequenceId** (int) – Sequence id to submit ray to.
- **ray** (omni.kit.raycast.query._omni_kit_raycast_query.Ray) – Ray object to submit.
#### Returns
- obj:'Result': Error code if function failed.
### Parameters
- **sequenceId** (int) – Sequence id returned by addRaycastSequence.
- **(ray)** – obj:’Ray’): The ray to submit.
### Returns
obj:’Result’: Error code if function failed.
### submit_raycast_query
```python
def submit_raycast_query(self: omni.kit.raycast.query._omni_kit_raycast_query.IRaycastQuery, ray: omni.kit.raycast.query._omni_kit_raycast_query.Ray, callback: Callable[[omni.kit.raycast.query._omni_kit_raycast_query.Ray, omni.kit.raycast.query._omni_kit_raycast_query.RayQueryResult], None]) -> None:
```
This function adds a raycast query operation in the current scene.
#### Parameters
- **(ray)** – obj:’Ray’): The ray to submit.
- **callback** (Callable) – The callback lambda function to execute when resolved.
function signature: void(Ray, RayQueryResult) | 3,028 |
omni.kit.raycast.query.md | # omni.kit.raycast.query
## Classes Summary
### IRaycastQuery
### Ray
Ray represents a ray in 3D space.
### RayQueryResult
### Result
Result stat code for raycast query.
## Functions Summary
### acquire_raycast_query_interface
acquire_raycast_query_interface(plugin_name: str = None, library_path: str = None) -> omni::kit::raycastquery::IRaycastQuery | 357 |
omni.kit.raycast.query.Ray.md | # Ray
## Ray
```python
class omni.kit.raycast.query.Ray
```
Ray represents a ray in 3D space.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self, origin, direction[, min_t, ...])` | A ray is defined by an origin point, a direction vector, and minimum and maximum distances along the ray. |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `forward` | direction of the ray |
| `max_t` | t value at end of ray |
| `min_t` | t value of start of ray |
| `origin` | origin of the ray |
omni.kit.raycast.query._omni_kit_raycast_query.Ray
,
origin : object
,
direction : object
,
min_t : float = 0.0
,
max_t : float = inf
,
adjust_for_section : bool = True
)
→ None
A ray is defined by an origin point, a direction vector, and minimum and maximum distances along the ray. The ray can optionally be adjusted to fit within a specific section of space.
**Parameters**
- **origin** (Vec3) – The origin point of the ray.
- **direction** (Vec3) – The direction vector of the ray.
- **min_t** (float, optional) – The minimum distance along the ray. Defaults to 0.0.
- **max_t** (float, optional) – The maximum distance along the ray. Defaults to positive infinity.
- **adjust_for_section** (bool, optional) – Whether to adjust the ray to fit within a specific section of space. Defaults to True.
**forward**
direction of the ray
**max_t**
t value at end of ray
**min_t**
t value of start of ray
**origin**
property
# Ray Origin
## Overview
The origin of the ray is a fundamental concept in various fields, including physics and engineering. It represents the starting point of a ray, which can be a line, a beam of light, or any other form of radiation. Understanding the origin of a ray is crucial for analyzing its behavior and properties.
## Key Points
- **Definition**: The origin of a ray is the point from which it emanates.
- **Applications**: In optics, the origin of a light ray helps determine the path of light through lenses and mirrors.
- **Mathematical Representation**: In geometry, a ray is represented with an endpoint (the origin) and an arrow indicating the direction of the ray.
## Conclusion
The origin of the ray is a basic yet essential element in many scientific and technical disciplines. It provides a foundation for further study and application of ray-related concepts. | 2,353 |
omni.kit.raycast.query.RayQueryResult.md | # RayQueryResult
## RayQueryResult
- **Bases:** `pybind11_object`
### Methods
- `__init__(self)`
- Create a new RayQueryResult
- `get_target_usd_path(self)`
- This function returns the usd path of geometry that was hit.
### Attributes
- `hit_position`
- position of hit
- `hit_t`
- t value of hit position
- `instance_id`
- instance id
- `normal`
- normal of geometry at hit point
| primitive_id | primitive id |
|--------------|-------------|
| valid | indicates whether result is valid |
```
```markdown
__init__(self: omni.kit.raycast.query._omni_kit_raycast_query.RayQueryResult) -> None
- Create a new RayQueryResult
get_target_usd_path(self: omni.kit.raycast.query._omni_kit_raycast_query.RayQueryResult) -> str
- This function returns the usd path of geometry that was hit.
- Returns: Usd path of object that is the target, or an empty string if nothing was hit
- Return type: str
hit_position
- position of hit
hit_t
- t value of hit position
instance_id
- instance id
normal
- normal of geometry at hit point
primitive_id
- primitive id
valid
- indicates whether result is valid | 1,122 |
omni.kit.raycast.query.Result.md | # Result
## Summary
The `Result` class in `omni.kit.raycast.query` is a stat code for raycast query, inheriting from `pybind11_object`.
### Members
- **SUCCESS**: The operation was successful.
- **INVALID_PARAMETER**: The parameter provided is invalid.
- **PARAMETER_IS_NULL**: The parameter is a null value.
- **RAYCAST_SEQUENCE_DOES_NOT_EXIST**: The raycast sequence does not exist.
- **RAYCAST_QUERY_MANAGER_DOES_NOT_EXIT**: The raycast query manager does not exist.
- **RAYCAST_SEQUENCE_ADDITION_FAILED**: The addition of the raycast sequence failed.
### Methods
- `__init__(self, value)`: Initializes the Result object.
### Attributes
- `INVALID_PARAMETER`
- `PARAMETER_IS_NULL`
- `RAYCAST_QUERY_MANAGER_DOES_NOT_EXIT`
- `RAYCAST_SEQUENCE_ADDITION_FAILED`
- `RAYCAST_SEQUENCE_DOES_NOT_EXIST`
- `SUCCESS` | 812 |
omni.kit.registry.nucleus.apply_index_changes_batch.md | # apply_index_changes_batch
## apply_index_changes_batch
```python
omni.kit.registry.nucleus.apply_index_changes_batch()
```
Update index and toggle off index changes batching mode.
``` | 188 |
omni.kit.registry.nucleus.Functions.md | # omni.kit.registry.nucleus Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| apply_index_changes_batch | Update index and toggle off index changes batching mode. |
| get_extension_metadata_possible_urls | Get possible urls for extension metadata using extension data dictionary. |
| get_extension_metadata_url | Get extension metadata url using extension data dictionary. |
| get_icon_url | Get icon url using extension data dictionary. |
| get_package_resource_url_by_key | Get package resource url using extension data dictionary by key in package dict (like icon_remote). |
| get_preview_image_url | Get preview image url using extension data dictionary. |
| get_registry_url_by_ext_dict | Get registry url using extension data dictionary. |
| get_registry_url_by_name | Get registry url by registry name. |
| start_index_changes_batching | Stop updating index, all index changes will be accumulated until `apply_index_changes_batch` call. |
| verify_extension_for_publishing | Verify extension for publishing. |
Verify extension for publishing. Returns tuple of (is_valid, changelog_content) | 1,136 |
omni.kit.registry.nucleus.get_extension_metadata_possible_urls.md | # get_extension_metadata_possible_urls
## get_extension_metadata_possible_urls
```python
omni.kit.registry.nucleus.get_extension_metadata_possible_urls(ext_dict: Item) -> List[str]
```
Get possible urls for extension metadata using extension data dictionary.
To support older format, more than one url can be returned if extension is hosted on different host than registry.
The first one is the most likely to be correct.
``` | 429 |
omni.kit.registry.nucleus.get_extension_metadata_url.md | # get_extension_metadata_url
## get_extension_metadata_url
### omni.kit.registry.nucleus.get_extension_metadata_url
```python
omni.kit.registry.nucleus.get_extension_metadata_url(ext_dict: Item) -> str
```
Get extension metadata url using extension data dictionary.
Only the latest supported format is returned. To get all possible urls use `get_extension_metadata_possible_urls`. | 384 |
omni.kit.registry.nucleus.get_icon_url.md | # get_icon_url
## get_icon_url
```python
def get_icon_url(ext_dict: Item) -> str:
"""
Get icon url using extension data dictionary.
"""
```
``` | 157 |
omni.kit.registry.nucleus.get_package_resource_url_by_key.md | # get_package_resource_url_by_key
## get_package_resource_url_by_key
```python
omni.kit.registry.nucleus.get_package_resource_url_by_key(key: str, ext_dict: Item) -> str
```
Get package resource url using extension data dictionary by key in package dict (like icon_remote).
``` | 279 |
omni.kit.registry.nucleus.get_preview_image_url.md | # get_preview_image_url
## get_preview_image_url
```python
omni.kit.registry.nucleus.get_preview_image_url(ext_dict: Item) -> str
```
Get preview image url using extension data dictionary.
## Navigation
- [API (python)](../API.html) »
- [Modules](../Modules.html) »
- [omni.kit.registry.nucleus](../omni.kit.registry.nucleus.html) »
- [omni.kit.registry.nucleus Functions](../omni.kit.registry.nucleus.Functions.html) »
- get_preview_image_url
## Footer
---
``` | 468 |
omni.kit.registry.nucleus.get_registry_url_by_ext_dict.md | # get_registry_url_by_ext_dict
## get_registry_url_by_ext_dict
```python
omni.kit.registry.nucleus.get_registry_url_by_ext_dict(ext_dict: Item) -> str
```
Get registry url using extension data dictionary.
``` | 215 |
omni.kit.registry.nucleus.get_registry_url_by_name.md | # get_registry_url_by_name
## get_registry_url_by_name
```python
omni.kit.registry.nucleus.get_registry_url_by_name(registry_name: str) -> str
```
Get registry url by registry name.
``` | 187 |
omni.kit.registry.nucleus.md | # omni.kit.registry.nucleus
## Classes Summary
- **RegistryProvider**
- Registry provider implementation.
## Functions Summary
- **apply_index_changes_batch**
- Update index and toggle off index changes batching mode.
- **get_extension_metadata_possible_urls**
- Get possible urls for extension metadata using extension data dictionary.
- **get_extension_metadata_url**
- Get extension metadata url using extension data dictionary.
- **get_icon_url**
- Get icon url using extension data dictionary.
- **get_package_resource_url_by_key**
- Get package resource url using extension data dictionary by key in package dict (like icon_remote).
- **get_preview_image_url**
- Get preview image url using extension data dictionary.
- **get_registry_url_by_ext_dict**
- Get registry url using extension data dictionary.
- **get_registry_url_by_name**
- Get registry url by registry name.
- **start_index_changes_batching**
- Start index changes batching.
Stop updating index, all index changes will be accumulated until `apply_index_changes_batch` call.
verify_extension_for_publishing
Verify extension for publishing. Returns tuple of (is_valid, changelog_content) | 1,180 |
omni.kit.registry.nucleus.RegistryProvider.md | # RegistryProvider
## Overview
Registry provider implementation.
There is one instance of this class per registry URL in settings. It registers itself in the extension manager. Extension manager will call this class to get the list of extensions and to download extensions, etc.
### Methods
- `__init__(self)`
- `apply_index_changes_batch()`
| Method Name | Description |
|-------------|-------------|
| `get_urls()` | |
| `publish_extension(ext_path, ext_item)` | |
| `pull_extension(ext_id, ext_folder)` | |
| `pull_extension_async(ext_id, ext_folder)` | |
| `refresh_index()` | |
| `shutdown()` | |
| `sync_index()` | |
| `unpublish_extension(ext_id)` | |
### __init__(self: omni.ext._extensions.IRegistryProvider) -> None
- **Parameters**:
- `self`: omni.ext._extensions.IRegistryProvider
- **Returns**: None | 828 |
omni.kit.registry.nucleus.start_index_changes_batching.md | # start_index_changes_batching
## start_index_changes_batching
```python
omni.kit.registry.nucleus.start_index_changes_batching()
```
Stop updating index, all index changes will be accumulated until `apply_index_changes_batch` call. | 234 |
omni.kit.registry.nucleus.verify_extension_for_publishing.md | # verify_extension_for_publishing
## verify_extension_for_publishing
```python
omni.kit.registry.nucleus.verify_extension_for_publishing(ext_dict: Item) -> Tuple[bool, str]
```
Verify extension for publishing. Returns tuple of (is_valid, changelog_content)
``` | 262 |
omni.kit.scene_view.opengl.ClipMode.md | # ClipMode
## Class Definition
```python
class omni.kit.scene_view.opengl.ClipMode
```
Bases: `pybind11_object`
### Members
- ZERO_TO_ONE
- NEGATIVE_ONE_TO_ONE
### Methods
```python
__init__(self, value)
```
### Attributes
- `NEGATIVE_ONE_TO_ONE`
- `ZERO_TO_ONE`
- `name`
- `value`
```
## Method Details
```python
__init__(self: omni.kit.scene_view.opengl._opengl_sceneview.ClipMode, value)
value: int
)
→ None
property
name | 430 |
omni.kit.scene_view.opengl.OpenGLSceneView.md | # OpenGLSceneView
## OpenGLSceneView
- **Bases:** `SceneView`
- **Description:** OpenGLSceneView: An omni.ui.scene.SceneView implementation that will draw the scene with OpenGL.
### Methods
- `__init__(self[, model])`
- **Description:** OpenGLSceneView: An omni.ui.scene.SceneView implementation that will draw the scene with OpenGL.
- `get_current_textures(self, color, depth)`
- **Description:** Get an object that represents the current color and depth textures in use.
- `import_texture(self, texture)`
- **Description:** Import an external GPU reference (such as RTX renderer output) into the OpenGL context.
- `texture_blit(self, color, depth, scale)`
- **Description:** Blit an external GPU reference (such as RTX renderer output) into the color or depth attachment.
### Attributes
- `clip_mode`
- `color_format`
| depth_format |
|--------------|
| depth_format |
|--------------|
## __init__
```python
__init__(self: omni.kit.scene_view.opengl._opengl_sceneview.OpenGLSceneView, model: omni.ui_scene._scene.AbstractManipulatorModel = None, **kwargs) -> None
```
OpenGLSceneView: An omni.ui.scene.SceneView implementation that will draw the scene with OpenGL.
## get_current_textures
```python
get_current_textures(self: omni.kit.scene_view.opengl._opengl_sceneview.OpenGLSceneView, color: bool = True, depth: bool = True) -> Dict[str, omni::ui::OpenGLTextureHandle]
```
Get an object that represents the current color and depth textures in use.
**Parameters:**
- **color** (bool) – Whether to put a reference to the color texture in the return value.
- **depth** (bool) – Whether to put a reference to the depth texture in the return value
**Returns:**
A dictionary with optional ‘color’ and ‘depth’ keys based on arguments.
## import_texture
```python
import_texture(self: omni.kit.scene_view.opengl._opengl_sceneview.OpenGLSceneView, texture)
```
<section name="top" class="level2">
<div class="document" id="omni.kit.scene_view.opengl.openglsceneview">
<div class="section" id="omni.kit.scene_view.opengl.openglsceneview">
<h2 id="omni.kit.scene_view.opengl.openglsceneview">OpenGLSceneView
<dl class="py function">
<dt class="sig sig-object py" id="omni.kit.scene_view.opengl.OpenGLSceneView.import_texture">
<span class="sig-name descname"><span class="pre">import_texture
<span class="sig-paren">(
<em class="sig-param"><span class="n"><span class="pre">texture:
<span class="sig-paren">)
<span class="sig-return"><span class="sig-return-icon">→
<dd>
<p>Import an external GPU reference (such as RTX renderer output) into the OpenGL context.
<dl class="field-list simple">
<dt class="field-odd">Parameters
<dd class="field-odd">
<p><strong>texture
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.scene_view.opengl.OpenGLSceneView.texture_blit">
<span class="sig-name descname"><span class="pre">texture_blit
<span class="sig-paren">(
<em class="sig-param"><span class="n"><span class="pre">self:
,
<em class="sig-param"><span class="n"><span class="pre">color:
,
<em class="sig-param"><span class="n"><span class="pre">depth:
,
<em class="sig-param"><span class="n"><span class="pre">scale:
,
<em class="sig-param"><span class="n"><span class="pre">1
,
<em class="sig-param"><span class="n"><span class="pre">1)
<span class="sig-paren">)
<span class="sig-return"><span class="sig-return-icon">→
<dd>
<p>Blit an external GPU reference (such as RTX renderer output) into the color or depth attachment.
<dl class="field-list simple">
<dt class="field-odd">Parameters
<dd class="field-odd">
<ul class="simple">
<li>
<p><strong>color
<li>
<p><strong>depth
<li>
<p><strong>scale
| 3,642 |
omni.kit.scene_view.opengl.ViewportOpenGLSceneView.md | # ViewportOpenGLSceneView
## Class: omni.kit.scene_view.opengl.ViewportOpenGLSceneView
Constructs a ViewportOpenGLSceneView instance that will draw the scene with OpenGL clipped against a Viewport's render.
### Methods
- **__init__(viewport_api, *args, **kwargs)**
- Constructs a ViewportOpenGLSceneView instance.
- **create_in_viewport_window(viewport_window, ...)**
- Helper static method to create a ViewportOpenGLSceneView into a ViewportWindow.
- **destroy(self)**
- Removes all the callbacks and circular references.
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.scene_view.opengl.ViewportOpenGLSceneView.__init__">
<em class="property">
<span class="pre">
__init__
<span class="sig-paren">
(
<em class="sig-param">
<span class="n">
<span class="pre">
viewport_api
,
<em class="sig-param">
<span class="o">
<span class="pre">
*
<span class="n">
<span class="pre">
args
,
<em class="sig-param">
<span class="o">
<span class="pre">
**
<span class="n">
<span class="pre">
kwargs
<span class="sig-paren">
)
<dd>
<p>
Construct a ViewportOpenGLSceneView instance that will draw the scene with OpenGL clipped against a Viewport’s render
<dl class="field-list simple">
<dt class="field-odd">
Parameters
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
viewport_api
– ViewportAPI The ViewportAPI to attach the ViewportOpenGLSceneView to
<li>
<p>
<strong>
*arg
– Additional arguments to pass to OpenGLSceneView constructor
<li>
<p>
<strong>
**kwargs
– Additional keyword arguments to pass to OpenGLSceneView constructor
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.scene_view.opengl.ViewportOpenGLSceneView.create_in_viewport_window">
<em class="property">
<span class="pre">
static
<span class="w">
<span class="sig-name descname">
<span class="pre">
create_in_viewport_window
<span class="sig-paren">
(
<em class="sig-param">
<span class="n">
<span class="pre">
viewport_window
,
<em class="sig-param">
<span class="n">
<span class="pre">
frame_name
<span class="p">
<span class="pre">
:
<span class="w">
<span class="n">
<span class="pre">
str
,
<em class="sig-param">
<span class="n">
<span class="pre">
build_fn
,
<em class="sig-param">
<span class="o">
<span class="pre">
*
<span class="n">
<span class="pre">
args
,
<em class="sig-param">
<span class="o">
<span class="pre">
**
<span class="n">
<span class="pre">
kwargs
<span class="sig-paren">
)
<dd>
<p>
Helper staticmethod to create a ViewportOpenGLSceneView into a ViewportWindow
<dl class="field-list simple">
<dt class="field-odd">
Parameters
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
viewport_window
– ViewportWindow The ViewportWindow to add the ViewportOpenGLSceneView into
<li>
<p>
<strong>
frame_name
– str Unique identifier for the parent frame
<li>
<p>
<strong>
build_fn
– Callable(gl_scene_view: ViewportOpenGLSceneView) Optional callback to use with parent frame’s build_fn
<li>
<p>
<strong>
\*args
– Additional positional arguments to pass to ViewportOpenGLSceneView constructor
<li>
<p>
<strong>
**kwargs
– Additional keyword arguments to pass to ViewportOpenGLSceneView constructor
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.scene_view.opengl.ViewportOpenGLSceneView.destroy">
<span class="sig-name descname">
<span class="pre">
destroy
<span class="sig-paren">
(
<em class="sig-param">
<span class="n">
<span class="pre">
self
<span class="p">
<span class="pre">
:
<span class="w">
<span class="n">
<span class="pre">
omni.ui._ui.Widget
<span class="sig-paren">
)
<span class="sig-return">
<span class="sig-return-icon">
→
<span class="sig-return-typehint">
<span class="pre">
None
<dd>
<p>
Removes all the callbacks and circular references.
| 4,848 |
omni.kit.selection.Classes.md | # omni.kit.selection Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| HideUnselectedCommand | Hide prims not selected. |
| SelectAllCommand | Select all prims. |
| SelectHierarchyCommand | Set the new selection to all child prims of the current selection. |
| SelectInvertCommand | Deselect current prims, and select everything else not selected before. |
| SelectKindCommand | Set the new selection to all prim with the given kind. |
| SelectLeafCommand | Set the new selection to all descendant prims of the current selection. |
| SelectListCommand | Set the new selection from the given list of prim paths. |
| SelectNoneCommand | Deselect all selected prims. |
| SelectParentCommand | Set the new selection to all parent prims of the current selection. |
| SelectSimilarCommand | Select all prims with the same type of the current selection. |
| SelectionExtension | |
# 标题
## 子标题
### 更小的标题
**加粗文本**
*斜体文本*
> 引用文本
`代码块`
无序列表：
- 列表项1
- 列表项2
有序列表：
1. 列表项1
2. 列表项2
表格（假设HTML中有表格）：
| 列1 | 列2 |
| --- | --- |
| 内容1 | 内容2 |
分割线：
---
脚注：
--- | 1,081 |
omni.kit.selection.HideUnselectedCommand.md | # HideUnselectedCommand
## HideUnselectedCommand
- **Bases:** `Command`
- **Description:** Hide prims not selected.
### Methods
- `__init__()`
- `do()`
- `undo()`
#### `__init__()` | 183 |
omni.kit.selection.md | # omni.kit.selection
## Submodules
Summary:
| Module | Description |
|--------|-------------|
| [omni.kit.selection.selection](omni.kit.selection.selection.html) | No submodule docstring provided |
| [omni.kit.selection.selection_actions](omni.kit.selection.selection_actions.html) | No submodule docstring provided |
## Classes
Summary:
| Class | Description |
|-------|-------------|
| [HideUnselectedCommand](omni.kit.selection/omni.kit.selection.HideUnselectedCommand.html) | Hide prims not selected. |
| [SelectAllCommand](omni.kit.selection/omni.kit.selection.SelectAllCommand.html) | Select all prims. |
| [SelectHierarchyCommand](omni.kit.selection/omni.kit.selection.SelectHierarchyCommand.html) | Set the new selection to all child prims of the current selection. |
| [SelectInvertCommand](omni.kit.selection/omni.kit.selection.SelectInvertCommand.html) | Deselect current prims, and select everything else not selected before. |
| [SelectKindCommand](omni.kit.selection/omni.kit.selection.SelectKindCommand.html) | Set the new selection to all prim with the given kind. |
| [SelectLeafCommand](omni.kit.selection/omni.kit.selection.SelectLeafCommand.html) | Set the new selection to all descendant prims of the current selection. |
| [SelectListCommand](omni.kit.selection/omni.kit.selection.SelectListCommand.html) | Set the new selection from the given list of prim paths. |
| [SelectNoneCommand](omni.kit.selection/omni.kit.selection.SelectNoneCommand.html) | Deselect all selected prims. |
| [SelectParentCommand](omni.kit.selection/omni.kit.selection.SelectParentCommand.html) | |
| Command | Description |
|---------|-------------|
| SelectParentCommand | Set the new selection to all parent prims of the current selection. |
| SelectSimilarCommand | Select all prims with the same type of the current selection. |
| SelectionExtension | |
Functions Summary:
| Function | Description |
|----------|-------------|
| deregister_actions | |
| register_actions | | | 1,984 |
omni.kit.selection.SelectAllCommand.md | # SelectAllCommand
## SelectAllCommand
```python
class omni.kit.selection.SelectAllCommand(type=None)
```
**Bases:** `Command`
Select all prims.
**Parameters:**
- **type** (Optional[str]) – Specific type name. If it’s None, it will select all prims. If it has type str with value type, it will select prims with that type. Otherwise, type.
**Methods:**
- `__init__(type)`
- `do()`
- `undo()`
```
<span class="n">
<span class="pre">
type
<span class="o">
<span class="pre">
=
<span class="default_value">
<span class="pre">
None
<span class="sig-paren">
)
<dd>
<footer>
<hr/>
| 614 |
omni.kit.selection.SelectHierarchyCommand.md | # SelectHierarchyCommand
## SelectHierarchyCommand
```
class omni.kit.selection.SelectHierarchyCommand
```
Bases: `Command`
Set the new selection to all child prims of the current selection.
### Methods
| Method | Description |
|--------|-------------|
| `__init__()` | |
| `do()` | |
| `undo()` | |
```
def __init__():
``` | 333 |
omni.kit.selection.SelectInvertCommand.md | # SelectInvertCommand
## SelectInvertCommand
```
class omni.kit.selection.SelectInvertCommand
```
**Bases:**
```
Command
```
**Description:**
Deselect current prims, and select everything else not selected before.
**Methods:**
- `__init__()`
- `do()`
- `undo()`
### __init__()
``` | 286 |
omni.kit.selection.selection.Classes.md | # omni.kit.selection.selection Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| HideUnselectedCommand | Hide prims not selected. |
| SelectAllCommand | Select all prims. |
| SelectHierarchyCommand | Set the new selection to all child prims of the current selection. |
| SelectInvertCommand | Deselect current prims, and select everything else not selected before. |
| SelectKindCommand | Set the new selection to all prim with the given kind. |
| SelectLeafCommand | Set the new selection to all descendant prims of the current selection. |
| SelectListCommand | Set the new selection from the given list of prim paths. |
| SelectNoneCommand | Deselect all selected prims. |
| SelectParentCommand | Set the new selection to all parent prims of the current selection. |
| SelectSimilarCommand | (Description not provided in the HTML snippet) |
| | |
|----------|-------------------------------------------------------------------------------------|
| | **Select all prims with the same type of the current selection.** |
| | |
| | **SelectionExtension** |
| | | | 1,480 |
omni.kit.selection.selection.md | # omni.kit.selection.selection
## Classes
Summary:
| Class | Description |
| --- | --- |
| [HideUnselectedCommand](omni.kit.selection.selection/omni.kit.selection.selection.HideUnselectedCommand.html) | Hide prims not selected. |
| [SelectAllCommand](omni.kit.selection.selection/omni.kit.selection.selection.SelectAllCommand.html) | Select all prims. |
| [SelectHierarchyCommand](omni.kit.selection.selection/omni.kit.selection.selection.SelectHierarchyCommand.html) | Set the new selection to all child prims of the current selection. |
| [SelectInvertCommand](omni.kit.selection.selection/omni.kit.selection.selection.SelectInvertCommand.html) | Deselect current prims, and select everything else not selected before. |
| [SelectKindCommand](omni.kit.selection.selection/omni.kit.selection.selection.SelectKindCommand.html) | Set the new selection to all prim with the given kind. |
| [SelectLeafCommand](omni.kit.selection.selection/omni.kit.selection.selection.SelectLeafCommand.html) | Set the new selection to all descendant prims of the current selection. |
| [SelectListCommand](omni.kit.selection.selection/omni.kit.selection.selection.SelectListCommand.html) | Set the new selection from the given list of prim paths. |
| [SelectNoneCommand](omni.kit.selection.selection/omni.kit.selection.selection.SelectNoneCommand.html) | Deselect all selected prims. |
| [SelectParentCommand](omni.kit.selection.selection/omni.kit.selection.selection.SelectParentCommand.html) | Set the new selection to all parent prims of the current selection. |
| [SelectSimilarCommand](omni.kit.selection.selection/omni.kit.selection.selection.SelectSimilarCommand.html) | Select all prims with the same type of the current selection. |
| | |
|----------|----------|
| SelectionExtension | |
| | |
| deregister_actions | |
| register_actions | |
```
```markdown
Functions
Summary:
```
```markdown
| | |
|----------|----------|
| deregister_actions | |
| register_actions | |
```
```markdown
--- | 2,088 |
omni.kit.selection.selection.SelectAllCommand.md | # SelectAllCommand
## SelectAllCommand
```
class omni.kit.selection.selection.SelectAllCommand(type=None)
```
**Bases:** `Command`
Select all prims.
**Parameters**
- **type** (Optional [str]) – Specific type name. If it’s None, it will select all prims. If it has type str with value type, it will select prims with that type. Otherwise, type.
**Methods**
- **__init__(type)**
- **do()**
- **undo()**
```
__init__(type=None) | 430 |
omni.kit.selection.selection.SelectKindCommand.md | # SelectKindCommand
## SelectKindCommand
```python
class omni.kit.selection.selection.SelectKindCommand(**kwargs)
```
Set the new selection to all prim with the given kind.
### Keyword Arguments
- **kind** (str) – kind of prim to select.
### Methods
```python
__init__(**kwargs)
do()
undo()
```
``` | 301 |
omni.kit.selection.selection.SelectLeafCommand.md | # SelectLeafCommand
## SelectLeafCommand
```
class omni.kit.selection.selection.SelectLeafCommand
```
Bases: `Command`
Set the new selection to all descendant prims of the current selection.
### Methods
- `__init__()`
- `collect_leafs(prim, leaf_set)`
- `do()`
- `undo()`
### `__init__()`
```
--- | 304 |
omni.kit.selection.selection.SelectListCommand.md | # SelectListCommand
## SelectListCommand
```
class omni.kit.selection.selection.SelectListCommand(**kwargs)
```
**Bases:** `Command`
**Description:**
Set the new selection from the given list of prim paths.
**Keyword Arguments:**
- **selection** (List[str]) – the new selection to set.
**Methods:**
- `__init__(**kwargs)`
- `do()`
- `undo()`
### __init__(**kwargs)
# Hello, World!
This is an example of [a link].
Here is an image: ![Description of image] | 463 |
omni.kit.selection.selection.SelectNoneCommand.md | # SelectNoneCommand
## SelectNoneCommand
### Class: omni.kit.selection.selection.SelectNoneCommand
**Bases:** `Command`
**Description:** Deselect all selected prims.
### Methods
| Method | Description |
|--------|-------------|
| `__init__()` | |
| `do()` | |
| `undo()` | |
#### `__init__()`
```
``` | 310 |
omni.kit.selection.selection.SelectParentCommand.md | # SelectParentCommand
## SelectParentCommand
```
class omni.kit.selection.selection.SelectParentCommand
```
Bases: `Command`
Set the new selection to all parent prims of the current selection.
### Methods
| Method | Description |
|--------|-------------|
| `__init__()` | |
| `do()` | |
| `undo()` | |
```
def __init__(self)
---
```
``` | 348 |
omni.kit.selection.selection.SelectSimilarCommand.md | # SelectSimilarCommand
## SelectSimilarCommand
### Class: omni.kit.selection.selection.SelectSimilarCommand
**Bases:** `Command`
**Description:** Select all prims with the same type of the current selection.
### Methods
- **`__init__()`**
- **`do()`**
- **`undo()`**
### `__init__()` | 290 |
omni.kit.selection.SelectionExtension.md | # SelectionExtension
## Class: omni.kit.selection.SelectionExtension
Bases: `IExt`
### Methods
| Method | Description |
|--------------|-------------|
| `on_shutdown()` | |
| `on_startup(ext_id)` | |
### `__init__(self: omni.ext._extensions.IExt) -> None` | 286 |
omni.kit.selection.SelectKindCommand.md | # SelectKindCommand
## SelectKindCommand
```class omni.kit.selection.SelectKindCommand(**kwargs)```
**Description:**
Bases: `Command`
Set the new selection to all prim with the given kind.
**Keyword Arguments:**
- **kind** (str) – kind of prim to select.
**Methods:**
- ```__init__(**kwargs)```
- ```do()```
- ```undo()```
### __init__(**kwargs)
``` | 355 |
omni.kit.selection.SelectListCommand.md | # SelectListCommand
## SelectListCommand
```
class omni.kit.selection.SelectListCommand(**kwargs)
```
**Bases:** `Command`
**Description:** Set the new selection from the given list of prim paths.
**Keyword Arguments:**
- **selection** (`List[str]`) – the new selection to set.
**Methods:**
- `__init__(**kwargs)`
- `do()`
- `undo()`
### __init__(**kwargs)
```
``` | 371 |
omni.kit.selection.SelectSimilarCommand.md | # SelectSimilarCommand
## SelectSimilarCommand
Bases: `Command`
Select all prims with the same type of the current selection.
### Methods
| Method | Description |
|--------|-------------|
| `__init__()` | |
| `do()` | |
| `undo()` | |
#### `__init__()` | 261 |
omni.kit.selection.Submodules.md | # omni.kit.selection Submodules
## Submodules Summary
- **omni.kit.selection.selection**
- No submodule docstring provided
- **omni.kit.selection.selection_actions**
- No submodule docstring provided | 206 |
omni.kit.telemetry.Classes.md | # omni.kit.telemetry Classes
## Classes Summary:
- **Extension**
- **ITelemetry**
- Interface to handle performing telemetry related tasks.
- **ITelemetry2**
- Interface to handle performing telemetry related tasks.
- **RunEnvironment**
- Names for the current Run environment used for telemetry. | 304 |
omni.kit.telemetry.Extension.md | # Extension
## Extension
```python
class omni.kit.telemetry.Extension
```
**Bases:**
```python
IExt
```
**Methods**
| Method | Description |
|--------|-------------|
| `on_startup()` | |
```python
def __init__(self: omni.ext._extensions.IExt) -> None:
```
``` | 265 |
omni.kit.telemetry.Functions.md | # omni.kit.telemetry Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| remove_sentry_pii_data | Tries our best to remove PII data from sentry events. |
| should_enable_sentry | Verifies if we’re an external build or disabled via settings. |
| start_sentry | Starts sentry if it should. | | 326 |
omni.kit.telemetry.impl.Extension.md | # Extension
## omni.kit.telemetry.impl.Extension
Bases: `IExt`
### Methods
| Method | Description |
|--------|-------------|
| `on_startup()` | |
### omni.kit.telemetry.impl.Extension.__init__
```python
__init__(self: omni.ext._extensions.IExt) -> None
``` | 263 |
omni.kit.telemetry.impl.md | # omni.kit.telemetry.impl
## Submodules
Summary:
| Module | Description |
|--------|-------------|
| [omni.kit.telemetry.impl.sentry_extension](omni.kit.telemetry.impl.sentry_extension.html) | No submodule docstring provided |
## Classes
Summary:
| Class | Description |
|-------|-------------|
| [Extension](omni.kit.telemetry.impl/omni.kit.telemetry.impl.Extension.html) | |
## Functions
Summary:
| Function | Description |
|----------|-------------|
| [remove_sentry_pii_data](omni.kit.telemetry.impl/omni.kit.telemetry.impl.remove_sentry_pii_data.html) | Tries our best to remove PII data from sentry events. |
| [should_enable_sentry](omni.kit.telemetry.impl/omni.kit.telemetry.impl.should_enable_sentry.html) | Verifies if we’re an external build or disabled via settings. |
| [start_sentry](omni.kit.telemetry.impl/omni.kit.telemetry.impl.start_sentry.html) | Starts sentry if it should. | | 903 |
omni.kit.telemetry.impl.remove_sentry_pii_data.md | # remove_sentry_pii_data
## remove_sentry_pii_data
```python
omni.kit.telemetry.impl.remove_sentry_pii_data(event, hint) -> dict
```
Tries our best to remove PII data from sentry events.
We replace userId by the sessionId (unique integer per whole session) and replace any paths we find in the
message or stack trace with their last part of the path, e.g: /home/foo/bar.py becomes bar.py
### Parameters
- **event** (dict) – The event that we filter
- **hint** (dict) – Not used but part of the API
### Returns
The filtered event.
### Return type
dict
``` | 560 |
omni.kit.telemetry.impl.sentry_extension.Classes.md | # omni.kit.telemetry.impl.sentry_extension Classes
## Classes Summary
- **Extension**
- [Extension](omni.kit.telemetry.impl.sentry_extension/omni.kit.telemetry.impl.sentry_extension.Extension.html) | 201 |
omni.kit.telemetry.impl.sentry_extension.Functions.md | # omni.kit.telemetry.impl.sentry_extension Functions
## Functions Summary
- **filter_path_from_string**
- If there’s a path on the string we get rid of it
- **remove_sentry_pii_data**
- Tries our best to remove PII data from sentry events.
- **should_enable_sentry**
- Verifies if we’re an external build or disabled via settings.
- **start_sentry**
- Starts sentry if it should. | 392 |
omni.kit.telemetry.impl.should_enable_sentry.md | # should_enable_sentry
## should_enable_sentry
```python
def should_enable_sentry(app, settings):
"""
Verifies if we’re an external build or disabled via settings.
Parameters
----------
app : omni.App
The application
settings : carb.settings
Carb dictionary
Returns
-------
bool
"""
```
``` | 349 |
omni.kit.telemetry.impl.start_sentry.md | # start_sentry
## start_sentry
```python
omni.kit.telemetry.impl.start_sentry(app, settings) -> bool
```
Starts sentry if it should.
### Returns
Returns True if sentry started
### Return type
bool
``` | 204 |
omni.kit.telemetry.impl.Submodules.md | # omni.kit.telemetry.impl Submodules
## Submodules Summary:
| Submodule | Description |
|-----------|-------------|
| omni.kit.telemetry.impl.sentry_extension | No submodule docstring provided | | 196 |
omni.kit.telemetry.ITelemetry.md | # ITelemetry
## Overview
Interface to handle performing telemetry related tasks.
This provides an abstraction over the lower level telemetry and structured logging systems and allows control over some common features of it.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(*args, **kwargs)` | Overloaded function. |
| `send_custom_event(self, eventType[, ...])` | |
| `send_generic_event(self, event_type, ...)` | Sends a generic structured log event with caller specified data. |
### Detailed Method Descriptions
#### `__init__(*args, **kwargs)`
Overloaded function.
- `__init__(self: omni.kit.telemetry._telemetry.ITelemetry, arg0: omni.core._core.IObject) -> None`
- `__init__(self: omni.kit.telemetry._telemetry.ITelemetry) -> None`
#### `send_custom_event(self, eventType[, ...])`
#### `send_generic_event(self, event_type, ...)`
Sends a generic structured log event with caller specified data.
send_custom_event(
self: omni.kit.telemetry._telemetry.ITelemetry,
eventType: str,
duration: float = 0.0,
data1: str = None,
data2: str = None,
value1: float = 0.0,
value2: float = 0.0
) → None
send_generic_event(
self: omni.kit.telemetry._telemetry.ITelemetry,
event_type: str,
duration: float,
data1: str,
data2: str,
value1: float
)
<span class="pre">
float
,
<em class="sig-param">
<span class="n">
<span class="pre">
value2
<span class="p">
<span class="pre">
:
<span class="w">
<span class="n">
<span class="pre">
float
<span class="sig-paren">
)
<span class="sig-return">
<span class="sig-return-icon">
→
<span class="sig-return-typehint">
<span class="pre">
None
<dd>
<p>
Sends a generic structured log event with caller specified data.
<blockquote>
<div>
<dl class="simple">
<dt>
@param[in] eventType A string describing the event that occurred. There is no
<dd>
<p>
restriction on the content or formatting of this value.
This should neither be `nullptr` nor an empty string.
<dt>
@param[in] duration A generic duration value that can be optionally included
<dd>
<p>
with the event. It is the caller’s responsibility to
decide on the usage and semantics of this value depending
on the @p eventType value. This may be 0.0 if no duration
value is needed for the event.
<dt>
@param[in] data1 A string data value to be sent with the event. The contents
<dd>
<p>
and interpretation of this string depend on the @p eventTyoe
value.
<dt>
@param[in] data2 A string data value to be sent with the event. The contents
<dd>
<p>
and interpretation of this string depend on the @p eventTyoe
value.
<dt>
@param[in] value1 A floating point value to be sent with the event. This value
<dd>
<p>
will be interpreted according to the @p eventType value.
<dt>
@param[in] value2 A floating point value to be sent with the event. This value
<dd>
<p>
will be interpreted according to the @p eventType value.
<p>
@returns No return value.
<dl class="simple">
<dt>
@remarks This sends a generic event to the structured logging log file. The contents,
<dd>
<p>
semantics, and interpretation of this event are left entirely up to the caller.
This will be a no-op if telemetry is disabled (ie: the telemetry module either
intentionally was not loaded or failed to load).
| 3,290 |
omni.kit.telemetry.ITelemetry2.md | # ITelemetry2
## ITelemetry2
- **Bases:** `_ITelemetry2`
- **Description:** Interface to handle performing telemetry related tasks. This provides an abstraction over the lower level telemetry and structured logging systems and allows control over some common features of it.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(*args, **kwargs)` | Overloaded function. |
| `send_custom_event(self, eventType[, ...])` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `cloud_session` | |
| `cloud_session_id` | |
| `customer_id` | |
| `run_environment` | |
### `__init__(*args, **kwargs)`
<dl>
<dt>
**kwargs
)
<dd>
<p>Overloaded function.
<ol>
<li>
<p>__init__(self: omni.kit.telemetry._telemetry.ITelemetry2, arg0: omni.core._core.IObject) -> None
<li>
<p>__init__(self: omni.kit.telemetry._telemetry.ITelemetry2) -> None
<dl>
<dt>
send_custom_event(self: omni.kit.telemetry._telemetry.ITelemetry2, eventType: str, duration: float = 0.0, data1: str = None, data2: str = None, value1: float = 0.0, value2: float = 0.0) -> None
<dd>
| 1,176 |
omni.kit.telemetry.md | # omni.kit.telemetry
## Submodules
Summary:
| Module | Description |
|--------|-------------|
| [omni.kit.telemetry.impl](omni.kit.telemetry.impl.html) | No submodule docstring provided |
## Classes
Summary:
| Class | Description |
|-------|-------------|
| [Extension](omni.kit.telemetry/omni.kit.telemetry.Extension.html) | |
| [ITelemetry](omni.kit.telemetry/omni.kit.telemetry.ITelemetry.html) | Interface to handle performing telemetry related tasks. |
| [ITelemetry2](omni.kit.telemetry/omni.kit.telemetry.ITelemetry2.html) | Interface to handle performing telemetry related tasks. |
| [RunEnvironment](omni.kit.telemetry/omni.kit.telemetry.RunEnvironment.html) | Names for the current Run environment used for telemetry. |
## Functions
Summary:
| Function | Description |
|----------|-------------|
| [remove_sentry_pii_data](omni.kit.telemetry/omni.kit.telemetry.remove_sentry_pii_data.html) | Tries our best to remove PII data from sentry events. |
| [should_enable_sentry](omni.kit.telemetry/omni.kit.telemetry.should_enable_sentry.html) | Verifies if we’re an external build or disabled via settings. |
| [start_sentry](omni.kit.telemetry/omni.kit.telemetry.start_sentry.html) | Starts sentry if it should. | | 1,226 |
omni.kit.telemetry.RunEnvironment.md | # RunEnvironment
## RunEnvironment
Bases: `pybind11_object`
Names for the current Run environment used for telemetry.
Identifiers used to outline what kind of environment this process is currently running in. This may be individual (OVI), cloud (OVC), or enterprise (OVE).
Members:
- UNDETERMINED : The run environment has not been determined yet.
- INDIVIDUAL : Omniverse individual (OVI) desktop session.
- CLOUD : Omniverse Cloud (OVC) session.
- ENTERPRISE : Omniverse Enterprise (OVE) session.
### Methods
- `__init__(self, value)`
### Attributes
- `CLOUD`
- `ENTERPRISE`
- `INDIVIDUAL`
- `UNDETERMINED`
- `name`
| value |
|-------|
## __init__
```python
__init__(self: omni.kit.telemetry._telemetry.RunEnvironment, value: int) -> None
```
## name
```python
property name
```
``` | 795 |
omni.kit.telemetry.should_enable_sentry.md | # should_enable_sentry
## should_enable_sentry
```python
omni.kit.telemetry.should_enable_sentry(app, settings) -> bool
```
Verifies if we’re an external build or disabled via settings.
### Parameters
- **app** (`omni.App`) – The application
- **settings** (`carb.settings`) – Carb dictionary | 295 |
omni.kit.undo.disabled.md | # disabled
## disabled
```
Prevent commands being added to the undo stack.
This function is a context manager.
Example:
```python
with omni.kit.undo.disabled():
omni.kit.commands.execute("Foo1")
omni.kit.commands.execute("Foo2")
``` | 245 |
omni.kit.undo.format_exception.md | # format_exception
## format_exception
```python
omni.kit.undo.format_exception(e: Exception, remove_n_last_frames: int = 2) -> str
```
Pretty format exception. Include exception info, call stack of exception itself and this function callstack.
This function is meant to be used in `except` clause.
### Parameters
- **e** – Exception.
- **remove_n_last_frames** – Number of last call stack frames to be removed. Usually this function and few above are meaningless to the user.
### Returns
Formatted string. | 510 |
omni.kit.undo.Functions.md | # omni.kit.undo Functions
## Functions Summary:
- **begin_disabled**: Begin preventing **Commands** being added to the undo stack.
- **begin_group**: Begin group of **Commands**.
- **can_redo**:
- **can_repeat**:
- **can_undo**:
- **clear_history**: Clear **Command** execution history.
- **clear_stack**:
- **disabled**: Prevent commands being added to the undo stack.
- **end_disabled**: Stop preventing **Commands** being added to the undo stack.
- **end_group**: End group of **Commands**.
- **execute**:
- **format_exception**: Pretty format exception. Include exception info, call stack of exception itself and this function callstack.
- **get_history**:
- Get **Command** execution history.
- get_redo_stack
- get_undo_stack
- group
- Group multiple commands in one.
- redo
- register_undo_commands
- repeat
- subscribe_on_change
- subscribe_on_change_detailed
- undo
- unsubscribe_on_change
- unsubscribe_on_change_detailed | 941 |
omni.kit.undo.get_history.md | # get_history
## get_history
Get **Command** execution history.
Returns a list of tuples: HistoryEntry(Command name, Arguments, Groupping level, Error status). | 162 |
omni.kit.undo.group.md | # group
## group
```
Group multiple commands in one.
This function is a context manager.
Example:
```python
with omni.kit.undo.group():
omni.kit.commands.execute("Foo1")
omni.kit.commands.execute("Foo2")
``` | 220 |
omni.kit.undo.history.add_history.md | # add_history
## add_history
Add a **Command** execution to the history.
Takes: (Command name, Arguments, Groupping level).
Return: index that can be used to modify it later | 174 |
omni.kit.undo.history.change_history.md | # change_history
## change_history
```python
omni.kit.undo.history.change_history(key: int, **kwargs)
```
Update the history entry for **key**.
- key: Index of the history entry to modify.
- kwargs: any of the properties of HistoryEntry.
``` | 244 |
omni.kit.undo.history.Classes.md | # omni.kit.undo.history Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| [HistoryEntry](omni.kit.undo.history/omni.kit.undo.history.HistoryEntry.html) | HistoryEntry(name, kwargs, level, error) |
| [OrderedDict](omni.kit.undo.history/omni.kit.undo.history.OrderedDict.html) | Dictionary that remembers insertion order |
| [islice](omni.kit.undo.history/omni.kit.undo.history.islice.html) | islice(iterable, stop) –> islice object | | 462 |
omni.kit.undo.history.Functions.md | # omni.kit.undo.history Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| add_history | Add a **Command** execution to the history. |
| change_history | Update the history entry for **key**. |
| clear_history | Clear **Command** execution history. |
| get_history | Get **Command** execution history. |
| get_history_item | |
| lru_cache | Least-recently-used cache decorator. |
| namedtuple | Returns a new subclass of tuple with named fields. | | 486 |
omni.kit.undo.history.get_history.md | # get_history
## get_history
```
```python
omni.kit.undo.history.get_history()
```
Get **Command** execution history.
Returns a list of tuples: HistoryEntry(Command name, Arguments, Groupping level, Error status). | 217 |
omni.kit.undo.history.HistoryEntry.md | # HistoryEntry
## Attributes
- **error**
- Alias for field number 3
- **kwargs**
- Alias for field number 1
- **level**
- Alias for field number 2
- **name**
- Alias for field number 0
### Alias for field number 3
### Alias for field number 1
### Alias for field number 2
### Alias for field number 0 | 313 |
omni.kit.undo.history.islice.md | # islice
## islice
```python
class omni.kit.undo.history.islice
```
### Description
islice(iterable, stop) –> islice object
islice(iterable, start, stop[, step]) –> islice object
Return an iterator whose next() method returns selected values from an iterable. If start is specified, will skip all preceding elements; otherwise, start defaults to zero. Step defaults to one. If specified as another value, step determines how many values are skipped between successive calls. Works like a slice() on a list but returns an iterator.
### Methods
```python
__init__()
```
``` | 576 |
omni.kit.undo.history.md | # omni.kit.undo.history
## Classes
Summary:
| Class | Description |
|-------|-------------|
| [HistoryEntry](omni.kit.undo.history/omni.kit.undo.history.HistoryEntry.html) | HistoryEntry(name, kwargs, level, error) |
| [OrderedDict](omni.kit.undo.history/omni.kit.undo.history.OrderedDict.html) | Dictionary that remembers insertion order |
| [islice](omni.kit.undo.history/omni.kit.undo.history.islice.html) | islice(iterable, stop) –> islice object |
## Functions
Summary:
| Function | Description |
|----------|-------------|
| [add_history](omni.kit.undo.history/omni.kit.undo.history.add_history.html) | Add a **Command** execution to the history. |
| [change_history](omni.kit.undo.history/omni.kit.undo.history.change_history.html) | Update the history entry for **key**. |
| [clear_history](omni.kit.undo.history/omni.kit.undo.history.clear_history.html) | Clear **Command** execution history. |
| [get_history](omni.kit.undo.history/omni.kit.undo.history.get_history.html) | Get **Command** execution history. |
| [get_history_item](omni.kit.undo.history/omni.kit.undo.history.get_history_item.html) | |
| [lru_cache](omni.kit.undo.history/omni.kit.undo.history.lru_cache.html) | Least-recently-used cache decorator. |
| [namedtuple](omni.kit.undo.history/omni.kit.undo.history.namedtuple.html) | Returns a new subclass of tuple with named fields. |
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
}); | 1,431 |
omni.kit.undo.history.namedtuple.md | # namedtuple
## namedtuple
```python
omni.kit.undo.history.namedtuple(typename, field_names, *, rename=False, defaults=None, module=None)
```
Returns a new subclass of tuple with named fields.
```python
>>> Point = namedtuple('Point', ['x', 'y'])
>>> Point.__doc__ # docstring for the new class
'Point(x, y)'
>>> p = Point(11, y=22) # instantiate with positional args or keywords
>>> p[0] + p[1] # indexable like a plain tuple
33
>>> x, y = p # unpack like a regular tuple
>>> x, y
(11, 22)
>>> p.x + p.y # fields also accessible by name
33
>>> d = p._asdict() # convert to a dictionary
>>> d['x']
```
11
>>> Point(**d) # convert from a dictionary
Point(x=11, y=22)
>>> p._replace(x=100) # _replace() is like str.replace() but targets named fields
Point(x=100, y=22) | 915 |
omni.kit.undo.history.OrderedDict.md | # OrderedDict
## Methods
- `__init__(*args, **kwargs)`
- `clear()`
- `copy()`
- `fromkeys([value])`
- Create a new ordered dictionary with keys from iterable and values set to value.
- `items()`
- `keys()`
- `move_to_end()`
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
move_to_end
(key[, last])
Move an existing element to the end (or beginning if last is false).
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
pop
(key[,default])
If the key is not found, return the default if given; otherwise, raise a KeyError.
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
popitem
([last])
Remove and return a (key, value) pair from the dictionary.
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
setdefault
(key[, default])
Insert key with a value of default if key is not in the dictionary.
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
update
([E, ]**F)
If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
values
()
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.undo.history.OrderedDict.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
<span class="sig-paren">
(
<em class="sig-param">
<span class="o">
<span class="pre">
*
<span class="n">
<span class="pre">
args
,
<em class="sig-param">
<span class="o">
<span class="pre">
**
<span class="n">
<span class="pre">
kwargs
<span class="sig-paren">
)
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.undo.history.OrderedDict.clear">
<span class="sig-name descname">
<span class="pre">
clear
<span class="sig-paren">
(
<span class="sig-paren">
)
<span class="sig-return">
<span class="sig-return-icon">
→
<span class="sig-return-typehint">
<span class="pre">
None.
<span class="pre">
Remove
<span class="pre">
all
<span class="pre">
items
<span class="pre">
from
<span class="pre">
od.
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.undo.history.OrderedDict.copy">
<span class="sig-name descname">
<span class="pre">
copy
<span class="sig-paren">
(
<span class="sig-paren">
)
<span class="sig-return">
<span class="sig-return-icon">
→
<span class="sig-return-typehint">
<span class="pre">
a
<span class="pre">
shallow
<span class="pre">
copy
<span class="pre">
of
<span class="pre">
od
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.undo.history.OrderedDict.fromkeys">
<span class="sig-name descname">
<span class="pre">
fromkeys
<span class="sig-paren">
(
<em class="sig-param">
<span class="n">
<span class="pre">
value
<span class="o">
<span class="pre">
=
<span class="default_value">
<span class="pre">
None
<span class="sig-paren">
)
<dd>
<p>
Create a new ordered dictionary with keys from iterable and values set to value.
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.undo.history.OrderedDict.items">
<span class="sig-name descname">
<span class="pre">
items
<span class="sig-paren">
(
<span class="sig-paren">
)
<span class="sig-return">
<span class="sig-return-icon">
→
<span class="sig-return-typehint">
<span class="pre">
a
<span class="pre">
set-like
<span class="pre">
object
<span class="pre">
providing
### items
- **Description**: Provides a view on D's items.
### keys
- **Description**: Provides a set-like object providing a view on D's keys.
### move_to_end
- **Parameters**:
- `key`
- `last = True`
- **Description**: Move an existing element to the end (or beginning if last is false). Raise KeyError if the element does not exist.
### pop
- **Parameters**:
- `key`
- `default` (optional)
- **Description**: If the key is not found, return the default if given; otherwise, raise a KeyError.
### popitem
- **Parameters**:
- `last = True`
- **Description**: Remove and return a (key, value) pair from the dictionary. Pairs are returned in LIFO order if last is true or FIFO order if false.
### setdefault
- **Parameters**:
- `key`
- `default = None`
- **Description**: Insert key with a value of default if key is not in the dictionary. Return the value for key if key is in the dictionary, else default.
### update
- **Parameters**:
- `E` (optional)
- `**F`
- **Description**: Update the dictionary with the key/value pairs from E and F, overwriting existing keys.
### Update
D from dict/iterable
E and F.
If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
In either case, this is followed by: for k in F: D[k] = F[k]
### values
()
→ an object providing a view on D's values | 4,998 |
omni.kit.undo.md | # omni.kit.undo
## Submodules
Summary:
- [omni.kit.undo.history](omni.kit.undo.history.html)
- No submodule docstring provided
## Functions
Summary:
- [begin_disabled](omni.kit.undo/omni.kit.undo.begin_disabled.html)
- Begin preventing **Commands** being added to the undo stack.
- [begin_group](omni.kit.undo/omni.kit.undo.begin_group.html)
- Begin group of **Commands**.
- [can_redo](omni.kit.undo/omni.kit.undo.can_redo.html)
- [can_repeat](omni.kit.undo/omni.kit.undo.can_repeat.html)
- [can_undo](omni.kit.undo/omni.kit.undo.can_undo.html)
- [clear_history](omni.kit.undo/omni.kit.undo.clear_history.html)
- Clear **Command** execution history.
- [clear_stack](omni.kit.undo/omni.kit.undo.clear_stack.html)
- [disabled](omni.kit.undo/omni.kit.undo.disabled.html)
- Prevent commands being added to the undo stack.
- [end_disabled](omni.kit.undo/omni.kit.undo.end_disabled.html)
- Stop preventing **Commands** being added to the undo stack.
- [end_group](omni.kit.undo/omni.kit.undo.end_group.html)
- End group of **Commands**.
- [execute](omni.kit.undo/omni.kit.undo.execute.html)
- [format_exception](omni.kit.undo/omni.kit.undo.format_exception.html)
## Table of Contents
### Functions
- **format_exception**
- Pretty format exception. Include exception info, call stack of exception itself and this function callstack.
- **get_history**
- Get **Command** execution history.
- **get_redo_stack**
- (No description provided)
- **get_undo_stack**
- (No description provided)
- **group**
- Group multiple commands in one.
- **redo**
- (No description provided)
- **register_undo_commands**
- (No description provided)
- **repeat**
- (No description provided)
- **subscribe_on_change**
- (No description provided)
- **subscribe_on_change_detailed**
- (No description provided)
- **undo**
- (No description provided)
- **unsubscribe_on_change**
- (No description provided)
- **unsubscribe_on_change_detailed**
- (No description provided) | 1,981 |
Subsets and Splits