file_path
stringlengths 5
148
| content
stringlengths 0
526k
|
|---|---|
omni.kit.context_menu.post_notification.md | # post_notification
## post_notification
```python
omni.kit.context_menu.post_notification(message: str, info: bool = False, duration: int = 3)
```
Post a notification via omni.kit.notification_manager.
### Parameters
- **message** (str) – The notification text.
- **info** (bool) – notification is NotificationStatus.INFO when True otherwise NotificationStatus.WARNING
- **duration** (int) – The duration (in seconds) after which the notification will be hidden. This duration only works if hide_after_timeout is True. |
omni.kit.context_menu.reorder_menu_dict.md | # reorder_menu_dict
## reorder_menu_dict
Reorder menus using “appear_after” value in menu
### Parameters
- **menu_dict** (list) – list of dictionaries |
omni.kit.context_menu.scripts.Classes.md | # omni.kit.context_menu.scripts Classes
## Classes Summary
- **ContextMenuExtension**
- Context menu core functionality.
- **ViewportMenu**
- Viewport context menu implementation with own styling
### ContextMenuExtension
[ContextMenuExtension](./omni.kit.context_menu.scripts/omni.kit.context_menu.scripts.ContextMenuExtension.html)
### ViewportMenu
[ViewportMenu](./omni.kit.context_menu.scripts/omni.kit.context_menu.scripts.ViewportMenu.html) |
omni.kit.context_menu.scripts.context_menu.Classes.md | # omni.kit.context_menu.scripts.context_menu Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| [ContextMenuExtension](./omni.kit.context_menu.scripts.context_menu/omni.kit.context_menu.scripts.context_menu.ContextMenuExtension.html) | Context menu core functionality. | |
omni.kit.context_menu.scripts.context_menu.md | # omni.kit.context_menu.scripts.context_menu
## Classes Summary
- [ContextMenuExtension](omni.kit.context_menu.scripts.context_menu/omni.kit.context_menu.scripts.context_menu.ContextMenuExtension.html): Context menu core functionality.
## Functions Summary
- [add_menu](omni.kit.context_menu.scripts.context_menu/omni.kit.context_menu.scripts.context_menu.add_menu.html): Add custom menu to any context_menu
- [close_menu](omni.kit.context_menu.scripts.context_menu/omni.kit.context_menu.scripts.context_menu.close_menu.html): Close currently open context menu. Used by tests not to leave context menu in bad state.
- [get_hovered_prim](omni.kit.context_menu.scripts.context_menu/omni.kit.context_menu.scripts.context_menu.get_hovered_prim.html): Get prim currently under mouse cursor or None.
- [get_instance](omni.kit.context_menu.scripts.context_menu/omni.kit.context_menu.scripts.context_menu.get_instance.html): Get instance of context menu class
- [get_menu_dict](omni.kit.context_menu.scripts.context_menu/omni.kit.context_menu.scripts.context_menu.get_menu_dict.html): Get custom menus
- [get_menu_event_stream](omni.kit.context_menu.scripts.context_menu/omni.kit.context_menu.scripts.context_menu.get_menu_event_stream.html): Gets menu event stream.
- [get_widget_instance](omni.kit.context_menu.scripts.context_menu/omni.kit.context_menu.scripts.context_menu.get_widget_instance.html): Get instance of context menu class
<p>
post_notification
</p>
<p>
Post a notification via omni.kit.notification_manager.
</p>
<p>
reorder_menu_dict
</p>
<p>
Reorder menus using “appear_after” value in menu
</p> |
omni.kit.context_menu.scripts.get_menu_dict.md | # get_menu_dict
## get_menu_dict
### omni.kit.context_menu.scripts.get_menu_dict
#### Parameters
- **index** (str) – name of the menu
- **extension_id** (str) – name of the target
#### Returns
- a list of dictionaries containing custom menu settings. See ContextMenuExtension docs for information on values
#### Return type
- (list) |
omni.kit.context_menu.scripts.md | # omni.kit.context_menu.scripts
## Submodules
Summary:
- [omni.kit.context_menu.scripts.context_menu](omni.kit.context_menu.scripts.context_menu.html)
- Context menu implementation classes.
- [omni.kit.context_menu.scripts.viewport_menu](omni.kit.context_menu.scripts.viewport_menu.html)
- Viewport context menu implementation with own styling
## Classes
Summary:
- [ContextMenuExtension](omni.kit.context_menu.scripts/omni.kit.context_menu.scripts.ContextMenuExtension.html)
- Context menu core functionality.
- [ViewportMenu](omni.kit.context_menu.scripts/omni.kit.context_menu.scripts.ViewportMenu.html)
- Viewport context menu implementation with own styling
## Functions
Summary:
- [add_menu](omni.kit.context_menu.scripts/omni.kit.context_menu.scripts.add_menu.html)
- Add custom menu to any context_menu
- [close_menu](omni.kit.context_menu.scripts/omni.kit.context_menu.scripts.close_menu.html)
- Close currently open context menu. Used by tests not to leave context menu in bad state.
- [get_hovered_prim](omni.kit.context_menu.scripts/omni.kit.context_menu.scripts.get_hovered_prim.html)
- Get prim currently under mouse cursor or None.
- [get_instance](omni.kit.context_menu.scripts/omni.kit.context_menu.scripts.get_instance.html)
- Get instance of context menu class
- [get_menu_dict](omni.kit.context_menu.scripts/omni.kit.context_menu.scripts.get_menu_dict.html)
- Get menu dictionary
| HTML Content | Markdown Content |
|--------------|------------------|
| Get custom menus | Get custom menus |
| get_menu_event_stream | get_menu_event_stream |
| Gets menu event stream. | Gets menu event stream. |
| get_widget_instance | get_widget_instance |
| Get instance of context menu class | Get instance of context menu class |
| post_notification | post_notification |
| Post a notification via omni.kit.notification_manager. | Post a notification via omni.kit.notification_manager. |
| reorder_menu_dict | reorder_menu_dict |
| Reorder menus using “appear_after” value in menu | Reorder menus using “appear_after” value in menu | |
omni.kit.context_menu.scripts.reorder_menu_dict.md | # reorder_menu_dict
## reorder_menu_dict
```python
omni.kit.context_menu.scripts.reorder_menu_dict(menu_dict: List[dict])
```
Reorder menus using “appear_after” value in menu
**Parameters**
- **menu_dict** (list) – list of dictionaries |
omni.kit.context_menu.scripts.Submodules.md | # omni.kit.context_menu.scripts Submodules
## Submodules Summary
| Module Name | Description |
|-------------|-------------|
| omni.kit.context_menu.scripts.context_menu | Context menu implementation classes. |
| omni.kit.context_menu.scripts.viewport_menu | Viewport context menu implementation with own styling | |
omni.kit.context_menu.scripts.ViewportMenu.md | # ViewportMenu
## ViewportMenu
| Function Name | Description |
|---------------|-------------|
| `set_prim_to_pos(path, new_pos)` | |
| `show_create_menu(objects)` | |
| `show_menu(usd_context_name[, prim_path, ...])` | |
### Attributes
| Attribute Name | Description |
|----------------|-------------|
| `menu_delegate` | |
### Methods
#### `__init__()`
#### `ViewportMenuDelegate`
**Class**: `ViewportMenuDelegate(**kwargs)`
- **Bases**: `DefaultMenuDelegate`
##### `get_style()`
- **Description**: Get current style |
omni.kit.context_menu.scripts.viewport_menu.Classes.md | # omni.kit.context_menu.scripts.viewport_menu Classes
## Classes Summary
- **ViewportMenu**
- Viewport context menu implementation with own styling |
omni.kit.context_menu.Submodules.md | # omni.kit.context_menu Submodules
## Submodules Summary
| Module | Description |
| --- | --- |
| [omni.kit.context_menu.scripts](omni.kit.context_menu.scripts.html) | Context menu implementation classes. | |
omni.kit.context_menu.ViewportMenu.md | # ViewportMenu
## ViewportMenu
Viewport context menu implementation with own styling
### Methods
- `bind_material_to_prim_dialog(objects)`
- `can_show_clear_clipboard(objects, menu_item)`
- `clear_clipboard()`
- `copy_prim_to_clipboard(objects)`
- `is_material_bindable(objects)`
- `is_on_clipboard(objects, name)`
- `is_prim_on_clipboard(objects)`
- `paste_prim_from_clipboard(objects)`
- `set_prim_to_pos(path, new_pos)`
```{code-block} html
:linenos:
<span class="pre">
show_create_menu
</span>
</code>
(objects)
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr class="row-odd">
<td>
<p>
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
show_menu
</span>
</code>
(usd_context_name[, prim_path, ...])
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
</tbody>
</table>
<p class="rubric">
Attributes
</p>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%"/>
<col style="width: 90%"/>
</colgroup>
<tbody>
<tr class="row-odd">
<td>
<p>
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
menu_delegate
</span>
</code>
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.context_menu.ViewportMenu.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)</span>
<a class="headerlink" href="#omni.kit.context_menu.ViewportMenu.__init__" title="Permalink to this definition">
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="omni.kit.context_menu.ViewportMenu.ViewportMenuDelegate">
<em class="property">
<span class="pre">
class
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
ViewportMenuDelegate
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="o">
<span class="pre">
**
</span>
</span>
<span class="n">
<span class="pre">
kwargs
</span>
</span>
</em>
<span class="sig-paren">
)</span>
<a class="headerlink" href="#omni.kit.context_menu.ViewportMenu.ViewportMenuDelegate" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Bases:
<code class="xref py py-class docutils literal notranslate">
<span class="pre">
DefaultMenuDelegate
</span>
</code>
</p>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.context_menu.ViewportMenu.ViewportMenuDelegate.get_style">
<span class="sig-name descname">
<span class="pre">
get_style
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)</span>
<a class="headerlink" href="#omni.kit.context_menu.ViewportMenu.ViewportMenuDelegate.get_style" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Get current style
</p>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</section>
</div>
</div>
<footer>
<hr/>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
``` |
omni.kit.converter.cad.CadConverter.md | # CadConverter
## Class: omni.kit.converter.cad.CadConverter
Bases: `omni.ext._extensions.IExt`
### Methods
- `__init__(self: omni.ext._extensions.IExt) -> None`
- `on_shutdown()`
- `on_startup()` |
omni.kit.converter.cad.Classes.md | # omni.kit.converter.cad Classes
## Classes Summary:
- [CadConverter](omni.kit.converter.cad/omni.kit.converter.cad.CadConverter.html) |
omni.kit.converter.cad.Functions.md | # omni.kit.converter.cad Functions
## Functions Summary
- **get_instance** |
omni.kit.converter.cad.get_instance.md | # get_instance
## omni.kit.converter.cad.get_instance
|
omni.kit.converter.cad.md | # omni.kit.converter.cad
## Classes Summary
- **CadConverter**
## Functions Summary
- **get_instance** |
omni.kit.converter.cad_core.acquire_interface.md | # acquire_interface
## acquire_interface
|
omni.kit.converter.cad_core.CadConverterHelper.md | # CadConverterHelper
## CadConverterHelper
```python
class omni.kit.converter.cad_core.CadConverterHelper
```
Bases: `object`
Can be used to make calls to the CAD converter and for updating the USD stage
### Methods
- `__init__()`
- Initialize CAD 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()`
- (No description provided)
- `set_progress_changed_callback(cb)`
- Set change in progress
- `set_step_changed_callback(cb)`
- (No description provided)
### Attributes
| Name | Description |
| --- | --- |
| `CONVERTER_EXT_NAME` | |
### Methods
#### `__init__()`
Initialize CAD Converter Helper class
#### `cancel_task()`
Cancel CAD file conversion
#### `create_import_task(converter_options: omni.kit.converter.cad_core._impl.options_models.HoopsOptions)`
Wraps the Hoops Exchange CAD Converter so that it works with Nucleus files.
**Parameters:**
- `converter_options` – converter settings object
**Returns:**
- Final output destination URL.
- hoops_convert_status(namedtuple): Hoops error code and associated message
**Return type:**
- output_destination_url (str)
#### `destroy()`
Clean up resources
#### `set_progress_changed_callback(cb)`
Set change in progress
#### `set_step_changed_callback(cb)`
Set change in step |
omni.kit.converter.cad_core.CadCoreConverter.md | # CadCoreConverter
## CadCoreConverter
```python
class omni.kit.converter.cad_core.CadCoreConverter(omni.ext._extensions.IExt)
```
CAD Core Converter Extension
### Methods
| Method | Description |
|--------|-------------|
| `create_converter_task(converter_options[, ...])` | Converts CAD file (import_path) to USD (output_path) |
| `on_shutdown()` | Uninitialize the CAD Converter and/or un-registers the service |
| `on_startup()` | Initialize the CAD Converter and/or un-registers the service |
```python
def __init__(self: omni.ext._extensions.IExt) -> None:
pass
def create_converter_task(self, converter_options, *args, **kwargs):
pass
def on_shutdown(self):
pass
def on_startup(self):
pass
```
<em>
<span class="n">
<span class="pre">
converter_options
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
omni.kit.converter.cad_core._impl.options_models.HoopsOptions
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
progress_changed_callback
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
step_changed_callback
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Converts CAD file (import_path) to USD (output_path)
</p>
<p>
Returns: An object containing the Path to the converted USD (str) and converter status (namedtuple).
</p>
<p>
If the path is empty, the conversion has failed.
</p>
<p>
The namedtuple contains error code (int) and error message (str).
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
converter_options
</strong>
– converter settings object
</p>
</li>
<li>
<p>
<strong>
progress_changed_callback
</strong>
– callback function (progress_text:str, progress_value:float)
</p>
</li>
<li>
<p>
<strong>
step_changed_callback
</strong>
– callback function (step_text:str)
</p>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.cad_core.CadCoreConverter.on_shutdown">
<span class="sig-name descname">
<span class="pre">
on_shutdown
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Uninitialize the CAD Converter and/or un-registers the service
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.cad_core.CadCoreConverter.on_startup">
<span class="sig-name descname">
<span class="pre">
on_startup
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Initialize the CAD Converter and/or un-registers the service
</p>
</dd>
</dl> |
omni.kit.converter.cad_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.
---
title: "文章标题"
author: "作者"
date: "2023-04-01"
---
## 一级标题
这里是正文内容，包含一些文本和格式。
### 二级标题
这里是更多的文本内容。
#### 三级标题
这里是更详细的文本内容。
---
这里是页脚内容。 |
omni.kit.converter.cad_core.Classes.md | # omni.kit.converter.cad_core Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| CadConverterHelper | Can be used to make calls to the CAD converter and for updating the USD stage |
| CadCoreConverter | CAD Core Converter Extension |
| CadRequest | Generic request object. Can be used to retrieve result after completing. |
| HoopsExchangeCadConverter | Initialize interface class |
| HoopsOptions | Please defer to the hoopsExchangeCADConverterSpec base class for a list of all HoopsOptions converter settings |
| hoopsExchangeCADConverterSpec | HoopsExchangeCADConverter Options Class. | |
omni.kit.converter.cad_core.Functions.md | # omni.kit.converter.cad_core Functions
## 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.cad_core._hoops_cad_converter.HoopsExchangeCadConverter
- **release_interface**
- release_interface(arg0: omni.kit.converter.cad_core._hoops_cad_converter.HoopsExchangeCadConverter) -> None |
omni.kit.converter.cad_core.get_instance.md | # get_instance
## get_instance
→ Optional[omni.kit.converter.cad_core._impl.extension.CadCoreConverter]
If available, returns the weakref pointer |
omni.kit.converter.cad_core.HoopsExchangeCadConverter.md | # HoopsExchangeCadConverter
## Class: omni.kit.converter.cad_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, ...)**
Enables asynchronous file conversion when used with convert_object()
<table>
<tbody>
<tr class="row-odd">
<td>
<p>
<code>get_cached_stage_id</code> (self)
</p>
</td>
<td>
<p>
Retrieves stage id
</p>
</td>
</tr>
<tr class="row-even">
<td>
<p>
<code>set_progress_changed_callback</code> (self, fn)
</p>
</td>
<td>
<p>
Set change in progress
</p>
</td>
</tr>
<tr class="row-odd">
<td>
<p>
<code>set_step_changed_callback</code> (self, fn)
</p>
</td>
<td>
<p>
Set change in step
</p>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt>
<code>__init__</code> (*args, **kwargs)
</dt>
<dd>
</dd>
</dl>
<dl class="py method">
<dt>
<code>cancel_convert</code> (self) -> None
</dt>
<dd>
<p>
Cancel CAD file conversion
</p>
</dd>
</dl>
<dl class="py method">
<dt>
<code>convert_file</code> (self, configPath: str) -> Tuple[int, str]
</dt>
<dd>
<p>
Convert file using JSON config file path
</p>
</dd>
</dl>
<dl class="py method">
<dt>
<code>convert_file_with_callback</code> (self, configPath: str)
</dt>
<dd>
</dd>
</dl>
</table>
### convert_file_with_callback(self: omni.kit.converter.cad_core._hoops_cad_converter.HoopsExchangeCadConverter, file: str, callback: Callable[[[Tuple[int, str]], None]) -> omni.kit.converter.cad_core.CadRequest
- Enables asynchronous file conversion when used with convert_file()
### convert_object(self: omni.kit.converter.cad_core._hoops_cad_converter.HoopsExchangeCadConverter, configObject: omni.kit.converter.cad_core._hoops_cad_converter.hoopsExchangeCADConverterSpec) -> Tuple[int, str]
- Converts file using JSON config object
### convert_object_with_callback(self: omni.kit.converter.cad_core._hoops_cad_converter.HoopsExchangeCadConverter, configObject: omni.kit.converter.cad_core._hoops_cad_converter.hoopsExchangeCADConverterSpec, callback: Callable[[[Tuple[int, str]], None]) -> Tuple[int, str]
- Converts file using JSON config object with callback
## omni.kit.converter.cad_core.HoopsExchangeCadConverter.convert_object_with_callback
- **Description**: Enables asynchronous file conversion when used with convert_object()
## omni.kit.converter.cad_core.HoopsExchangeCadConverter.get_cached_stage_id
- **Description**: Retrieves stage id
## omni.kit.converter.cad_core.HoopsExchangeCadConverter.set_progress_changed_callback
- **Description**: Set change in progress
## omni.kit.converter.cad_core.HoopsExchangeCadConverter.set_step_changed_callback
- **Description**: Set step change callback |
omni.kit.converter.cad_core.hoopsExchangeCADConverterSpec.md | # hoopsExchangeCADConverterSpec
## Class
class omni.kit.converter.cad_core.hoopsExchangeCADConverterSpec
### Description
HoopsExchangeCADConverter Options Class.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self)` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `bAccurateSurfaceCurvatures` | Consider surface curvature to control triangles elongation direction |
| `bDedup` | Deduplicate mesh vertices and normals (welds mesh) |
| `bGlobalXforms` | When instancing = false, this flag controls whether globalXforms are composited. |
| `bInstancing` | If true, enable instancing |
| `bMappedMaterials` | |
| Key | Description |
| --- | ----------- |
| bMappedMaterials | Use material mapping or native materials |
| 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 |
| sFileNameOut | Name of output USD file (the head file only in the case of multiple output files) |
| sFilePathIn | Path to input model head file |
| sFolderPathOut | Path to output destination folder |
| sSettingsFolderPath | Path to material csv and potentially any other settings files |
| sUsdSuffix | 'usd', 'usda', 'usdc' |
omni.kit.converter.cad_core._hoops_cad_converter.hoopsExchangeCADConverterSpec
property bAccurateSurfaceCurvatures
Consider surface curvature to control triangles elongation direction
Type: (bool)
property bDedup
Deduplicate mesh vertices and normals (welds mesh)
Type: (bool)
property bGlobalXforms
When instancing = false, this flag controls whether globalXforms are composited. If false local transforms are applied
Type: (bool)
property bInstancing
If true, enable instancing
Type: (bool)
property bMappedMaterials
Use material mapping or native materials
Type: (bool)
property bOptimize
Run UJITSO optimization on completed usd files
Type: (bool)
property bReportProgress
If true then we report import/export progress
Type: (bool)
property bReportProgressFreq
Progress reporting frequency in Hz.
Type: (bool)
(int)
### bUseCurrentStage
property
Use currently opened USD.
Type: (bool)
### bUseMaterials
property
If true then use specified modes of materials. if false, then use only basic display colors
Type: (bool)
### bUseNormals
property
If true then we pass normals to USD. if false, then we do not.
Type: (bool)
### iTessLOD
property
0=kA3DTessLODExtraLow, 1=kA3DTessLODLow,2=kA3DTessLODMedium, 3=kA3DTessLODHigh, 4=kA3DTessLODExtraHigh
Type: (int)
Tessellation Level of Detail (LOD) presets
### sConfigFilePath
property
Configuration file path
Type: (str)
### sFileNameOut
property
Name of output USD file (the head file only in the case of multiple output files)
Type: (str)
### sFilePathIn
property
Path to input model head file
Type: (str)
### sFolderPathOut
property
Path to output destination folder
Type: (str)
### sSettingsFolderPath
property
Path to settings folder
Type: (str)
Path to material csv and potentially any other settings files
Type:
- (str)
sUsdSuffix:
- ‘usd’, ‘usda’, ‘usdc’
- Type: (UsdSuffix)
- Type: Save file(s) in following formats |
omni.kit.converter.cad_core.HoopsOptions.md | # HoopsOptions
## Class: omni.kit.converter.cad_core.HoopsOptions
Bases:
- omni.kit.converter.cad_core._hoops_cad_converter.hoopsExchangeCADConverterSpec
- omni.kit.converter.common.common.BaseOptions
Please defer to the hoopsExchangeCADConverterSpec base class for a list of all HoopsOptions converter settings
### Methods
- **__init__()**
- Initialize the Hoops Exchange Converter Spec
### Attributes
- None listed
### __init__
Initialize the Hoops Exchange Converter Spec |
omni.kit.converter.cad_core.md | # omni.kit.converter.cad_core
## Classes Summary:
- **CadConverterHelper**
- Can be used to make calls to the CAD converter and for updating the USD stage
- **CadCoreConverter**
- CAD Core Converter Extension
- **CadRequest**
- Generic request object. Can be used to retrieve result after completing.
- **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.cad_core._hoops_cad_converter.HoopsExchangeCadConverter
- **release_interface**
- release_interface(arg0: omni.kit.converter.cad_core._hoops_cad_converter.HoopsExchangeCadConverter) -> None |
omni.kit.converter.cad_core.release_interface.md | # release_interface
## release_interface |
omni.kit.converter.cad_core_api.md | # omni.kit.converter.cad_core API
## Directory hierarchy
- **dir**
- **8fa04669143f4cb0**
- **_build**
- **target-deps**
- **hoops_exchange_cad_converter_release**
## Namespace hierarchy
### Namespace hierarchy
#### Namespace hierarchy
##### Namespace hierarchy
###### Namespace hierarchy
- dir
- 8fa04669143f4cb0/_build/target-deps/hoops_exchange_cad_converter_release/hoops_exchange_cad_converter
- dir
- 8fa04669143f4cb0/_build/target-deps/hoops_exchange_cad_converter_release/hoops_exchange_cad_converter/include
- dir
- 8fa04669143f4cb0/_build/target-deps/hoops_exchange_cad_converter_release/hoops_exchange_cad_converter/include/hoops_reader
- file
- 8fa04669143f4cb0/_build/target-deps/hoops_exchange_cad_converter_release/hoops_exchange_cad_converter/include/hoops_reader/CADConverterSpec.h
## Namespace hierarchy
- struct
- hoopsExchangeCADConverterSpec
- struct
- hoopsExchangeCADConverterSpecDescription
## API contents
- [Directories](directories.html)
- [Files](files.html)
- [Structs](structs.html) |
omni.kit.converter.common.BaseOptions.md | # BaseOptions
## BaseOptions
```python
class omni.kit.converter.common.BaseOptions
```
A utility for storing and managing JSON data associated with CAD Converter options
### Methods
| Method | Description |
|--------|-------------|
| `as_dict()` | Returns object as a python dictionary |
| `from_json(json_dict)` | Parse json and store in the options class |
| `json()` | Returns object as a json string |
| `write_json(file_path)` | Takes json object and writes out to a file |
```python
def __init__():
pass
```
```python
def as_dict():
return dict
```
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.BaseOptions.from_json">
<em class="property">
<span class="pre">
classmethod
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
from_json
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
json_dict
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Parse json and store in the options class
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.BaseOptions.json">
<span class="sig-name descname">
<span class="pre">
json
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Returns object as a json string
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.BaseOptions.write_json">
<span class="sig-name descname">
<span class="pre">
write_json
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
file_path
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
str
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Takes json object and writes out to a file
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<p>
<strong>
file_path
</strong>
(
<em>
str
</em>
) – output file path
</p>
</dd>
</dl>
</dd>
</dl> |
omni.kit.converter.common.Classes.md | # omni.kit.converter.common Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| BaseOptions | A utility for storing and managing JSON data associated with CAD Converter options |
| ConverterFilterData | Used to hold information about a CAD Converters supported file types |
| ConverterStatus | Represents the conversion status |
| ICadCoreExtBase | Base Cad Converter Extension Class |
| ICadExtBase | Base Cad Converter Extension Class |
| OmniClientWrapper | Helper class based on omni.client library |
| OmniUrl | Omniverse Url Helper Class |
| UsdSuffix | Enums for USD Suffixes | |
omni.kit.converter.common.ConverterFilterData.md | # ConverterFilterData
## Class Definition
```python
class omni.kit.converter.common.ConverterFilterData(name: str, filter_regexes: List[str], filter_descriptions: List[str])
```
### Description
Bases: `object`
Used to hold information about a CAD Converters supported file types
### Methods
- `__init__(name, filter_regexes, filter_descriptions)`
### Attributes
- `name`: Name of the CAD Converter and the native application
- `filter_regexes`: List of regexes for filtering file types
- `filter_descriptions`: List of descriptions for the filter regexes
```
| Key | Description |
|--------------------------|------------------------------|
| `filter_regexes` | List of the supported file extensions |
| `filter_descriptions` | Description of the supported file extensions |
### `__init__(name: str, filter_regexes: List[str], filter_descriptions: List[str]) -> None`
- **name**: str
- **filter_regexes**: List[str]
- **filter_descriptions**: List[str]
### `filter_descriptions`: List[str]
- Description of the supported file extensions
### `filter_regexes`: List[str]
- List of the supported file extensions
### `name`: str
- Name of the CAD Converter and the native application |
omni.kit.converter.common.ConverterStatus.md | # ConverterStatus
## Summary
Bases: `NamedTuple`
Represents the conversion status
### Methods
### Attributes
| Attribute | Description |
|-----------|-------------|
| `error_code` | Alias for field number 0 |
| `error_msg` | Alias for field number 1 |
<dl class="py attribute">
<dt class="sig sig-object py" id="omni.kit.converter.common.ConverterStatus.error_code">
<span class="sig-name descname">
<span class="pre">
error_code
</span>
</span>
<em class="property">
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="pre">
int
</span>
</em>
<a class="headerlink" href="#omni.kit.converter.common.ConverterStatus.error_code" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Alias for field number 0
</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="omni.kit.converter.common.ConverterStatus.error_msg">
<span class="sig-name descname">
<span class="pre">
error_msg
</span>
</span>
<em class="property">
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="pre">
str
</span>
</em>
<a class="headerlink" href="#omni.kit.converter.common.ConverterStatus.error_msg" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Alias for field number 1
</p>
</dd>
</dl> |
omni.kit.converter.common.Functions.md | # omni.kit.converter.common Functions
## Functions Summary:
| Function Name | Description |
|---------------|-------------|
| initialize_connect_sdk | Initializes the Connect SDK |
| is_asset_supported | If the asset is supported by the specified filters. |
| run_scene_opt | If the stage was successfully authored then execute the scene optimizer. |
| strip_file_regex | Strips the input_path regex from input_path file; else, returns stem |
| validate_file_path | Utility to address file picker issue which is returning url-escaped versions of special chars. | |
omni.kit.converter.common.ICadCoreExtBase.md | # ICadCoreExtBase
## Methods
- `get_converter_registry()`
- Import and return ConverterRegistry or None if service ext is not loaded
- `get_ext_name()`
- Return the extension name, ie: omni.kit.converter.hoops_core
- `get_ext_path()`
- Return the path to the extension
- `get_ext_version()`
- Return the version of the extension
- `get_filters()`
- Return list of `ConverterFilterData`
## Attributes
- `FILTER_DATA`
- (Description not provided in the HTML)
<p>
</p>
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
OPTIONS_CLS
</span>
</code>
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
SERVICE_TITLE
</span>
</code>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.ICadCoreExtBase.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
</span>
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
self
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
omni.ext._extensions.IExt
</span>
</span>
</em>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
None
</span>
</span>
</span>
</dt>
<dd>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.ICadCoreExtBase.get_converter_registry">
<span class="sig-name descname">
<span class="pre">
get_converter_registry
</span>
</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
Optional
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
ConverterRegistry
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
</span>
</dt>
<dd>
<p>
Import and return ConverterRegistry or None if service ext is not loaded
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.ICadCoreExtBase.get_ext_name">
<span class="sig-name descname">
<span class="pre">
get_ext_name
</span>
</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
str
</span>
</span>
</span>
</dt>
<dd>
<p>
Return the extension name, ie: omni.kit.converter.hoops_core
</p>
<p>
Returns: `str`
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.ICadCoreExtBase.get_ext_path">
<span class="sig-name descname">
<span class="pre">
get_ext_path
</span>
</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
pathlib.Path
</span>
</span>
</span>
</dt>
<dd>
<p>
Return the path to the extension
</p>
<p>
Returns: `Path`
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.ICadCoreExtBase.get_ext_version">
<span class="sig-name descname">
<span class="pre">
get_ext_version
</span>
</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
str
</span>
</span>
</span>
</dt>
<dd>
<p>
Return the version of the extension
</p>
<p>
Returns: `str`
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.ICadCoreExtBase.get_filters">
<span class="sig-name descname">
<span class="pre">
get_filters
</span>
</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
List
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
omni.kit.converter.common.common.ConverterFilterData
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
</span>
</dt>
<dd>
<p>
Return list of `ConverterFilterData`
</p>
</dd>
</dl> |
omni.kit.converter.common.ICadExtBase.md | # ICadExtBase
## ICadExtBase
- Bases: `omni.ext._extensions.IExt`
- Base Cad Converter Extension Class
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self)` | |
| `get_ext_name()` | Return the extension name, ie: omni.kit.converter.hoops |
| `get_ext_path()` | Return the path to the extension |
| `get_ext_version()` | Return the version of the extension |
| `get_filters()` | Return list of `ConverterFilterData` |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `DELEGATE` | |
| FILTER_DATA |
| --- |
__init__(self: omni.ext._extensions.IExt) -> None
get_ext_name() -> str
Return the extension name, ie: omni.kit.converter.hoops
Returns: `str`
get_ext_path() -> pathlib.Path
Return the path to the extension
Returns: `Path`
get_ext_version() -> str
Return the version of the extension
Returns: `str`
get_filters() -> List[omni.kit.converter.common.common.ConverterFilterData]
Return list of `ConverterFilterData` |
omni.kit.converter.common.initialize_connect_sdk.md | # initialize_connect_sdk
## initialize_connect_sdk
```python
omni.kit.converter.common.initialize_connect_sdk(core_ext_name: str) -> None
```
Initializes the Connect SDK
``` |
omni.kit.converter.common.is_asset_supported.md | # is_asset_supported
## is_asset_supported
```python
omni.kit.converter.common.is_asset_supported(path: str, filters: List[str]) -> bool
```
If the asset is supported by the specified filters.
``` |
omni.kit.converter.common.md | # omni.kit.converter.common
## Classes Summary
- **BaseOptions**
- A utility for storing and managing JSON data associated with CAD Converter options
- **ConverterFilterData**
- Used to hold information about a CAD Converters supported file types
- **ConverterStatus**
- Represents the conversion status
- **ICadCoreExtBase**
- Base Cad Converter Extension Class
- **ICadExtBase**
- Base Cad Converter Extension Class
- **OmniClientWrapper**
- Helper class based on omni.client library
- **OmniUrl**
- Omniverse Url Helper Class
- **UsdSuffix**
- Enums for USD Suffixes
## Functions Summary
- **initialize_connect_sdk**
- Initializes the Connect SDK
- **is_asset_supported**
- If the asset is supported by the specified filters.
- **run_scene_opt**
- (Function description not provided in the HTML snippet)
| | |
| --- | --- |
| | If the stage was successfully authored then execute the scene optimizer. |
| | Strips the input_path regex from input_path file; else, returns stem |
| | Utility to address file picker issue which is returning url-escaped versions of special chars. | |
omni.kit.converter.common.OmniClientWrapper.md | # OmniClientWrapper
## OmniClientWrapper
- **Bases:** `object`
- **Description:** Helper class based on omni.client library
### Methods
| Method | Description |
|--------|-------------|
| `copy(src_path, dest_path)` | Asynchronously copy an item from src_url to dst_url and wait for the result |
| `copy_sync(src_path, dest_path)` | Copy an item from src_url to dst_url and wait for the result |
| `create_folder(path)` | Asynchronously create a folder |
| `create_folder_sync(path)` | Create a folder |
| `exists(path)` | Asynchronously Retrieve information about a single item |
| `exists_sync(path)` | Retrieve information about a single item and wait for the result |
| Method | Description |
| ------ | ----------- |
| `read` (src_path) | Asynchronously read a file |
| `write` (path, content) | Asynchronously write a file |
### `__init__`
### `copy`
```python
async static copy(src_path: str, dest_path: str)
```
Asynchronously copy an item from src_url to dst_url and wait for the result
**Parameters:**
- **src_path** – input file to copy
- **dest_path** – destination path to copy to
**Returns:**
- true if successfully copied to destination
**Return type:**
- boolean
### `copy_sync`
```python
static copy_sync(src_path: str, dest_path: str)
```
Copy an item from src_url to dst_url and wait for the result
**Parameters:**
- **src_path** – input file to copy
- **dest_path** – destination path to copy to
**Returns:**
- true if successfully copied to destination
**Return type:**
- boolean
### `create_folder`
```python
async static create_folder(path)
```
Asynchronously create a folder
### `create_folder_sync`
```python
static create_folder_sync(path)
```
```
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.OmniClientWrapper.create_folder_sync">
<span class="pre">create_folder_sync</span>
<span class="sig-paren">(</span>
<em class="sig-param">
<span class="n">
<span class="pre">path</span>
</span>
</em>
<span class="sig-paren">)</span>
</dt>
<dd>
<p>Create a folder</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.OmniClientWrapper.exists">
<em class="property">
<span class="pre">async</span>
<span class="w"></span>
<span class="pre">static</span>
<span class="w"></span>
</em>
<span class="sig-name descname">
<span class="pre">exists</span>
</span>
<span class="sig-paren">(</span>
<em class="sig-param">
<span class="n">
<span class="pre">path</span>
</span>
</em>
<span class="sig-paren">)</span>
</dt>
<dd>
<p>Asynchronously Retrieve information about a single item</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd">
<p><strong>path</strong> – file path</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even">
<p>true if the result is OK</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd">
<p>boolean</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.OmniClientWrapper.exists_sync">
<em class="property">
<span class="pre">static</span>
<span class="w"></span>
</em>
<span class="sig-name descname">
<span class="pre">exists_sync</span>
</span>
<span class="sig-paren">(</span>
<em class="sig-param">
<span class="n">
<span class="pre">path</span>
</span>
</em>
<span class="sig-paren">)</span>
</dt>
<dd>
<p>Retrieve information about a single item and wait for the result</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd">
<p><strong>path</strong> – file path</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even">
<p>true if the result is OK</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd">
<p>boolean</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.OmniClientWrapper.read">
<em class="property">
<span class="pre">async</span>
<span class="w"></span>
<span class="pre">static</span>
<span class="w"></span>
</em>
<span class="sig-name descname">
<span class="pre">read</span>
</span>
<span class="sig-paren">(</span>
<em class="sig-param">
<span class="n">
<span class="pre">src_path</span>
</span>
<span class="p">
<span class="pre">:</span>
</span>
<span class="w"></span>
<span class="n">
<span class="pre">str</span>
</span>
</em>
<span class="sig-paren">)</span>
</dt>
<dd>
<p>Asynchronously read a file</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.kit.converter.common.OmniClientWrapper.write">
<em class="property">
<span class="pre">async</span>
<span class="w"></span>
<span class="pre">static</span>
<span class="w"></span>
</em>
<span class="sig-name descname">
<span class="pre">write</span>
</span>
<span class="sig-paren">(</span>
<em class="sig-param">
<span class="n">
<span class="pre">path</span>
</span>
<span class="p">
<span class="pre">:</span>
</span>
<span class="w"></span>
<span class="n">
<span class="pre">str</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">content</span>
</span>
</em>
<span class="sig-paren">)</span>
</dt>
<dd>
<p>Asynchronously write a file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd">
<p><strong>path</strong> – output file path</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even">
<p>true if file was written successfully</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd">
<p>boolean</p>
</dd>
</dl>
</dd>
</dl> |
omni.kit.converter.common.OmniUrl.md | # OmniUrl
## OmniUrl
```
class omni.kit.converter.common.OmniUrl(url: Union[str, pathlib.Path], list_entry=None)
```
**Bases:** `object`
**Omniverse Url Helper Class**
### Methods
| Method | Description |
|--------|-------------|
| `__init__(url[, list_entry])` | Returns url as a OmniUrl() |
| `get_local_file()` | Returns: Path() object for local file |
| `get_local_file_async()` | Returns: Path() object for local file |
| `sync_stat()` | Returns the status of the url |
```
| Attribute | Description |
|-----------|-------------|
| `url_with_name(name)` | Return a new url with the url path final component changed. |
| `url_with_path(path)` | Return a new url with the path changed. |
| `url_with_suffix(suffix)` | Return a url with the file full suffix changed. |
| `exists` | True if exists; else False |
| `full_suffix` | Return path suffix(s) if any. |
| `name` | The final path component, if any. |
| `parent_url` | OmniUrl object |
| `path` | Returns the path |
| `scheme` | |
| `stat` | Status of the url |
| `stem` | The final path component, minus its suffix(s). |
| `suffix` | The final component's last suffix, if any. |
| `writeable` | Checks if the url path is writeable |
### `__init__(url: Union[str, pathlib.Path], list_entry)`
## Methods
### `__init__(self)`
- Returns url as a OmniUrl()
### `get_local_file()`
- Returns: Path() object for local file
### `get_local_file_async()`
- Returns: Path() object for local file
### `sync_stat()`
- Returns the status of the url
### `url_with_name(name: str)`
- Return a new url with the url path final component changed.
### `url_with_path(path: pathlib.Path)`
- Return a new url with the path changed.
### `url_with_suffix(suffix: str)`
- Return a url with the file full suffix changed. If the url path has no suffix, add given suffix. If the given suffix is an empty string, remove the suffix from the url path.
### `exists`
- (Property)
### OmniUrl Properties
#### exists
True if exists; else False
- **Type**: Returns
#### full_suffix
Return path suffix(s) if any.
This includes the leading period. For example: ‘.skelanim.usd’
#### name
The final path component, if any.
#### parent_url
OmniUrl object
- **Type**: Returns
#### path
Returns the path
#### stat
Status of the url
#### stem
The final path component, minus its suffix(s).
#### suffix
The final component’s last suffix, if any.
This includes the leading period. For example: ‘.txt’
#### writeable
Checks if the url path is writeable |
omni.kit.converter.common.run_scene_opt.md | # run_scene_opt
## run_scene_opt
```python
omni.kit.converter.common.run_scene_opt(output_path: str, bOptimize: bool, bConvertHidden: bool)
```
If the stage was successfully authored then execute the scene optimizer.
``` |
omni.kit.converter.common.strip_file_regex.md | # strip_file_regex
## strip_file_regex
```python
omni.kit.converter.common.strip_file_regex(input_path: pathlib.Path, file_regex_patterns) -> str
```
**Description:**
Strips the input_path regex from input_path file; else, returns stem
**Parameters:**
- **input_path** (Path) – input file path
- **file_regex_patterns** – regex patterns to strip from input_path
**Returns:**
- name of file without suffix
**Return type:**
- str
``` |
omni.kit.converter.common.UsdSuffix.md | # UsdSuffix
## Attributes
- **USD**
- USD (Universal Scene Description) file format
- **USDC**
- USD Crate File Format
- **USDA**
- USDA are human-readable and editable USD files
## USDA
USDA are human-readable and editable USD files
## USDC
USD Crate File Format |
omni.kit.converter.common.validate_file_path.md | # validate_file_path
## validate_file_path
```python
omni.kit.converter.common.validate_file_path(file_path: str) -> Optional[str]
```
Utility to address file picker issue which is returning url-escaped versions of special chars.
If a raw path and path does not exist, returns the escaped file path if it exists, otherwise returns None.
``` |
omni.kit.converter.dgn.Classes.md | # omni.kit.converter.dgn Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| [DgnConverter](omni.kit.converter.dgn/omni.kit.converter.dgn.DgnConverter.html) | Base Cad Converter Extension Class |
| [DgnConverterDelegate](omni.kit.converter.dgn/omni.kit.converter.dgn.DgnConverterDelegate.html) | AbstractImporterDelegate is abstract class for extending | |
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
这是一个段落，包含一个链接。
```
这是一段代码。
```
描述图片的文本
--- |
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. |
omni.kit.converter.dgn.Functions.md | # omni.kit.converter.dgn Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| `get_instance` | If available, returns the weakref pointer | |
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
``` |
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 |
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 |
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 |
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__()` |
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
```
``` |
omni.kit.converter.dgn_core.Functions.md | # omni.kit.converter.dgn_core Functions
## Functions Summary
- **get_instance**
- If available, returns the weakref pointer |
omni.kit.converter.dgn_core.get_instance.md | # get_instance
## get_instance
```
If available, returns the weakref pointer
``` |
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 | |
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>
<span class="n">
<span class="pre">
omni.ext._extensions.IExt
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
None
</span>
</span>
</span>
<dt>
<dd>
</dd>
</dl>
<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
</span>
</span>
<dd>
<p>
alias of
<code class="xref py py-class docutils literal notranslate">
<span class="pre">
omni.kit.converter.dgn_core.impl.options.OdaDgnOptions
</span>
</code>
</p>
</dd>
</dl>
<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>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-paren">
)
</span>
<dd>
<p>
Uninitialize the DGN Converter and/or un-registers the service
</p>
</dd>
</dl>
<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>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
ext_id
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<dd>
<p>
Initialize the DGN Converter and/or registers the service
</p>
</dd>
</dl>
</dd>
</dl>
</section>
</div>
</div>
<footer>
<hr/>
</footer>
</div>
</div>
</section>
</div> |
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__()` |
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 |
omni.kit.converter.dgn_core.impl.extension.Functions.md | # omni.kit.converter.dgn_core.impl.extension Functions
## Functions Summary
- **get_instance**
- If available, returns the weakref pointer |
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 |
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 |
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 | |
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 |
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 | |
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 |
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 |
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 |
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 |
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 |
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 |
omni.kit.converter.dgn_core.Submodules.md | # omni.kit.converter.dgn_core Submodules
## Submodules Summary
- **omni.kit.converter.dgn_core.impl**
- No submodule docstring provided |
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. | |
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 | |
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. |
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` |
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. |
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 |
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
```
``` |
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.
```
这是一个代码块。
```
描述图片的文本 |
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. | |
omni.kit.converter.hoops_core.get_instance.md | # get_instance
## get_instance
If available, returns the weakref pointer
Returns: Optional[HoopsCoreConverter] |
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>
<p>
Set change in step
</p>
<p class="rubric">
Attributes
</p>
<p>
CONVERTER_EXT_NAME
</p>
<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></span>
<span class="sig-paren">()</span>
</dt>
<dd>
<p>
Initialize Hoops Converter Helper class
</p>
</dd>
</dl>
<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></span>
<span class="sig-paren">()</span>
</dt>
<dd>
<p>
Cancel CAD file conversion
</p>
</dd>
</dl>
<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><span class="w"></span></em>
<span class="sig-name descname"><span class="pre">create_import_task</span></span>
<span class="sig-paren">()</span>
<em class="sig-param"><span class="n"><span class="pre">converter_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"></span><span class="n"><span class="pre">omni.kit.converter.hoops_core._impl.options.HoopsOptions</span></span></em>
<span class="sig-return"><span class="sig-return-icon">→</span><span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"></span><span class="pre">omni.kit.converter.common.common.ConverterStatus</span><span class="p"><span class="pre">]</span></span></span></span>
</dt>
<dd>
<p>
Wraps the Hoops Exchange CAD Converter so that it works with Nucleus files.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<p>
<strong>converter_options</strong> – converter settings object
</p>
</dd>
<dt class="field-even">
Returns
</dt>
<dd class="field-even">
<p>
Final output destination URL.
hoops_convert_status(namedtuple): Hoops error code and associated message
</p>
</dd>
<dt class="field-odd">
Return type
</dt>
<dd class="field-odd">
<p>
output_destination_url (str)
</p>
</dd>
</dl>
</dd>
</dl>
<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></span>
<span class="sig-paren">()</span>
</dt>
<dd>
<p>
Clean up resources
</p>
</dd>
</dl>
<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></span>
<span class="sig-paren">()</span>
<em class="sig-param"><span class="n"><span class="pre">cb</span></span></em>
</dt>
<dd>
<p>
Set change in progress
</p>
</dd>
</dl>
<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></span>
<span class="sig-paren">()</span>
<em class="sig-param"><span class="n"><span class="pre">cb</span></span></em>
</dt>
<dd>
<p>
Set change in step
</p>
</dd>
</dl> |
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
</span>
</dt>
<dd>
<p>
alias of
<code class="xref py py-class docutils literal notranslate">
<span class="pre">
omni.kit.converter.hoops_core._impl.options.HoopsOptions
</span>
</code>
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-name descname">
<span class="pre">
create_converter_task
</span>
</dt>
<dd>
<p>
Converts CAD file (import_path) to USD (output_path)
</p>
<p>
Returns: An object containing the Path to the converted USD (str) and converter status (namedtuple).
</p>
<p>
If the path is empty, the conversion has failed.
</p>
<p>
The namedtuple contains error code (int) and error message (str).
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
converter_options
</strong>
– converter settings object
</p>
</li>
<li>
<p>
<strong>
progress_changed_callback
</strong>
– callback function (progress_text:str, progress_value:float)
</p>
</li>
<li>
<p>
<strong>
step_changed_callback
</strong>
– callback function (step_text:str)
</p>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-name descname">
<span class="pre">
on_shutdown
</span>
</dt>
<dd>
<p>
Uninitialize the Hoops Converter and/or un-registers the service
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-name descname">
<span class="pre">
on_startup
</span>
</dt>
<dd>
<p>
Initialize the Hoops Converter and/or un-registers the service
</p>
</dd>
</dl>
</section> |
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>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
str
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
callback
</span>
</span>
<span class="p">
<span class="pre">:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Callable
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
Tuple
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
int
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
str
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
None
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
</em>
<span class="sig-paren">
)</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
omni.kit.converter.hoops_core.CadRequest
</span>
</span>
</span>
</dt>
<dd>
<p>
Enables asynchronous file conversion when used with convert_file()
</p>
</dd>
</dl>
<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>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
self
</span>
</span>
<span class="p">
<span class="pre">:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
omni.kit.converter.hoops_core._hoops_cad_converter.HoopsExchangeCadConverter
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
configObject
</span>
</span>
<span class="p">
<span class="pre">:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
omni.kit.converter.hoops_core._hoops_cad_converter.hoopsExchangeCADConverterSpec
</span>
</span>
</em>
<span class="sig-paren">
)</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
Tuple
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
int
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
str
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
</span>
</dt>
<dd>
<p>
Converts file using JSON config object
</p>
</dd>
</dl>
<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>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
self
</span>
</span>
<span class="p">
<span class="pre">:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
omni.kit.converter.hoops_core._hoops_cad_converter.HoopsExchangeCadConverter
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
configObject
</span>
</span>
<span class="p">
<span class="pre">:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
omni.kit.converter.hoops_core._hoops_cad_converter.hoopsExchangeCADConverterSpec
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
callback
</span>
</span>
<span class="p">
<span class="pre">:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Callable
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
Tuple
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
int
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
str
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
None
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
</em>
<span class="sig-paren">
)</span>
</dt>
<dd>
<p>
Converts file using JSON config object
</p>
</dd>
</dl>
### 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
</span>
<dt>
<a class="headerlink" href="#omni.kit.converter.hoops_core.HoopsExchangeCadConverter.set_step_changed_callback" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Set change in step
</p>
</dd>
<footer>
<hr/>
</footer> |
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) |
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 |
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 |
omni.kit.converter.hoops_core_api.md | # omni.kit.converter.hoops_core API
## Directory hierarchy |
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__()
```
``` |
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__()`
``` |
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)
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
``` |
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__() |
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 |
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__()
```
``` |
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 |
Subsets and Splits