file_path
stringlengths 5
148
| content
stringlengths 150
498k
| size
int64 150
498k
|
|---|---|---|
omni.kit.converter.dgn.DgnConverter.md | # DgnConverter
## Class
```python
class omni.kit.converter.dgn.DgnConverter(omni.ext._extensions.IExt)
```
### Methods
```python
def on_shutdown():
pass
def on_startup(ext_id):
pass
```
### Attributes
```python
FILTER_DATA
```
### Initializer
```python
def __init__(self: omni.ext._extensions.IExt) -> None:
pass
```
### Attribute
```python
DELEGATE = omni.kit.converter.dgn.delegate.DgnConverterDelegate
```
# 标题1
这是一个段落，包含一个链接。
```
这是一段代码。
```
描述图片的文本
--- | 479 |
omni.kit.converter.dgn.DgnConverterDelegate.md | # DgnConverterDelegate
## Methods
- `__init__(name, filters, descriptions)`
- `build_options(paths)`
- Options pane builder for file picker after paths are selected.
- `convert_assets(paths, **kargs)`
- The real worker to convert assets.
- `create_temp_json(import_path)`
- `destroy()`
- `launch_kit_app(file_path, output_path)`
| Function Name | Description |
|---------------|-------------|
| `supports_usd_stage_cache()` | Whether the importer can write to UsdStageCache for us to retrieve data from |
| Attribute Name | Description |
|----------------|-------------|
| `filter_descriptions` | List of descriptions for each regex filter. |
| `filter_regexes` | List of regex filters of this importer supported. |
| `name` | [No description provided] |
### __init__(name, filters, descriptions)
[No description provided]
### build_options(paths)
Options pane builder for file picker after paths are selected. It will only include those paths that are supported by this importer filtered with regex filters.
- **Parameters**
- **paths** (List[str]) – The list of selected paths from file picker.
### async convert_assets(paths, **kwargs)
The real worker to convert assets. It will only include those paths that are supported by this importer filtered with regex filters.
- **Parameters**
- **paths** (List[str]) – The list of selected paths from file picker.
- **kwargs** – Optional arguments. Following args are supported currently: add_reference: If it will be added into stage after convert.
- **Returns**
- The key is the asset path to be converted, and the value is the target path or stage ID within UsdStageCache that this asset converted to.
If value is None, it means it’s failed to be converted.
### Return type
Dict[str, Union[str, None]]
### supports_usd_stage_cache
```python
supports_usd_stage_cache() -> bool
```
Whether the importer can write to UsdStageCache for us to retrieve data from
### filter_descriptions
```python
property filter_descriptions : List[str]
```
List of descriptions for each regex filter. It will be used for filter description in the file picker.
#### Parameters
None –
#### Returns
List of regex descriptions.
### filter_regexes
```python
property filter_regexes : List[str]
```
List of regex filters of this importer supported. It’s provided as a list because it’s possible that the importer will support multiple formats and share the same options list.
#### Parameters
None –
#### Returns
List of regex strings. | 2,487 |
omni.kit.converter.dgn.Functions.md | # omni.kit.converter.dgn Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| `get_instance` | If available, returns the weakref pointer | | 175 |
omni.kit.converter.dgn.get_instance.md | # get_instance
## get_instance
```python
omni.kit.converter.dgn.get_instance()
```
Returns: Optional[DgnConverter]
If available, returns the weakref pointer
``` | 163 |
omni.kit.converter.dgn.md | # omni.kit.converter.dgn
## Classes Summary
- **DgnConverter**
- Base Cad Converter Extension Class
- **DgnConverterDelegate**
- AbstractImporterDelegate is abstract class for extending
## Functions Summary
- **get_instance**
- If available, returns the weakref pointer | 276 |
omni.kit.converter.dgn_core.Classes.md | # omni.kit.converter.dgn_core Classes
## Classes Summary
- **DgnConverter**
- DGN Core Converter Extension
- **DgnConverterCoreHelper**
- Can be used to make calls to the DGN CAD Converter and for updating the USD stage
- **DgnOptionsStandin**
- Temp standin object for dgn options
- **OdaDgnOptions**
- Oda Dgn Specification | 338 |
omni.kit.converter.dgn_core.DgnConverter.md | # DgnConverter
## Class omni.kit.converter.dgn_core.DgnConverter
Bases: omni.kit.converter.common.cad_core_ext_base.ICadCoreExtBase
DGN Core Converter Extension
### Methods
- **create_converter_task**(input_path, ...)
- **on_shutdown**()
- Uninitialize the DGN Converter and/or un-registers the service
- **on_startup**(ext_id)
- Initialize the DGN Converter and/or registers the service
### Attributes
- **FILTER_DATA**
- **SERVICE_TITLE**
## omni.kit.converter.dgn_core.DgnConverter.__init__
__init__(self: omni.ext._extensions.IExt)
## omni.kit.converter.dgn_core.DgnConverter.__init__
- **Return Type**: None
## omni.kit.converter.dgn_core.DgnConverter.OPTIONS_CLS
- **Description**: alias of `omni.kit.converter.dgn_core.impl.options.OdaDgnOptions`
## omni.kit.converter.dgn_core.DgnConverter.on_shutdown
- **Description**: Uninitialize the DGN Converter and/or un-registers the service
## omni.kit.converter.dgn_core.DgnConverter.on_startup
- **Parameters**:
- ext_id
- **Description**: Initialize the DGN Converter and/or registers the service | 1,066 |
omni.kit.converter.dgn_core.DgnConverterCoreHelper.md | # DgnConverterCoreHelper
## Overview
Bases: `object`
Can be used to make calls to the DGN CAD Converter and for updating the USD stage
### Methods
| Name | Description |
| --- | --- |
### Attributes
| Name | Description |
| --- | --- |
| `CONVERTER_EXT_NAME` | |
## Details
### `__init__()` | 301 |
omni.kit.converter.dgn_core.DgnOptionsStandin.md | # DgnOptionsStandin
## DgnOptionsStandin
```python
class omni.kit.converter.dgn_core.DgnOptionsStandin(bInstancing: bool = True, bOptimize: bool = True, bConvertHidden: bool = False, dSurfaceTolerance: float = 0.2)
```
Bases: `omni.kit.converter.common.common.BaseOptions`
Temp standin object for dgn options
### Methods
- `__init__(bInstancing: bool = True, bOptimize: bool = True, bConvertHidden: bool = False, dSurfaceTolerance: float = 0.2)`
| Attributes |
| --- |
| `bConvertHidden` |
| `bInstancing` |
| `bOptimize` |
| `dSurfaceTolerance` |
```python
__init__(bInstancing: bool = True, bOptimize: bool = True, bConvertHidden: bool = False, dSurfaceTolerance: float = 0.2) -> None
```
``` | 700 |
omni.kit.converter.dgn_core.impl.Classes.md | # omni.kit.converter.dgn_core.impl Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| DgnConverter | DGN Core Converter Extension |
| DgnConverterCoreHelper | Can be used to make calls to the DGN CAD Converter and for updating the USD stage |
| DgnOptionsStandin | Temp standin object for dgn options |
| OdaDgnOptions | Oda Dgn Specification | | 383 |
omni.kit.converter.dgn_core.impl.DgnConverter.md | # DgnConverter
## Class: omni.kit.converter.dgn_core.impl.DgnConverter
Bases: `omni.kit.converter.common.cad_core_ext_base.ICadCoreExtBase`
DGN Core Converter Extension
### Methods
- `create_converter_task(input_path, ...)`
- `on_shutdown()`
- Uninitialize the DGN Converter and/or un-registers the service
- `on_startup(ext_id)`
- Initialize the DGN Converter and/or registers the service
### Attributes
- `FILTER_DATA`
- `SERVICE_TITLE`
## Method: omni.kit.converter.dgn_core.impl.DgnConverter.__init__(self)`
<span class="w">
<span class="n">
<span class="pre">
omni.ext._extensions.IExt
<span class="sig-paren">
)
<span class="sig-return">
<span class="sig-return-icon">
→
<span class="sig-return-typehint">
<span class="pre">
None
<dt>
<dd>
<dl class="py attribute">
<dt class="sig sig-object py" id="omni.kit.converter.dgn_core.impl.DgnConverter.OPTIONS_CLS">
<span class="sig-name descname">
<span class="pre">
OPTIONS_CLS
<dd>
<p>
alias of
<code class="xref py py-class docutils literal notranslate">
<span class="pre">
omni.kit.converter.dgn_core.impl.options.OdaDgnOptions
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.dgn_core.impl.DgnConverter.on_shutdown">
<span class="sig-name descname">
<span class="pre">
on_shutdown
<span class="sig-paren">
(
<span class="sig-paren">
)
<dd>
<p>
Uninitialize the DGN Converter and/or un-registers the service
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.dgn_core.impl.DgnConverter.on_startup">
<span class="sig-name descname">
<span class="pre">
on_startup
<span class="sig-paren">
(
<em class="sig-param">
<span class="n">
<span class="pre">
ext_id
<span class="sig-paren">
)
<dd>
<p>
Initialize the DGN Converter and/or registers the service
<footer>
<hr/>
| 1,931 |
omni.kit.converter.dgn_core.impl.DgnConverterCoreHelper.md | # DgnConverterCoreHelper
## Overview
Can be used to make calls to the DGN CAD Converter and for updating the USD stage
### Methods
-
### Attributes
- `CONVERTER_EXT_NAME`
## Details
### Initialization
- `__init__()` | 224 |
omni.kit.converter.dgn_core.impl.DgnOptionsStandin.md | # DgnOptionsStandin
Temp standin object for dgn options
## Methods
- **__init__**
- **Parameters**:
- `bInstancing: bool = True`
- `bOptimize: bool = True`
- `bConvertHidden: bool = False`
- `dSurfaceTolerance: float = 0.2`
- **Bases**: `omni.kit.converter.common.common.BaseOptions`
# Attributes
| Attribute | Description |
|-----------------|-------------|
| `bConvertHidden` | |
| `bInstancing` | |
| `bOptimize` | |
| `dSurfaceTolerance` | |
## Method Details
### `__init__(bInstancing: bool = True, bOptimize: bool = True, bConvertHidden: bool = False, dSurfaceTolerance: float = 0.2) -> None`
- **bInstancing**: bool = True
- **bOptimize**: bool = True
- **bConvertHidden**: bool = False
- **dSurfaceTolerance**: float = 0.2
Returns: None | 826 |
omni.kit.converter.dgn_core.impl.extension.md | # omni.kit.converter.dgn_core.impl.extension
## Classes Summary
- **DgnConverter**
- DGN Core Converter Extension
- **DgnConverterCoreHelper**
- Can be used to make calls to the DGN CAD Converter and for updating the USD stage
- **DgnOptionsStandin**
- Temp standin object for dgn options
- **OdaDgnOptions**
- Oda Dgn Specification
## Functions Summary
- **get_instance**
- If available, returns the weakref pointer | 433 |
omni.kit.converter.dgn_core.impl.filters.Classes.md | # omni.kit.converter.dgn_core.impl.filters Classes
## Classes Summary
- **ConverterFilterData**
- Used to hold information about a CAD Converters supported file types | 170 |
omni.kit.converter.dgn_core.impl.Functions.md | # omni.kit.converter.dgn_core.impl Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| [get_instance](#) | If available, returns the weakref pointer | | 188 |
omni.kit.converter.dgn_core.impl.get_instance.md | # get_instance
## get_instance
```python
omni.kit.converter.dgn_core.impl.get_instance() -> Optional[omni.kit.converter.dgn_core.impl.extension.DgnConverter]
```
If available, returns the weakref pointer | 205 |
omni.kit.converter.dgn_core.impl.helper.Classes.md | # omni.kit.converter.dgn_core.impl.helper Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| [DgnConverterCoreHelper](omni.kit.converter.dgn_core.impl.helper/omni.kit.converter.dgn_core.impl.helper.DgnConverterCoreHelper.html) | Can be used to make calls to the DGN CAD Converter and for updating the USD stage | | 351 |
omni.kit.converter.dgn_core.impl.helper.md | # omni.kit.converter.dgn_core.impl.helper
## Classes Summary:
- **DgnConverterCoreHelper**
- Can be used to make calls to the DGN CAD Converter and for updating the USD stage | 178 |
omni.kit.converter.dgn_core.impl.md | # omni.kit.converter.dgn_core.impl
## Submodules Summary
- [omni.kit.converter.dgn_core.impl.extension](omni.kit.converter.dgn_core.impl.extension.html)
- No submodule docstring provided
- [omni.kit.converter.dgn_core.impl.filters](omni.kit.converter.dgn_core.impl.filters.html)
- No submodule docstring provided
- [omni.kit.converter.dgn_core.impl.helper](omni.kit.converter.dgn_core.impl.helper.html)
- No submodule docstring provided
- [omni.kit.converter.dgn_core.impl.options](omni.kit.converter.dgn_core.impl.options.html)
- No submodule docstring provided
## Classes Summary
- [DgnConverter](omni.kit.converter.dgn_core.impl/omni.kit.converter.dgn_core.impl.DgnConverter.html)
- DGN Core Converter Extension
- [DgnConverterCoreHelper](omni.kit.converter.dgn_core.impl/omni.kit.converter.dgn_core.impl.DgnConverterCoreHelper.html)
- Can be used to make calls to the DGN CAD Converter and for updating the USD stage
- [DgnOptionsStandin](omni.kit.converter.dgn_core.impl/omni.kit.converter.dgn_core.impl.DgnOptionsStandin.html)
- Temp standin object for dgn options
- [OdaDgnOptions](omni.kit.converter.dgn_core.impl/omni.kit.converter.dgn_core.impl.OdaDgnOptions.html)
- Oda Dgn Specification
## Functions Summary
- [get_instance](omni.kit.converter.dgn_core.impl/omni.kit.converter.dgn_core.impl.get_instance.html)
- If available, returns the weakref pointer | 1,389 |
omni.kit.converter.dgn_core.impl.OdaDgnOptions.md | # OdaDgnOptions
## OdaDgnOptions
```python
class omni.kit.converter.dgn_core.impl.OdaDgnOptions:
def __init__(
sConfigFilePath: str = '',
sFilePathIn: str = '',
sFilePathOut: str = '',
bInstancing: bool = True,
bOptimize: bool = True,
bDedup: bool = True
):
pass
bool = True
,
iTessLOD : int = 2
,
bUseMaterials : bool = True
,
bReportProgress : bool = True
,
_bUseCurrentStage : bool = True
,
bLogFile : bool = True
,
sKind : str = ''
,
bHideLevelsByList : bool = True
,
bImportAttributesByList : bool = True
)
Bases:
```
omni.kit.converter.dgn_core.impl.options.SharedCADConverterOptions
```
Oda Dgn Specification
sConfigFilePath: configuration file path
Type: str
sFilePathIn: path to input model head file
Type: str
sFilePathOut: path to output file
Type: str
path to output usd file
- **Type**: str
bInstancing
- are we instancing or not
- **Type**: bool
bOptimize
- run UJITSO optimization on completed usd files
- **Type**: bool
bDedup
- deduplicate mesh vertices and normals (welds mesh)
- **Type**: bool
iTessLOD
- Tessellation Level of Detail presets: 0=kA3DTessLODExtraLow, 1=kA3DTessLODLow, 2=kA3DTessLODMedium, 3=kA3DTessLODHigh, 4=kA3DTessLODExtraHigh
- **Type**: int
bUseMaterials
- if true then use whatever modes of materials are called for. if false, then use only basic display colors
- **Type**: bool
bLogFile
- log file per converted file
- **Type**: bool
sKind
- USD Kind
- **Type**: str
bHideLevelsByList
- true means listed levels will be hidden (does not mean they are or are not converted); false means all converted levels are visible
- **Type**: bool
bImportAttributesByList
- all listed custom attributes will be imported
- **Type**: bool
## Methods
- `__init__` (sConfigFilePath, sFilePathIn, ...)
## Attributes
- bHideLevelsByList
bHideLevelsByList
bImportAttributesByList
bLogFile
sKind
__init__(sConfigFilePath: str = '', sFilePathIn: str = '', sFilePathOut: str = '', bInstancing: bool = True, bOptimize: bool = True, bDedup: bool = True, iTessLOD: int = 2, bUseMaterials: bool = True, bReportProgress: bool = True)
bool = True,
_bUseCurrentStage: bool = True,
bLogFile: bool = True,
sKind: str = '',
bHideLevelsByList: bool = True,
bImportAttributesByList: bool = True
)
→ None | 2,297 |
omni.kit.converter.dgn_core.impl.options.Classes.md | # omni.kit.converter.dgn_core.impl.options Classes
## Classes Summary
- **DgnOptionsStandin**
- Temp standin object for dgn options
- **OdaDgnOptions**
- Oda Dgn Specification | 182 |
omni.kit.converter.dgn_core.impl.Submodules.md | # omni.kit.converter.dgn_core.impl Submodules
## Submodules Summary
- **omni.kit.converter.dgn_core.impl.extension**
- No submodule docstring provided
- **omni.kit.converter.dgn_core.impl.filters**
- No submodule docstring provided
- **omni.kit.converter.dgn_core.impl.helper**
- No submodule docstring provided
- **omni.kit.converter.dgn_core.impl.options**
- No submodule docstring provided | 405 |
omni.kit.converter.dgn_core.OdaDgnOptions.md | # OdaDgnOptions
## Description
```python
class omni.kit.converter.dgn_core.OdaDgnOptions:
def __init__(
sConfigFilePath: str = '',
sFilePathIn: str = '',
sFilePathOut: str = '',
bInstancing: bool = True,
bOptimize: bool = True,
bDedup: bool = True
):
```
## Parameters
- `sConfigFilePath`: The path to the configuration file. Default is an empty string.
- `sFilePathIn`: The input file path. Default is an empty string.
- `sFilePathOut`: The output file path. Default is an empty string.
- `bInstancing`: A boolean indicating whether to use instancing. Default is `True`.
- `bOptimize`: A boolean indicating whether to optimize. Default is `True`.
- `bDedup`: A boolean indicating whether to deduplicate. Default is `True`.
```
Bases:
```python
omni.kit.converter.dgn_core.impl.options.SharedCADConverterOptions
```
Oda Dgn Specification
### sConfigFilePath
configuration file path
- Type: str
### sFilePathIn
path to input model head file
- Type: str
### sFilePathOut
path to output usd file
- Type: str
### bInstancing
are we instancing or not
- **Type**: bool
### bOptimize
run UJITSO optimization on completed usd files
- **Type**: bool
### bDedup
deduplicate mesh vertices and normals (welds mesh)
- **Type**: bool
### iTessLOD
Tessellation Level of Detail presets: 0=kA3DTessLODExtraLow, 1=kA3DTessLODLow, 2=kA3DTessLODMedium, 3=kA3DTessLODHigh, 4=kA3DTessLODExtraHigh
- **Type**: int
### bUseMaterials
if true then use whatever modes of materials are called for. if false, then use only basic display colors
- **Type**: bool
### bLogFile
log file per converted file
- **Type**: bool
### sKind
USD Kind
- **Type**: str
### bHideLevelsByList
true means listed levels will be hidden (does not mean they are or are not converted); false means all converted levels are visible
- **Type**: bool
### bImportAttributesByList
all listed custom attributes will be imported
- **Type**: bool
### Methods
| Method | Description |
|--------|-------------|
| `__init__` ([sConfigFilePath, sFilePathIn, ...]) | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `bHideLevelsByList` | |
| `bImportAttributesByList` | |
bImportAttributesByList
bLogFile
sKind
__init__(sConfigFilePath: str = '', sFilePathIn: str = '', sFilePathOut: str = '', bInstancing: bool = True, bOptimize: bool = True, bDedup: bool = True, iTessLOD: int = 2, bUseMaterials: bool = True, bReportProgress: bool = True)
_bUseCurrentStage : bool = True
bLogFile : bool = True
sKind : str = ''
bHideLevelsByList : bool = True
bImportAttributesByList : bool = True
)
→ None | 2,629 |
omni.kit.converter.hoops.Classes.md | # omni.kit.converter.hoops Classes
## Classes Summary:
| Class | Description |
| --- | --- |
| [HoopsConverter](omni.kit.converter.hoops/omni.kit.converter.hoops.HoopsConverter.html) | Base Cad Converter Extension Class |
| [HoopsConverterDelegate](omni.kit.converter.hoops/omni.kit.converter.hoops.HoopsConverterDelegate.html) | CAD Converter delegate implementation for Asset Importer AbstractImporterDelegate. | | 416 |
omni.kit.converter.hoops.Functions.md | # omni.kit.converter.hoops Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| [get_instance](omni.kit.converter.hoops/omni.kit.converter.hoops.get_instance.html) | If available, returns the weakref pointer | | 246 |
omni.kit.converter.hoops.get_instance.md | # get_instance
## get_instance
```python
omni.kit.converter.hoops.get_instance()
```
Returns: Optional[HoopsConverter]
If available, returns the weakref pointer. | 164 |
omni.kit.converter.hoops.HoopsConverter.md | # HoopsConverter
## Methods
- `on_shutdown()`
- `on_startup(ext_id)`
## Attributes
- `FILTER_DATA`
### `__init__(self: omni.ext._extensions.IExt) -> None`
### `DELEGATE`
- alias of `omni.kit.converter.hoops.delegate.HoopsConverterDelegate` | 245 |
omni.kit.converter.hoops.HoopsConverterDelegate.md | # HoopsConverterDelegate
## Class: omni.kit.converter.hoops.HoopsConverterDelegate
### Constructor
- **__init__(name, filters, descriptions)**
### Methods
- **build_options(paths)**
- Options pane builder for file picker after paths are selected.
- **convert_assets(paths, **kargs)**
- The real worker to convert assets.
- **destroy()**
- **supports_usd_stage_cache()**
- Whether the importer can write to UsdStageCache for us to retrieve data from
Bases: omni.kit.tool.asset_importer.importer_delegate.AbstractImporterDelegate
CAD Converter delegate implementation for Asset Importer AbstractImporterDelegate.
## Attributes
| | |
|--------|-----------------------------------------------------------------|
| filter_descriptions | List of descriptions for each regex filter. |
| filter_regexes | List of regex filters of this importer supported. |
| name | |
## __init__
```python
__init__(name, filters, descriptions)
```
## build_options
```python
build_options(paths)
```
Options pane builder for file picker after paths are selected. It will only include those paths that are supported by this importer filtered with regex filters.
**Parameters:**
- **paths** (List[str]) – The list of selected paths from file picker.
## convert_assets
```python
async convert_assets(paths, **kwargs)
```
The real worker to convert assets. It will only include those paths that are supported by this importer filtered with regex filters.
**Parameters:**
- **paths** (List[str]) – The list of selected paths from file picker.
- ****kwargs** – Optional arguments. Following args are supported currently: add_reference: If it will be added into stage after convert.
**Returns:**
- The key is the asset path to be converted, and the value is the target path or stage ID within UsdStageCache that this asset converted to. If value is None, it means it’s failed to be converted.
**Return type:**
- Dict[str, Union[str, None]]
## supports_usd_stage_cache
```python
supports_usd_stage_cache()
```
Whether the importer can write to UsdStageCache for us to retrieve data from
## filter_descriptions
```python
property filter_descriptions
```
List of descriptions for each regex filter. It will be used for filter description in the file picker.
### Parameters
None –
### Returns
List of regex descriptions.
### filter_regexes
List of regex filters of this importer supported. It’s provided as a list because it’s possible that the importer will support multiple formats and share the same options list.
#### Parameters
None –
#### Returns
List of regex strings. | 2,755 |
omni.kit.converter.hoops.md | # omni.kit.converter.hoops
## Classes Summary
- **HoopsConverter**
- Base Cad Converter Extension Class
- **HoopsConverterDelegate**
- CAD Converter delegate implementation for Asset Importer AbstractImporterDelegate.
## Functions Summary
- **get_instance**
- If available, returns the weakref pointer | 309 |
omni.kit.converter.hoops_core.acquire_interface.md | # acquire_interface
## Functions
### acquire_interface
```python
omni.kit.converter.hoops_core.acquire_interface(plugin_name: str = None, library_path: str = None) -> omni.kit.converter.hoops_core._hoops_cad_converter.HoopsExchangeCadConverter
```
``` | 258 |
omni.kit.converter.hoops_core.CadRequest.md | # CadRequest
## CadRequest
Generic request object. Can be used to retrieve result after completing.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(*args, **kwargs)` | |
| `is_finished(self)` | Status of request. |
#### `__init__(*args, **kwargs)`
#### `is_finished(self)`
Status of request. Returns true if request complete.
这是一个段落，包含一个链接 Example Link.
```
这是一个代码块。
```
描述图片的文本 | 414 |
omni.kit.converter.hoops_core.Classes.md | # omni.kit.converter.hoops_core Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| [CadRequest](#) | Generic request object. Can be used to retrieve result after completing. |
| [HoopsConverterHelper](#) | Can be used to make calls to the CAD converter and for updating the USD stage |
| [HoopsCoreConverter](#) | Hoops Core Converter Extension |
| [HoopsExchangeCadConverter](#) | Initialize interface class |
| [HoopsOptions](#) | Please defer to the hoopsExchangeCADConverterSpec base class for a list of all HoopsOptions converter settings |
| [hoopsExchangeCADConverterSpec](#) | HoopsExchangeCADConverter Options Class. | | 658 |
omni.kit.converter.hoops_core.HoopsConverterHelper.md | # HoopsConverterHelper
## Methods
- `__init__()`
- Initialize Hoops Converter Helper class
- `cancel_task()`
- Cancel CAD file conversion
- `create_import_task(converter_options)`
- Wraps the Hoops Exchange CAD Converter so that it works with Nucleus files.
- `destroy()`
- Clean up resources
- `get_cached_stage_id()`
- `set_progress_changed_callback(cb)`
- Set change in progress
<p>
set_step_changed_callback (cb)
<p>
Set change in step
<p class="rubric">
Attributes
<p>
CONVERTER_EXT_NAME
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.hoops_core.HoopsConverterHelper.__init__">
<span class="sig-name descname"><span class="pre">__init__
<span class="sig-paren">()
<dd>
<p>
Initialize Hoops Converter Helper class
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.hoops_core.HoopsConverterHelper.cancel_task">
<span class="sig-name descname"><span class="pre">cancel_task
<span class="sig-paren">()
<dd>
<p>
Cancel CAD file conversion
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.hoops_core.HoopsConverterHelper.create_import_task">
<em class="property"><span class="pre">async
<span class="sig-name descname"><span class="pre">create_import_task
<span class="sig-paren">()
<em class="sig-param"><span class="n"><span class="pre">converter_options
<span class="sig-return"><span class="sig-return-icon">→
<dd>
<p>
Wraps the Hoops Exchange CAD Converter so that it works with Nucleus files.
<dl class="field-list simple">
<dt class="field-odd">
Parameters
<dd class="field-odd">
<p>
<strong>converter_options
<dt class="field-even">
Returns
<dd class="field-even">
<p>
Final output destination URL.
hoops_convert_status(namedtuple): Hoops error code and associated message
<dt class="field-odd">
Return type
<dd class="field-odd">
<p>
output_destination_url (str)
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.hoops_core.HoopsConverterHelper.destroy">
<span class="sig-name descname"><span class="pre">destroy
<span class="sig-paren">()
<dd>
<p>
Clean up resources
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.hoops_core.HoopsConverterHelper.set_progress_changed_callback">
<span class="sig-name descname"><span class="pre">set_progress_changed_callback
<span class="sig-paren">()
<em class="sig-param"><span class="n"><span class="pre">cb
<dd>
<p>
Set change in progress
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.hoops_core.HoopsConverterHelper.set_step_changed_callback">
<span class="sig-name descname"><span class="pre">set_step_changed_callback
<span class="sig-paren">()
<em class="sig-param"><span class="n"><span class="pre">cb
<dd>
<p>
Set change in step
| 2,802 |
omni.kit.converter.hoops_core.HoopsCoreConverter.md | # HoopsCoreConverter
## Summary
Bases: `omni.kit.converter.common.cad_core_ext_base.ICadCoreExtBase`
Hoops Core Converter Extension
### Methods
| Method | Description |
| --- | --- |
| `create_converter_task(converter_options[, ...])` | Converts CAD file (import_path) to USD (output_path) |
| `on_shutdown()` | Uninitialize the Hoops Converter and/or un-registers the service |
| `on_startup(ext_id)` | Initialize the Hoops Converter and/or un-registers the service |
### Attributes
| Attribute | Description |
| --- | --- |
| `FILTER_DATA` | |
| `SERVICE_TITLE` | |
<section>
<dl class="py attribute">
<dt class="sig sig-name descname">
<span class="pre">
OPTIONS_CLS
<dd>
<p>
alias of
<code class="xref py py-class docutils literal notranslate">
<span class="pre">
omni.kit.converter.hoops_core._impl.options.HoopsOptions
<dl class="py method">
<dt class="sig sig-name descname">
<span class="pre">
create_converter_task
<dd>
<p>
Converts CAD file (import_path) to USD (output_path)
<p>
Returns: An object containing the Path to the converted USD (str) and converter status (namedtuple).
<p>
If the path is empty, the conversion has failed.
<p>
The namedtuple contains error code (int) and error message (str).
<dl class="field-list simple">
<dt class="field-odd">
Parameters
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
converter_options
– converter settings object
<li>
<p>
<strong>
progress_changed_callback
– callback function (progress_text:str, progress_value:float)
<li>
<p>
<strong>
step_changed_callback
– callback function (step_text:str)
<dl class="py method">
<dt class="sig sig-name descname">
<span class="pre">
on_shutdown
<dd>
<p>
Uninitialize the Hoops Converter and/or un-registers the service
<dl class="py method">
<dt class="sig sig-name descname">
<span class="pre">
on_startup
<dd>
<p>
Initialize the Hoops Converter and/or un-registers the service
| 2,621 |
omni.kit.converter.hoops_core.HoopsExchangeCadConverter.md | # HoopsExchangeCadConverter
## Class: omni.kit.converter.hoops_core.HoopsExchangeCadConverter
Initialize interface class
### Methods
- **__init__(*args, **kwargs)**
- **cancel_convert(self)**
Cancel CAD file conversion
- **convert_file(self, configPath)**
Convert file using JSON config file path
- **convert_file_with_callback(self, configPath, ...)**
Enables asynchronous file conversion when used with convert_file()
- **convert_object(self, configObject)**
Converts file using JSON config object
- **convert_object_with_callback(self, ...)**
Converts file using JSON config object with callback
Enables asynchronous file conversion when used with convert_object()
`get_cached_stage_id(self)` (self)
Retrieves stage id
`set_progress_changed_callback(self, fn)` (self, fn)
Set change in progress
`set_step_changed_callback(self, fn)` (self, fn)
Set change in step
`__init__(self, *args, **kwargs)` (self, *args, **kwargs)
`cancel_convert(self)` (self)
Cancel CAD file conversion
`convert_file(self, configPath: str)` (self, configPath: str)
Convert file using JSON config file path
`convert_file_with_callback(self, configPath: str)` (self, configPath: str)
<span class="pre">:
<span class="w">
<span class="n">
<span class="pre">
str
,
<em class="sig-param">
<span class="n">
<span class="pre">
callback
<span class="p">
<span class="pre">:
<span class="w">
<span class="n">
<span class="pre">
Callable
<span class="p">
<span class="pre">
[
<span class="p">
<span class="pre">
[
<span class="pre">
Tuple
<span class="p">
<span class="pre">
[
<span class="pre">
int
<span class="p">
<span class="pre">
,
<span class="w">
<span class="pre">
str
<span class="p">
<span class="pre">
]
<span class="p">
<span class="pre">
]
<span class="p">
<span class="pre">
,
<span class="w">
<span class="pre">
None
<span class="p">
<span class="pre">
]
<span class="sig-paren">
)
<span class="sig-return">
<span class="sig-return-icon">
→
<span class="sig-return-typehint">
<span class="pre">
omni.kit.converter.hoops_core.CadRequest
<dd>
<p>
Enables asynchronous file conversion when used with convert_file()
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.hoops_core.HoopsExchangeCadConverter.convert_object">
<span class="sig-name descname">
<span class="pre">
convert_object
<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.kit.converter.hoops_core._hoops_cad_converter.HoopsExchangeCadConverter
,
<em class="sig-param">
<span class="n">
<span class="pre">
configObject
<span class="p">
<span class="pre">:
<span class="w">
<span class="n">
<span class="pre">
omni.kit.converter.hoops_core._hoops_cad_converter.hoopsExchangeCADConverterSpec
<span class="sig-paren">
)
<span class="sig-return">
<span class="sig-return-icon">
→
<span class="sig-return-typehint">
<span class="pre">
Tuple
<span class="p">
<span class="pre">
[
<span class="pre">
int
<span class="p">
<span class="pre">
,
<span class="w">
<span class="pre">
str
<span class="p">
<span class="pre">
]
<dd>
<p>
Converts file using JSON config object
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.hoops_core.HoopsExchangeCadConverter.convert_object_with_callback">
<span class="sig-name descname">
<span class="pre">
convert_object_with_callback
<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.kit.converter.hoops_core._hoops_cad_converter.HoopsExchangeCadConverter
,
<em class="sig-param">
<span class="n">
<span class="pre">
configObject
<span class="p">
<span class="pre">:
<span class="w">
<span class="n">
<span class="pre">
omni.kit.converter.hoops_core._hoops_cad_converter.hoopsExchangeCADConverterSpec
,
<em class="sig-param">
<span class="n">
<span class="pre">
callback
<span class="p">
<span class="pre">:
<span class="w">
<span class="n">
<span class="pre">
Callable
<span class="p">
<span class="pre">
[
<span class="p">
<span class="pre">
[
<span class="pre">
Tuple
<span class="p">
<span class="pre">
[
<span class="pre">
int
<span class="p">
<span class="pre">
,
<span class="w">
<span class="pre">
str
<span class="p">
<span class="pre">
]
<span class="p">
<span class="pre">
]
<span class="p">
<span class="pre">
,
<span class="w">
<span class="pre">
None
<span class="p">
<span class="pre">
]
<span class="sig-paren">
)
<dd>
<p>
Converts file using JSON config object
### omni.kit.converter.hoops_core.HoopsExchangeCadConverter.convert_object_with_callback
- **Description**: Enables asynchronous file conversion when used with convert_object()
### omni.kit.converter.hoops_core.HoopsExchangeCadConverter.get_cached_stage_id
- **Description**: Retrieves stage id
### omni.kit.converter.hoops_core.HoopsExchangeCadConverter.set_progress_changed_callback
- **Description**: Set change in progress
### omni.kit.converter.hoops_core.HoopsExchangeCadConverter.set_step_changed_callback
- **Description**: Set step change callback
<span class="pre">
None
<dt>
<a class="headerlink" href="#omni.kit.converter.hoops_core.HoopsExchangeCadConverter.set_step_changed_callback" title="Permalink to this definition">
<dd>
<p>
Set change in step
<footer>
<hr/>
| 5,521 |
omni.kit.converter.hoops_core.hoopsExchangeCADConverterSpec.md | # hoopsExchangeCADConverterSpec
## Class
class omni.kit.converter.hoops_core.hoopsExchangeCADConverterSpec
### Description
HoopsExchangeCADConverter Options Class.
### Methods
- `__init__(self)`
### Attributes
- `bAccurateSurfaceCurvatures`
- Consider surface curvature to control triangles elongation direction
- `bConvertHidden`
- If false, ignore hidden or non-visible parts during conversion.
- `bDedup`
- Deduplicate mesh vertices and normals (welds mesh)
- `bGlobalXforms`
- When instancing = false, this flag controls whether globalXforms are composited.
- `bInstancing`
- When true, use instancing for duplicated geometry.
| 参数 | 描述 |
| --- | --- |
| bInstancing | If true, enable instancing |
| bOptimize | Run UJITSO optimization on completed usd files |
| bReportProgress | If true then we report import/export progress |
| bReportProgressFreq | Progress reporting frequency in Hz. |
| bUseCurrentStage | Use currently opened USD. |
| bUseMaterials | If true then use specified modes of materials. |
| bUseNormals | If true then we pass normals to USD. |
| iTessLOD | 0=kA3DTessLODExtraLow, 1=kA3DTessLODLow,2=kA3DTessLODMedium, 3=kA3DTessLODHigh, 4=kA3DTessLODExtraHigh |
| sConfigFilePath | Configuration file path |
| sFilePathIn | Path to input model head file |
| sFilePathOut | Path to output usd file |
```python
__init__(self: omni.kit.converter.hoops_core._hoops_cad_converter.hoopsExchangeCADConverterSpec) -> None
```
```python
property bAccurateSurfaceCurvatures
```
Consider surface curvature to control triangles elongation direction
Type
: (bool)
bConvertHidden
: If false, ignore hidden or non-visible parts during conversion. If true, convert all parts and maintain visibility settings
Type
: (bool)
bDedup
: Deduplicate mesh vertices and normals (welds mesh)
Type
: (bool)
bGlobalXforms
: When instancing = false, this flag controls whether globalXforms are composited. If false local transforms are applied
Type
: (bool)
bInstancing
: If true, enable instancing
Type
: (bool)
bOptimize
: Run UJITSO optimization on completed usd files
Type
: (bool)
bReportProgress
: If true then we report import/export progress
Type
: (bool)
bReportProgressFreq
: Progress reporting frequency in Hz.
Type
: (int)
bUseCurrentStage
: Use currently opened USD.
Type
: (bool)
bUseMaterials
: Use materials.
Type
: (bool)
If true then use specified modes of materials. if false, then use only basic display colors
### Type
(bool)
### bUseNormals
If true then we pass normals to USD. if false, then we do not.
#### Type
(bool)
### iTessLOD
0=kA3DTessLODExtraLow, 1=kA3DTessLODLow,2=kA3DTessLODMedium, 3=kA3DTessLODHigh, 4=kA3DTessLODExtraHigh
#### Type
(int)
#### Type
Tessellation Level of Detail (LOD) presets
### sConfigFilePath
Configuration file path
#### Type
(str)
### sFilePathIn
Path to input model head file
#### Type
(str)
### sFilePathOut
Path to output usd file
#### Type
(str) | 2,986 |
omni.kit.converter.hoops_core.HoopsOptions.md | # HoopsOptions
## Overview
Bases:
- [hoopsExchangeCADConverterSpec](omni.kit.converter.hoops_core.hoopsExchangeCADConverterSpec.html#omni.kit.converter.hoops_core.hoopsExchangeCADConverterSpec)
- BaseOptions
Please defer to the hoopsExchangeCADConverterSpec base class for a list of all HoopsOptions converter settings.
### Methods
| Method | Description |
|--------|-------------|
| `__init__()` | Initialize the Hoops Exchange Converter Spec |
### Attributes
(No attributes listed)
## Detailed Method Description
### `__init__()`
Initialize the Hoops Exchange Converter Spec | 586 |
omni.kit.converter.hoops_core.md | # omni.kit.converter.hoops_core
## Classes Summary
- **CadRequest**
- Generic request object. Can be used to retrieve result after completing.
- **HoopsConverterHelper**
- Can be used to make calls to the CAD converter and for updating the USD stage
- **HoopsCoreConverter**
- Hoops Core Converter Extension
- **HoopsExchangeCadConverter**
- Initialize interface class
- **HoopsOptions**
- Please defer to the hoopsExchangeCADConverterSpec base class for a list of all HoopsOptions converter settings
- **hoopsExchangeCADConverterSpec**
- HoopsExchangeCADConverter Options Class.
## Functions Summary
- **get_instance**
- If available, returns the weakref pointer
- **acquire_interface**
- acquire_interface(plugin_name: str = None, library_path: str = None) -> omni.kit.converter.hoops_core._hoops_cad_converter.HoopsExchangeCadConverter
- **release_interface**
- release_interface(arg0: omni.kit.converter.hoops_core._hoops_cad_converter.HoopsExchangeCadConverter) -> None | 996 |
omni.kit.data2ui.core.Button.md | # Button
## Button
```python
class omni.kit.data2ui.core.Button
```
Bases:
```python
omni.kit.data2ui.core.model.Widget
```
### Methods
### Attributes
| Attribute | Description |
|-----------------|-------------|
| `clicked_fn` | |
| `image_height` | |
| `image_url` | |
| `image_width` | |
| `spacing` | |
| `text` | |
```python
__init__()
```
``` | 458 |
omni.kit.data2ui.core.CallbackContainer.md | # CallbackContainer
## Class CallbackContainer
Bases: `object`
The user should reimplement it to set the callabcks to the widgets.
### Methods
#### `__init__()`
``` | 169 |
omni.kit.data2ui.core.ChangeType.md | # ChangeType
## ChangeType
```
class omni.kit.data2ui.core.ChangeType(value)
```
Bases: `enum.IntEnum`
An enumeration.
### Attributes
| Attribute | Description |
|-----------|-------------|
| `REMOVED` | |
| `ADDED` | |
| `PROPERTY`| |
```
def __init__(self)
```
``` | 311 |
omni.kit.data2ui.core.Circle.md | # Circle
## Circle
### Class: omni.kit.data2ui.core.Circle
Bases: [omni.kit.data2ui.core.model.Widget](omni.kit.data2ui.core.Widget.html#omni.kit.data2ui.core.Widget)
#### Methods
| Method | Description |
|--------|-------------|
#### Attributes
| Attribute | Description |
|-----------|-------------|
| alignment | |
| arc | |
| radius | |
| size_policy | |
#### omni.kit.data2ui.core.Circle.__init__() | 463 |
omni.kit.data2ui.core.Classes.md | # omni.kit.data2ui.core Classes
## Classes Summary
| Class | Description |
|-------|-------------|
| [Button](omni.kit.data2ui.core/omni.kit.data2ui.core.Button.html) | The user is responsible to add own properties. |
| [CallbackContainer](omni.kit.data2ui.core/omni.kit.data2ui.core.CallbackContainer.html) | The user should reimplement it to set the callabcks to the widgets. |
| [ChangeType](omni.kit.data2ui.core/omni.kit.data2ui.core.ChangeType.html) | An enumeration. |
| [Circle](omni.kit.data2ui.core/omni.kit.data2ui.core.Circle.html) | The user is responsible to add own properties. |
| [CollapsableFrame](omni.kit.data2ui.core/omni.kit.data2ui.core.CollapsableFrame.html) | Container is an item with children |
| [Container](omni.kit.data2ui.core/omni.kit.data2ui.core.Container.html) | Container is an item with children |
| [DDView](omni.kit.data2ui.core/omni.kit.data2ui.core.DDView.html) | |
| [Delegate](omni.kit.data2ui.core/omni.kit.data2ui.core.Delegate.html) | |
| [Frame](omni.kit.data2ui.core/omni.kit.data2ui.core.Frame.html) | Container is an item with children |
| [HStack](omni.kit.data2ui.core/omni.kit.data2ui.core.HStack.html) | Container is an item with children |
| [Image](omni.kit.data2ui.core/omni.kit.data2ui.core.Image.html) | The user is responsible to add own properties. |
| [Label](omni.kit.data2ui.core/omni.kit.data2ui.core.Label.html) | The user is responsible to add own properties. |
- Line
- The user is responsible to add own properties.
- Model
-
- OmniUiDelegate
-
- Placer
- Container is an item with children
- Rectangle
- The user is responsible to add own properties.
- ScrollingFrame
- Container is an item with children
- Spacer
- The user is responsible to add own properties.
- Stack
- Container is an item with children
- StyleContainer
- This is the style primitive placeholder
- Triangle
- The user is responsible to add own properties.
- VStack
- Container is an item with children
- ViewportButton
- The user is responsible to add own properties.
- ViewportCircle
- The user is responsible to add own properties.
- Widget
- The user is responsible to add own properties.
- ZStack
- Container is an item with children | 2,214 |
omni.kit.data2ui.core.CollapsableFrame.md | # CollapsableFrame
## CollapsableFrame
```python
class omni.kit.data2ui.core.CollapsableFrame
```
Bases:
```python
omni.kit.data2ui.core.model.Frame
```
### Methods
### Attributes
```python
collapsed
title
```
## __init__
```python
__init__()
```
``` | 254 |
omni.kit.data2ui.core.Container.md | # Container
## Container
Container is an item with children
### Methods
### Attributes
| Attribute | Description |
|-----------|-------------|
| `children` | Returns the list of the children |
#### `__init__()`
#### `children`
Returns the list of the children | 267 |
omni.kit.data2ui.core.DDView.md | # DDView
## Overview
The `DDView` class is a part of the `omni.kit.data2ui.core` module. It is used to manage the display and interaction of data within a user interface.
### Class Definition
```python
class omni.kit.data2ui.core.DDView(model: omni.kit.data2ui.core.model.Model, delegate: omni.kit.data2ui.core.delegate.Delegate, **kwargs)
```
### Base Class
- `object`
### Methods
- `__init__(model, delegate, **kwargs)`
- `destroy()`
- `rebuild_all()`
```
delegate : omni.kit.data2ui.core.delegate.Delegate
**kwargs
) | 523 |
omni.kit.data2ui.core.Delegate.md | # Delegate
## Methods
- **get_widget(item)**
- Finds the widget class for a given item class, taking inheritance into account.
- **register_type(widget_type, item_type)**
- Registers a new widget type for a given item type.
## Attributes
- **widget_types_by_item_type**
## __init__()
## get_widget(item)
- Finds the widget class for a given item class, taking inheritance into account.
<dl>
<dd class="field-odd">
<p>
<strong>
item_type
– The item class to find the associated widget class for.
<dt class="field-even">
Returns
<dd class="field-even">
<p>
The widget class associated with the item class, or None if not found.
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.data2ui.core.Delegate.register_type">
<em class="property">
<span class="pre">
classmethod
<span class="w">
<span class="sig-name descname">
<span class="pre">
register_type
<span class="sig-paren">
(
<em class="sig-param">
<span class="n">
<span class="pre">
widget_type
,
<em class="sig-param">
<span class="n">
<span class="pre">
item_type
<span class="sig-paren">
)
<a class="headerlink" href="#omni.kit.data2ui.core.Delegate.register_type" title="Permalink to this definition">
<dd>
<p>
Registers a new widget type for a given item type.
<dl class="field-list simple">
<dt class="field-odd">
Parameters
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
widget_type
– The widget class to register.
<li>
<p>
<strong>
item_type
– The item class to associate with the widget.
<dt class="field-even">
Returns
<dd class="field-even">
<p>
A TypeRegistry instance that handles adding/removing the mapping.
| 2,069 |
omni.kit.data2ui.core.Frame.md | # Frame
## Class omni.kit.data2ui.core.Frame
**Bases:**
- [omni.kit.data2ui.core.model.Container](omni.kit.data2ui.core.Container.html#omni.kit.data2ui.core.Container)
### Methods
### Attributes
| Attribute | Description |
|-----------------|-------------|
| separate_window | |
### omni.kit.data2ui.core.Frame.__init__ | 343 |
omni.kit.data2ui.core.HStack.md | # HStack
## HStack
```python
class omni.kit.data2ui.core.HStack
```
Bases:
```python
omni.kit.data2ui.core.model.Stack
```
### Methods
### Attributes
```python
__init__()
```
``` | 182 |
omni.kit.data2ui.core.Image.md | # Image
## Image
### Class
```python
class omni.kit.data2ui.core.Image
```
**Bases:**
```python
omni.kit.data2ui.core.model.Widget
```
### Methods
### Attributes
| Attribute | Description |
|-----------|-------------|
| alignment | |
| fill_policy | |
| pixel_aligned | |
| source_url | |
### `__init__`
```python
__init__()
```
``` | 367 |
omni.kit.data2ui.core.Label.md | # Label
## Class omni.kit.data2ui.core.Label
Bases: [omni.kit.data2ui.core.model.Widget](omni.kit.data2ui.core.Widget.html#omni.kit.data2ui.core.Widget)
### Methods
### Attributes
| Attribute | Description |
|-----------|-------------|
| alignment | |
| elided_text | |
| text | |
| word_wrap | |
### omni.kit.data2ui.core.Label.__init__ | 386 |
omni.kit.data2ui.core.Line.md | # Line
## Line
### Class: omni.kit.data2ui.core.Line
**Bases:**
- [omni.kit.data2ui.core.model.Widget](omni.kit.data2ui.core.Widget.html#omni.kit.data2ui.core.Widget)
#### Methods
#### Attributes
| Name | Description |
|------------|-------------|
| alignment | |
#### `__init__()` | 307 |
omni.kit.data2ui.core.Model.md | # Model
## Class Definition
```python
class omni.kit.data2ui.core.Model(object)
```
## Methods
- `__init__()`
- `create_scene_view_model()`
- `create_subscription_to_push(callable, event, ...)`
- Callable will be called immediately on item changed
- `get_item_data(ItemType)`
- Finds the registered data using item type.
- `get_type_from_data(Data)`
- Finds the registered item type using data.
- `keep_item(item)`
- `register_type(ItemType, Data)`
- Register the custom model item.
## Attributes
```
| all_types |
| --- |
__init__()
create_subscription_to_push(callable, event, info)
- Callable will be called immediately on item changed
get_item_data(ItemType) → Any
- Finds the registered data using item type.
get_type_from_data(Data) → Any
- Finds the registered item type using data.
register_type(ItemType, Data)
- Register the custom model item.
- Registered item will go to the model namespace. | 920 |
omni.kit.data2ui.core.OmniUiDelegate.md | # OmniUiDelegate
## Class
```python
class omni.kit.data2ui.core.OmniUiDelegate
```
### Bases
```python
omni.kit.data2ui.core.delegate.Delegate
```
### Methods
### Attributes
```python
Button
Circle
CollapsableFrame
Frame
HStack
Image
Label
Line
Placer
```
| | |
| ------ | ------ |
| Rectangle | |
| ScrollingFrame | |
| Spacer | |
| Stack | |
| Triangle | |
| VStack | |
| ViewportButton | |
| ViewportCircle | |
| ZStack | |
__init__() | 465 |
omni.kit.data2ui.core.Placer.md | # Placer
## Class Overview
**Class:** `omni.kit.data2ui.core.Placer`
**Bases:** `omni.kit.data2ui.core.model.Container`
### Methods
- **__init__**
### Attributes
- **drag_axis**
- **draggable**
- **offset_x**
- **offset_y**
- **stable_size** | 247 |
omni.kit.data2ui.core.Rectangle.md | # Rectangle
## Rectangle
### omni.kit.data2ui.core.Rectangle
Bases: `omni.kit.data2ui.core.model.Widget`
### Methods
### Attributes
### omni.kit.data2ui.core.Rectangle.__init__ | 179 |
omni.kit.data2ui.core.ScrollingFrame.md | # ScrollingFrame
## ScrollingFrame
```python
class omni.kit.data2ui.core.ScrollingFrame
```
Bases:
```python
omni.kit.data2ui.core.model.Frame
```
### Methods
### Attributes
```python
horizontal_scrollbar_policy
scroll_x
scroll_x_max
scroll_y
scroll_y_max
vertical_scrollbar_policy
```
```python
__init__()
``` | 314 |
omni.kit.data2ui.core.Spacer.md | # Spacer
## Spacer
```
class omni.kit.data2ui.core.Spacer
```
Bases:
```
omni.kit.data2ui.core.model.Widget
```
### Methods
### Attributes
```
__init__
```
``` | 165 |
omni.kit.data2ui.core.Stack.md | # Stack
## Stack
Bases: [omni.kit.data2ui.core.model.Container](omni.kit.data2ui.core.Container.html#omni.kit.data2ui.core.Container)
### Methods
| Method | Description |
|--------|-------------|
### Attributes
| Attribute | Description |
|-----------|-------------|
| content_clipping | |
| direction | |
| send_mouse_events_to_back | |
| spacing | |
### __init__
``` | 383 |
omni.kit.data2ui.core.StyleContainer.md | # StyleContainer
## StyleContainer
```python
class omni.kit.data2ui.core.StyleContainer
```
This is the style primitive placeholder
### Methods
```python
__init__()
```
``` | 176 |
omni.kit.data2ui.core.Triangle.md | # Triangle
## Triangle
Bases: omni.kit.data2ui.core.model.Widget
### Methods
### Attributes
| Attribute | Description |
|-----------|-------------|
| alignment | |
## omni.kit.data2ui.core.Triangle.__init__ | 224 |
omni.kit.data2ui.core.ViewportButton.md | # ViewportButton
## Class
```python
class omni.kit.data2ui.core.ViewportButton
```
### Bases
```python
omni.kit.data2ui.core.model.Item
```
### Methods
### Attributes
- **checked**
- **clicked_fn**
- **enabled**
- **height**
- **image_url**
- **selected**
- **shape**
- **style**
- **target_path**
- **visible**
<p>
<code>
width
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.data2ui.core.ViewportButton.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
<span class="sig-paren">
(
<span class="sig-paren">
)
<dd>
| 567 |
omni.kit.data2ui.core.ViewportCircle.md | # ViewportCircle
## Methods
## Attributes
- `checked`
- `clicked_fn`
- `enabled`
- `radius`
- `selected`
- `shape`
- `style`
- `target_path`
- `visible`
## __init__
(
) | 171 |
omni.kit.data2ui.core.VStack.md | # VStack
## VStack
### Class
```
class omni.kit.data2ui.core.VStack
```
Bases:
```
omni.kit.data2ui.core.model.Stack
```
### Methods
### Attributes
### __init__
```
( )
``` | 172 |
omni.kit.data2ui.core.Widget.md | # Widget
## Class
```python
class omni.kit.data2ui.core.Widget
```
Bases: `omni.kit.data2ui.core.model.Item`
### Attributes
- `checked`
- `computed_height`
- `computed_width`
- `enabled`
- `height`
- `identifier`
- `name`
- `screen_position_x`
- `screen_position_y`
- `selected`
```
| 属性名 | 描述 |
|-----------------------------|------|
| `skip_draw_when_clipped` | |
| `style` | |
| `style_type_name_override` | |
| `tooltip` | |
| `tooltip_offset_x` | |
| `tooltip_offset_y` | |
| `visible` | |
| `width` | |
### __init__ | 683 |
omni.kit.data2ui.core.ZStack.md | # ZStack
## ZStack
### omni.kit.data2ui.core.ZStack
Bases: [omni.kit.data2ui.core.model.Stack](omni.kit.data2ui.core.Stack.html#omni.kit.data2ui.core.Stack)
### Methods
### Attributes
### omni.kit.data2ui.core.ZStack.__init__ | 228 |
omni.kit.documentation.ui.style.Classes.md | # omni.kit.documentation.ui.style Classes
## Classes Summary:
- [UIStyleDocsExtension](./omni.kit.documentation.ui.style/omni.kit.documentation.ui.style.UIStyleDocsExtension.html) | 181 |
omni.kit.documentation.ui.style.md | # omni.kit.documentation.ui.style
## Submodules
Summary:
- **omni.kit.documentation.ui.style.ui_style_docs_extension**
- No submodule docstring provided
- **omni.kit.documentation.ui.style.ui_style_docs_window**
- No submodule docstring provided
## Classes
Summary:
- **UIStyleDocsExtension** | 301 |
omni.kit.documentation.ui.style.Submodules.md | # omni.kit.documentation.ui.style Submodules
## Submodules Summary
- **omni.kit.documentation.ui.style.ui_style_docs_extension**
- No submodule docstring provided
- **omni.kit.documentation.ui.style.ui_style_docs_window**
- No submodule docstring provided | 262 |
omni.kit.documentation.ui.style.UIStyleDocsExtension.md | # UIStyleDocsExtension
## UIStyleDocsExtension
```python
class omni.kit.documentation.ui.style.UIStyleDocsExtension
```
Bases: `IExt`
### Methods
| Method | Description |
|--------------|-------------|
| `on_shutdown()` | |
| `on_startup(ext_id)` | |
```python
def __init__(self: omni.ext._extensions.IExt) -> None:
```
``` | 355 |
omni.kit.documentation.ui.style.ui_style_docs_extension.UIStyleDocsExtension.md | # UIStyleDocsExtension
## UIStyleDocsExtension
```
Bases: `IExt`
### Methods
| Method | Description |
|--------------|-------------|
| `on_shutdown()` | |
| `on_startup(ext_id)` | |
```python
__init__(self: omni.ext._extensions.IExt) -> None
``` | 277 |
omni.kit.documentation.ui.style.ui_style_docs_window.md | # omni.kit.documentation.ui.style.ui_style_docs_window
## Classes Summary:
| Class | Description |
|-------|-------------|
| [UIStyleDocsWindow](omni.kit.documentation.ui.style.ui_style_docs_window/omni.kit.documentation.ui.style.ui_style_docs_window.UIStyleDocsWindow.html) | The window with the documentation | | 314 |
omni.kit.documentation.ui.style.ui_style_docs_window.UIStyleDocsWindow.md | # UIStyleDocsWindow
## Arguments
### `__init__` (title: str, **kwargs)
### Arguments
> - `title: str`
> - The title of the window.
> - `filenames: List[str]`
> - The list of .md files to process.
> - `show_catalog: bool`
> - Show catalog pane (default True) | 265 |
omni.kit.exec.core_api.md | # Kit Orchestration and Execution Framework API
## Directory hierarchy
### dir omni
- **omni/kit**
- **omni/kit/exec**
- **omni/kit/exec/core**
### dir
- **omni/kit/exec/core/unstable**
#### Files
- **omni/kit/exec/core/unstable/IClearCallback.gen.h**
- **omni/kit/exec/core/unstable/IClearCallback.h**
- **omni/kit/exec/core/unstable/IExecutionContext.gen.h**
- **omni/kit/exec/core/unstable/IExecutionContext.h**
- **omni/kit/exec/core/unstable/IExecutionController.gen.h**
- **omni/kit/exec/core/unstable/IExecutionController.h**
- **omni/kit/exec/core/unstable/IExecutionControllerFactory.gen.h**
- **omni/kit/exec/core/unstable/IExecutionControllerFactory.h**
- **omni/kit/exec/core/unstable/IExecutionGraphSettings.gen.h**
- **omni/kit/exec/core/unstable/IExecutionGraphSettings.h**
- **omni/kit/exec/core/unstable/ITbbSchedulerState.gen.h**
- **omni/kit/exec/core/unstable/ITbbSchedulerState.h**
- **omni/kit/exec/core/unstable/Module.h**
- **omni/kit/exec/core/unstable/ParallelScheduler.h**
- **omni/kit/exec/core/unstable/TbbSchedulerState.h**
### namespace
- **omni**
### namespace
- **omni::kit**
### namespace
- **omni::kit::exec**
### namespace
- **omni::kit::exec::core**
### namespace
- **omni::kit::exec::core::unstable**
### namespace
- **omni::kit::exec::core::unstable::detail**
### struct
- **omni::kit::exec::core::unstable::ExecutionContextTime**
### class
- **omni::kit::exec::core::unstable::IClearCallback**
### class
- **omni::kit::exec::core::unstable::IClearCallback_abi**
- omni::kit::exec::core::unstable::IExecutionContext
- omni::kit::exec::core::unstable::IExecutionContext_abi
- omni::kit::exec::core::unstable::IExecutionController
- omni::kit::exec::core::unstable::IExecutionControllerFactory
- omni::kit::exec::core::unstable::IExecutionControllerFactory_abi
- omni::kit::exec::core::unstable::IExecutionController_abi
- omni::kit::exec::core::unstable::IExecutionGraphSettings
- omni::kit::exec::core::unstable::IExecutionGraphSettings_abi
- omni::kit::exec::core::unstable::ITbbSchedulerState
- omni::kit::exec::core::unstable::ITbbSchedulerState_abi
- omni::kit::exec::core::unstable::ParallelSpawner
- omni::kit::exec::core::unstable::TbbSchedulerState
- omni::kit::StageUpdateSettings
- omni::usd
## API contents
- Classes
- Macros
- Directories
- Files
- Functions
- Groups
- Namespaces
- Structs
- Typedefs
这是一个段落，包含一个链接和一张图片。 | 2,391 |
omni.kit.gfn.get_geforcenow_interface.md | # get_geforcenow_interface
## get_geforcenow_interface
```python
omni.kit.gfn.get_geforcenow_interface()
```
Returns cached IGeForceNow interface
``` | 150 |
omni.kit.gfn.IGeForceNow.md | # IGeForceNow
Interface class to GFN SDK
## Methods
| Method | Description |
| --- | --- |
| `__init__(*args, **kwargs)` | |
| `get_partner_secure_data(self)` | Get partner secure data from GFN SDK |
| `shutdown(self)` | Shutdown the GFN SDK |
| `startup(self[, sdk_library_path])` | Initialize the GFN SDK |
## Methods
### get_partner_secure_data
```python
omni.kit.gfn._kit_gfn.IGeForceNow.get_partner_secure_data(self: omni.kit.gfn._kit_gfn.IGeForceNow) -> str
```
Get partner secure data from GFN SDK
### shutdown
```python
omni.kit.gfn._kit_gfn.IGeForceNow.shutdown(self: omni.kit.gfn._kit_gfn.IGeForceNow) -> None
```
Shutdown the GFN SDK
### startup
```python
omni.kit.gfn._kit_gfn.IGeForceNow.startup(self: omni.kit.gfn._kit_gfn.IGeForceNow, sdk_library_path: str = '') -> None
```
Initialize the GFN SDK | 819 |
omni.kit.gfn.md | # omni.kit.gfn
## Classes Summary
| Class | Description |
|-------|-------------|
| [IGeForceNow](./omni.kit.gfn.Classes.html) | Interface class to GFN SDK |
## Functions Summary
| Function | Description |
|----------|-------------|
| [get_geforcenow_interface](./omni.kit.gfn.Functions.html) | Returns cached IGeForceNow interface | | 337 |
omni.kit.hotkeys.core.Classes.md | # omni.kit.hotkeys.core Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| [Hotkey](omni.kit.hotkeys.core/omni.kit.hotkeys.core.Hotkey.html) | Hotkey object class. |
| [HotkeyFilter](omni.kit.hotkeys.core/omni.kit.hotkeys.core.HotkeyFilter.html) | Hotkey filter class. |
| [HotkeyRegistry](omni.kit.hotkeys.core/omni.kit.hotkeys.core.HotkeyRegistry.html) | Registry of hotkeys. |
| [HotkeysExtension](omni.kit.hotkeys.core/omni.kit.hotkeys.core.HotkeysExtension.html) | Hotkeys extension. |
| [KeyCombination](omni.kit.hotkeys.core/omni.kit.hotkeys.core.KeyCombination.html) | Key binding class. | | 636 |
omni.kit.hotkeys.core.Functions.md | # omni.kit.hotkeys.core Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| `get_hotkey_context` | Get the hotkey context. |
| `get_hotkey_registry` | Get the hotkey registry. | | 215 |
omni.kit.hotkeys.core.get_hotkey_context.md | # get_hotkey_context
## get_hotkey_context
```python
omni.kit.hotkeys.core.get_hotkey_context() -> HotkeyContext
```
Get the hotkey context.
**Returns:**
HotkeyContext object which implements the hotkey context interface.
``` | 228 |
omni.kit.hotkeys.core.get_hotkey_registry.md | # get_hotkey_registry
## get_hotkey_registry
```python
omni.kit.hotkeys.core.get_hotkey_registry()
```
- **Returns**: HotkeyRegistry object which implements the hotkey registry interface.
Get the hotkey registry.
``` | 219 |
omni.kit.hotkeys.core.Hotkey.md | # Hotkey
## Hotkey
```
class omni.kit.hotkeys.core.Hotkey
(
hotkey_ext_id: str,
key: Union[str, KeyCombination],
action_ext_id: str,
action_id: str,
filter: Optional[HotkeyFilter] = None
)
```
Bases: `object`
Hotkey object class.
### Methods
| Method | Description |
| --- | --- |
| `__init__(hotkey_ext_id, key, action_ext_id, ...)` | Define a hotkey object. |
| `execute()` | Execute action assigned to the hotkey |
### Attributes
| Attribute | Description |
| --- | --- |
| `action` | Action object assigned to this hotkey. |
| `action_text` | String of action object assigned to this hotkey. |
| `filter_text` | String of filter object assigned to this hotkey. |
| `id` | Identifier string of this hotkey. |
| `key_text` | String of key bindings assigned to this hotkey. |
### `__init__(hotkey_ext_id: str, key: Union[str, KeyCombination], action_ext_id: str, action_id: str, filter: Optional[HotkeyFilter] = None)`
Define a hotkey object.
Parameters:
- `hotkey_ext_id`: str
- `key`: Union[str, KeyCombination]
- `action_ext_id`: str
- `action_id`: str
- `filter`: Optional[HotkeyFilter] = None
- **hotkey_ext_id** (`str`) – Extension id which owns the hotkey.
- **key** (`Union[str, KeyCombination]`) – Key combination.
- **action_ext_id** (`str`) – Extension id which owns the action assigned to the hotkey.
- **action_id** (`str`) – Action id assigned to the hotkey.
**Keyword Arguments**
- **filter** (`Optional[HotkeyFilter]`) – Hotkey filter. Default None
**Returns**
- The hotkey object that was created.
**execute** () → None
- Execute action assigned to the hotkey
**property action** : Action
- Action object assigned to this hotkey.
**property action_text** : str
- String of action object assigned to this hotkey.
**property filter_text** : str
- String of filter object assigned to this hotkey.
**property id** : str
- Identifier string of this hotkey.
**property key_text** : str
- String of key bindings assigned to this hotkey. | 1,985 |
omni.kit.hotkeys.core.HotkeyFilter.md | # HotkeyFilter
## HotkeyFilter
```
Bases: `object`
Hotkey filter class.
### Methods
| Method | Description |
| --- | --- |
| `__init__(context=None, windows=None)` | Define a hotkey filter object. |
### Attributes
| Attribute | Description |
| --- | --- |
| `windows_text` | |
```
| | |
|---|---|
| | String of windows defined in this filter. |
### omni.kit.hotkeys.core.HotkeyFilter.__init__
__init__(context: Optional[str] = None, windows: Optional[List[str]] = None)
- Define a hotkey filter object.
- **Keyword Arguments**
- **context** (Optional[str]) – Name of context to filter. Default None.
- **windows** (Optional[List[str]]) – List of window names to filter. Default None
- **Returns**
- The hotkey filter object that was created.
### omni.kit.hotkeys.core.HotkeyFilter.windows_text
property windows_text
- String of windows defined in this filter. | 878 |
omni.kit.hotkeys.core.HotkeyRegistry.md | # HotkeyRegistry
## Methods
- `__init__()`
- Define hotkey registry object.
- `clear_storage()`
- Clear user defined hotkeys.
- `deregister_all_hotkeys_for_extension(...)`
- Deregister hotkeys registered from a special extension.
- `deregister_all_hotkeys_for_filter(filter)`
- Deregister hotkeys registered with special filter.
- `deregister_hotkey(*args, **kwargs)`
- Deregister hotkey by hotkey object or arguments.
- `deregister_hotkeys(hotkey_ext_id, key)`
- [Description missing]
Deregister hotkeys registered from a special extension with special key combination.
disable_hotkey (hotkey)
Disable a system hotkey.
edit_hotkey (hotkey, key, filter)
Change key combination of hotkey object.
export_storage (url)
Export user defined hotkeys to file.
get_all_hotkeys ()
Discover all registered hotkeys.
get_all_hotkeys_for_extension (hotkey_ext_id)
Discover hotkeys registered from a special extension.
get_all_hotkeys_for_filter (filter)
Discover hotkeys registered with special filter.
get_all_hotkeys_for_key (key)
Discover hotkeys registered from a special key.
get_hotkey (hotkey_ext_id, key[, filter])
Discover a registered hotkey.
get_hotkey_default (hotkey)
Discover hotkey default key binding and filter.
get_hotkey_for_filter (key, filter)
Discover hotkey registered with special key combination and filter.
get_hotkey_for_trigger (key[, context, window])
Discover hotkey for trigger from key combination and filter.
get_hotkeys (hotkey_ext_id, key)
Discover hotkeys registered from a special extension with special key combination.
has_duplicated_hotkey (hotkey)
Check if already have hotkey registered.
import_storage (url)
Import user defined hotkeys from file.
<p>
is_user_hotkey (hotkey)
<p>
If a user defined hotkey.
<p>
register_hotkey (*args, **kwargs)
<p>
Register hotkey by hotkey object or arguments.
<p>
restore_defaults ()
<p>
Clean user defined hotkeys and restore system hotkey to default
<p>
switch_layout (layout_name)
<p>
Change keyboard layout.
<p>
verify_hotkey (hotkey[, key_combination, ...])
<p>
Verify hotkey.
<p class="rubric">
Attributes
<p>
keyboard_layout
<p>
Current keyboard layout object in using.
<p>
last_error
<p>
Error code for last hotkey command.
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.hotkeys.core.HotkeyRegistry.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
<span class="sig-paren">
()
<a class="headerlink" href="#omni.kit.hotkeys.core.HotkeyRegistry.__init__" title="Permalink to this definition">
<dd>
<p>
Define hotkey registry object.
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.hotkeys.core.HotkeyRegistry.clear_storage">
<span class="sig-name descname">
<span class="pre">
clear_storage
<span class="sig-paren">
()
<span class="sig-return">
<span class="sig-return-icon">→
<span class="sig-return-typehint">
<span class="pre">
None
<a class="headerlink" href="#omni.kit.hotkeys.core.HotkeyRegistry.clear_storage" title="Permalink to this definition">
<dd>
<p>
Clear user defined hotkeys.
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.hotkeys.core.HotkeyRegistry.deregister_all_hotkeys_for_extension">
<span class="sig-name descname">
<span class="pre">
deregister_all_hotkeys_for_extension
<span class="sig-paren">
(
<em class="sig-param">
<span class="n">
<span class="pre">
hotkey_ext_id
<span class="p">
<span class="pre">
:
<span class="w">
<span class="n">
<span class="pre">
Optional
<span class="p">
<span class="pre">
[
<span class="pre">
str
<span class="p">
<span class="pre">
]
)
<span class="sig-return">
<span class="sig-return-icon">→
<span class="sig-return-typehint">
<span class="pre">
None
<a class="headerlink" href="#omni.kit.hotkeys.core.HotkeyRegistry.deregister_all_hotkeys_for_extension" title="Permalink to this definition">
<dd>
<p>
Deregister hotkeys registered from a special extension.
<dl class="field-list simple">
<dt class="field-odd">
Parameters
<dd class="field-odd">
<p>
<strong>
hotkey_ext_id
(
<em>
Optional
<em>
[
<em>
str
<em>
]
) – Extension id that hotkeys belongs to. If None, discover all global hotkeys
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.hotkeys.core.HotkeyRegistry.deregister_all_hotkeys_for_filter">
<span class="sig-name descname">
<span class="pre">
deregister_all_hotkeys_for_filter
<span class="sig-paren">
(
<em class="sig-param">
<span class="n">
<span class="pre">
filter
)
<span class="sig-return">
<span class="sig-return-icon">→
<span class="sig-return-typehint">
<span class="pre">
None
<a class="headerlink" href="#omni.kit.hotkeys.core.HotkeyRegistry.deregister_all_hotkeys_for_filter" title="Permalink to this definition">
<dd>
<p>
Deregister hotkeys registered from a special filter.
<dl class="field-list simple">
<dt class="field-odd">
Parameters
<dd class="field-odd">
<p>
<strong>
filter
(
<em>
Optional
<em>
[
<em>
str
<em>
]
) – Filter id that hotkeys belongs to. If None, discover all global hotkeys
### deregister_all_hotkeys_for_filter(filter: HotkeyFilter) -> None
- **Description**: Deregister hotkeys registered with special filter.
- **Parameters**:
- **filter** (HotkeyFilter) – Hotkey HotkeyFilter.
### deregister_hotkey(*args, **kwargs) -> bool
- **Description**: Deregister hotkey by hotkey object or arguments.
- **Usage**:
```python
deregister_hotkey(hotkey: Hotkey)
```
or
```python
deregister_hotkey(
hotkey_ext_id: str,
key: Union[str, KeyCombination],
filter: Optional[HotkeyFilter] = None
)
```
- **Returns**: True if hotkey found. Otherwise return False.
### deregister_hotkeys(hotkey_ext_id: str, key: Union[str, KeyCombination]) -> None
- **Description**: Deregister hotkeys registered from a special extension with special key combination.
- **Parameters**:
- **hotkey_ext_id** (str) – Extension id that hotkeys belongs to.
- **key** (Union[str, KeyCombination]) – Key combination.
### Disable_hotkey
Disable a system hotkey.
Disable means:
- Deregister the hotkey immediately
- If the hotkey is a system hotkey, do not make it work even register again until preset reset
**Parameters**
- **[Hotkey]** (`hotkey`) – Hotkey object
**Returns**
- True if hotkey found. Otherwise return False.
### Edit_hotkey
Change key combination of hotkey object.
**Parameters**
- **hotkey** (`Hotkey`) – Hotkey object to change.
- **key** (`Union[str, KeyCombination]`) – New key combination.
- **filter** (`Optional[HotkeyFilter]`) – New filter.
**Returns**
- Result code.
### Export_storage
Export storage to a specified URL.
**Parameters**
- **url** (`str`) – The URL to export the storage to.
**Returns**
- None
### Export user defined hotkeys to file.
**Parameters**
- **url** (str) – File path to export user defined hotkeys.
### Discover all registered hotkeys.
**Returns**
- List of all registered hotkeys.
### Discover hotkeys registered from a special extension.
**Parameters**
- **hotkey_ext_id** (Optional[str]) – Extension id that hotkeys belongs to. If None, discover all global hotkeys
**Returns**
- List of discovered hotkeys.
### Discover hotkeys registered with special filter.
**Parameters**
- **filter** (HotkeyFilter) – Hotkey HotkeyFilter.
**Returns**
- List of discovered hotkeys.
### Discover hotkeys registered with a specific key.
**Parameters**
- **key** (str) – The key to search for hotkeys.
**Returns**
- List of discovered hotkeys.
**get_all_hotkeys_for_key**
(Union[str, KeyCombination]) → List[Hotkey]
Discover hotkeys registered from a special key.
**Parameters**
- **key** (Union[str, KeyCombination]) – Key combination.
**Returns**
List of discovered hotkeys.
**get_hotkey**
(str, Union[str, KeyCombination], Optional[HotkeyFilter] = None) → Optional[Hotkey]
Discover a registered hotkey.
**Parameters**
- **hotkey_ext_id** (str) – Extension id which owns the hotkey.
- **key** (Union[str, KeyCombination]) – Key combination.
**Keyword Arguments**
- **filter** (Optional[HotkeyFilter] = None)
### HotkeyFilter
] ) – Hotkey filter. Default None
### Returns
Hotkey object if discovered. Otherwise None.
### get_hotkey_default
( hotkey : Hotkey ) → Tuple[ str , HotkeyFilter ]
Discover hotkey default key binding and filter.
#### Parameters
- **hotkey** ( Hotkey ) – Hotkey object.
#### Returns
Tuple of key binding string and hotkey filter object.
### get_hotkey_for_filter
( key : Union[ str , KeyCombination ] , filter : HotkeyFilter ) → Optional[ Hotkey ]
Discover hotkey registered with special key combination and filter
#### Parameters
- **key** ( Union[ str , KeyCombination ] ) – Key combination.
- **filter** ( HotkeyFilter ) – Hotkey filter.
#### Returns
First discovered hotkey. None if nothing found.
## get_hotkey_for_trigger
**Parameters**
- **key** (`Union[str, KeyCombination]`) – Key combination.
- **context** (`Optional[str]` = `None`) – Context assigned to Hotkey
- **window** (`Optional[str]` = `None`) – Window assigned to Hotkey
**Returns**
- `Optional[Hotkey]` – Hotkey object if discovered. Otherwise None.
**Description**
Discover hotkey for trigger from key combination and filter.
## get_hotkeys
**Parameters**
- **hotkey_ext_id** (`str`)
- **key** (`Union[str, KeyCombination]`)
**Returns**
- `List[Hotkey]`
### Discover hotkeys registered from a special extension with special key combination.
#### Parameters
- **hotkey_ext_id** (`str`) – Extension id that hotkeys belongs to.
- **key** (`Union[str, KeyCombination]`) – Key combination.
#### Returns
List of discovered hotkeys.
### Check if already have hotkey registered.
#### Parameters
- **hotkey** (`Hotkey`) – Hotkey object to check.
#### Returns
Result code.
### Import user defined hotkeys from file.
#### Parameters
- **url** (`str`) – File path to import user defined hotkeys.
### If a user defined hotkey.
#### Parameters
- **hotkey** (`Hotkey`) – Hotkey object.
#### Returns
True if user defined. Otherwise False.
### register_hotkey
```python
register_hotkey(hotkey: Hotkey)
```
or
```python
register_hotkey(
hotkey_ext_id: str,
key: Union[str, KeyCombination],
action_ext_id: str,
action_id: str,
filter: Optional[HotkeyFilter] = None
)
```
**Returns**
- Created hotkey object if register succeeded. Otherwise return None.
### restore_defaults
- Clean user defined hotkeys and restore system hotkey to default
### switch_layout
```python
switch_layout(layout_name: str)
```
**Parameters**
- **layout_name** (str) – Name of keyboard layout to use.
### verify_hotkey
```python
verify_hotkey(hotkey: Hotkey, key_combination: Optional[KeyCombination] = None, hotkey_filter: Optional[HotkeyFilter] = None)
```
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.hotkeys.core.HotkeyRegistry.verify_hotkey">
<em class="property">
<span class="pre">
def
<span class="w">
<span class="sig-name descname">
<span class="pre">
verify_hotkey
<span class="p">
<span class="pre">
(
<span class="sig-param">
<span class="sig-paren">
<span class="pre">
self
<span class="p">
<span class="pre">
,
<span class="sig-param">
<span class="sig-paren">
<span class="pre">
hotkey
<span class="p">
<span class="pre">
:
<span class="w">
<span class="pre">
Optional
<span class="p">
<span class="pre">
[
<span class="pre">
Hotkey
<span class="p">
<span class="pre">
]
<span class="w">
<span class="o">
<span class="pre">
=
<span class="w">
<span class="default_value">
<span class="pre">
None
<span class="sig-paren">
)
<span class="sig-return">
<span class="sig-return-icon">
→
<span class="sig-return-typehint">
<span class="pre">
Result
<dd>
<p>
Verify hotkey.
<dl class="py property">
<dt class="sig sig-object py" id="omni.kit.hotkeys.core.HotkeyRegistry.keyboard_layout">
<em class="property">
<span class="pre">
property
<span class="w">
<span class="sig-name descname">
<span class="pre">
keyboard_layout
<em class="property">
<span class="p">
<span class="pre">
:
<span class="w">
<span class="pre">
Optional
<span class="p">
<span class="pre">
[
<span class="pre">
KeyboardLayoutDelegate
<span class="p">
<span class="pre">
]
<dd>
<p>
Current keyboard layout object in using.
<dl class="py property">
<dt class="sig sig-object py" id="omni.kit.hotkeys.core.HotkeyRegistry.last_error">
<em class="property">
<span class="pre">
property
<span class="w">
<span class="sig-name descname">
<span class="pre">
last_error
<em class="property">
<span class="p">
<span class="pre">
:
<span class="w">
<span class="pre">
Result
<dd>
<p>
Error code for last hotkey command.
| 13,728 |
omni.kit.hotkeys.core.HotkeysExtension.md | # HotkeysExtension
## HotkeysExtension
```python
class omni.kit.hotkeys.core.HotkeysExtension(IExt):
```
Hotkeys extension.
### Methods
| Method | Description |
|-----------------------|----------------------|
| `on_shutdown()` | |
| `on_startup(ext_id)` | Extension startup entrypoint. |
```python
def __init__(self: omni.ext._extensions.IExt) -> None:
```
```python
def on_startup(ext_id):
```
Extension startup entrypoint. | 484 |
omni.kit.hotkeys.core.KeyCombination.md | # KeyCombination
## KeyCombination
```python
class omni.kit.hotkeys.core.KeyCombination:
def __init__(key: Union[str, KeyboardInput], modifiers: int = 0, trigger_press: bool = True):
"""
Bases: object
Key binding class.
Methods:
- __init__(key[, modifiers, trigger_press]): Create a key binding object.
- from_string(key_string):
"""
## Key Binding Information
### Key Combination Functions
- **is_valid_key_string(key)**
If key string valid.
- **as_string**
Get string to describe key combination
- **id**
Identifier string of this key binding object.
- **is_valid**
If a valid key binding object.
### Attributes
- **as_string**
Get string to describe key combination
- **id**
Identifier string of this key binding object.
- **is_valid**
If a valid key binding object.
### KeyCombination Initialization
**__init__(key: Union[str, KeyboardInput], modifiers: int = 0, trigger_press: bool = True)**
Create a key binding object.
**Parameters:**
- **key** (Union[str, carb.input.KeyboardInput]) – could be string or carb.input.KeyboardInput. If string, use “+” to join carb.input.KeyboardInput and modifiers, for example: “CTRL+D” or “CTRL+SHIFT+D”
**Keyword Arguments:**
- **modifiers** (int) – Represent combination of keyboard modifier flags, which could be:
- carb.input.KEYBOARD_MODIFIER_FLAG_CONTROL
- carb.input.KEYBOARD_MODIFIER_FLAG_SHIFT
- carb.input.KEYBOARD_MODIFIER_FLAG_ALT
- carb.input.KEYBOARD_MODIFIER_FLAG_SUPER
- **trigger_press** (bool) – Trigger when key pressed if True. Otherwise trigger when key released. Default True.
### Static Method
**from_string(key_string: str)**
<span class="pre">
KeyboardInput
<span class="pre">
int
<span class="pre">
bool
<p>
Get key binding information from a string.
<dl class="field-list simple">
<dt class="field-odd">
Parameters
<dd class="field-odd">
<p>
<strong>
key_string
(
<em>
str
) – String represent a key binding.
<dt class="field-even">
Returns
<dd class="field-even">
<p>
Tuple of carb.input.KeyboardInput, modifiers and flag for press/release.
<p>
If key string valid.
<dl class="field-list simple">
<dt class="field-odd">
Parameters
<dd class="field-odd">
<p>
<strong>
key
(
<em>
str
) – Key string to check.
<dt class="field-even">
Returns
<dd class="field-even">
<p>
True if key string is valid. Otherwise False.
<p>
Get string to describe key combination
<p>
Identifier string of this key binding object.
<p>
If a valid key binding object.
| 2,556 |
omni.kit.hotkeys.core.md | # omni.kit.hotkeys.core
## Classes Summary
- **Hotkey**
- Hotkey object class.
- **HotkeyFilter**
- Hotkey filter class.
- **HotkeyRegistry**
- Registry of hotkeys.
- **HotkeysExtension**
- Hotkeys extension.
- **KeyCombination**
- Key binding class.
## Functions Summary
- **get_hotkey_context**
- Get the hotkey context.
- **get_hotkey_registry**
- Get the hotkey registry. | 393 |
omni.kit.hotkeys.window.Classes.md | # omni.kit.hotkeys.window Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| HotkeysExtension | Simple helper class for adding/removing “Window” menu to your extension. ui.Window creation/show/hide is still down to user to provide functionally. | | 285 |
omni.kit.hotkeys.window.column_delegate.action_column_delegate.Classes.md | # omni.kit.hotkeys.window.column_delegate.action_column_delegate Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| ActionColumnDelegate | A simple delegate to display/add action in column. | | 230 |
omni.kit.hotkeys.window.column_delegate.hotkey_column_delegate.Classes.md | # omni.kit.hotkeys.window.column_delegate.hotkey_column_delegate Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| [HotkeyColumnDelegate](omni.kit.hotkeys.window.column_delegate.hotkey_column_delegate/omni.kit.hotkeys.window.column_delegate.hotkey_column_delegate.HotkeyColumnDelegate.html) | A simple delegate to display a editable hotkey in column. |
| [KeyResetHelper](omni.kit.hotkeys.window.column_delegate.hotkey_column_delegate/omni.kit.hotkeys.window.column_delegate.hotkey_column_delegate.KeyResetHelper.html) | | | 563 |
omni.kit.hotkeys.window.column_delegate.key_editor.Classes.md | # omni.kit.hotkeys.window.column_delegate.key_editor Classes
## Classes Summary:
| Class | Description |
| --- | --- |
| [KeyEditor](#) | |
| [TriggerPressOption](#) | |
| [TriggerPressWindow](#) | The Window class represents a window in the underlying windowing system. | | 276 |
omni.kit.hotkeys.window.column_delegate.md | # omni.kit.hotkeys.window.column_delegate
## Submodules Summary:
- **omni.kit.hotkeys.window.column_delegate.action_column_delegate**
- No submodule docstring provided
- **omni.kit.hotkeys.window.column_delegate.hotkey_column_delegate**
- No submodule docstring provided
- **omni.kit.hotkeys.window.column_delegate.key_editor**
- No submodule docstring provided
- **omni.kit.hotkeys.window.column_delegate.reset_button**
- No submodule docstring provided
- **omni.kit.hotkeys.window.column_delegate.window_column_delegate**
- No submodule docstring provided | 573 |
omni.kit.hotkeys.window.column_delegate.reset_button.Classes.md | # omni.kit.hotkeys.window.column_delegate.reset_button Classes
## Classes Summary:
| Class Name |
|------------------|
| [ResetButton](#) |
| [ResetHelper](#) | | 168 |
omni.kit.hotkeys.window.column_delegate.Submodules.md | # omni.kit.hotkeys.window.column_delegate Submodules
## Submodules Summary
| Submodule | Description |
|-----------|-------------|
| omni.kit.hotkeys.window.column_delegate.action_column_delegate | No submodule docstring provided |
| omni.kit.hotkeys.window.column_delegate.hotkey_column_delegate | No submodule docstring provided |
| omni.kit.hotkeys.window.column_delegate.key_editor | No submodule docstring provided |
| omni.kit.hotkeys.window.column_delegate.reset_button | No submodule docstring provided |
| omni.kit.hotkeys.window.column_delegate.window_column_delegate | No submodule docstring provided | | 615 |
omni.kit.hotkeys.window.column_delegate.window_column_delegate.Classes.md | # omni.kit.hotkeys.window.column_delegate.window_column_delegate Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| [WindowColumnDelegate](#windowcolumndelegate) | A simple delegate to display/add action in column. |
### WindowColumnDelegate
A simple delegate to display/add action in column. | 322 |
omni.kit.hotkeys.window.extension.HotkeysExtension.md | # HotkeysExtension
## Methods
- `on_shutdown()`
- `on_startup()`
- `show_window(visible)`
## Attributes
- `MENU_GROUP`
- `WINDOW_NAME`
### `__init__(self: omni.ext._extensions.IExt)`
None | 192 |
omni.kit.hotkeys.window.md | # omni.kit.hotkeys.window
## Submodules
Summary:
| Module | Description |
|--------|-------------|
| omni.kit.hotkeys.window.column_delegate | No submodule docstring provided |
| omni.kit.hotkeys.window.extension | No submodule docstring provided |
| omni.kit.hotkeys.window.model | No submodule docstring provided |
| omni.kit.hotkeys.window.style | No submodule docstring provided |
| omni.kit.hotkeys.window.view | No submodule docstring provided |
| omni.kit.hotkeys.window.window | No submodule docstring provided |
## Classes
Summary:
| Class | Description |
|-------|-------------|
| HotkeysExtension | Simple helper class for adding/removing “Window” menu to your extension. ui.Window creation/show/hide is still down to user to provide functionally. | | 764 |
omni.kit.hotkeys.window.model.hotkeys_model.md | # omni.kit.hotkeys.window.model.hotkeys_model
## Classes Summary:
| Class | Description |
|-------|-------------|
| [HotkeysModel](omni.kit.hotkeys.window.model.hotkeys_model/omni.kit.hotkeys.window.model.hotkeys_model.HotkeysModel.html) | General data model for actions. | | 275 |
omni.kit.hotkeys.window.model.hotkey_item.Classes.md | # omni.kit.hotkeys.window.model.hotkey_item Classes
## Classes Summary
- **AbstractFilterItem**
- Represent extension actions belongs to.
- **AddWindowItem**
- Represent extension actions belongs to.
- **EmptyFilterWindowItem**
- Represent extension actions belongs to.
- **EmptyHotkey**
- Hotkey object class.
- **EmptyHotkeyItem**
- General action item.
- **FilterContextItem**
- Represent extension actions belongs to.
- **FilterWindowItem**
- Represent extension actions belongs to.
- **GlobalFilterItem**
- Represent extension actions belongs to.
- **HotkeyDetailItem**
- (No description provided)
# General action item. | 653 |
Subsets and Splits