file_path
stringlengths 5
148
| content
stringlengths 0
526k
|
|---|---|
omni.ui.set_shade.md | # set_shade
## set_shade |
omni.ui.ShadowFlag.md | # ShadowFlag
## Class omni.ui.ShadowFlag
Bases: pybind11_object
Members:
- NONE
- CUT_OUT_SHAPE_BACKGROUND
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self, value)` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `CUT_OUT_SHAPE_BACKGROUND` | |
| `NONE` | |
| `name` | |
| `value` | |
### Method Details
#### `__init__(self, value)`
<section name="omni.ui.ShadowFlag">
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.ShadowFlag.__init__">
<em class="method object">
<span class="pre">
def
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
__init__
</span>
</span>
<span class="sig-paren">
(
</span>
<span class="sig-params">
<span class="p">
<span class="pre">
self
</span>
</span>
<span class="p">
<span class="pre">
value
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</span>
</span>
</span>
<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>
</em>
</dt>
<dd>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.ShadowFlag.name">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
name
</span>
</span>
</dt>
<dd>
</dd>
</dl>
</section> |
omni.ui.Shape.md | # Shape
## Shape
The Shape widget provides a base class for all the Shape Widget. Currently implemented are Rectangle, Circle, Triangle, Line, Ellipse and BezierCurve.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(*args, **kwargs)` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
## `__init__(*args, **kwargs)` |
omni.ui.ShapeAnchorHelper.md | # ShapeAnchorHelper
## ShapeAnchorHelper
The ShapeAnchorHelper provides common functionality for Shape Anchors.
### Methods
- **__init__(*args, **kwargs)**
- **call_anchor_fn(self)**
Sets the function that will be called for the curve anchor.
- **get_closest_parametric_position(self, ...)**
Function that returns the closest parametric T value to a given x,y position.
- **has_anchor_fn(self)**
Sets the function that will be called for the curve anchor.
- **invalidate_anchor(self)**
Function that causes the anchor frame to be redrawn.
- **set_anchor_fn(self, fn)**
Sets the function that will be called for the curve anchor.
<p>
Sets the function that will be called for the curve anchor.
</p>
<p class="rubric">
Attributes
</p>
<table>
<colgroup>
<col style="width: 10%"/>
<col style="width: 90%"/>
</colgroup>
<tbody>
<tr class="row-odd">
<td>
<p>
<code>anchor_alignment</code>
</p>
</td>
<td>
<p>
This property holds the Alignment of the curve anchor.
</p>
</td>
</tr>
<tr class="row-even">
<td>
<p>
<code>anchor_position</code>
</p>
</td>
<td>
<p>
This property holds the parametric value of the curve anchor.
</p>
</td>
</tr>
</tbody>
</table>
<dl>
<dt>
<code>__init__(*args, **kwargs)</code>
<a href="#omni.ui.ShapeAnchorHelper.__init__" title="Permalink to this definition"></a>
</dt>
<dd>
</dd>
</dl>
<dl>
<dt>
<code>call_anchor_fn(self: omni.ui._ui.ShapeAnchorHelper) -> None</code>
<a href="#omni.ui.ShapeAnchorHelper.call_anchor_fn" title="Permalink to this definition"></a>
</dt>
<dd>
<p>
Sets the function that will be called for the curve anchor.
</p>
</dd>
</dl>
<dl>
<dt>
<code>get_closest_parametric_position(self: omni.ui._ui.ShapeAnchorHelper, position_x: float, position_y: float) -> float</code>
<a href="#omni.ui.ShapeAnchorHelper.get_closest_parametric_position" title="Permalink to this definition"></a>
</dt>
<dd>
<p>
Function that returns the closest parametric T value to a given x,y position.
</p>
</dd>
</dl>
<dl>
<dt>
<code>has_anchor_fn(self: omni.ui._ui.ShapeAnchorHelper) -> bool</code>
<a href="#omni.ui.ShapeAnchorHelper.has_anchor_fn" title="Permalink to this definition"></a>
</dt>
<dd>
<p>
Sets the function that will be called for the curve anchor.
</p>
</dd>
</dl>
<dl>
<dt>
<code>invalidate_anchor(self: omni.ui._ui.ShapeAnchorHelper)</code>
<a href="#omni.ui.ShapeAnchorHelper.invalidate_anchor" title="Permalink to this definition"></a>
</dt>
<dd>
</dd>
</dl>
### omni.ui.ShapeAnchorHelper.invalidate_anchor
Function that causes the anchor frame to be redrawn.
### omni.ui.ShapeAnchorHelper.set_anchor_fn
Sets the function that will be called for the curve anchor.
### omni.ui.ShapeAnchorHelper.anchor_alignment
This property holds the Alignment of the curve anchor.
### omni.ui.ShapeAnchorHelper.anchor_position
This property holds the parametric value of the curve anchor. |
omni.ui.SimpleBoolModel.md | # SimpleBoolModel
## SimpleBoolModel
Bases: `AbstractValueModel`
A very simple bool model.
### Methods
- `__init__(self[, default_value])`
- `get_max(self)`
- `get_min(self)`
- `set_max(self, arg0)`
- `set_min(self, arg0)`
### Attributes
- `max`
- This property holds the model's maximum value.
<table>
<tbody>
<tr class="row-even">
<td>
<p>
<code>min</code>
</p>
</td>
<td>
<p>This property holds the model's minimum value.</p>
</td>
</tr>
</tbody>
</table>
<dl>
<dt>
<code>__init__(self: omni.ui._ui.SimpleBoolModel, default_value: bool = False, **kwargs)</code>
<span>→ None</span>
</dt>
<dd></dd>
</dl>
<dl>
<dt>
<code>get_max(self: omni.ui._ui.SimpleBoolModel)</code>
<span>→ bool</span>
</dt>
<dd></dd>
</dl>
<dl>
<dt>
<code>get_min(self: omni.ui._ui.SimpleBoolModel)</code>
<span>→ bool</span>
</dt>
<dd></dd>
</dl>
<dl>
<dt>
<code>set_max(self: omni.ui._ui.SimpleBoolModel, arg0: bool)</code>
<span>→ None</span>
</dt>
<dd></dd>
</dl>
<dl>
<dt>
<code>set_min(self: omni.ui._ui.SimpleBoolModel, arg0: bool)</code>
<span>→ None</span>
</dt>
<dd></dd>
</dl>
## omni.ui.SimpleBoolModel.set_min
- **Type**: `bool`
- **Returns**: `None`
## omni.ui.SimpleBoolModel.max
- **Type**: `property`
- **Description**: This property holds the model’s maximum value.
## omni.ui.SimpleBoolModel.min
- **Type**: `property`
- **Description**: This property holds the model’s minimum value. |
omni.ui.SimpleFloatModel.md | # SimpleFloatModel
## SimpleFloatModel
- **Bases:** [AbstractValueModel](omni.ui.AbstractValueModel.html#omni.ui.AbstractValueModel)
- **Description:** A very simple double model.
### Methods
- `__init__(self[, default_value])`
- `get_max(self)`
- `get_min(self)`
- `set_max(self, arg0)`
- `set_min(self, arg0)`
### Attributes
- `max`
This property holds the model's minimum value.
<code>min</code>
This property holds the model's minimum value.
<dl>
<dt>
<code>__init__(self: omni.ui._ui.SimpleFloatModel, default_value: float = 0.0, **kwargs)</code>
<dd>
</dt>
<dt>
<code>get_max(self: omni.ui._ui.SimpleFloatModel)</code>
<dd>
</dt>
<dt>
<code>get_min(self: omni.ui._ui.SimpleFloatModel)</code>
<dd>
</dt>
<dt>
<code>set_max(self: omni.ui._ui.SimpleFloatModel, arg0: float)</code>
<dd>
</dt>
<dt>
<code>set_min(self: omni.ui._ui.SimpleFloatModel, arg0: float)</code>
<dd>
</dt>
</dl>
## omni.ui.SimpleFloatModel.set_min
### set_min(float) -> None
- **Description**:
## omni.ui.SimpleFloatModel.max
### property max
- **Description**: This property holds the model’s maximum value.
## omni.ui.SimpleFloatModel.min
### property min
- **Description**: This property holds the model’s minimum value. |
omni.ui.SimpleIntModel.md | # SimpleIntModel
## SimpleIntModel
Bases: `AbstractValueModel`
A very simple Int model.
### Methods
- `__init__(self[, default_value])`
- `get_max(self)`
- `get_min(self)`
- `set_max(self, arg0)`
- `set_min(self, arg0)`
### Attributes
- `max`
- This property holds the model's minimum value.
| Property | Description |
|----------|-------------|
| `min` | This property holds the model's minimum value. |
```python
__init__(self: omni.ui._ui.SimpleIntModel, default_value: int = 0, **kwargs) -> None
```
```python
get_max(self: omni.ui._ui.SimpleIntModel) -> int
```
```python
get_min(self: omni.ui._ui.SimpleIntModel) -> int
```
```python
set_max(self: omni.ui._ui.SimpleIntModel, arg0: int) -> None
```
```python
set_min(self: omni.ui._ui.SimpleIntModel, arg0: int) -> None
```
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.SimpleIntModel.max">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
max
</span>
</span>
</dt>
<dd>
<p>
This property holds the model’s minimum value.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.SimpleIntModel.min">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
min
</span>
</span>
</dt>
<dd>
<p>
This property holds the model’s minimum value.
</p>
</dd>
</dl> |
omni.ui.SimpleStringModel.md | # SimpleStringModel
## SimpleStringModel
A very simple value model that holds a single string.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self[, defaultValue])` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
### `__init__(self, defaultValue='')`
- **Parameters**:
- **self** : `omni.ui._ui.SimpleStringModel`
- **defaultValue** : `str` = ''
- **Returns**:
- `None`
# Hello, World!
This is an example of [a link].
Here is an image: ![Description of image] |
omni.ui.singleton.md | # omni.ui.singleton
## Functions Summary:
- **Singleton**
- Description: A singleton decorator |
omni.ui.SliderDrawMode.md | # SliderDrawMode
## Overview
The `SliderDrawMode` class is a part of the `omni.ui` module, inheriting from `pybind11_object`. It defines several modes for slider drawing.
### Members
- **FILLED**
- **HANDLE**
- **DRAG**
### Methods
- **__init__(self, value)**
### Attributes
- **DRAG**
- **FILLED**
- **HANDLE**
- **name**
- **value**
omni.ui._ui.SliderDrawMode(
value: int
) -> None
property name |
omni.ui.Spacer.md | # Spacer
The Spacer class provides blank space. Normally, it’s used to place other widgets correctly in a layout.
## Methods
- **__init__(self, **kwargs)**
- Construct Spacer.
## Attributes
## __init__
- **Parameters:**
- `self` : omni.ui._ui.Spacer
- `**kwargs` : dict
- **Returns:** None
Construct Spacer.
### Keyword Arguments:
- `width` : ui.Length
- This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
<dt>
`height
<span class="classifier">
ui.Length`
</span>
</dt>
<dd>
<p>
This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
</p>
</dd>
<dt>
`name
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
The name of the widget that user can set.
</p>
</dd>
<dt>
`style_type_name_override
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
</p>
</dd>
<dt>
`identifier
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
An optional identifier of the widget we can use to refer to it in queries.
</p>
</dd>
<dt>
`visible
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds whether the widget is visible.
</p>
</dd>
<dt>
`visibleMin
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
If the current zoom factor and DPI is less than this value, the widget is not visible.
</p>
</dd>
<dt>
`visibleMax
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
If the current zoom factor and DPI is bigger than this value, the widget is not visible.
</p>
</dd>
<dt>
`tooltip
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
</p>
</dd>
<dt>
`tooltip_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
</p>
</dd>
<dt>
`tooltip_offset_x
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`tooltip_offset_y
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`enabled
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
</p>
</dd>
<dt>
`selected
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds a flag that specifies the widget has to use eSelected state of the style.
</p>
</dd>
<dt>
`checked
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
</p>
</dd>
<dt>
`dragging
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds if the widget is being dragged.
</p>
</dd>
<dt>
`opaque_for_mouse_events
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
</p>
</dd>
<dt>
`skip_draw_when_clipped
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
</p>
</dd>
<dt>
`mouse_moved_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
</p>
</dd>
<dt>
`mouse_pressed_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
</p>
</dd>
<dt>
`mouse_released_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_double_clicked_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_wheel_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_hovered_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user hovers the mouse over the widget. The function specification is the same as in setMousePressedFn. void onMouseHovered(float x, float y, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dl>
<dt>
onMouseHovered(bool hovered)
</dt>
<dd>
<p>
Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHoveredFn. void onMouseHovered(bool hovered)
</p>
</dd>
<dt>
drag_fn
<span class="classifier">
Callable
</span>
</dt>
<dd>
<p>
Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
</p>
</dd>
<dt>
accept_drop_fn
<span class="classifier">
Callable
</span>
</dt>
<dd>
<p>
Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
</p>
</dd>
<dt>
drop_fn
<span class="classifier">
Callable
</span>
</dt>
<dd>
<p>
Specify that this Widget accepts drops and set the callback to the drop operation.
</p>
</dd>
<dt>
computed_content_size_changed_fn
<span class="classifier">
Callable
</span>
</dt>
<dd>
<p>
Called when the size of the widget is changed.
</p>
</dd>
</dl> |
omni.ui.Stack.md | # Stack
## Stack
The Stack class lines up child widgets horizontally, vertically or sorted in a Z-order.
### Methods
- **__init__(self, arg0, **kwargs)**
- Constructor.
### Attributes
- **content_clipping**
- Determines if the child widgets should be clipped by the rectangle of this Stack.
- **direction**
- This type is used to determine the direction of the layout.
- **send_mouse_events_to_back**
- When children of a Z-based stack overlap mouse events are normally sent to the topmost one.
- **spacing**
- Sets a non-stretchable space in pixels between child items of this layout.
(
self: omni.ui._ui.Stack,
arg0: omni.ui._ui.Direction,
**kwargs
) → None
### Arguments:
- `direction :`
- Determines the orientation of the Stack.
- `kwargs` dict
- See below
### Keyword Arguments:
- `direction`
- This type is used to determine the direction of the layout. If the Stack’s orientation is eLeftToRight the widgets are placed in a horizontal row, from left to right. If the Stack’s orientation is eRightToLeft the widgets are placed in a horizontal row, from right to left. If the Stack’s orientation is eTopToBottom, the widgets are placed in a vertical column, from top to bottom. If the Stack’s orientation is eBottomToTop, the widgets are placed in a vertical column, from bottom to top. If the Stack’s orientation is eBackToFront, the widgets are placed sorted in a Z-order in top right corner. If the Stack’s orientation is eFrontToBack, the widgets are placed sorted in a Z-order in top right corner, the first widget goes to front.
- `content_clipping`
- Determines if the child widgets should be clipped by the rectangle of this Stack.
- `spacing`
- Sets a non-stretchable space in pixels between child items of this layout.
- `send_mouse_events_to_back`
- When children of a Z-based stack overlap mouse events are normally sent to the topmost one. Setting this property true will invert that behavior, sending mouse events to the bottom-most child.
- `width` ui.Length
- This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
- `height` ui.Length
- This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
- `name` str
- The name of the widget that user can set.
- `style_type_name_override` str
- By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
- `identifier` str
- An optional identifier of the widget we can use to refer to it in queries.
- `visible` bool
- This property holds whether the widget is visible.
- `visibleMin` float
- If the current zoom factor and DPI is less than this value, the widget is not visible.
- `visibleMax` float
- If the current zoom factor and DPI is bigger than this value, the widget is not visible.
- `tooltip` str
- Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
- `tooltip_fn` Callable
- Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
- `tooltip_offset_x` float
- Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
- `tooltip_offset_y` float
- Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
### Properties
#### enabled
- **Type:** bool
- **Description:** This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
#### selected
- **Type:** bool
- **Description:** This property holds a flag that specifies the widget has to use eSelected state of the style.
#### checked
- **Type:** bool
- **Description:** This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
#### dragging
- **Type:** bool
- **Description:** This property holds if the widget is being dragged.
#### opaque_for_mouse_events
- **Type:** bool
- **Description:** If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
#### skip_draw_when_clipped
- **Type:** bool
- **Description:** The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
#### mouse_moved_fn
- **Type:** Callable
- **Description:** Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
#### mouse_pressed_fn
- **Type:** Callable
- **Description:** Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
#### mouse_released_fn
- **Type:** Callable
- **Description:** Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
#### mouse_double_clicked_fn
- **Type:** Callable
- **Description:** Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
#### mouse_wheel_fn
- **Type:** Callable
- **Description:** Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
#### mouse_hovered_fn
- **Type:** Callable
- **Description:** Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
#### drag_fn
- **Type:** Callable
- **Description:** Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
#### accept_drop_fn
- **Type:** Callable
- **Description:** Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
#### drop_fn
- **Type:** Callable
- **Description:** Specify that this Widget accepts drops and set the callback to the drop operation.
#### computed_content_size_changed_fn
- **Type:** Callable
- **Description:** Called when the size of the widget is changed.
### content_clipping
- **Description:** Determines if the child widgets should be clipped by the rectangle of this Stack.
### direction
- **Description:** This type is used to determine the direction of the layout. If the Stack’s orientation is eLeftToRight the widgets are placed in a horizontal row, from left to right. If the Stack’s orientation is eRightToLeft the widgets are placed in a horizontal row, from right to left. If the Stack’s orientation is eTopToBottom, the widgets are placed in a vertical column, from top to bottom. If the Stack’s orientation is eBottomToTop, the widgets are placed in a vertical column, from bottom to top. If the Stack’s orientation is eBackToFront, the widgets are placed sorted in a Z-order in top right corner. If the Stack’s orientation is eFrontToBack, the widgets are placed sorted in a Z-order in top right corner, the first widget goes to front.
### send_mouse_events_to_back
- **Description:**
## 属性说明
### omni.ui.Stack.send_mouse_events_to_back
当Z-based stack的子元素重叠时，鼠标事件通常会被发送到最顶层的子元素。设置此属性为true将反转该行为，将鼠标事件发送到最底层的子元素。
### omni.ui.Stack.spacing
设置此布局的子项之间的非可拉伸空间（以像素为单位）。 |
omni.ui.StringField.md | # StringField
## StringField
The StringField widget is a one-line text editor with a string model.
### Methods
| Method | Description |
| --- | --- |
| `__init__(self[, model])` | Constructs StringField. |
### Attributes
| Attribute | Description |
| --- | --- |
| `allow_tab_input` | This property holds if the field allows Tab input. |
| `multiline` | Multiline allows to press enter and create a new line. |
| `password_mode` | This property holds the password mode. |
| `read_only` | This property holds if the field is read-only. |
<dt>
Constructs StringField.
</dt>
<dd>
<p>
### Arguments:
</p>
<blockquote>
<div>
<dl class="simple">
<dt>
`model :`
</dt>
<dd>
<p>
The widget’s model. If the model is not assigned, the default model is created.
</p>
</dd>
<dt>
`kwargs
<span class="classifier">
dict`
</span>
</dt>
<dd>
<p>
See below
</p>
</dd>
</dl>
</div>
</blockquote>
<p>
### Keyword Arguments:
</p>
<blockquote>
<div>
<dl class="simple">
<dt>
`password_mode
<span class="classifier">
`
</span>
</dt>
<dd>
<p>
This property holds the password mode. If the field is in the password mode when the entered text is obscured.
</p>
</dd>
<dt>
`read_only
<span class="classifier">
`
</span>
</dt>
<dd>
<p>
This property holds if the field is read-only.
</p>
</dd>
<dt>
`multiline
<span class="classifier">
`
</span>
</dt>
<dd>
<p>
Multiline allows to press enter and create a new line.
</p>
</dd>
<dt>
`allow_tab_input
<span class="classifier">
`
</span>
</dt>
<dd>
<p>
This property holds if the field allows Tab input.
</p>
</dd>
<dt>
`width
<span class="classifier">
ui.Length`
</span>
</dt>
<dd>
<p>
This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
</p>
</dd>
<dt>
`height
<span class="classifier">
ui.Length`
</span>
</dt>
<dd>
<p>
This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
</p>
</dd>
<dt>
`name
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
The name of the widget that user can set.
</p>
</dd>
<dt>
`style_type_name_override
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
</p>
</dd>
<dt>
`identifier
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
An optional identifier of the widget we can use to refer to it in queries.
</p>
</dd>
<dt>
`visible
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds whether the widget is visible.
</p>
</dd>
<dt>
`visibleMin
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
If the current zoom factor and DPI is less than this value, the widget is not visible.
</p>
</dd>
<dt>
`visibleMax
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
If the current zoom factor and DPI is bigger than this value, the widget is not visible.
</p>
</dd>
<dt>
`tooltip
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
</p>
</dd>
<dt>
`tooltip_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
</p>
</dd>
<dt>
`tooltip_offset_x
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`tooltip_offset_y
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`enabled
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds whether the widget is enabled.
</p>
</dd>
</dl>
</div>
</blockquote>
</dd>
<dl>
<dt>enabled</dt>
<dd>
<p>This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.</p>
</dd>
<dt>selected bool</dt>
<dd>
<p>This property holds a flag that specifies the widget has to use eSelected state of the style.</p>
</dd>
<dt>checked bool</dt>
<dd>
<p>This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.</p>
</dd>
<dt>dragging bool</dt>
<dd>
<p>This property holds if the widget is being dragged.</p>
</dd>
<dt>opaque_for_mouse_events bool</dt>
<dd>
<p>If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either</p>
</dd>
<dt>skip_draw_when_clipped bool</dt>
<dd>
<p>The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.</p>
</dd>
<dt>mouse_moved_fn Callable</dt>
<dd>
<p>Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)</p>
</dd>
<dt>mouse_pressed_fn Callable</dt>
<dd>
<p>Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.</p>
</dd>
<dt>mouse_released_fn Callable</dt>
<dd>
<p>Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)</p>
</dd>
<dt>mouse_double_clicked_fn Callable</dt>
<dd>
<p>Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)</p>
</dd>
<dt>mouse_wheel_fn Callable</dt>
<dd>
<p>Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)</p>
</dd>
<dt>mouse_hovered_fn Callable</dt>
<dd>
<p>Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)</p>
</dd>
<dt>drag_fn Callable</dt>
<dd>
<p>Specify that this Widget is draggable, and set the callback that is attached to the drag operation.</p>
</dd>
<dt>accept_drop_fn Callable</dt>
<dd>
<p>Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.</p>
</dd>
<dt>drop_fn Callable</dt>
<dd>
<p>Specify that this Widget accepts drops and set the callback to the drop operation.</p>
</dd>
<dt>computed_content_size_changed_fn Callable</dt>
<dd>
<p>Called when the size of the widget is changed.</p>
</dd>
</dl>
<dl>
<dt>allow_tab_input</dt>
<dd>
<p>This property holds if the field allows Tab input.</p>
</dd>
</dl>
<dl>
<dt>multiline</dt>
<dd>
<p>Multiline allows to press enter and create a new line.</p>
</dd>
</dl>
<dl>
<dt>password_mode</dt>
<dd>
<p>This property holds the password mode. If the field is in the password mode when the entered text is obscured.</p>
</dd>
</dl>
<dl>
<dt>read_only</dt>
<dd>
<p>This property holds if the field is read only.</p>
</dd>
</dl>
This property holds if the field is read-only. |
omni.ui.StringStore.md | # StringStore
## Methods
- `__init__(*args, **kwargs)`
- `find(name)`
- Return the index of the color with specific name.
- `store(name, string)`
- Save the color by name.
<span class="w">
</span>
<span class="n">
<span class="pre">
str
</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">
str
</span>
</span>
</span>
<dt class="sig sig-object py" id="omni.ui.StringStore.find">
<em class="property">
<span class="pre">
static
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
find
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
name
</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>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
str
</span>
</span>
</span>
<dd>
<p>
Return the index of the color with specific name.
</p>
</dd>
</dt>
<dt class="sig sig-object py" id="omni.ui.StringStore.store">
<em class="property">
<span class="pre">
static
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
store
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
name
</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">
string
</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>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
None
</span>
</span>
</span>
<dd>
<p>
Save the color by name.
</p>
</dd>
</dt> |
omni.ui.Style.md | # Style
## Methods
- `__init__(*args, **kwargs)`
- `get_instance()`
- Get the instance of this singleton object.
## Attributes
- `default`
- Set the default root style.
### `__init__(*args, **kwargs)`
### `get_instance()`
### omni.ui.Style.get_instance
Get the instance of this singleton object.
### omni.ui.Style.default
property default
Set the default root style. It’s the style that is preselected when no alternative is specified. |
omni.ui.style_utils.md | # omni.ui.style_utils
## Module Overview
This document provides an overview of the `omni.ui.style_utils` module, which is part of the `omni.ui` submodules.
### Navigation
- [Home](https://docs.omniverse.nvidia.com/kit/docs)
- [API (python)](API.html)
- [Modules](Modules.html)
- [omni.ui](omni.ui.html)
- [omni.ui Submodules](omni.ui.Submodules.html)
### Module Details
#### omni.ui.style_utils
The `omni.ui.style_utils` module provides utility functions for styling components within the Omniverse Kit.
---
This documentation is part of the Omniverse Kit 2.25.15 documentation. |
omni.ui.Submodules.md | # omni.ui Submodules
## Submodules Summary
| Submodule | Description |
|-----------|-------------|
| omni.ui.abstract_shade | No submodule docstring provided |
| omni.ui.color_utils | No submodule docstring provided |
| omni.ui.constant_utils | No submodule docstring provided |
| omni.ui.extension | No submodule docstring provided |
| omni.ui.singleton | No submodule docstring provided |
| omni.ui.style_utils | No submodule docstring provided |
| omni.ui.url_utils | No submodule docstring provided |
| omni.ui.workspace_utils | The utilities to capture and restore layout | |
omni.ui.TextureFormat.md | # TextureFormat
## TextureFormat
```
class omni.ui.TextureFormat
```
Bases:
```
pybind11_object
```
Members:
- R8_UNORM
- R8_SNORM
- R8_UINT
- R8_SINT
- RG8_UNORM
- RG8_SNORM
- RG8_UINT
- RG8_SINT
- BGRA8_UNORM
- BGRA8_SRGB
- RGBA8_UNORM
- RGBA8_SNORM
- RGBA8_UINT
- RGBA8_SINT
- RGBA8_SRGB
- R16_UNORM
- R16_SNORM
- R16_UINT
- R16_SINT
- R16_SFLOAT
- RG16_UNORM
- RG16_SNORM
- RG16_UINT
- RG16_SINT
- RG16_SFLOAT
- RGBA16_UNORM
- RGBA16_SNORM
- RGBA16_UINT
- RGBA16_SINT
- RGBA16_SFLOAT
- R32_UINT
- R32_SINT
- R32_SFLOAT
- RG32_UINT
- RG32_SINT
- RG32_SFLOAT
- RGB32_UINT
- RGB32_SINT
- RGB32_SFLOAT
- RGBA32_UINT
- RGBA32_SINT
- RGBA32_SFLOAT
- R10_G10_B10_A2_UNORM
- R10_G10_B10_A2_UINT
- R11_G11_B10_UFLOAT
- R9_G9_B9_E5_UFLOAT
- B5_G6_R5_UNORM
- B5_G5_R5_A1_UNORM
- BC1_RGBA_UNORM
- BC1_RGBA_SRGB
- BC2_RGBA_UNORM
- BC2_RGBA_SRGB
- BC3_RGBA_UNORM
- BC3_RGBA_SRGB
- BC4_R_UNORM
- BC4_R_SNORM
- BC5_RG_UNORM
- BC5_RG_SNORM
- BC6H_RGB_UFLOAT
- BC6H_RGB_SFLOAT
- BC7_RGBA_UNORM
- BC7_RGBA_SRGB
- D16_UNORM
- D24_UNORM_S8_UINT
- D32_SFLOAT
- D32_SFLOAT_S8_UINT_X24
- R24_UNORM_X8
- X24_R8_UINT
- X32_R8_UINT_X24
- R32_SFLOAT_X8_X24
- SAMPLER_FEEDBACK_MIN_MIP
- SAMPLER_FEEDBACK_MIP_REGION_USED
### Methods
```
| Attribute | Description |
|-----------|-------------|
| `__init__` | (self, value) |
## Attributes
| Attribute | Description |
|-----------|-------------|
| `B5_G5_R5_A1_UNORM` | |
| `B5_G6_R5_UNORM` | |
| `BC1_RGBA_SRGB` | |
| `BC1_RGBA_UNORM` | |
| `BC2_RGBA_SRGB` | |
| `BC2_RGBA_UNORM` | |
| `BC3_RGBA_SRGB` | |
| `BC3_RGBA_UNORM` | |
| `BC4_R_SNORM` | |
| `BC4_R_UNORM` | |
| `BC5_RG_SNORM` | |
| `BC5_RG_UNORM` | |
| `BC6H_RGB_SFLOAT` | |
| `BC6H_RGB_UFLOAT` | |
| `BC7_RGBA_SRGB` | |
| `BC7_RGBA_UNORM` | |
| `BGRA8_SRGB` | |
| `BGRA8_UNORM` | |
| `D16_UNORM` | |
| `D24_UNORM_S8_UINT` | |
| `D32_SFLOAT` | |
| `D32_SFLOAT_S8_UINT_X24` | |
- **R10_G10_B10_A2_UINT**
- **R10_G10_B10_A2_UNORM**
- **R11_G11_B10_UFLOAT**
- **R16_SFLOAT**
- **R16_SINT**
- **R16_SNORM**
- **R16_UINT**
- **R16_UNORM**
- **R24_UNORM_X8**
- **R32_SFLOAT**
- **R32_SFLOAT_X8_X24**
- **R32_SINT**
- **R32_UINT**
- **R8_SINT**
- **R8_SNORM**
- **R8_UINT**
- **R8_UNORM**
- **R9_G9_B9_E5_UFLOAT**
- **RG16_SFLOAT**
- **RG16_SINT**
- **RG16_SNORM**
- **RG16_UINT**
- **RG16_UNORM**
- **RG32_SFLOAT**
- **RG32_SINT**
- **RG32_UINT**
- `RG8_SINT`
- `RG8_SNORM`
- `RG8_UINT`
- `RG8_UNORM`
- `RGB32_SFLOAT`
- `RGB32_SINT`
- `RGB32_UINT`
- `RGBA16_SFLOAT`
- `RGBA16_SINT`
- `RGBA16_SNORM`
- `RGBA16_UINT`
- `RGBA16_UNORM`
- `RGBA32_SFLOAT`
- `RGBA32_SINT`
- `RGBA32_UINT`
- `RGBA8_SINT`
- `RGBA8_SNORM`
- `RGBA8_SRGB`
- `RGBA8_UINT`
- `RGBA8_UNORM`
- `SAMPLER_FEEDBACK_MIN_MIP`
- `SAMPLER_FEEDBACK_MIP_REGION_USED`
- `X24_R8_UINT`
- `X32_R8_UINT_X24`
| name | value |
|------|-------|
| name | |
| value| |
__init__(self: omni.gpu_foundation_factory._gpu_foundation_factory.TextureFormat, value: int) -> None
property name |
omni.ui.ToolBar.md | # ToolBar
## ToolBar
The ToolBar class represents a window in the underlying windowing system that as some fixed size property.
### Methods
- **__init__**(self, title, **kwargs)
- Construct ToolBar.
- **set_axis_changed_fn**(self, arg0)
-
### Attributes
- **axis**
-
Construct ToolBar.
> ```
> kwargs
> dict
> ```
> See below
### Keyword Arguments:
> ```
> axis
> ui.Axis
> ```
> @brief axis for the toolbar
> ```
> axis_changed_fn
> Callable[[ui.Axis], None]
> ```
> @brief axis for the toolbar
> ```
> flags
> ```
> This property set the Flags for the Window.
> ```
> visible
> ```
> This property holds whether the window is visible.
> ```
> title
> ```
> This property holds the window’s title.
> ```
> padding_x
> ```
> This property set the padding to the frame on the X axis.
> ```
> padding_y
> ```
> This property set the padding to the frame on the Y axis.
> ```
> width
> ```
> This property holds the window Width.
> ```
> height
> ```
> This property holds the window Height.
> ```
> position_x
> ```
> This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
> ```
> position_y
> ```
> This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
> ```
> auto_resize
> ```
> setup the window to resize automatically based on its content
> ```
> noTabBar
> ```
> setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically
> ```
> tabBarTooltip
> ```
> This property sets the tooltip when hovering over window’s tabbar.
> ```
> raster_policy
> ```
> Determine how the content of the window should be rastered.
> ```
> width_changed_fn
> ```
> This property holds the window Width.
> ```
> height_changed_fn
> ```
> This property holds the window Height.
> ```
> visibility_changed_fn
> ```
> This property holds whether the window is visible.
</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">
None
</span>
</span>
</span>
</dt>
<dd>
</dd>
</dl>
</dd>
</dl>
</section>
</div>
</div>
<footer>
<hr/>
</footer>
</div>
</div>
</section> |
omni.ui.ToolBarAxis.md | # ToolBarAxis
## Class Definition
```python
class omni.ui.ToolBarAxis(pybind11_object)
```
### Members
- X
- Y
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self, value)` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `X` | |
| `Y` | |
| `name` | |
| `value` | |
## `__init__` Method
```python
__init__(self, value)
```
```
<section>
<dl class="py function">
<dt class="sig sig-object py" id="omni.ui.ToolBarAxis.__init__">
<em class="function">
<span class="pre">
def
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
__init__
</span>
</span>
<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>
</em>
</dt>
<dd>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.ToolBarAxis.name">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
name
</span>
</span>
</dt>
<dd>
</dd>
</dl>
</section> |
omni.ui.ToolButton.md | # ToolButton
## ToolButton
```python
class omni.ui.ToolButton
```
Bases:
```python
Button, ValueModelHelper
```
ToolButton is functionally similar to Button, but provides a model that determines if the button is checked. This button toggles between checked (on) and unchecked (off) when the user clicks it.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self[, model])` | Construct a checkable button with the model. |
### Attributes
| Attribute | Description |
|-----------|-------------|
```python
def __init__(self, model=None, **kwargs):
self: omni.ui._ui.ToolButton
model: omni.ui._ui.AbstractValueModel = None
```
```
<dt>
`model :`
</dt>
<dd>
<p>
The model that determines if the button is checked.
</p>
</dd>
<dt>
`kwargs
<span class="classifier">
dict`
</span>
</dt>
<dd>
<p>
See below
</p>
</dd>
</dl>
</div>
</blockquote>
<p>
### Keyword Arguments:
</p>
<blockquote>
<div>
<dl class="simple">
<dt>
`text
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
This property holds the button’s text.
</p>
</dd>
<dt>
`image_url
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
This property holds the button’s optional image URL.
</p>
</dd>
<dt>
`image_width
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
This property holds the width of the image widget. Do not use this function to find the width of the image.
</p>
</dd>
<dt>
`image_height
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
This property holds the height of the image widget. Do not use this function to find the height of the image.
</p>
</dd>
<dt>
`spacing
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
Sets a non-stretchable space in points between image and text.
</p>
</dd>
<dt>
`clicked_fn
<span class="classifier">
Callable[[], None]`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when when the button is activated (i.e., pressed down then released while the mouse cursor is inside the button).
</p>
</dd>
<dt>
`width
<span class="classifier">
ui.Length`
</span>
</dt>
<dd>
<p>
This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
</p>
</dd>
<dt>
`height
<span class="classifier">
ui.Length`
</span>
</dt>
<dd>
<p>
This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
</p>
</dd>
<dt>
`name
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
The name of the widget that user can set.
</p>
</dd>
<dt>
`style_type_name_override
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
</p>
</dd>
<dt>
`identifier
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
An optional identifier of the widget we can use to refer to it in queries.
</p>
</dd>
<dt>
`visible
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds whether the widget is visible.
</p>
</dd>
<dt>
`visibleMin
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
If the current zoom factor and DPI is less than this value, the widget is not visible.
</p>
</dd>
<dt>
`visibleMax
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
If the current zoom factor and DPI is bigger than this value, the widget is not visible.
</p>
</dd>
<dt>
`tooltip
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
</p>
</dd>
<dt>
`tooltip_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
</p>
</dd>
<dt>
`tooltip_offset_x
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`tooltip_offset_y
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`enabled
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
</p>
</dd>
<dt>
`selected
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds a flag that specifies the widget has to use eSelected state of the style.
</p>
</dd>
<dt>
`checked
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
</p>
</dd>
</dl>
</div>
</blockquote>
<dl>
<dt>
`dragging
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds if the widget is being dragged.
</p>
</dd>
<dt>
`opaque_for_mouse_events
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
</p>
</dd>
<dt>
`skip_draw_when_clipped
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
</p>
</dd>
<dt>
`mouse_moved_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
</p>
</dd>
<dt>
`mouse_pressed_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
</p>
</dd>
<dt>
`mouse_released_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_double_clicked_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_wheel_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_hovered_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
</p>
</dd>
<dt>
`drag_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
</p>
</dd>
<dt>
`accept_drop_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
</p>
</dd>
<dt>
`drop_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Specify that this Widget accepts drops and set the callback to the drop operation.
</p>
</dd>
<dt>
`computed_content_size_changed_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Called when the size of the widget is changed.
</p>
</dd>
</dl> |
omni.ui.TreeView.md | # TreeView
## TreeView
TreeView is a widget that presents a hierarchical view of information. Each item can have a number of subitems. An indentation often visualizes this in a list. An item can be expanded to reveal subitems, if any exist, and collapsed to hide subitems.
TreeView can be used in file manager applications, where it allows the user to navigate the file system directories. They are also used to present hierarchical data, such as the scene object hierarchy.
TreeView uses a model/view pattern to manage the relationship between data and the way it is presented. The separation of functionality gives developers greater flexibility to customize the presentation of items and provides a standard interface to allow a wide range of data sources to be used with other widgets.
TreeView is responsible for the presentation of model data to the user and processing user input. To allow some flexibility in the way the data is presented, the creation of the sub-widgets is performed by the delegate. It provides the ability to customize any sub-item of TreeView.
### Methods
- `__init__(*args, **kwargs)`
- Overloaded function.
- `call_hover_changed_fn(self, arg0, arg1)`
- Set the callback that is called when the item hover status is changed.
- `call_selection_changed_fn(self, arg0)`
- Set the callback that is called when the selection is changed.
- `clear_selection(self)`
- Clear the selection.
### Methods
- **Deselects all selected items.**
- **dirty_widgets (self)**
- When called, it will make the delegate to regenerate all visible widgets the next frame.
- **extend_selection (self, item)**
- Extends the current selection selecting all the items between currently selected nodes and the given item.
- **has_hover_changed_fn (self)**
- Set the callback that is called when the item hover status is changed.
- **has_selection_changed_fn (self)**
- Set the callback that is called when the selection is changed.
- **is_expanded (self, item)**
- Returns true if the given item is expanded.
- **set_expanded (self, item, expanded, recursive)**
- Sets the given item expanded or collapsed.
- **set_hover_changed_fn (self, fn)**
- Set the callback that is called when the item hover status is changed.
- **set_selection_changed_fn (self, fn)**
- Set the callback that is called when the selection is changed.
- **toggle_selection (self, item)**
- Switches the selection state of the given item.
### Attributes
- **column_widths**
- Widths of the columns.
- **columns_resizable**
- When true, the columns can be resized with the mouse.
- **drop_between_items**
- When true, the tree nodes can be dropped between items.
- **expand_on_branch_click**
- This flag allows to prevent expanding when the user clicks the plus icon.
- **header_visible**
- This property holds if the header is shown or not.
- **keep_alive**
- This property holds if the header is shown or not.
| Property Name | Description |
|---------------|-------------|
| `keep_alive` | When true, the tree nodes are never destroyed even if they are disappeared from the model. |
| `keep_expanded` | Expand all the nodes and keep them expanded regardless their state. |
| `min_column_widths` | Minimum widths of the columns. |
| `root_expanded` | The expanded state of the root item. |
| `root_visible` | This property holds if the root is shown. |
| `selection` | Set current selection. |
### Arguments:
#### `model :`
- The given model.
#### `kwargs : dict`
- See below
### Keyword Arguments:
#### `delegate :`
- The Item delegate that generates a widget per item.
#### `header_visible :`
- This property holds if the header is shown or not.
#### `selection :`
- Set current selection.
#### `expand_on_branch_click :`
- This flag allows to prevent expanding when the user clicks the plus icon. It’s used in the case the user wants to control how the items expanded or collapsed.
#### `keep_alive :`
- When true, the tree nodes are never destroyed even if they are disappeared from the model. It’s useful for the temporary filtering if it’s necessary to display thousands of nodes.
#### `keep_expanded :`
- Expand all the nodes and keep them expanded regardless their state.
#### `drop_between_items :`
- When true, the tree nodes can be dropped between items.
#### `column_widths :`
- Widths of the columns. If not set, the width is Fraction(1).
#### `min_column_widths :`
- Minimum widths of the columns. If not set, the width is Pixel(0).
#### `columns_resizable :`
- When true, the columns can be resized with the mouse.
#### `selection_changed_fn :`
- Set the callback that is called when the selection is changed.
<dt>
`root_expanded
<span class="classifier">
`
</span>
</dt>
<dd>
<p>
The expanded state of the root item. Changing this flag doesn’t make the children repopulated.
</p>
</dd>
<dt>
`width
<span class="classifier">
ui.Length`
</span>
</dt>
<dd>
<p>
This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
</p>
</dd>
<dt>
`height
<span class="classifier">
ui.Length`
</span>
</dt>
<dd>
<p>
This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
</p>
</dd>
<dt>
`name
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
The name of the widget that user can set.
</p>
</dd>
<dt>
`style_type_name_override
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
</p>
</dd>
<dt>
`identifier
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
An optional identifier of the widget we can use to refer to it in queries.
</p>
</dd>
<dt>
`visible
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds whether the widget is visible.
</p>
</dd>
<dt>
`visibleMin
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
If the current zoom factor and DPI is less than this value, the widget is not visible.
</p>
</dd>
<dt>
`visibleMax
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
If the current zoom factor and DPI is bigger than this value, the widget is not visible.
</p>
</dd>
<dt>
`tooltip
<span class="classifier">
str`
</span>
</dt>
<dd>
<p>
Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
</p>
</dd>
<dt>
`tooltip_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
</p>
</dd>
<dt>
`tooltip_offset_x
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`tooltip_offset_y
<span class="classifier">
float`
</span>
</dt>
<dd>
<p>
Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`enabled
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
</p>
</dd>
<dt>
`selected
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds a flag that specifies the widget has to use eSelected state of the style.
</p>
</dd>
<dt>
`checked
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
</p>
</dd>
<dt>
`dragging
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
This property holds if the widget is being dragged.
</p>
</dd>
<dt>
`opaque_for_mouse_events
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
</p>
</dd>
<dt>
`skip_draw_when_clipped
<span class="classifier">
bool`
</span>
</dt>
<dd>
<p>
The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
</p>
</dd>
<dt>
`mouse_moved_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
</p>
</dd>
<dt>
`mouse_pressed_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
</p>
</dd>
<dt>
`mouse_released_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_double_clicked_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dl>
<dt>
`mouse_wheel_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_hovered_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
</p>
</dd>
<dt>
`drag_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
</p>
</dd>
<dt>
`accept_drop_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
</p>
</dd>
<dt>
`drop_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Specify that this Widget accepts drops and set the callback to the drop operation.
</p>
</dd>
<dt>
`computed_content_size_changed_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Called when the size of the widget is changed.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.TreeView.call_hover_changed_fn">
<span class="sig-name descname">
<span class="pre">
call_hover_changed_fn
</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">
<a class="reference internal" href="#omni.ui.TreeView" title="omni.ui._ui.TreeView">
<span class="pre">
omni.ui._ui.TreeView
</span>
</a>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg0
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<a class="reference internal" href="omni.ui.AbstractItem.html#omni.ui.AbstractItem" title="omni.ui._ui.AbstractItem">
<span class="pre">
omni.ui._ui.AbstractItem
</span>
</a>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg1
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</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>
<a class="headerlink" href="#omni.ui.TreeView.call_hover_changed_fn" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Set the callback that is called when the item hover status is changed.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.TreeView.call_selection_changed_fn">
<span class="sig-name descname">
<span class="pre">
call_selection_changed_fn
</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">
<a class="reference internal" href="#omni.ui.TreeView" title="omni.ui._ui.TreeView">
<span class="pre">
omni.ui._ui.TreeView
</span>
</a>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg0
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
List
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<a class="reference internal" href="omni.ui.AbstractItem.html#omni.ui.AbstractItem" title="omni.ui._ui.AbstractItem">
<span class="pre">
omni.ui._ui.AbstractItem
</span>
</a>
<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">
None
</span>
</span>
</span>
<a class="headerlink" href="#omni.ui.TreeView.call_selection_changed_fn" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Set the callback that is called when the selection is changed.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.TreeView.clear_selection">
<span class="sig-name descname">
<span class="pre">
clear_selection
</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">
<a class="reference internal" href="#omni.ui.TreeView" title="omni.ui._ui.TreeView">
<span class="pre">
omni.ui._ui.TreeView
</span>
</a>
</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>
<a class="headerlink" href="#omni.ui.TreeView.clear_selection" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Deselects all selected items.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.TreeView.dirty_widgets">
<span class="sig-name descname">
### dirty_widgets(self: omni.ui._ui.TreeView) -> None
When called, it will make the delegate to regenerate all visible widgets the next frame.
### extend_selection(self: omni.ui._ui.TreeView, item: omni.ui._ui.AbstractItem) -> None
Extends the current selection selecting all the items between currently selected nodes and the given item. It’s when user does shift+click.
### has_hover_changed_fn(self: omni.ui._ui.TreeView) -> bool
Set the callback that is called when the item hover status is changed.
### has_selection_changed_fn(self: omni.ui._ui.TreeView) -> bool
Set the callback that is called when the selection is changed.
### is_expanded(self: omni.ui._ui.TreeView, item: omni.ui._ui.AbstractItem) -> bool
Returns true if the given item is expanded.
### set_expanded(self: omni.ui._ui.TreeView, item: omni.ui._ui.AbstractItem) -> None
### omni.ui.TreeView.set_expanded
```python
set_expanded(self: omni.ui._ui.TreeView, item: omni.ui._ui.AbstractItem, expanded: bool, recursive: bool) -> None
```
Sets the given item expanded or collapsed.
#### Arguments:
- `item :` The item to expand or collapse.
- `expanded :` True if it’s necessary to expand, false to collapse.
- `recursive :` True if it’s necessary to expand children.
### omni.ui.TreeView.set_hover_changed_fn
```python
set_hover_changed_fn(self: omni.ui._ui.TreeView, fn: Callable[[omni.ui._ui.AbstractItem, bool], None]) -> None
```
Set the callback that is called when the item hover status is changed.
### omni.ui.TreeView.set_selection_changed_fn
```python
set_selection_changed_fn(self: omni.ui._ui.TreeView, fn: Callable[[List[omni.ui._ui.AbstractItem]], None]) -> None
```
Set the callback that is called when the item selection status is changed.
### set_selection_changed_fn
Set the callback that is called when the selection is changed.
### toggle_selection
Switches the selection state of the given item.
### column_widths
Widths of the columns. If not set, the width is Fraction(1).
### columns_resizable
When true, the columns can be resized with the mouse.
### drop_between_items
When true, the tree nodes can be dropped between items.
### expand_on_branch_click
This flag allows to prevent expanding when the user clicks the plus icon. It’s used in the case the user wants to control how the items expanded or collapsed.
### header_visible
This property holds if the header is shown or not.
### keep_alive
When true, the tree nodes are never destroyed even if they are disappeared from the model. It’s useful for the temporary filtering if it’s necessary to display thousands of nodes.
### keep_expanded
Expand all the nodes and keep them expanded regardless their state.
### min_column_widths
Minimum widths of the columns. If not set, the width is Pixel(0).
### root_expanded
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
root_expanded
</span>
</span>
</dt>
<dd>
<p>
The expanded state of the root item. Changing this flag doesn’t make the children repopulated.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.TreeView.root_visible">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
root_visible
</span>
</span>
</dt>
<dd>
<p>
This property holds if the root is shown. It can be used to make a single level tree appear like a simple list.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.TreeView.selection">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
selection
</span>
</span>
</dt>
<dd>
<p>
Set current selection.
</p>
</dd>
</dl>
</dd>
</dl>
</section>
</div>
</div>
<footer>
<hr/>
</footer>
</div>
</div>
</section>
</div> |
omni.ui.Triangle.md | # Triangle
## Triangle
The Triangle widget provides a colored triangle to display.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self, **kwargs)` | Constructs Triangle. |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `alignment` | This property holds the alignment of the triangle when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. |
#### `__init__(self, **kwargs)`
Constructs Triangle.
**Parameters:**
- `self` : `omni.ui._ui.Triangle`
- `**kwargs` : dict
**Returns:**
- `None`
See below
### Keyword Arguments:
- `alignment`
- This property holds the alignment of the triangle when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. By default, the triangle is centered.
- `width` (ui.Length)
- This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
- `height` (ui.Length)
- This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
- `name` (str)
- The name of the widget that user can set.
- `style_type_name_override` (str)
- By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
- `identifier` (str)
- An optional identifier of the widget we can use to refer to it in queries.
- `visible` (bool)
- This property holds whether the widget is visible.
- `visibleMin` (float)
- If the current zoom factor and DPI is less than this value, the widget is not visible.
- `visibleMax` (float)
- If the current zoom factor and DPI is bigger than this value, the widget is not visible.
- `tooltip` (str)
- Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
- `tooltip_fn` (Callable)
- Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
- `tooltip_offset_x` (float)
- Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
- `tooltip_offset_y` (float)
- Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
- `enabled` (bool)
- This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
- `selected` (bool)
- This property holds a flag that specifies the widget has to use eSelected state of the style.
- `checked` (bool)
- This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
- `dragging` (bool)
- This property holds if the widget is being dragged.
- `opaque_for_mouse_events` (bool)
- If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
- `skip_draw_when_clipped` (bool)
- The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
- `mouse_moved_fn` (Callable)
- Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
- `mouse_pressed_fn` (Callable)
- Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
- `mouse_released_fn` (Callable)
- Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
- `mouse_double_clicked_fn` (Callable)
- Sets the function that will be called when the user double clicks the mouse button inside the widget.
<dl>
<dt>
`onMouseDoubleClicked`
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_wheel_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
</p>
</dd>
<dt>
`mouse_hovered_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
</p>
</dd>
<dt>
`drag_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
</p>
</dd>
<dt>
`accept_drop_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
</p>
</dd>
<dt>
`drop_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Specify that this Widget accepts drops and set the callback to the drop operation.
</p>
</dd>
<dt>
`computed_content_size_changed_fn
<span class="classifier">
Callable`
</span>
</dt>
<dd>
<p>
Called when the size of the widget is changed.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.Triangle.alignment">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
alignment
</span>
</span>
<a class="headerlink" href="#omni.ui.Triangle.alignment" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
This property holds the alignment of the triangle when the fill policy is ePreserveAspectFit or ePreserveAspectCrop. By default, the triangle is centered.
</p>
</dd>
</dl> |
omni.ui.Type.md | # Type
## Methods
- `__init__(self, value)`
## Attributes
- `HISTOGRAM`
- `LINE`
- `LINE2D`
- `name`
- `value` |
omni.ui.UIPreferencesExtension.md | # UIPreferencesExtension
## UIPreferencesExtension
```python
class omni.ui.UIPreferencesExtension(IExt)
```
**Methods**
| Method | Description |
|--------------|-------------|
| `on_shutdown()` | |
| `on_startup(ext_id)` | |
```python
def __init__(self: omni.ext._extensions.IExt) -> None:
pass
```
``` |
omni.ui.UnitType.md | # UnitType
## Overview
Unit types.
Widths, heights or other UI length can be specified in pixels or relative to window (or child window) size.
### Members
- PIXEL
- PERCENT
- FRACTION
## Methods
- `__init__(self, value)`
## Attributes
- `FRACTION`
- `PERCENT`
- `PIXEL`
- `name`
- `value`
<span class="pre">
self
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
omni.ui._ui.UnitType
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
value
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</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 property">
<dt class="sig sig-object py" id="omni.ui.UnitType.name">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
name
</span>
</span>
</dt>
<dd>
</dd>
</dl>
</dd>
</dl>
</section>
</div>
</div>
<footer>
<hr/>
</footer>
</div>
</div>
</section> |
omni.ui.url_utils.Classes.md | # omni.ui.url_utils Classes
## Classes Summary
- **AbstractShade**
- The implementation of shades for custom style parameter type.
- **StringShade**
- |
omni.ui.url_utils.Functions.md | # omni.ui.url_utils Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| [Singleton](#) | A singleton decorator | |
omni.ui.url_utils.md | # omni.ui.url_utils
## Classes Summary
- **AbstractShade**
- The implementation of shades for custom style parameter type.
- **StringShade**
## Functions Summary
- **Singleton**
- A singleton decorator |
omni.ui.url_utils.Singleton.md | # Singleton
## Singleton
```python
omni.ui.url_utils.Singleton(class_)
```
A singleton decorator
``` |
omni.ui.url_utils.StringShade.md | # StringShade
## StringShade
### StringShade
- alias of `getinstance` |
omni.ui.ValueModelHelper.md | # ValueModelHelper
The ValueModelHelper class provides the basic functionality for value widget classes. ValueModelHelper class is the base class for every standard widget that uses a AbstractValueModel. ValueModelHelper is an abstract class and itself cannot be instantiated. It provides a standard interface for interoperating with models.
## Methods
- `__init__(*args, **kwargs)`
## Attributes
- `model`
## `__init__(*args, **kwargs)` |
omni.ui.VectorImageProvider.md | # VectorImageProvider
## VectorImageProvider
```python
class omni.ui.VectorImageProvider
```
Bases: `ImageProvider`
doc
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self[, source_url])` | doc |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `max_mip_levels` | Maximum number of mip map levels allowed |
| `source_url` | Sets the vector image URL. |
```python
def __init__(self, source_url: str):
# Implementation details
```
<dl class="py function">
<dt class="sig sig-object py" id="omni.ui.VectorImageProvider.__init__">
<em class="sig-param">
<span class="o">
</span>
<span class="o">
<span class="pre">
=</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
None</span>
</span>
</em>
,
<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>
<span class="sig-return">
<span class="sig-return-icon">
→</span>
<span class="sig-return-typehint">
<span class="pre">
None</span>
</span>
</span>
</dt>
<dd>
<p>
doc</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.VectorImageProvider.max_mip_levels">
<em class="property">
<span class="pre">
property</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
max_mip_levels</span>
</span>
</dt>
<dd>
<p>
Maximum number of mip map levels allowed</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.VectorImageProvider.source_url">
<em class="property">
<span class="pre">
property</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
source_url</span>
</span>
</dt>
<dd>
<p>
Sets the vector image URL. Asset loading doesn’t happen immediately, but rather is started the next time widget is visible, in prepareDraw call.</p>
</dd>
</dl>
</dd>
</dl>
</section>
</div>
</div>
<footer>
<hr/>
</footer>
</div>
</div>
</section>
</div> |
omni.ui.VGrid.md | # VGrid
## VGrid
Bases: [Grid](omni.ui.Grid.html#omni.ui.Grid)
Shortcut for Grid{eTopToBottom}. The grid grows from top to bottom with the widgets placed.
### Methods
| Method | Description |
|--------|-------------|
| `__init__` (self, **kwargs) | Construct a grid that grows from top to bottom with the widgets placed. |
### Attributes
| Attribute | Description |
|-----------|-------------|
### `__init__` (self, **kwargs)
Construct a grid that grows from top to bottom with the widgets placed.
#### Keyword Arguments:
| Argument | Description |
|----------|-------------|
| `column_width` | The width of the column. It’s only possible to set it if the grid is vertical. Once it’s set, the column count depends on the size of the widget. |
<dt>
`row_height`
</dt>
<dd>
<p>
The height of the row. It’s only possible to set it if the grid is horizontal. Once it’s set, the row count depends on the size of the widget.
</p>
</dd>
<dt>
`column_count`
</dt>
<dd>
<p>
The number of columns. It’s only possible to set it if the grid is vertical. Once it’s set, the column width depends on the widget size.
</p>
</dd>
<dt>
`row_count`
</dt>
<dd>
<p>
The number of rows. It’s only possible to set it if the grid is horizontal. Once it’s set, the row height depends on the widget size.
</p>
</dd>
<dt>
`direction`
</dt>
<dd>
<p>
This type is used to determine the direction of the layout. If the Stack’s orientation is eLeftToRight the widgets are placed in a horizontal row, from left to right. If the Stack’s orientation is eRightToLeft the widgets are placed in a horizontal row, from right to left. If the Stack’s orientation is eTopToBottom, the widgets are placed in a vertical column, from top to bottom. If the Stack’s orientation is eBottomToTop, the widgets are placed in a vertical column, from bottom to top. If the Stack’s orientation is eBackToFront, the widgets are placed sorted in a Z-order in top right corner. If the Stack’s orientation is eFrontToBack, the widgets are placed sorted in a Z-order in top right corner, the first widget goes to front.
</p>
</dd>
<dt>
`content_clipping`
</dt>
<dd>
<p>
Determines if the child widgets should be clipped by the rectangle of this Stack.
</p>
</dd>
<dt>
`spacing`
</dt>
<dd>
<p>
Sets a non-stretchable space in pixels between child items of this layout.
</p>
</dd>
<dt>
`send_mouse_events_to_back`
</dt>
<dd>
<p>
When children of a Z-based stack overlap mouse events are normally sent to the topmost one. Setting this property true will invert that behavior, sending mouse events to the bottom-most child.
</p>
</dd>
<dt>
`width`
ui.Length
</dt>
<dd>
<p>
This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.
</p>
</dd>
<dt>
`height`
ui.Length
</dt>
<dd>
<p>
This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
</p>
</dd>
<dt>
`name`
str
</dt>
<dd>
<p>
The name of the widget that user can set.
</p>
</dd>
<dt>
`style_type_name_override`
str
</dt>
<dd>
<p>
By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
</p>
</dd>
<dt>
`identifier`
str
</dt>
<dd>
<p>
An optional identifier of the widget we can use to refer to it in queries.
</p>
</dd>
<dt>
`visible`
bool
</dt>
<dd>
<p>
This property holds whether the widget is visible.
</p>
</dd>
<dt>
`visibleMin`
float
</dt>
<dd>
<p>
If the current zoom factor and DPI is less than this value, the widget is not visible.
</p>
</dd>
<dt>
`visibleMax`
float
</dt>
<dd>
<p>
If the current zoom factor and DPI is bigger than this value, the widget is not visible.
</p>
</dd>
<dt>
`tooltip`
str
</dt>
<dd>
<p>
Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
</p>
</dd>
<dt>
`tooltip_fn`
Callable
</dt>
<dd>
<p>
Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
</p>
</dd>
<dt>
`tooltip_offset_x`
float
</dt>
<dd>
<p>
Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`tooltip_offset_y`
float
</dt>
<dd>
<p>
Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
</p>
</dd>
<dt>
`enabled`
bool
</dt>
<dd>
<p>
This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
</p>
</dd>
<dt>
`selected`
bool
</dt>
<dd>
<p>
This property holds a flag that specifies the widget has to use eSelected state of the style.
</p>
</dd>
<dt>
`checked`
bool
</dt>
<dd>
<p>
This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
</p>
</dd>
<dt>
`dragging`
bool
</dt>
<dd>
<p>
This property holds if the widget is being dragged.
</p>
</dd>
<dt>
`opaque_for_mouse_events`
- `skip_draw_when_clipped bool`
- If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either.
- The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
- `mouse_moved_fn Callable`
- Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
- `mouse_pressed_fn Callable`
- Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
- `mouse_released_fn Callable`
- Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
- `mouse_double_clicked_fn Callable`
- Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
- `mouse_wheel_fn Callable`
- Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
- `mouse_hovered_fn Callable`
- Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
- `drag_fn Callable`
- Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
- `accept_drop_fn Callable`
- Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
- `drop_fn Callable`
- Specify that this Widget accepts drops and set the callback to the drop operation.
- `computed_content_size_changed_fn Callable`
- Called when the size of the widget is changed. |
omni.ui.Widget.md | # Widget
## omni.ui.Widget
The Widget class is the base class of all user interface objects.
The widget is the atom of the user interface: it receives mouse, keyboard and other events, and paints a representation of itself on the screen. Every widget is rectangular. A widget is clipped by its parent and by the widgets in front of it.
### Methods
- **__init__(self, **kwargs)**
- **call_accept_drop_fn(self, arg0)**
Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
- **call_computed_content_size_changed_fn(self)**
Called when the size of the widget is changed.
- **call_drag_fn(self)**
Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
- **call_drop_fn(self, arg0)**
Specify that this Widget accepts drops and set the callback to the drop operation.
- **call_key_pressed_fn(self, arg0)**
Specify that this Widget can handle key presses and set the callback for key press events.
- `call_key_pressed_fn(self, arg0, arg1, arg2)`
- Sets the function that will be called when the user presses the keyboard key when the mouse clicks the widget.
- `call_mouse_double_clicked_fn(self, arg0, ...)`
- Sets the function that will be called when the user presses the mouse button twice inside the widget.
- `call_mouse_hovered_fn(self, arg0)`
- Sets the function that will be called when the user use mouse enter/leave on the focused window.
- `call_mouse_moved_fn(self, arg0, arg1, arg2, arg3)`
- Sets the function that will be called when the user moves the mouse inside the widget.
- `call_mouse_pressed_fn(self, arg0, arg1, ...)`
- Sets the function that will be called when the user presses the mouse button inside the widget.
- `call_mouse_released_fn(self, arg0, arg1, ...)`
- Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget.
- `call_mouse_wheel_fn(self, arg0, arg1, arg2)`
- Sets the function that will be called when the user uses mouse wheel on the focused window.
- `call_tooltip_fn(self)`
- Set dynamic tooltip that will be created dynamically the first time it is needed.
- `destroy(self)`
- Removes all the callbacks and circular references.
- `has_accept_drop_fn(self)`
- Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
- `has_computed_content_size_changed_fn(self)`
- Called when the size of the widget is changed.
- `has_drag_fn(self)`
- Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
- `has_drop_fn(self)`
- Specify that this Widget accepts drops and set the callback to the drop operation.
- `has_key_pressed_fn(self)`
- Sets the function that will be called when the user presses the keyboard key when the mouse clicks the widget.
- `has_mouse_double_clicked_fn(self)`
- Sets the function that will be called when the user presses the mouse button twice inside the widget.
| Function Name | Description |
|---------------|-------------|
| has_mouse_hovered_fn (self) | Sets the function that will be called when the user use mouse enter/leave on the focused window. |
| has_mouse_moved_fn (self) | Sets the function that will be called when the user moves the mouse inside the widget. |
| has_mouse_pressed_fn (self) | Sets the function that will be called when the user presses the mouse button inside the widget. |
| has_mouse_released_fn (self) | Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. |
| has_mouse_wheel_fn (self) | Sets the function that will be called when the user uses mouse wheel on the focused window. |
| has_tooltip_fn (self) | Set dynamic tooltip that will be created dynamically the first time it is needed. |
| scroll_here (self[, center_ratio_x, ...]) | Adjust scrolling amount in two axes to make current item visible. |
| scroll_here_x (self[, center_ratio]) | Adjust scrolling amount to make current item visible. |
| scroll_here_y (self[, center_ratio]) | Adjust scrolling amount to make current item visible. |
| set_accept_drop_fn (self, fn) | Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted. |
| set_checked_changed_fn (self, fn) | This property holds a flag that specifies the widget has to use eChecked state of the style. |
| set_computed_content_size_changed_fn (self, fn) | Called when the size of the widget is changed. |
| set_drag_fn (self, fn) | Specify that this Widget is draggable, and set the callback that is attached to the drag operation. |
| set_drop_fn (self, fn) | Specify that this Widget accepts drops and set the callback to the drop operation. |
| 方法 | 描述 |
| --- | --- |
| `set_key_pressed_fn(self, fn)` | Sets the function that will be called when the user presses the keyboard key when the mouse clicks the widget. |
| `set_mouse_double_clicked_fn(self, fn)` | Sets the function that will be called when the user presses the mouse button twice inside the widget. |
| `set_mouse_hovered_fn(self, fn)` | Sets the function that will be called when the user use mouse enter/leave on the focused window. |
| `set_mouse_moved_fn(self, fn)` | Sets the function that will be called when the user moves the mouse inside the widget. |
| `set_mouse_pressed_fn(self, fn)` | Sets the function that will be called when the user presses the mouse button inside the widget. |
| `set_mouse_released_fn(self, fn)` | Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. |
| `set_mouse_wheel_fn(self, fn)` | Sets the function that will be called when the user uses mouse wheel on the focused window. |
| `set_style(self, arg0)` | Set the current style. |
| `set_tooltip(self, tooltip_label)` | Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style. |
| `set_tooltip_fn(self, fn)` | Set dynamic tooltip that will be created dynamically the first time it is needed. |
### Attributes
| 属性 | 描述 |
| --- | --- |
| `FLAG_WANT_CAPTURE_KEYBOARD` | |
| `checked` | This property holds a flag that specifies the widget has to use eChecked state of the style. |
| `computed_content_height` | Returns the final computed height of the content of the widget. |
| `computed_content_width` | Returns the final computed width of the content of the widget. |
| `computed_height` | Returns the final computed height of the widget. |
- **computed_height**
- Returns the final computed height of the widget.
- **computed_width**
- Returns the final computed width of the widget.
- **dragging**
- This property holds if the widget is being dragged.
- **enabled**
- This property holds whether the widget is enabled.
- **height**
- This property holds the height of the widget relative to its parent.
- **identifier**
- An optional identifier of the widget we can use to refer to it in queries.
- **name**
- The name of the widget that user can set.
- **opaque_for_mouse_events**
- If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don't get routed to the child widgets either
- **screen_position_x**
- Returns the X Screen coordinate the widget was last draw.
- **screen_position_y**
- Returns the Y Screen coordinate the widget was last draw.
- **scroll_only_window_hovered**
- When it's false, the scroll callback is called even if other window is hovered.
- **selected**
- This property holds a flag that specifies the widget has to use eSelected state of the style.
- **skip_draw_when_clipped**
- The flag that specifies if it's necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame.
- **style**
- The local style.
- **style_type_name_override**
- By default, we use typeName to look up the style.
- **tooltip**
- Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
- **tooltip_offset_x**
- (No description provided)
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
tooltip_offset_x
</span>
</code>
</a>
</p>
</td>
<td>
<p>
Set the X tooltip offset in points.
</p>
</td>
</tr>
<tr class="row-even">
<td>
<p>
<a class="reference internal" href="#omni.ui.Widget.tooltip_offset_y" title="omni.ui.Widget.tooltip_offset_y">
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
tooltip_offset_y
</span>
</code>
</a>
</p>
</td>
<td>
<p>
Set the Y tooltip offset in points.
</p>
</td>
</tr>
<tr class="row-odd">
<td>
<p>
<a class="reference internal" href="#omni.ui.Widget.visible" title="omni.ui.Widget.visible">
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
visible
</span>
</code>
</a>
</p>
</td>
<td>
<p>
This property holds whether the widget is visible.
</p>
</td>
</tr>
<tr class="row-even">
<td>
<p>
<a class="reference internal" href="#omni.ui.Widget.visible_max" title="omni.ui.Widget.visible_max">
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
visible_max
</span>
</code>
</a>
</p>
</td>
<td>
<p>
If the current zoom factor and DPI is bigger than this value, the widget is not visible.
</p>
</td>
</tr>
<tr class="row-odd">
<td>
<p>
<a class="reference internal" href="#omni.ui.Widget.visible_min" title="omni.ui.Widget.visible_min">
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
visible_min
</span>
</code>
</a>
</p>
</td>
<td>
<p>
If the current zoom factor and DPI is less than this value, the widget is not visible.
</p>
</td>
</tr>
<tr class="row-even">
<td>
<p>
<a class="reference internal" href="#omni.ui.Widget.width" title="omni.ui.Widget.width">
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
width
</span>
</code>
</a>
</p>
</td>
<td>
<p>
This property holds the width of the widget relative to its parent.
</p>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Widget.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
</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">
<a class="reference internal" href="#omni.ui.Widget" title="omni.ui._ui.Widget">
<span class="pre">
omni.ui._ui.Widget
</span>
</a>
</span>
</em>
,
<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>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
None
</span>
</span>
</span>
<a class="headerlink" href="#omni.ui.Widget.__init__" title="Permalink to this definition">
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Widget.call_accept_drop_fn">
<span class="sig-name descname">
<span class="pre">
call_accept_drop_fn
</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">
<a class="reference internal" href="#omni.ui.Widget" title="omni.ui._ui.Widget">
<span class="pre">
omni.ui._ui.Widget
</span>
</a>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg0
</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>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
bool
</span>
</span>
</span>
<a class="headerlink" href="#omni.ui.Widget.call_accept_drop_fn" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Widget.call_computed_content_size_changed_fn">
<span class="sig-name descname">
<span class="pre">
call_computed_content_size_changed_fn
</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">
<a class="reference internal" href="#omni.ui.Widget" title="omni.ui._ui.Widget">
<span class="pre">
omni.ui._ui.Widget
</span>
</a>
</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>
<a class="headerlink" href="#omni.ui.Widget.call_computed_content_size_changed_fn" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Called when the size of the widget is changed.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Widget.call_drag_fn">
<span class="sig-name descname">
<span class="pre">
call_drag_fn
</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">
<a class="reference internal" href="#omni.ui.Widget" title="omni.ui._ui.Widget">
<span class="pre">
omni.ui._ui.Widget
</span>
</a>
</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>
<a class="headerlink" href="#omni.ui.Widget.call_drag_fn" title="Permalink to this definition">
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Widget.call_drag_fn">
<span class="sig-name descname">
<span class="pre">
call_drag_fn
</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">
<a class="reference internal" href="#omni.ui.Widget" title="omni.ui._ui.Widget">
<span class="pre">
omni.ui._ui.Widget
</span>
</a>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
fn
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Callable[[omni.ui._ui.Widget, omni.ui._ui.WidgetDragEvent], None]
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<span class="sig-return">
<span class="sig-return-icon">
→
</span>
<span class="sig-return-typehint">
<span class="pre">
str
</span>
</span>
</span>
</dt>
<dd>
<p>
Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Widget.call_drop_fn">
<span class="sig-name descname">
<span class="pre">
call_drop_fn
</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">
<a class="reference internal" href="#omni.ui.Widget" title="omni.ui._ui.Widget">
<span class="pre">
omni.ui._ui.Widget
</span>
</a>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg0
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
omni.ui._ui.WidgetMouseDropEvent
</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>
<p>
Specify that this Widget accepts drops and set the callback to the drop operation.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Widget.call_key_pressed_fn">
<span class="sig-name descname">
<span class="pre">
call_key_pressed_fn
</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">
<a class="reference internal" href="#omni.ui.Widget" title="omni.ui._ui.Widget">
<span class="pre">
omni.ui._ui.Widget
</span>
</a>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg0
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg1
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg2
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</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>
<p>
Sets the function that will be called when the user presses the keyboard key when the mouse clicks the widget.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Widget.call_mouse_double_clicked_fn">
<span class="sig-name descname">
<span class="pre">
call_mouse_double_clicked_fn
</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">
<a class="reference internal" href="#omni.ui.Widget" title="omni.ui._ui.Widget">
<span class="pre">
omni.ui._ui.Widget
</span>
</a>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg0
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
float
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg1
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
float
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg2
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg3
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</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>
<p>
Sets the function that will be called when the user double clicks the mouse on the widget.
</p>
</dd>
</dl>
### omni.ui.Widget.call_mouse_double_clicked_fn
Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
### omni.ui.Widget.call_mouse_hovered_fn
Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
### omni.ui.Widget.call_mouse_moved_fn
Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
### omni.ui.Widget.call_mouse_pressed_fn
Sets the function that will be called when the user presses the mouse button inside the widget. void onMousePressed(float x, float y, int32_t button, int modifier)
Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.
### destroy
- **Parameters**:
- `self` : omni.ui._ui.Widget
- **Returns**: `None`
- **Description**: Removes all the callbacks and circular references.
### has_accept_drop_fn
- **Parameters**:
- `self` : omni.ui._ui.Widget
- **Returns**: `bool`
- **Description**: Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
### has_computed_content_size_changed_fn
- **Parameters**:
- `self` : omni.ui._ui.Widget
- **Returns**: `bool`
- **Description**: Called when the size of the widget is changed.
### has_drag_fn
- **Parameters**:
- `self` : omni.ui._ui.Widget
- **Returns**: `bool`
- **Description**: Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
### has_drop_fn
- **Parameters**:
- `self` : omni.ui._ui.Widget
- **Returns**: `bool`
- **Description**: Specify that this Widget accepts drops and set the callback to the drop operation.
### has_key_pressed_fn
- **Parameters**:
- `self` : omni.ui._ui.Widget
- **Returns**: `bool`
- **Description**: Sets the function that will be called when the user presses the keyboard key when the mouse clicks the widget.
### has_mouse_double_clicked_fn
```python
has_mouse_double_clicked_fn(self: omni.ui._ui.Widget) -> bool
```
Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. `void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)`
### has_mouse_hovered_fn
```python
has_mouse_hovered_fn(self: omni.ui._ui.Widget) -> bool
```
Sets the function that will be called when the user uses mouse enter/leave on the focused window. The function specification is the same as in setMouseHoveredFn. `void onMouseHovered(bool hovered)`
### has_mouse_moved_fn
```python
has_mouse_moved_fn(self: omni.ui._ui.Widget) -> bool
```
Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. `void onMouseMoved(float x, float y, int32_t modifier)`
### has_mouse_pressed_fn
```python
has_mouse_pressed_fn(self: omni.ui._ui.Widget) -> bool
```
Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: `void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)` Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
### has_mouse_released_fn
```python
has_mouse_released_fn(self: omni.ui._ui.Widget) -> bool
```
Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. `void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)`
### has_mouse_wheel_fn
```python
has_mouse_wheel_fn(self: omni.ui._ui.Widget) -> bool
```
Sets the function that will be called when the user uses the mouse wheel. The function specification is the same as in setMouseWheelFn. `void onMouseWheel(float x, float y, int32_t modifier)`
### omni.ui.Widget.has_mouse_wheel_fn
Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
### omni.ui.Widget.has_tooltip_fn
Set dynamic tooltip that will be created dynamically the first time it is needed. The function is called inside a ui.Frame scope that the widget will be parented correctly.
### omni.ui.Widget.scroll_here
Adjust scrolling amount in two axes to make current item visible.
#### Arguments:
- `centerRatioX :`
- 0.0: left, 0.5: center, 1.0: right
- `centerRatioY :`
- 0.0: top, 0.5: center, 1.0: bottom
### omni.ui.Widget.scroll_here_x
Adjust scrolling amount to make current item visible.
#### Arguments:
- `centerRatio :`
- 0.0: left, 0.5: center, 1.0: right
## omni.ui.Widget.scroll_here_y
```
```python
scroll_here_y(self: omni.ui._ui.Widget, center_ratio: float = 0.0) -> None
```
- **Description**: Adjust scrolling amount to make current item visible.
- **Arguments**:
- `centerRatio :`
- 0.0: top, 0.5: center, 1.0: bottom
## omni.ui.Widget.set_accept_drop_fn
```python
set_accept_drop_fn(self: omni.ui._ui.Widget, fn: Callable[[str], bool]) -> None
```
- **Description**: Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.
## omni.ui.Widget.set_checked_changed_fn
```python
set_checked_changed_fn(self: omni.ui._ui.Widget, fn: Callable[[bool], None]) -> None
```
- **Description**: This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
:
omni.ui._ui.Widget
fn: Callable[[], None]
)
→ None
Called when the size of the widget is changed.
set_drag_fn(self: omni.ui._ui.Widget, fn: Callable[[], str])
→ None
Specify that this Widget is draggable, and set the callback that is attached to the drag operation.
set_drop_fn(self: omni.ui._ui.Widget, fn: Callable[[omni.ui._ui.WidgetMouseDropEvent], None])
→ None
Specify that this Widget accepts drops and set the callback to the drop operation.
set_key_pressed_fn(self: omni.ui._ui.Widget, fn: Callable[[], None])
→ None
### set_key_pressed_fn
Sets the function that will be called when the user presses the keyboard key when the mouse clicks the widget.
### set_mouse_double_clicked_fn
Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
### set_mouse_hovered_fn
Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)
### set_mouse_moved_fn
### set_mouse_moved_fn
```python
set_mouse_moved_fn(self: omni.ui._ui.Widget, fn: Callable[[float, float, int, bool], None]) -> None
```
Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)
### set_mouse_pressed_fn
```python
set_mouse_pressed_fn(self: omni.ui._ui.Widget, fn: Callable[[float, float, int, int], None]) -> None
```
Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
### set_mouse_released_fn
```python
set_mouse_released_fn(self: omni.ui._ui.Widget, fn: Callable[[float, float, int, int], None]) -> None
```
Sets the function that will be called when the user releases the mouse button inside the widget. The function should be like this: void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.
### omni.ui.Widget.set_mouse_released_fn
Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)
### omni.ui.Widget.set_mouse_wheel_fn
Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)
### omni.ui.Widget.set_style
Set the current style. The style contains a description of customizations to the widget’s style.
### omni.ui.Widget.set_tooltip
Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
## set_tooltip_fn
```python
set_tooltip_fn(self: omni.ui._ui.Widget, fn: Callable[[], None]) -> None
```
Set dynamic tooltip that will be created dynamically the first time it is needed. The function is called inside a ui.Frame scope that the widget will be parented correctly.
## checked
```python
property checked
```
This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.
## computed_content_height
```python
property computed_content_height
```
Returns the final computed height of the content of the widget. It’s in public section. For the explanation why please see the draw() method.
## computed_content_width
```python
property computed_content_width
```
Returns the final computed width of the content of the widget. It’s in public section. For the explanation why please see the draw() method.
## computed_height
```python
property computed_height
```
Returns the final computed height of the widget. It includes margins. It’s in public section. For the explanation why please see the draw() method.
## computed_width
```python
property computed_width
```
Returns the final computed width of the widget. It includes margins. It’s in public section. For the explanation why please see the draw() method.
## dragging
```python
property dragging
```
This property holds if the widget is being dragged.
## enabled
```python
property enabled
```
This property holds whether the widget is enabled. In general, an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.
## height
```python
property height
```
This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.
### identifier
An optional identifier of the widget we can use to refer to it in queries.
### name
The name of the widget that user can set.
### opaque_for_mouse_events
If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either
### screen_position_x
Returns the X Screen coordinate the widget was last draw. This is in Screen Pixel size.
It’s a float because we need negative numbers and precise position considering DPI scale factor.
### screen_position_y
Returns the Y Screen coordinate the widget was last draw. This is in Screen Pixel size.
It’s a float because we need negative numbers and precise position considering DPI scale factor.
### scroll_only_window_hovered
When it’s false, the scroll callback is called even if other window is hovered.
### selected
This property holds a flag that specifies the widget has to use eSelected state of the style.
### skip_draw_when_clipped
The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.
### style
The local style. When the user calls setStyle()
### style_type_name_override
By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.
### tooltip
Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style
### tooltip_offset_x
Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
## Property: tooltip_offset_y
Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.
## Property: visible
This property holds whether the widget is visible.
## Property: visible_max
If the current zoom factor and DPI is bigger than this value, the widget is not visible.
## Property: visible_min
If the current zoom factor and DPI is less than this value, the widget is not visible.
## Property: width
This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen. |
omni.ui.WidgetMouseDropEvent.md | # WidgetMouseDropEvent
## WidgetMouseDropEvent
Bases: `pybind11_object`
Holds the data which is sent when a drag and drop action is completed.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(*args, **kwargs)` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `mime_data` | The data that was dropped on the widget. |
| `x` | Position where the drop was made. |
| `y` | Position where the drop was made. |
### `__init__(*args, **kwargs)`
## Properties
### mime_data
The data that was dropped on the widget.
### x
Position where the drop was made.
### y
Position where the drop was made. |
omni.ui.Window.md | # Window
The Window class represents a window in the underlying windowing system. This window is a child window of main Kit window. And it can be docked.
Rasterization
omni.ui generates vertices every frame to render UI elements. One of the features of the framework is the ability to bake a DrawList per window and reuse it if the content has not changed, which can significantly improve performance. However, in some cases, such as the Viewport window and Console window, it may not be possible to detect whether the window content has changed, leading to a frozen window. To address this problem, you can control the rasterization behavior by adjusting RasterPolicy. The RasterPolicy is an enumeration class that defines the rasterization behavior of a window. It has three possible values:
- NEVER: Do not rasterize the widget at any time.
- ON_DEMAND: Rasterize the widget as soon as possible and always use the rasterized version. The widget will only be updated when the user calls invalidateRaster.
- AUTO: Automatically determine whether to rasterize the widget based on performance considerations. If necessary, the widget will be rasterized and updated when its content changes.
To resolve the frozen window issue, you can manually set the RasterPolicy of the problematic window to Never. This will force the window to rasterize its content and use the rasterized version until the user explicitly calls invalidateRaster to request an update.
```python
window = ui.Window("Test window", raster_policy=ui.RasterPolicy.NEVER)
```
## Methods
- `__init__(self, title, dockPreference, **kwargs)`
- Construct the window, add it to the underlying windowing system, and makes it appear.
- `call_key_pressed_fn(self, arg0, arg1, arg2)`
- Sets the function that will be called when the user presses the keyboard key on the focused window.
- `deferred_dock_in(self, target_window, ...)`
- Deferred docking.
- `destroy(self)`
- Destroy the window.
- **destroy** (self)
- Removes all the callbacks and circular references.
- **dock_in_window** (self, title, dockPosition[, ...])
- place the window in a specific docking position based on a target window name.
- **get_window_callback** (self)
- Returns window set draw callback pointer for the given UI window.
- **has_key_pressed_fn** (self)
- Sets the function that will be called when the user presses the keyboard key on the focused window.
- **move_to_app_window** (self, arg0)
- Moves the window to the specific OS window.
- **move_to_main_os_window** (self)
- Bring back the Window callback to the Main Window and destroy the Current OS Window.
- **move_to_new_os_window** (self)
- Move the Window Callback to a new OS Window.
- **notify_app_window_change** (self, arg0)
- Notifies the window that window set has changed.
- **setPosition** (self, x, y)
- This property set/get the position of the window in both axis calling the property.
- **set_docked_changed_fn** (self, arg0)
- Has true if this window is docked.
- **set_focused_changed_fn** (self, arg0)
- Read only property that is true when the window is focused.
- **set_height_changed_fn** (self, arg0)
- This property holds the window Height.
- **set_key_pressed_fn** (self, fn)
- Sets the function that will be called when the user presses the keyboard key on the focused window.
- **set_position_x_changed_fn** (self, arg0)
- This property set/get the position of the window in the X Axis.
- **set_position_y_changed_fn** (self, arg0)
- This property set/get the position of the window in the Y Axis.
- **set_selected_in_dock_changed_fn** (self, arg0)
- This property set/get the position of the window in the Y Axis.
### Methods
| Description |
| --- |
| `set_selected_in_dock_changed_fn(self, arg0)` - Has true if this window is currently selected in the dock. |
| `set_top_modal(self)` - Brings this window to the top level of modal windows. |
| `set_visibility_changed_fn(self, arg0)` - This property holds whether the window is visible. |
| `set_width_changed_fn(self, arg0)` - This property holds the window Width. |
### Attributes
| Attribute | Description |
| --- | --- |
| `app_window` | |
| `auto_resize` | setup the window to resize automatically based on its content |
| `detachable` | If the window is able to be separated from the main application window. |
| `docked` | Has true if this window is docked. |
| `exclusive_keyboard` | When true, only the current window will receive keyboard events when it's focused. |
| `flags` | This property set the Flags for the Window. |
| `focus_policy` | How the Window gains focus. |
| `focused` | Read only property that is true when the window is focused. |
| `frame` | The main layout of this window. |
| `height` | This property holds the window Height. |
| `menu_bar` | |
| `noTabBar` | setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically |
| Property | Description |
|----------|-------------|
| padding_x | This property set the padding to the frame on the X axis. |
| padding_y | This property set the padding to the frame on the Y axis. |
| position_x | This property set/get the position of the window in the X Axis. |
| position_y | This property set/get the position of the window in the Y Axis. |
| raster_policy | Determine how the content of the window should be rastered. |
| selected_in_dock | Has true if this window is currently selected in the dock. |
| tabBar_tooltip | This property sets the tooltip when hovering over window's tabbar. |
| title | This property holds the window's title. |
| visible | This property holds whether the window is visible. |
| width | This property holds the window Width. |
### omni.ui.Window.__init__
```python
__init__(self: omni.ui._ui.Window, title: str, dockPreference: omni.ui._ui.DockPreference = <DockPreference.DISABLED: 0>, **kwargs) -> None
```
Construct the window, add it to the underlying windowing system, and makes it appear.
#### Arguments:
- `title :` The window title. It’s also used as an internal window ID.
- `dockPreference :` In the old Kit determines where the window should be docked. In Kit Next it’s unused.
- `kwargs` See below
#### Keyword Arguments:
- `flags` This property set the Flags for the Window.
- `visible` This property holds whether the window is visible.
```
<dl>
<dt>title</dt>
<dd>
<p>This property holds the window’s title.</p>
</dd>
<dt>padding_x</dt>
<dd>
<p>This property set the padding to the frame on the X axis.</p>
</dd>
<dt>padding_y</dt>
<dd>
<p>This property set the padding to the frame on the Y axis.</p>
</dd>
<dt>width</dt>
<dd>
<p>This property holds the window Width.</p>
</dd>
<dt>height</dt>
<dd>
<p>This property holds the window Height.</p>
</dd>
<dt>position_x</dt>
<dd>
<p>This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.</p>
</dd>
<dt>position_y</dt>
<dd>
<p>This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.</p>
</dd>
<dt>auto_resize</dt>
<dd>
<p>setup the window to resize automatically based on its content</p>
</dd>
<dt>noTabBar</dt>
<dd>
<p>setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically</p>
</dd>
<dt>tabBarTooltip</dt>
<dd>
<p>This property sets the tooltip when hovering over window’s tabbar.</p>
</dd>
<dt>raster_policy</dt>
<dd>
<p>Determine how the content of the window should be rastered.</p>
</dd>
<dt>width_changed_fn</dt>
<dd>
<p>This property holds the window Width.</p>
</dd>
<dt>height_changed_fn</dt>
<dd>
<p>This property holds the window Height.</p>
</dd>
<dt>visibility_changed_fn</dt>
<dd>
<p>This property holds whether the window is visible.</p>
</dd>
</dl>
<dl class="py method">
<dt>call_key_pressed_fn</dt>
<dd>
<p>Sets the function that will be called when the user presses the keyboard key on the focused window.</p>
</dd>
</dl>
<dl class="py method">
<dt>deferred_dock_in</dt>
<dd>
<p>TODO: Add description for deferred_dock_in method.</p>
</dd>
</dl>
## omni.ui.Window.deferred_dock_in
Deferred docking. We need it when we want to dock windows before they were actually created. It’s helpful when extension initialization, before any window is created.
### Arguments:
- `targetWindowTitle :` Dock to window with this title when it appears.
- `activeWindow :` Make target or this window active when docked.
## omni.ui.Window.destroy
Removes all the callbacks and circular references.
## omni.ui.Window.dock_in_window
place the window in a specific docking position based on a target window name. We will find the target window dock node and insert this window in it, either by spliting on ratio or on top if the window is not found false is return, otherwise true
### Arguments:
- `self : omni.ui._ui.Window`
- `title : str`
- `dockPosition : omni.ui._ui.DockPosition`
- `ratio : float = 0.5`
## omni.ui.Window.get_window_callback
Returns window set draw callback pointer for the given UI window.
## omni.ui.Window.has_key_pressed_fn
Returns whether there is a key pressed function set for the window.
### Sets the function that will be called when the user presses the keyboard key on the focused window.
### move_to_app_window
```python
move_to_app_window(self: omni.ui._ui.Window, arg0: omni::kit::IAppWindow) -> None
```
Moves the window to the specific OS window.
### move_to_main_os_window
```python
move_to_main_os_window(self: omni.ui._ui.Window) -> None
```
Bring back the Window callback to the Main Window and destroy the Current OS Window.
### move_to_new_os_window
```python
move_to_new_os_window(self: omni.ui._ui.Window) -> None
```
Move the Window Callback to a new OS Window.
### notify_app_window_change
```python
notify_app_window_change(self: omni.ui._ui.Window, arg0: omni::kit::IAppWindow) -> None
```
Notifies the window that window set has changed.
### setPosition
```python
setPosition(self: omni.ui._ui.Window, x: float, y: float) -> None
```
This property set/get the position of the window in both axis calling the property.
### set_docked_changed_fn
```python
set_docked_changed_fn(self: omni.ui._ui.Window) -> None
```
### set_docked_changed_fn
```python
set_docked_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[bool], None]) -> None
```
- Has true if this window is docked. False otherwise. It’s a read-only property.
### set_focused_changed_fn
```python
set_focused_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[bool], None]) -> None
```
- Read only property that is true when the window is focused.
### set_height_changed_fn
```python
set_height_changed_fn(self: omni.ui._ui.Window, arg0: Callable[[float], None]) -> None
```
- This property holds the window Height.
### set_key_pressed_fn
```python
set_key_pressed_fn(self: omni.ui._ui.Window, fn: Callable[[int, int, int], None]) -> None
```
- Sets the function to be called when a key is pressed.
### omni.ui.Window.set_key_pressed_fn
Sets the function that will be called when the user presses the keyboard key on the focused window.
### omni.ui.Window.set_position_x_changed_fn
This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
### omni.ui.Window.set_position_y_changed_fn
This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
### omni.ui.Window.set_selected_in_dock_changed_fn
<em class="sig-param">
<span class="n">
<span class="pre">
arg0
</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">
bool
</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">
None
</span>
</span>
</span>
</dt>
<dd>
<p>
Has true if this window is currently selected in the dock. False otherwise. It’s a read-only property.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Window.set_top_modal">
<span class="sig-name descname">
<span class="pre">
set_top_modal
</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.ui._ui.Window
</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>
<p>
Brings this window to the top level of modal windows.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Window.set_visibility_changed_fn">
<span class="sig-name descname">
<span class="pre">
set_visibility_changed_fn
</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.ui._ui.Window
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg0
</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">
bool
</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">
None
</span>
</span>
</span>
</dt>
<dd>
<p>
This property holds whether the window is visible.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Window.set_width_changed_fn">
<span class="sig-name descname">
<span class="pre">
set_width_changed_fn
</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.ui._ui.Window
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
arg0
</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">
float
</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">
None
</span>
</span>
</span>
</dt>
<dd>
<p>
This property holds the window Width.
</p>
</dd>
</dl>
- **property auto_resize**
- setup the window to resize automatically based on its content
- **property detachable**
- If the window is able to be separated from the main application window.
- **property docked**
- Has true if this window is docked. False otherwise. It’s a read-only property.
- **property exclusive_keyboard**
- When true, only the current window will receive keyboard events when it’s focused. It’s useful to override the global key bindings.
- **property flags**
- This property set the Flags for the Window.
- **property focus_policy**
- How the Window gains focus.
- **property focused**
- Read only property that is true when the window is focused.
- **property frame**
- The main layout of this window.
- **property height**
- This property holds the window Height.
- **property noTabBar**
- setup the visibility of the TabBar Handle, this is the small triangle at the corner of the view If it is not shown then it is not possible to undock that window and it need to be closed/moved programatically
- **property padding_x**
- This property set the padding to the frame on the X axis.
- **property padding_y**
- This property set the padding to the frame on the Y axis.
- **property position_x**
- This property set/get the position of the window in the X Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
### position_y
This property set/get the position of the window in the Y Axis. The default is kWindowFloatInvalid because we send the window position to the underlying system only if the position is explicitly set by the user. Otherwise the underlying system decides the position.
### raster_policy
Determine how the content of the window should be rastered.
### selected_in_dock
Has true if this window is currently selected in the dock. False otherwise. It’s a read-only property.
### tabBar_tooltip
This property sets the tooltip when hovering over window’s tabbar.
### title
This property holds the window’s title.
### visible
This property holds whether the window is visible.
### width
This property holds the window Width. |
omni.ui.WindowHandle.md | # WindowHandle
## WindowHandle
WindowHandle is a handle object to control any of the windows in Kit. It can be created any time, and if it’s destroyed, the source window doesn’t disappear.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(*args, **kwargs)` | |
| `dock_in(self, window, dock_position[, ratio])` | Dock the window to the existing window. |
| `focus(self)` | Brings the window to the top. |
| `is_selected_in_dock(self)` | Return true is the window is the current window in the docking area. |
| `notify_app_window_change(self, arg0)` | Notifies the UI window that the AppWindow it attached to has changed. |
| `undock(self)` | Undock the window and make it floating. |
## Attributes
- `dock_id`: Returns ID of the dock node this window is docked to.
- `dock_order`: The position of the window in the dock.
- `dock_tab_bar_enabled`: Checks if the current docking space is disabled.
- `dock_tab_bar_visible`: Checks if the current docking space has the tab bar.
- `docked`: True if this window is docked.
- `height`: The height of the window in points.
- `position_x`: The position of the window in points.
- `position_y`: The position of the window in points.
- `title`: The title of the window.
- `visible`: Returns whether the window is visible.
- `width`: The width of the window in points.
## Methods
### `__init__(*args, **kwargs)`
### `dock_in(self: omni.ui._ui.WindowHandle, window: omni.ui._ui.WindowHandle)`
- **dock_in**(*dock_position*: `omni.ui._ui.DockPosition`, ratio: `float` = 0.5) -> `None`
- Dock the window to the existing window. It can split the window to two parts or it can convert the window to a docking tab.
- **focus**(self: `omni.ui._ui.WindowHandle`) -> `None`
- Brings the window to the top. If it’s a docked window, it makes the window currently visible in the dock.
- **is_selected_in_dock**(self: `omni.ui._ui.WindowHandle`) -> `bool`
- Return true is the window is the current window in the docking area.
- **notify_app_window_change**(self: `omni.ui._ui.WindowHandle`, arg0: `omni::kit::IAppWindow`) -> `None`
- Notifies the UI window that the AppWindow it attached to has changed.
- **undock**(self: `omni.ui._ui.WindowHandle`) -> `None`
- Undock the window and make it floating.
- **dock_id**
- Returns ID of the dock node this window is docked to.
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.dock_order">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
dock_order
</span>
</span>
</dt>
<dd>
<p>
The position of the window in the dock.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.dock_tab_bar_enabled">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
dock_tab_bar_enabled
</span>
</span>
</dt>
<dd>
<p>
Checks if the current docking space is disabled. The disabled docking tab bar can’t be shown by the user.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.dock_tab_bar_visible">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
dock_tab_bar_visible
</span>
</span>
</dt>
<dd>
<p>
Checks if the current docking space has the tab bar.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.docked">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
docked
</span>
</span>
</dt>
<dd>
<p>
True if this window is docked. False otherwise.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.height">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
height
</span>
</span>
</dt>
<dd>
<p>
The height of the window in points.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.position_x">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
position_x
</span>
</span>
</dt>
<dd>
<p>
The position of the window in points.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.position_y">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
position_y
</span>
</span>
</dt>
<dd>
<p>
The position of the window in points.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.title">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
title
</span>
</span>
</dt>
<dd>
<p>
The title of the window.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.visible">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
visible
</span>
</span>
</dt>
<dd>
<p>
Returns whether the window is visible.
</p>
</dd>
</dl>
<dl class="py property">
<dt class="sig sig-object py" id="omni.ui.WindowHandle.width">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
width
</span>
</span>
</dt>
<dd>
<p>
The width of the window in points.
</p>
</dd>
</dl> |
omni.ui.Workspace.md | # Workspace
## omni.ui.Workspace
Bases: `pybind11_object`
Workspace object provides access to the windows in Kit.
### Methods
- `__init__(*args, **kwargs)`
- `clear()`
- Undock all.
- `compare_workspace([compare_delegate])`
- Compare current docked windows according to the workspace description.
- `dump_workspace()`
- Capture current workspace and return the dict with the description of the docking state and window size.
- `get_dock_children_id(dock_id)`
- Get two dock children of the given dock ID.
- `get_dock_id_height(dock_id)`
- Returns the height of the docking node.
- `get_dock_id_width(dock_id)`
- Returns the width of the docking node.
- `get_dock_position(dock_id)`
- Returns the position of the given dock ID.
- `get_docked_neighbours(member)`
- Get all the windows that docked with the given widow.
- `get_docked_windows(dock_id)`
- Get all the windows of the given dock ID.
- `get_dpi_scale()`
- Returns current DPI Scale.
- `get_main_window_height()`
- Get the height in points of the current main window.
- `get_main_window_width()`
- Get the width in points of the current main window.
- `get_parent_dock_id(dock_id)`
- Return the parent Dock Node ID.
- `get_selected_window_index(dock_id)`
- Get currently selected window index from the given dock id.
- `get_window(title)`
- Find Window by name.
- `get_window_from_callback(callback)`
- Find Window by window callback.
- `get_windows()`
- Returns the list of windows ordered from back to front.
- `remove_window_visibility_changed_callback(fn)`
- Remove the callback that is triggered when window's visibility changed.
- `restore_workspace([keep_windows_open])`
- Dock the windows according to the workspace description.
- `set_dock_id_height(dock_id, height)`
- Set the height of the dock node.
- `set_dock_id_width(dock_id, width)`
- Set the width of the dock node.
| Method | Description |
|--------|-------------|
| `set_dock_id_width(dock_id, width)` | Set the width of the dock node. |
| `set_show_window_fn(title, fn)` | Add the callback to create a window with the given title. |
| `set_window_created_callback(fn)` | Add the callback that is triggered when a new window is created. |
| `set_window_visibility_changed_callback(fn)` | Add the callback that is triggered when window's visibility changed. |
| `show_window(title[, show])` | Makes the window visible or create the window with the callback provided with set_show_window_fn. |
### omni.ui.Workspace.__init__(*args, **kwargs)
- Initializes the Workspace.
### omni.ui.Workspace.clear()
- Undock all.
### omni.ui.Workspace.compare_workspace(compare_delegate: ~omni.ui.workspace_utils.CompareDelegate = <omni.ui.workspace_utils.CompareDelegate object>)
- Compare current docked windows according to the workspace description.
- ### Arguments
- `workspace_dump List[Any]`
- The dictionary with the description of the layout. It’s the dict received from `dump_workspace`.
### omni.ui.Workspace.dump_workspace()
- Capture current workspace and return the dict with the description of the docking state and window size.
### omni.ui.Workspace.get_dock_children_id(dock_id: int)`
- Returns the children IDs of a given dock ID.
Get two dock children of the given dock ID.
true if the given dock ID has children
### Arguments:
> `dockId :`
> the given dock ID
>
> `first :`
> output. the first child dock ID
>
> `second :`
> output. the second child dock ID
Returns the height of the docking node.
It’s different from the window height because it considers dock tab bar.
### Arguments:
> `dockId :`
> the given dock ID
Returns the width of the docking node.
### Arguments:
> `dockId :`
> the given dock ID
Returns the position of the given dock ID. Left/Right/Top/Bottom.
Get all the windows that docked with the given widow.
### get_docked_windows(dock_id: int) -> List[omni.ui._ui.WindowHandle]
Get all the windows of the given dock ID.
### get_dpi_scale() -> float
Returns current DPI Scale.
### get_main_window_height() -> float
Get the height in points of the current main window.
### get_main_window_width() -> float
Get the width in points of the current main window.
### get_parent_dock_id(dock_id: int) -> int
Return the parent Dock Node ID.
#### Arguments:
- `dockId :` the child Dock Node ID to get parent
### get_selected_window_index(dock_id: int) -> int
Get currently selected window index from the given dock id.
## omni.ui.Workspace.get_window
**static** `get_window`(name: str) → omni.ui._ui.WindowHandle
- Find Window by name.
## omni.ui.Workspace.get_window_from_callback
**static** `get_window_from_callback`(callback: omni::ui::windowmanager::IWindowCallback) → omni.ui._ui.WindowHandle
- Find Window by window callback.
## omni.ui.Workspace.get_windows
**static** `get_windows`() → List[omni.ui._ui.WindowHandle]
- Returns the list of windows ordered from back to front. If the window is a Omni::UI window, it can be upcasted.
## omni.ui.Workspace.remove_window_visibility_changed_callback
**static** `remove_window_visibility_changed_callback`(fn: int) → None
- Remove the callback that is triggered when window’s visibility changed.
## omni.ui.Workspace.restore_workspace
`restore_workspace`(keep_windows_open = False)
- Dock the windows according to the workspace description.
### Arguments
- `workspace_dump` List[Any]
- The dictionary with the description of the layout. It’s the dict received from `dump_workspace`.
- `keep_windows_open` bool
- Determines if it’s necessary to hide the already opened windows that are not present in `workspace_dump`.
## omni.ui.Workspace.set_dock_id_height
**static** `set_dock_id_height`(dock_id: int, height: int)
- Set the height of a specific dock ID.
<dt>
<em class="property">
<span class="pre">
static
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
set_dock_id_height
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
dock_id
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
height
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
float
</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>
<p>
Set the height of the dock node.
It also sets the height of parent nodes if necessary and modifies the height of siblings.
</p>
<p>
### Arguments:
</p>
<blockquote>
<div>
<dl class="simple">
<dt>
`dockId :`
</dt>
<dd>
<p>
the given dock ID
</p>
</dd>
<dt>
`height :`
</dt>
<dd>
<p>
the given height
</p>
</dd>
</dl>
</div>
</blockquote>
</dd>
<dt>
<em class="property">
<span class="pre">
static
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
set_dock_id_width
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
dock_id
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
width
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
float
</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>
<p>
Set the width of the dock node.
It also sets the width of parent nodes if necessary and modifies the width of siblings.
</p>
<p>
### Arguments:
</p>
<blockquote>
<div>
<dl class="simple">
<dt>
`dockId :`
</dt>
<dd>
<p>
the given dock ID
</p>
</dd>
<dt>
`width :`
</dt>
<dd>
<p>
the given width
</p>
</dd>
</dl>
</div>
</blockquote>
</dd>
<dt>
<em class="property">
<span class="pre">
static
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
set_show_window_fn
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
title
</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">
fn
</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">
bool
</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">
None
</span>
</span>
</span>
</dt>
<dd>
<p>
Add the callback to create a window with the given title. When the callback’s argument is true, it’s necessary to create the window. Otherwise remove.
</p>
</dd>
<dt>
<em class="property">
<span class="pre">
static
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
set_window_created_callback
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
fn
</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">
omni.ui._ui.WindowHandle
</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">
None
</span>
</span>
</span>
</dt>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Workspace.set_window_created_callback">
<em class="property">
<span class="pre">
static
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
set_window_created_callback
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
fn
</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">
None
</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">
None
</span>
</span>
</span>
</dt>
<dd>
<p>
Add the callback that is triggered when a new window is created.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Workspace.set_window_visibility_changed_callback">
<em class="property">
<span class="pre">
static
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
set_window_visibility_changed_callback
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
fn
</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">
str
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
bool
</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">
int
</span>
</span>
</span>
</dt>
<dd>
<p>
Add the callback that is triggered when window’s visibility changed.
</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.ui.Workspace.show_window">
<em class="property">
<span class="pre">
static
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
show_window
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
title
</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">
show
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
True
</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">
bool
</span>
</span>
</span>
</dt>
<dd>
<p>
Makes the window visible or create the window with the callback provided with set_show_window_fn.
true if the window is already created, otherwise it’s necessary to wait one frame
</p>
<p>
### Arguments:
</p>
<blockquote>
<div>
<dl class="simple">
<dt>
`title :`
</dt>
<dd>
<p>
the given window title
</p>
</dd>
<dt>
`show :`
</dt>
<dd>
<p>
true to show, false to hide
</p>
</dd>
</dl>
</div>
</blockquote>
</dd>
</dl> |
omni.ui.workspace_utils.Classes.md | # omni.ui.workspace_utils Classes
## Classes Summary:
- [CompareDelegate](omni.ui.workspace_utils/omni.ui.workspace_utils.CompareDelegate.html) |
omni.ui.workspace_utils.CompareDelegate.md | # CompareDelegate
## Methods
- `__init__()`
- `compare_dock_in_value_dock_id(key, value, target)`
- `compare_dock_in_value_height(key, value, target)`
- `compare_dock_in_value_position_x(key, value, ...)`
- `compare_dock_in_value_position_y(key, value, ...)`
- `compare_dock_in_value_width(key, value, target)`
- `compare_value(key, value, target)`
- `compare_window_value_dock_id(key, value, target)` |
omni.ui.workspace_utils.compare_workspace.md | # compare_workspace
## compare_workspace
```python
omni.ui.workspace_utils.compare_workspace(
workspace_dump: typing.List[typing.Any],
compare_delegate: omni.ui.workspace_utils.CompareDelegate = <omni.ui.workspace_utils.CompareDelegate object>
)
```
Compare current docked windows according to the workspace description.
### Arguments
- `workspace_dump List[Any]`
- The dictionary with the description of the layout. It’s the dict received from `dump_workspace`.
``` |
omni.ui.workspace_utils.dump_workspace.md | # dump_workspace
## dump_workspace
Capture current workspace and return the dict with the description of the docking state and window size. |
omni.ui.workspace_utils.Functions.md | # omni.ui.workspace_utils Functions
## Functions Summary:
| Function Name | Description |
|---------------|-------------|
| `compare_workspace` | Compare current docked windows according to the workspace description. |
| `dump_workspace` | Capture current workspace and return the dict with the description of the workspace. |
| `handle_exception` | Decorator to print exception in async functions |
| `restore_workspace` | Dock the windows according to the workspace description. | |
omni.ui.workspace_utils.handle_exception.md | # handle_exception
## handle_exception
```python
omni.ui.workspace_utils.handle_exception(func)
```
Decorator to print exception in async functions
``` |
omni.ui.workspace_utils.md | # omni.ui.workspace_utils
## Classes Summary
- **CompareDelegate**
## Functions Summary
- **compare_workspace**
- Compare current docked windows according to the workspace description.
- **dump_workspace**
- Capture current workspace and return the dict with the description of the
- **handle_exception**
- Decorator to print exception in async functions
- **restore_workspace**
- Dock the windows according to the workspace description. |
omni.ui.workspace_utils.restore_workspace.md | # restore_workspace
## restore_workspace
### Arguments
#### `workspace_dump List[Any]`
The dictionary with the description of the layout. It’s the dict received from `dump_workspace`.
#### `keep_windows_open bool`
Determines if it’s necessary to hide the already opened windows that are not present in `workspace_dump`. |
omni.ui_api.md | # Omniverse Kit API
## Class Hierarchy
- namespace omni
- namespace ui
- class WindowHandle
- class Workspace
- enum Alignment
## File Hierarchy
- Directory omni
- Directory ui
- File Alignment.h
- File WindowHandle.h
- File Workspace.h
## Namespaces
- omni
- omni::kit
- omni::ui
- omni::ui::windowmanager
## Classes and Structs
- omni::ui::WindowHandle
## Classes
- **omni::ui::WindowHandle**: is a handle object to control any of the windows in Kit.
- **omni::ui::Workspace**: object provides access to the windows in Kit.
## Enums
- **omni::ui::Alignment** |
omni.usd.add_hydra_engine.md | # add_hydra_engine
## add_hydra_engine |
omni.usd.attach_all_hydra_engines.md | # attach_all_hydra_engines
## attach_all_hydra_engines
```python
omni.usd.attach_all_hydra_engines(context: omni.usd._usd.UsdContext) -> None
```
Attach all Hydra engines to the given context.
``` |
omni.usd.attr_has_timesample_on_key.md | # attr_has_timesample_on_key
## attr_has_timesample_on_key |
omni.usd.audio.AssetLoadStatus.md | # AssetLoadStatus
## Class Overview
The `AssetLoadStatus` class is a part of the `omni.usd.audio` module and is based on `pybind11_object`. It defines the status of asset loading.
### Members
- **IN_PROGRESS**
- **DONE**
- **FAILED**
- **NOT_REGISTERED**
### Methods
- **__init__(self, value)**
### Attributes
- **DONE**
- **FAILED**
- **IN_PROGRESS**
- **NOT_REGISTERED**
- **name**
- **value**
__init__
(
self:
omni.usd.audio._audio.AssetLoadStatus
,
value: int
)
→ None
property
name |
omni.usd.audio.Classes.md | # omni.usd.audio Classes
## Classes Summary:
| Class | Description |
|-------|-------------|
| [AssetLoadStatus](#) | Members: |
| [EventType](#) | Members: |
| [FeatureDefault](#) | Members: |
| [IStageAudio](#) | This module contains bindings for the omni::usd::audio module. |
| [SoundLengthType](#) | Members: |
| [StreamListener](#) | | |
omni.usd.audio.EventType.md | # EventType
## EventType
```
class omni.usd.audio.EventType
```
Bases:
```
pybind11_object
```
Members:
- METADATA_CHANGE
- LISTENER_LIST_CHANGE
- ACTIVE_LISTENER_CHANGE
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self, value)` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `ACTIVE_LISTENER_CHANGE` | |
| `LISTENER_LIST_CHANGE` | |
| `METADATA_CHANGE` | |
| `name` | |
| `value` | |
```
omni.usd.audio._audio.EventType
,
value : int
)
→ None
property
name |
omni.usd.audio.FeatureDefault.md | # FeatureDefault
## Members
- ON
- OFF
- FORCE_ON
- FORCE_OFF
## Methods
| Method | Description |
| --- | --- |
| `__init__(self, value)` | |
## Attributes
| Attribute | Description |
| --- | --- |
| `FORCE_OFF` | |
| `FORCE_ON` | |
| `OFF` | |
| `ON` | |
| `name` | |
| `value` | |
__init__(self: omni.usd.audio._audio.FeatureDefault, value: int) -> None
property name |
omni.usd.audio.Functions.md | # omni.usd.audio Functions
## Functions Summary
- **get_stage_audio_interface**
- helper method to retrieve a cached version of the IStageAudio interface.
- **test_hydra_plugin**
- test_hydra_plugin() -> bool |
omni.usd.audio.get_stage_audio_interface.md | # get_stage_audio_interface
## get_stage_audio_interface
```python
omni.usd.audio.get_stage_audio_interface()
```
Returns:
The `omni.usd.audio.IStageAudio` interface.
Helper method to retrieve a cached version of the IStageAudio interface. |
omni.usd.audio.IStageAudio.md | # IStageAudio
## IStageAudio
- Bases: `object`
- This module contains bindings for the omni::usd::audio module. This provides functionality for playing and managing sound prims in USD scenes.
- Sound files may be in RIFF/WAV, Ogg, or FLAC format. Data in the sound files may use 8, 16, 24, or 32 bit integer samples, or 32 bit floating point samples. Channel counts may be from 1 to 64. If more channels of data are provided than the audio device can play, some channels will be blended together automatically.
### Methods
- `__init__()`: Constructor for the IStageAudio interface instance.
- `create_capture_streamer()`: Creates a new capture streamer.
- `create_event_stream_for_capture(id)`: Creates an event stream that the capture streamer will send data to.
- `destroy_capture_streamer(id)`: Destroys a capture streamer.
- `draw_waveform(prim, width, height[, flags, ...])`: This will draw an RGBA image of the waveform of the sound asset in use by a `Sound` prim.
- `get_active_listener()` - Get the active listener prim in the scene.
- `get_concurrent_voices()` - Get the minimum number of sounds in a scene that can be played concurrently.
- `get_distance_delay_default()` - Get the default value for whether distance delayed audio is enable for the current USD Stage.
- `get_doppler_default()` - Get the default value for whether doppler calculations are enabled for the current USD Stage.
- `get_doppler_limit()` - Gets the Limit on the maximum Doppler pitch shift that can be applied to a playing voice.
- `get_doppler_scale()` - Gets the scaler that can exaggerate or lessen the Doppler effect.
- `get_interaural_delay_default()` - Get the default value for whether interaural delay is enabled for the current USD Stage.
- `get_listener_by_index(index)` - Retrieves a single listener prim currently in the stage.
- `get_listener_count()` - Retrieves the total number of listener prims currently in the stage.
- `get_metadata_change_stream()` - Retrieve the event stream for metadata changes.
- `get_nonspatial_time_scale()` - Gets the timescale modifier for all non-spatial voices.
- `get_sound_asset_status(prim)` - Queries whether the asset of an individual sound has been fully loaded.
- `get_sound_count()` - Retrieves the total number of registered sound objects in the USD stage.
- `get_sound_length(prim[, length_type])` - Retrieves length of a sound in seconds (if known).
- `get_spatial_time_scale()` - Gets the timescale for all spatial voices.
```code
get_spatial_time_scale
```
()
This gets the timescale modifier for all spatial voices.
```code
get_speed_of_sound
```
()
Gets the speed of sound in the medium surrounding the listener.
```code
has_audio
```
()
Test if audio is working.
```code
is_sound_playing
```
(prim)
Queries whether a sound object is currently playing.
```code
play_sound
```
(prim)
Immediately plays the requested USD stage sound if it is loaded.
```code
set_active_listener
```
(prim)
Change the active Listener prim in the scene.
```code
set_capture_filename
```
(id, filename)
Sets the filename that a capture streamer will write to.
```code
set_concurrent_voices
```
([value])
The minimum number of sounds in a scene that can be played concurrently.
```code
set_device
```
(deviceName)
Switches to use a new device for for audio output.
```code
set_distance_delay_default
```
([value])
Set the default value for whether distance delayed audio is enable for the current USD Stage.
```code
set_doppler_default
```
([value])
Set the default value for whether doppler calculations are enabled for the current USD Stage.
```code
set_doppler_limit
```
([value])
Sets a Limit on the maximum Doppler pitch shift that can be applied to a playing voice.
```code
set_doppler_scale
```
([value])
Sets a scaler that can exaggerate or lessen the Doppler effect.
```code
set_interaural_delay_default
```
([value])
Set the default value for whether interaural delay is enabled for the current USD Stage.
```code
set_nonspatial_time_scale
```
([value])
```
| Description |
| --------------------------------------------------------------------------- |
| Sets the timescale modifier for all non-spatial voices. |
| Method | Description |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `set_spatial_time_scale([value])` | This sets the timescale modifier for all spatial voices. |
| `set_speed_of_sound([value])` | Sets the speed of sound in the medium surrounding the listener (typically air). |
| `spawn_voice(prim)` | Immediately plays the requested USD stage sound as a new carb.audio.Voice if it is loaded. |
| `start_capture(id[, filename])` | Starts the capture on a single streamer. |
| `start_captures(ids)` | Starts multiple streamers simultaneously. |
| `stop_all_sounds()` | Stops all currently playing USD stage sounds. |
| `stop_capture(id)` | Stops the capture on a single streamer. |
| `stop_captures(ids)` | Stops the capture on multiple streamers simultaneously. |
| `stop_sound(prim)` | Immediately schedules the stop of the playback of a sound. |
| `subscribe_to_asset_load(prim, callback)` | Bind a callback for when assets are loaded. |
| `wait_for_capture(id, timeout_milliseconds)` | Wait until the capture streamer has been disconnected. |
| Attribute | Description |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `INVALID_STREAMER_ID` | |
| `mgr` | |
| Method | Description |
| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `__init__()` | Constructor for the IStageAudio interface instance. This will raise an Exception if it was unable to obtain an instance of the USD context interface. |
| `create_capture_streamer()` | |
### create_capture_streamer
Creates a new capture streamer. This streamer object may be used multiple times to capture audio for a stage. Once a capture has been stopped on it, this streamer can be reused for another capture without issue. It must be destroyed with destroy_capture_streamer() when it is no longer needed.
#### Parameters
- **mgr** – the audio manager to create the new streamer on. This may not be None.
#### Returns
- The handle to a new capture streamer if it is successfully created. When this handle is no longer needed, it must be destroyed with destroy_capture_streamer().
- INVALID_STREAMER_ID if the new capture streamer could not be created.
### create_event_stream_for_capture
Creates an event stream that the capture streamer will send data to.
#### Parameters
- **mgr** – the audio manager that owns the streamer id. This may not be None.
- **id** – the streamer to set the filename for. This handle will have been returned from a previous call to create_capture_streamer(). This may not be INVALID_STREAMER_ID.
#### Returns
An event stream object. Call omni.usd.audio.create_event_listener() to receive callbacks for this object. Although you can directly subscribe to this callback, python is unsuitable for the required data conversion this needs.
### destroy_capture_streamer
Destroys a capture streamer.
Note that if the capture streamer is still running, this will asynchronously stop the capture streamer, so the file may not be finished being written by the time this call returns. If you need to ensure that capture has finished, call stop_capture() then call wait_for_capture() on that streamer before calling this function.
#### Parameters
- **mgr** – the audio manager to destroy the streamer for. This may not be None.
- **id** – the streamer to be destroyed. If this streamer is currently running a capture, it will be stopped first. Note that currently stopping one streamer will stop all installed streamers. All but the removed one will be restarted afterward. This will have the side effect of overwriting each other streamer’s file though. This can be avoided by stopping all streamers simultaneously first with stop_captures().
#### Returns
no return value.
### draw_waveform
This will draw an RGBA image of the waveform of the sound asset in use by a `Sound` prim.
#### Parameters
- **prim**
- **width**
- **height**
- **flags** = 34
- **channel** = 0
- **background** = [0, 0, 0, 1.0]
- **colors** = []
## Parameters
- **prim** – The prim which has the sound asset that will be rendered. Note that the `mediaOffsetStart` and `mediaOffsetEnd` properties of the prim are used to choose the region of the sound that is drawn. The asset for this prim must have been loaded or the call will fail.
- **width** – The width, in pixels, of the output image.
- **height** – The width, in pixels, of the output image.
- **flags** – Flags that alter the style of the rendered image. This must be a combination of carb.audio.AUDIO_IMAGE_FLAG*.
- AUDIO_IMAGE_FLAG_USE_LINES: The sound samples in the output image will be connected with lines, rather than just being individual points.
- AUDIO_IMAGE_FLAG_NOISE_COLOR: Each sound sample is given a random color and the colors parameter is ignored.
- AUDIO_IMAGE_FLAG_MULTI_CHANNEL: Each channel is drawn on top of the previous channel. The channel parameter is not used when this flag is set.
- AUDIO_IMAGE_FLAG_ALPHA_BLEND: Each pixel drawn is alpha blended into the output image. This is only useful if the colors specified don’t have an alpha component of 1.0.
- AUDIO_IMAGE_FLAG_SPLIT_CHANNELS: Each channel is rendered separately, organized vertically. This cannot be used in combination with AUDIO_IMAGE_FLAG_MULTI_CHANNEL; the rendering style chosen in this case is undefined. The channel parameter is not used when this flag is set.
- **channel** – Which audio channel will be rendered. This is only used if AUDIO_IMAGE_FLAG_MULTI_CHANNEL and AUDIO_IMAGE_FLAG_SPLIT_CHANNELS are not set.
- **background** – A normalized RGBA color to use as the background of the image.
- **colors** – Normalized RGBA colors to use for each channel. If AUDIO_IMAGE_FLAG_MULTI_CHANNEL or AUDIO_IMAGE_FLAG_SPLIT_CHANNELS are used, each index into this list is the color of that audio channel. When those flags are not set, index 0 into this list is always used to render the selected channel. If a color is not specified, a default color is used instead.
## Returns
A raw RGBA image with the rendered waveform. If the prim was not a sound prim or its asset had not been loaded yet, an empty list will be returned.
## get_active_listener
Get the active listener prim in the scene.
- **Parameters**
- **arguments** (No) –
- **Returns**
- The active listener is returned, if an active listener prim is bound.
- None is returned if no active listener prim is bound, which means the active camera is being used as the active listener.
## get_concurrent_voices
Get the minimum number of sounds in a scene that can be played concurrently.
- **Parameters**
- **arguments** (No) –
- **Returns**
- The minimum number of sounds in a scene that can be played concurrently.
## get_distance_delay_default
Get the default value for whether distance delayed audio is enable for the current USD Stage.
- **Parameters**
- **arguments** (No) –
- **Returns**
- The default value for whether distance delayed audio is enable for the current USD Stage.
## get_doppler_default
Get the default value for whether doppler calculations are enabled for the current USD Stage.
- **Parameters**
- **arguments** (No) –
- **Returns**
- The default value for whether doppler calculations are enabled for the current USD Stage.
- **arguments.** (No) –
- Returns
- The default value for whether doppler calculations are enabled for the current USD Stage.
- **get_doppler_limit**()
- Gets the Limit on the maximum Doppler pitch shift that can be applied to a playing voice.
- Parameters
- **arguments.** (No) –
- Returns
- The Limit on the maximum Doppler pitch shift that can be applied to a playing voice.
- **get_doppler_scale**()
- Gets the scaler that can exaggerate or lessen the Doppler effect.
- Parameters
- **arguments.** (No) –
- Returns
- The scaler that can exaggerate or lessen the Doppler effect.
- **get_interaural_delay_default**()
- Get the default value for whether interaural delay is enabled for the current USD Stage.
- Parameters
- **arguments.** (No) –
- Returns
- The default value for whether interaural delay is enabled for the current USD Stage.
- **get_listener_by_index**(index)
- Retrieves a single listener prim currently in the stage.
- Parameters
- **index** – The zero based index of the listener to retrieve the SDF path for. This should be strictly less than the most recent return value of _get_listener_count().
- Returns
- The requested indexed listener prim in the stage if the index is valid.
- None is returned if the given index was out of bounds of the number of listeners in the stage.
- **get_listener_count**()
- Retrieves the total number of listener prims currently in the stage.
- Parameters
- **arguments.** (No) –
- Returns
- The total number of listener prims currently in the stage. Note that this may change at any time due to user or script action so it is best to call this immediately before enumerating listeners.
- **get_metadata_change_stream**()
- Retrieve the event stream for metadata changes.
- Parameters
- **mgr** – The stage audio manager instance that this function acts upon. This must not be None.
- Returns
- An IEventStream which is pushed when metadata is changed.
None if the event stream could not be created for some reason.
## get_nonspatial_time_scale
Gets the timescale modifier for all non-spatial voices.
### Parameters
- **arguments.** (No) –
### Returns
The timescale modifier for all non-spatial voices.
## get_sound_asset_status
Queries whether the asset of an individual sound has been fully loaded.
Once the asset of a sound has been fully loaded, it should be possible to play with play_sound().
NOTE: this function is deprecated and will be replaced with a sound asset loaded callback.
### Parameters
- **of.** (path The path to sound prim to retrieve the status) –
### Returns
- AssetLoadStatus.IN_PROGRESS if the asset is in the process of loading.
- AssetLoadStatus.DONE if the asset has finished loading and is ready for immediate playback.
- AssetLoadStatus.FAILED if the audio manager has not loaded.
- AssetLoadStatus.FAILED if the asset has failed to load.
- AssetLoadStatus.NOT_REGISTERED if the sound prim is not of type Sound or the path corresponds to a prim that doesn’t exist.
## get_sound_count
Retrieves the total number of registered sound objects in the USD stage.
### Returns
- The total number of sound prims in the current USD stage.
- Sounds that have not had their asset loaded yet (or their asset failed to load) will not show up in the sound count unless they’ve been passed to an IStageAudio function.
## get_sound_length
Retrieves length of a sound in seconds (if known).
This calculates the length of a USD stage sound in seconds. This will be the lesser of the difference between the sound’s start and end times (if an end time is set on the prim) or the length of the actual sound asset itself (if not looping). In either case, this will be the amount of time that the sound would be expected to play for if it were triggered. For sounds that are set to loop, the returned time will include all scheduled loop iterations. For sounds that are set to loop infinitely, this will be INFINITY.
### Parameters
- **prim** – The USD prim to query the length of. This must be of type OmniAudioSchemaOmniSound.
- **length_type** – How the length of the sound is measured.
- **Valid values** –
- SoundLengthType.PLAY_LENGTH: The length of time the sound is estimated to play for in the stage once it’s triggered. This will be the lesser of the difference between the sound’s start and end times (if an end time is set on the prim) or the length of the actual sound itself, multiplied by loop count. Note that timeScale is taken into account when calculating the play time of an asset. For sounds that are set to loop infinitely, this will be a very large number (on the scale of 100 days).
- SoundLengthType.SOUND_LENGTH: The length of the sound. This doesn’t include the sound’s start time, end time or loop count. This is calculated using mediaOffsetStart and mediaOffsetEnd if those are set; otherwise, this just returns the sound asset’s length.
- SoundLengthType.ASSET_LENGTH: The length of the underlying sound asset, ignoring any USD parameters.
### Returns
The play length of the sound in seconds if the asset is loaded and the length can be calculated.
0.0 if the sound asset is not available yet or the length could not be properly calculated.
This gets the timescale modifier for all spatial voices.
**Parameters**
- **arguments.** (No) –
**Returns**
- The timescale modifier for all spatial voices.
Gets the speed of sound in the medium surrounding the listener. This is measured in meters per second.
**Parameters**
- **arguments.** (No) –
**Returns**
- The speed of sound in the medium surrounding the listener.
Test if audio is working. If the audio manager has failed to load or has been explicitly disabled, this function will return False. This function will otherwise return True.
**Returns**
- True if audio is in a working state.
- False if audio is in a disabled state.
Queries whether a sound object is currently playing.
This queries whether a sound is currently playing. If this fails, that may mean that the sound ended naturally on its own or it was explicitly stopped. Note that this may continue to return true for a short period after a sound has been stopped with stop_sound() or stop_all_sounds(). This period may be up to 20 milliseconds in extreme cases but will usually not exceed 10 milliseconds.
This only checks the most recently playing instance of a sound, if multiple simultaneous sounds have been spawned with playSound().
**Parameters**
- **prim** – The USD prim to query the playing state for. This must be of type OmniAudioSchemaOmniSound.
**Returns**
- true if the sound object is currently playing.
- false if the sound has either finished playing or has not been played yet.
Immediately plays the requested USD stage sound if it is loaded.
This plays a single non-looping instance of a USD stage sound immediately. The sound must have already been loaded. If the sound resource was missing or couldn’t be loaded, this call will simply be ignored. This will return immediately after scheduling the sound to play. It will never block for the duration of the sound playback. This sound may be prematurely stopped with stop_sound().
The loopCount parameter of the prim parameter is ignored in this call. This functionality will be added in a future revision.
Sound prims that are scheduled to play in an animation should not also be played with playSound(), since it may prevent them from playing when they are scheduled to play. This will be fixed in a future revision.
**Parameters**
- **prim** – The USD prim to play. This must be of type OmniAudioSchemaOmniSound.
**Returns**
- No return value.
Change the active Listener prim in the scene.
Note that updating the active Listener’s uniform attributes, such as orientationFromView, will reset the active listener back to the active camera.
- **Parameters**
- **prim** – The prim to set as the active listener. This can be None to use the active camera as the active listener.
- **Returns**
- True if the prim at @p path was set as the active prim. False if the prim at @p path was not registered with hydra. This can occur if hydra has not informed the audio manager about its existence yet.
- **set_capture_filename**
- Sets the filename that a capture streamer will write to.
- **Parameters**
- **mgr** – the audio manager that owns the streamer id. This may not be None.
- **id** – the streamer to set the filename for. This handle will have been returned from a previous call to create_capture_streamer(). This may not be INVALID_STREAMER_ID.
- **filename** – the name and path of the file to write the streamer’s data to once its capture is started. If the filename is set here, a None filename may be passed into start_capture().
- **Returns**
- No return value.
- **set_concurrent_voices**
- The minimum number of sounds in a scene that can be played concurrently.
- In a scene where `concurrentVoices` is set to `N` and `N + 1` sounds are played concurrently, Omniverse Kit will choose to not play the `N+1` th sound to the audio device and just track it as a ‘virtual’ voice. The voices chosen to become ‘virtual’ will be the lowest priority or silent. A ‘virtual’ voice should begin playing again once there is an empty voice to play on.
- **Parameters**
- **value** – The new value for the number of concurrent voices.
- **Returns**
- No return value.
- **set_device**
- Switches to use a new device for for audio output.
- This sets the device that the audio manager will use for its output. If the requested device cannot be used for any reason, the default output device will be used instead. The device may change the final output format. If a streamer is attached to the previous output, its stream will be closed before opening a new stream on the new device. Even if the new device name matches the current device’s name, the device will still be changed and any stream reset.
- If multiple devices attached to the system have the same name, the one that is chosen may be undefined. This can be a common issue with certain devices showing up in the system as simply “Speakers”. Using the device’s GUID instead will allow a specific device to be used instead, even its name exactly matches that of another device.
- **Parameters**
- **deviceName** – The name or GUID of the device to set as active. This must exactly match the name or GUID of one of the devices attached to the system at the time. If the given name or GUID doesn’t match one of the connected devices, the default device will be used instead. This may be set to nullptr or an empty string to use the system’s default device. This device name or identifier may be retrieved from the IAudioDeviceEnum interface.
- **Returns**
- No return value.
- **set_distance_delay_default**
- Set the default value for whether distance delayed audio is enable for the current USD Stage.
- This will append the USD Stage metadata to add this new scene setting.
- **Parameters**
- **value** – The new value for whether distance delayed audio is enable for the current USD Stage.
- **Returns**
- No return value.
## Parameters
**value** – The value to set this as. This must be one of the following values:
- **FeatureDefault.ON**: Sounds with enableDistanceDelay set to "default" will have distance delay effects applied.
- **FeatureDefault.OFF**: Sounds with enableDistanceDelay set to "default" will not have distance delay effects applied. This is the default because distance delay can have a very confusing effect if worldUnitScale hasn’t been set correctly.
- **FeatureDefault.FORCE_ON**: all Sounds will have distance delay effects applied. This setting is intended to let users test what effect distance delay is having on their scene without requiring all Sounds to have their enableDistanceDelay property set to "default".
- **FeatureDefault.FORCE_OFF**: all Sounds will have distance delay effects disabled. This setting is intended to let users test what effect distance delay having on their scene without requiring all Sounds to have their enableDistanceDelay property set to "default".
## Returns
No return value.
## set_doppler_default
Set the default value for whether doppler calculations are enabled for the current USD Stage.
This will append the USD Stage metadata to add this new scene setting.
### Parameters
**value** – The value to set this as. This must be one of the following values:
- **FeatureDefault.ON**: Sounds with enableDoppler set to "default" will have Doppler effects applied.
- **FeatureDefault.OFF**: Sounds with enableDoppler set to "default" will not have Doppler effects applied. This is the default because Doppler effect’s implementation is still experimental. The default will be switched to FeatureDefault.ON when the feature is stabilized.
- **FeatureDefault.FORCE_ON**: all Sounds will have Doppler effects applied. This setting is intended to let users test what effect the Doppler effect is having on their scene without requiring all Sounds to have their enableDoppler property set to "default".
- **FeatureDefault.FORCE_OFF**: all Sounds will have Doppler effects disabled. This setting is intended to let users test what effect the Doppler effect having on their scene without requiring all Sounds to have their enableDoppler property set to "default".
### Returns
No return value.
## set_doppler_limit
Sets a Limit on the maximum Doppler pitch shift that can be applied to a playing voice. Since Omniverse Kit does not handle supersonic spatial audio, a maximum frequency shift must be set for prims that move toward the listener at or faster than the speed of sound. This is mostly useful for handling edge cases such as teleporting an object far away while it’s playing a sound.
### Parameters
**value** – The new value for the doppler limit.
### Returns
No return value.
## set_doppler_scale
Sets a scaler that can exaggerate or lessen the Doppler effect. Setting this above 1.0 will exaggerate the Doppler effect. Setting this below 1.0 will lessen the Doppler effect. Negative values and zero are not allowed. Doppler effects alter the pitch of a sound based on its relative velocity to the listener.
### Parameters
**value** – The new value for the doppler scale.
### Returns
No return value.
1.
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#omni.usd.audio.IStageAudio.set_interaural_delay_default" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Set the default value for whether interaural delay is enabled for the current USD Stage.
</p>
<p>
This will append the USD Stage metadata to add this new scene setting.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<p>
<strong>
value
</strong>
–
<p>
The value to set. This must be one of the following values:
</p>
<ul class="simple">
<li>
<p>
FeatureDefault.ON: Sounds with enableInterauralDelay set to “default” will have interaural delay effects applied. This is the default.
</p>
</li>
<li>
<p>
FeatureDefault.OFF: Sounds with enableInterauralDelay set to “default” will not have interaural delay effects applied.
</p>
</li>
<li>
<p>
FeatureDefault.FORCE_ON: all Sounds will have interaural delay effects applied. This setting is intended to let users test what effect interaural delay is having on their scene without requiring all Sounds to have their enableInterauralDelay property set to “default”.
</p>
</li>
<li>
<p>
FeatureDefault.FORCE_OFF: all Sounds will have distance delay effects disabled. This setting is intended to let users test what effect interaural delay having on their scene without requiring all Sounds to have their enableInterauralDelay property set to “default”.
</p>
</li>
</ul>
</p>
</dd>
<dt class="field-even">
Returns
</dt>
<dd class="field-even">
<p>
No return value.
</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.usd.audio.IStageAudio.set_nonspatial_time_scale">
<span class="sig-name descname">
<span class="pre">
set_nonspatial_time_scale
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
value
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
1.0
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#omni.usd.audio.IStageAudio.set_nonspatial_time_scale" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Sets the timescale modifier for all non-spatial voices. Each prim multiplies its timeScale attribute by this value. For example, setting this to 0.5 will play all non-spatial sounds at half speed and setting this to 2.0 will play all non-spatial sounds at double speed. Altering the playback speed of a sound will affect the pitch of the sound. The limits of this setting under Omniverse Kit are [1/1024, 1024].
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<p>
<strong>
value
</strong>
– The new value for the non-spatial timescale.
</p>
</dd>
<dt class="field-even">
Returns
</dt>
<dd class="field-even">
<p>
No return value.
</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.usd.audio.IStageAudio.set_spatial_time_scale">
<span class="sig-name descname">
<span class="pre">
set_spatial_time_scale
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
value
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
1.0
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#omni.usd.audio.IStageAudio.set_spatial_time_scale" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
This sets the timescale modifier for all spatial voices. Each prim multiplies its timeScale attribute by this value. For example, setting this to 0.5 will play all spatial sounds at half speed and setting this to 2.0 will play all non-spatial sounds at double speed. This affects delay times for the distance delay effect. Altering the playback speed of a sound will affect the pitch of the sound. The limits of this setting under Omniverse Kit are [1/1024, 1024]. This feature is intended to allow time-dilation to be performed with the sound effects in the scene without affecting non-spatial elements like the background music.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<p>
<strong>
value
</strong>
– The new value for the spatial timescale.
</p>
</dd>
<dt class="field-even">
Returns
</dt>
<dd class="field-even">
<p>
No return value.
</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.usd.audio.IStageAudio.set_speed_of_sound">
<span class="sig-name descname">
<span class="pre">
set_speed_of_sound
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
value
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
340.0
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#omni.usd.audio.IStageAudio.set_speed_of_sound" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Sets the speed of sound in the medium surrounding the listener (typically air). This is measured in meters per second. This would typically be adjusted when doing an underwater scene. The speed of sound in dry air at sea level is approximately 340.0m/s.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<p>
<strong>
value
</strong>
– The new value for the speed of sound.
</p>
</dd>
<dt class="field-even">
Returns
</dt>
<dd class="field-even">
<p>
No return value.
</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="omni.usd.audio.IStageAudio.spawn_voice">
<span class="sig-name descname">
<span class="pre">
spawn_voice
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
prim
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#omni.usd.audio.IStageAudio.spawn_voice" title="Permalink to this definition">
</a>
</dt>
<dd>
Immediately plays the requested USD stage sound as a new carb.audio.Voice if it is loaded.
This begins playing the requested sound as a new carb.audio.Voice. The sound must have already been loaded or None will be returned. The spawned voice plays the sound asynchronously for the lifetime of the voice. This is intended for cases where the behavior of playSound() is too limiting.
stopAllSounds() and stopSound() do not affect the playing voices spawned from this call.
Unlike playSound(), the loopCount parameter of the prim is used, so the voice must be explicitly stopped if the voice is infinitely looping.
Unlike playSound(), these voice handles are managed separately from the voice handles of the timeline, so spawning a voice from a sound that will play on the timeline shouldn’t affect that sound’s timeline playback. Stopping the timeline will also not stop these playing voices.
### Parameters
- **path** – The path to sound prim to spawn a voice from.
### Returns
This returns the new voice that was spawned. This voice’s settings are only a snapshot of the sound prim that they were based off. Updates to these parameters will have to be performed on the returned voice through the IAudioPlayback interface.
this returns nullptr if a new voice could not be spawned.
### start_capture
```python
start_capture(id, filename=None)
```
Starts the capture on a single streamer.
#### Parameters
- **mgr** – the audio manager that owns the streamer id. This may not be None.
- **id** – the handle of the streamer to start. This handle will have been returned from a previous call to create_capture_streamer(). This may not be INVALID_STREAMER_ID.
- **filename** – the name and path of the filename to write the streamer’s data to once its capture is started. If a filename was set with a previous call to set_capture_filename() on the same streamer, this may be None to use that filename. If a non-None and non-empty filename is given here, it will always override any filename previously set on the streamer.
#### Returns
True if the streamer is successfully started. Note that starting a streamer currently has the side effect of stopping and restarting all other streamers that are currently running a capture. This will result in each streamer’s output file being overwritten. If multiple streamers need to be started simultaneously, start_captures() should be used instead.
False if the streamer could not be started.
### start_captures
```python
start_captures(ids)
```
Starts multiple streamers simultaneously. This attempts to start one or more streamers simultaneously. If successful, all streamers are guaranteed to be started in sync with each other such that their first written audio frame matches. If this method is used to start multiple streamers, the stop_captures() function must also be used to stop those same streamers simultaneously. If another streamer starts or stops independently, it will cause all streamers to be closed then reopened which will overwrite each of their files.
#### Parameters
- **mgr** – the audio manager that owns the streamer handles in ids. This may not be None.
- **ids** – the list of streamers to start a capture on. Any entries that are set to INVALID_STREAMER_ID in this list will be ignored. Each valid entry must have had its filename set with set_capture_filename() first otherwise it will be skipped. Any streamer that is already running a capture will be skipped, but a side effect of this operation will be that its stream will be closed and reopened thereby overwriting its file. this may not be None.
#### Returns
True if at least one streamer is successfully started.
False if no streamers could be started or all streamers were skipped for one of the reasons listed under streamers.
### stop_all_sounds
```python
stop_all_sounds()
```
Stops all currently playing USD stage sounds.
This stops all currently playing stage sounds. Any sounds that have been queued for playback will be stopped. UI sounds will not be affected. This is intended to be used to reset the sound playback system when an animation sequence is stopped. This will be automatically called internally whenever the animation sequence is stopped or it loops.
#### Returns
No return value.
### stop_capture
```python
stop_capture(id)
```
Stops the capture on a single streamer.
This will asynchronously stop the capture streamer, so the file may not be finished being written by the time this call returns. If you need to ensure that capture has finished, call wait_for_capture().
#### Parameters
- **mgr** – the audio manager that owns the streamer id. This may not be None.
- **id** – the handle to the streamer to stop. This will have been returned from a previous call to create_capture_streamer(). If a capture is not running on this streamer, it will be ignored. This may not be INVALID_STREAMER_ID.
#### Returns
- True if the streamer is successfully stopped.
- False if the streamer handle was invalid or a capture was not running on it.
### stop_captures
```python
stop_captures(ids)
```
Stops the capture on multiple streamers simultaneously.
This will asynchronously stop the capture streamer, so the file may not be finished being written by the time this call returns. If you need to ensure that capture has finished, call wait_for_capture().
#### Parameters
- **mgr** – the audio manager that owns the streamer handles in ids. This may not be None.
- **ids** – the list of streamers to stop the capture on. Any INVALID_STREAMER_ID entries will be ignored. Each valid entry must be currently running a capture otherwise it will be skipped. This may not be None.
#### Returns
- True if at least one streamer is successfully stopped.
- False if no streamers could be stopped.
### stop_sound
```python
stop_sound(prim)
```
Immediately schedules the stop of the playback of a sound.
This stops the playback of an active sound. If the sound was not playing or had already naturally stopped on its own, this call is ignored. Note that is_sound_playing() may continue to return true for a short period after a sound has been stopped for a period of up to 20 milliseconds in extreme cases but will usually not exceed 10 milliseconds.
This only stops the most recently played instance of a sound, if multiple overlapping instances of a sound were played with playSound().
#### Parameters
- **prim** – The USD prim to stop. This must be of type OmniAudioSchemaOmniSound.
#### Returns
- No return value.
### subscribe_to_asset_load
```python
subscribe_to_asset_load(prim, callback)
```
Bind a callback for when assets are loaded.
This will fire the callback when the sound’s asset is loaded or immediately if the asset was already loaded. The callback will only fire once.
#### Parameters
- **prim** – The sound prim to bind a callback to.
- **callback** – The callback to fire once a load has occurred.
#### Returns
- true if the callback was bound successfully.
- true if the callback was executed immediately.
- false if the prim path passed corresponds to a prim that’s not of type Sound.
- false if an unexpected error prevents the callback from occurring.
### IStageAudio.wait_for_capture(id, timeout_milliseconds)
Wait until the capture streamer has been disconnected.
Because stop_capture() does not stop the audio system or otherwise block to ensure that the streamer is disconnected, you must call wait_for_capture() to verify that a capture streamer has actually finished. This is mainly useful if you need to verify that a file written by a streamer has finished being written.
#### Parameters
- **id** – the handle to the streamer to wait for. This will have been returned from a previous call to create_capture_streamer(). If a capture is not running on this streamer, it will be ignored. This may not be INVALID_STREAMER_ID.
- **timeout_milliseconds** – The maximum number of milliseconds to wait for the streamer to close.
#### Returns
- True if the capture streamer has disconnected.
- False if the call timed out before the streamer could disconnect. |
omni.usd.audio.md | # omni.usd.audio
## Classes Summary
- **AssetLoadStatus**
- Members:
- **EventType**
- Members:
- **FeatureDefault**
- Members:
- **IStageAudio**
- This module contains bindings for the omni::usd::audio module.
- **SoundLengthType**
- Members:
- **StreamListener**
## Functions Summary
- **get_stage_audio_interface**
- helper method to retrieve a cached version of the IStageAudio interface.
- **test_hydra_plugin**
- test_hydra_plugin() -> bool |
omni.usd.audio.SoundLengthType.md | # SoundLengthType
## Overview
The `SoundLengthType` class, derived from `pybind11_object`, defines various types of sound lengths used in audio processing.
### Members
- `PLAY_LENGTH`
- `SOUND_LENGTH`
- `ASSET_LENGTH`
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self, value)` | Initializes the `SoundLengthType` instance. |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `ASSET_LENGTH` | Description not provided. |
| `PLAY_LENGTH` | Description not provided. |
| `SOUND_LENGTH` | Description not provided. |
| `name` | Description not provided. |
| `value` | Description not provided. |
<em class="sig-param">
<span class="n">
<span class="pre">
omni.usd.audio._audio.SoundLengthType
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
value
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
int
</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 property">
<dt class="sig sig-object py" id="omni.usd.audio.SoundLengthType.name">
<em class="property">
<span class="pre">
property
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
name
</span>
</span>
</dt>
<dd>
</dd>
</dl> |
omni.usd.audio.StreamListener.md | # StreamListener
## omni.usd.audio.StreamListener
Bases: `pybind11_object`
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self, p, open, writeData, close)` | |
#### __init__(self, p, open, writeData, close)
- **Parameters**:
- `self`: An instance of `omni.usd.audio._audio.StreamListener`
- `p`: `carb.events._events.IEventStream`
- `open`: `Callable[[carb.audio.SoundFormat], None]`
- `writeData`: `Callable[[bytes], None]`
- `close`: `Callable[[], None]`
**Callable**[list], **None**],
**close**: **Callable**[[], **None**] |
omni.usd.audio.test_hydra_plugin.md | # test_hydra_plugin
## test_hydra_plugin
Test whether the Hydra audio plugin is accessible.
This is intended to allow the tests to check whether the Hydra audio
plugin is still working.
**Parameters**
- **arguments** (No) –
**Returns**
- True if the plugin is accessible. False otherwise. |
omni.usd.AudioManager.md | # AudioManager
## AudioManager
```python
class omni.usd.AudioManager(pybind11_object)
```
### Methods
| Method | Description |
|--------|-------------|
| `__init__(*args, **kwargs)` | |
```python
def __init__(*args, **kwargs):
pass
``` |
omni.usd.can_be_copied.md | # can_be_copied
## can_be_copied
```python
omni.usd.can_be_copied(prim)
```
```
``` |
omni.usd.can_prim_have_children.md | # can_prim_have_children
## can_prim_have_children |
omni.usd.check_ancestral.md | # check_ancestral
## check_ancestral
### omni.usd.check_ancestral |
omni.usd.Classes.md | # omni.usd Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| AudioManager | - |
| EngineCreationConfig | EngineCreationConfig structure. |
| EngineCreationFlags | Specifies the flags for the hydra engine creation. |
| OpaqueSharedHydraEngineContext | - |
| PickingMode | Members: |
| PrimCaching | - |
| Selection | omni.usd.Selection manages all stage selections and provides APIs for querying/setting selections. |
| StageEventType | Stage Event Type. |
| StageRenderingEventType | Rendering Events. |
| StageState | Stage states. |
| TransformHelper | - |
| UsdContext | - |
| UsdContextInitialLoadSet | - |
| 属性 | 描述 |
| --- | --- |
| `initialSetOfPrims` | Specifies the initial set of prims to load when opening a UsdStage. |
| `UsdExtension` | |
| `UsdWatcher` | |
| `Value_On_Layer` | An enumeration. | |
omni.usd.clear_attr_val_at_time.md | # clear_attr_val_at_time
## clear_attr_val_at_time
```python
omni.usd.clear_attr_val_at_time(attr: Attribute, time_code=Usd.TimeCode.Default(), auto_target_layer: bool = True)
```
Clears attribute at specified timecode.
### Parameters
- **attr** (Usd.Attribute) – Attribute handle.
- **time_code** (_type_, optional) – specified timecode. Defaults to Usd.TimeCode.Default().
- **auto_target_layer** (bool, optional) – When it’s True and the property exists in session layer or its sublayers, it will switch EditTarget to the session layer instead to clear the strongest opinion. Defaults to True. |
omni.usd.commands.active_edit_context.md | # active_edit_context
## active_edit_context |
omni.usd.commands.AddPayloadCommand.md | # AddPayloadCommand
## Class Definition
```python
class omni.usd.commands.AddPayloadCommand(stage, prim_path: Path, payload: Payload, position=Usd.ListPositionBackOfPrependList)
```
**Bases:**
```python
PayloadCommandBase
```
### Methods
| Method | Description |
|--------|-------------|
| `__init__(stage, prim_path, payload[, position])` | |
| `do()` | |
```
Path, payload: Payload, position = Usd.ListPositionBackOfPrependList) |
omni.usd.commands.AddReferenceCommand.md | # AddReferenceCommand
## Class Definition
```python
class omni.usd.commands.AddReferenceCommand(stage, prim_path: Path, reference: Reference, position=Usd.ListPositionBackOfPrependList)
```
**Bases:**
```python
ReferenceCommandBase
```
### Methods
| Method | Description |
|--------|-------------|
| `__init__(stage, prim_path, reference[, position])` | |
| `do()` | |
### Detailed Method Descriptions
#### `__init__(stage, prim_path, reference[, position])`
```python
__init__(stage, prim_path, reference[, position])
```
#### `do()`
```python
do()
```
Path
: Reference
,
reference
: Reference
,
position
= Usd.ListPositionBackOfPrependList
) |
omni.usd.commands.AddRelationshipTargetCommand.md | # AddRelationshipTargetCommand
## AddRelationshipTargetCommand
```python
class omni.usd.commands.AddRelationshipTargetCommand(relationship: Relationship, target: Path, position=Usd.ListPositionBackOfPrependList)
```
**Bases:**
[RelationshipTargetBase](omni.usd.commands.RelationshipTargetBase.html#omni.usd.commands.RelationshipTargetBase)
**Description:**
Add target to a relationship
### Methods
| Method | Description |
|--------|-------------|
| `__init__(relationship, target[, position])` | |
| `do()` | |
```
,
**target** : **Path**,
**position** = **Usd.ListPositionBackOfPrependList** |
omni.usd.commands.BindMaterialCommand.md | # BindMaterialCommand
## BindMaterialCommand
## BindMaterialCommand
**Bases:**
- `Command`
- `UsdStageHelper`
**Description:**
Bind material undoable **Command**.
### Parameters
- **prim_path** (str or list) – Path(s) to prim or collection
- **material_path** (str) – Path to material to bind.
- **strength** (float) – Strength.
- **stage** (Usd.Stage) – Stage to operate. Optional.
- **context_name** (str) – The usd context to operate. Optional.
- **material_purpose** (str) – Material purpose. Optional.
### Methods
- `__init__(prim_path, material_path[, ...])`
- `do()`
- `undo()`
#### `__init__(prim_path, material_path, strength=None, stage=None, context_name=None)`
- **prim_path**: Union[str, list]
- **material_path**: str
- **strength**: Optional[float] = None
- **stage**: Optional[Stage] = None
- **context_name**: Optional[str] = None
<dl class="sig sig-object py" id="omni.usd.commands.BindMaterialCommand.__init__">
<dt class="sig sig-object py">
<em class="sig-object">
<span class="n">
<span class="pre">
__init__
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
self
</span>
</span>
</em>
<span class="sig-paren">
,
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
material_path
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Optional
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
str
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
material_purpose
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Optional
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
str
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
''
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
</dt>
<dd>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="omni.usd.commands.BindMaterialCommand.PathType">
<em class="property">
<span class="pre">
class
</span>
<span class="w">
</span>
</em>
<span class="sig-name descname">
<span class="pre">
PathType
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
value
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Bases:
<code>
<span class="pre">
Enum
</span>
</code>
</p>
<p>
An enumeration.
</p>
</dd>
</dl>
</dl> |
omni.usd.commands.ChangeAttributesColorSpaceCommand.md | # ChangeAttributesColorSpaceCommand
## ChangeAttributesColorSpaceCommand
```python
class omni.usd.commands.ChangeAttributesColorSpaceCommand(attributes: List[Attribute], color_space: Any)
```
Bases: `Command`
Change attribute color space undoable **Command**.
### Parameters
- **attributes** (List[str]) – attributes to set color space on.
- **color_space** – Value of metadata to change to.
### Methods
- `__init__(attributes, color_space)`
- `do()`
```
| undo |
| ---- |
| () |
```
```
__init__(attributes: List[Attribute], color_space: Any)
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
``` |
omni.usd.commands.ChangeMetadataCommand.md | # ChangeMetadataCommand
## ChangeMetadataCommand
```python
class omni.usd.commands.ChangeMetadataCommand(object_paths: List[str], key: Any, value: Any, usd_context_name: str = '')
```
Bases: `Command`
Change object metadata undoable **Command**.
### Parameters
- **object_paths** (List[str]) – Object paths, can be attribute or prim.
- **key** – Key of metadata to change.
- **value** – Value of metadata to change to.
- **usd_context_name** (str) – (default is '')
```
(
<em>
str
</em>
) – Name of the usd context to work on. Leave to “” to use default USD context.
## Methods
| | |
| ---- | --------------------------------------------------------------- |
| | [__init__](#omni.usd.commands.ChangeMetadataCommand.__init__)(object_paths, key, value[, ...]) |
| | do() |
| | undo() |
### __init__
__init__(object_paths: List[str], key: Any, value: Any, usd_context_name: str = '') |
omni.usd.commands.ChangeMetadataInPrimsCommand.md | # ChangeMetadataInPrimsCommand
## ChangeMetadataInPrimsCommand
```python
class omni.usd.commands.ChangeMetadataInPrimsCommand(prim_paths: List[str], key: Any, value: Any, usd_context_name: str = '')
```
Bases: `Command`
Change prim metadata undoable **Command**.
### Parameters
- **prim_paths** (List[str]) – Prim paths.
- **key** – Key of metadata to change.
- **value** – Value of metadata to change to.
- **usd_context_name** (str) – (default: '')
```
**Methods**
- `__init__(prim_paths, key, value[, usd_context_name=""])`
- `prim_paths`: List[str]
- `key`: Any
- `value`: Any
- `usd_context_name`: str = ''
- `do()`
- `undo()` |
omni.usd.commands.ChangePropertyCommand.md | # ChangePropertyCommand
## ChangePropertyCommand
```python
class omni.usd.commands.ChangePropertyCommand(prop_path: str, value: Any, prev: Any, timecode=Usd.TimeCode.Default(), type_to_create_if_not_exist: Optional[ValueTypeNames] = None, target_layer: Optional[Layer] = None)
```
```
Union[str, UsdContext, Stage] = ''
,
bool = False
,
Variability = Sdf.VariabilityVarying
)
Bases:
```
Command
```
Change prim property undoable **Command**.
**Parameters**
- **prop_path** (str) – Prim property path.
- **value** (Any) – Value to change to. If it’s None, current attribute value is cleared.
- **prev** (Any) – Value to undo to.
- **timecode** (Usd.TimeCode) – The timecode to set property value to.
- **type_to_create_if_not_exist** (Sdf.ValueTypeName) – If not None AND property does not already exist, a new property will be created with given type and value.
- **target_layer** (sdf.Layer) – Target layer to write value to. Leave to None to use current stage’s EditTarget.
- **usd_context_name** (Union[str, Usd.Stage]) – Union that could be:
* Name of the usd context to work on. Leave to “” to use default USD context.
* Instance of UsdContext.
* Or stage instance.
- **is_custom** (bool) – If the property is created, specify if it is a ‘custom’ property (not part of the Schema).
- **variability** (Sdf.Variability) – If the property is created, specify the variability.
**Methods**
- **__init__**(prop_path, value, prev[, timecode, ...])
- **do**()
- **undo**()
**Attributes**
- **overriden_notification**
<dl class="py method">
<dt class="sig sig-object py" id="omni.usd.commands.ChangePropertyCommand.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
prop_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">
value
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Any
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
prev
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Any
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
timecode
</span>
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="default_value">
<span class="pre">
Usd.TimeCode.Default()
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
type_to_create_if_not_exist
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Optional
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
ValueTypeNames
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
target_layer
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Optional
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
Layer
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
usd_context_name
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Union
</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">
UsdContext
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
Stage
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
''
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
is_custom
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
False
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
variability
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Variability
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
Sdf.VariabilityVarying
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#omni.usd.commands.ChangePropertyCommand.__init__" title="Permalink to this definition">
</a>
</dt>
<dd>
</dd>
</dl> |
omni.usd.commands.Classes.md | # omni.usd.commands Classes
## Classes Summary:
| Class Name | Description |
|------------|-------------|
| AddPayloadCommand | Base class for all **Commands**. |
| AddReferenceCommand | Base class for all **Commands**. |
| AddRelationshipTargetCommand | Add target to a relationship |
| BindMaterialCommand | Bind material undoable **Command**. |
| ChangeAttributesColorSpaceCommand | Change attribute color space undoable **Command**. |
| ChangeMetadataCommand | Change object metadata undoable **Command**. |
| ChangeMetadataInPrimsCommand | Change prim metadata undoable **Command**. |
| ChangePropertyCommand | Change prim property undoable **Command**. |
| ClearCurvesSplitsOverridesCommand | Clear Curves Splits Overrides **Command**. |
| ClearRefinementOverridesCommand | Clear Refinement Overrides **Command**. |
| CopyPrimCommand | Description not provided. |
| Command | Description |
|---------|-------------|
| CopyPrimCommand | Copy primitive undoable **Command**. |
| CopyPrimsCommand | Copy multiple primitives undoable **Command**. |
| CreateAudioPrimFromAssetPathCommand | Create reference undoable **Command**. |
| CreateDefaultXformOnPrimCommand | Create DefaultXform On Prim undoable **Command**. |
| CreateInstanceCommand | Instance primitive undoable **Command**. |
| CreateInstancesCommand | Instance multiple primitives undoable **Command**. |
| CreateMdlMaterialPrimCommand | Create Mdl Material undoable **Command**. |
| CreateMtlxMaterialPrimCommand | Create MaterialX Material undoable **Command**. |
| CreatePayloadCommand | Create payload undoable **Command**. |
| CreatePreviewSurfaceMaterialPrimCommand | Create Preview Surface Material undoable **Command**. |
| CreatePreviewSurfaceTextureMaterialPrimCommand | Create Preview Surface Texture Material undoable **Command**. |
| CreatePrimCommand | Create primitive undoable **Command**. It is same as `CreatePrimWithDefaultXformCommand`. |
| CreatePrimCommandBase | Base class to create a prim (and remove when undo) |
| CreatePrimWithDefaultXformCommand | Create primitive undoable **Command**. |
| CreatePrimsCommand | Create multiple primitives undoable **Command**. |
| CreateReferenceCommand | Create reference undoable **Command**. |
| CreateShaderPrimFromSdrCommand | Load the shader specified by ‘identifier’ from the SDR registry and create and a shader prim under |
| CreateUsdAttributeCommand | Create USD Attribute **Command**. |
| CreateUsdAttributeOnPathCommand | Create USD Attribute **Command**. |
| DeletePrimsCommand | Delete primitives undoable **Command**. |
| FramePrimsCommand | Transform a primitive to encompass the bounds of a list of paths. |
- **GroupPrimsCommand**: Group primitive undoable **Command**.
- **MovePrimCommand**: Move primitive undoable **Command**.
- **MovePrimsCommand**: Move primitives undoable **Command**.
- **ParentPrimsCommand**: Base class for all **Commands**.
- **PayloadCommandBase**: Base class for all **Commands**.
- **ReferenceCommandBase**: Base class for all **Commands**.
- **RelationshipTargetBase**: Base class for all **Commands**.
- **RemovePayloadCommand**: Base class for all **Commands**.
- **RemovePropertyCommand**: Remove Property **Command**.
- **RemoveReferenceCommand**: Base class for all **Commands**.
- **RemoveRelationshipTargetCommand**: Remove target from a relationship
- **RenamePrimCommand**: Rename a primitive undoable **Command**.
- **ReplacePayloadCommand**: Base class for all **Commands**.
- **ReplaceReferenceCommand**: Base class for all **Commands**.
- **ReplaceReferencesCommand**: Clears/Add references undoable **Command**.
- **SelectPrimsCommand**: Select primitives undoable **Command**.
- **SetMaterialStrengthCommand**: Set material binding strength undoable **Command**.
- **SetPayLoadLoadSelectedPrimsCommand**: Base class for all **Commands**.
- **SetRelationshipTargetsCommand**: Set target(s) to a relationship
- **ToggleActivePrimsCommand**: Undoable command to toggle the active state of prims.
- **TogglePayLoadLoadSelectedPrimsCommand**: Base class for all **Commands**.
| Command Name | Description |
|--------------|-------------|
| ToggleVisibilitySelectedPrimsCommand | Toggles the visibility of the selected primitives undoable **Command**. |
| TransformPrimCommand | Transform primitive undoable **Command**. |
| TransformPrimSRTCommand | Transform primitive undoable **Command**. |
| TransformPrimsCommand | Transform multiple primitives undoable **Command**. |
| TransformPrimsSRTCommand | Transform multiple primitives undoable **Command**. |
| UngroupPrimsCommand | Ungroup primitive undoable **Command**. |
| UnhideAllPrimsCommand | Base class for all **Commands**. |
| UnparentPrimsCommand | Base class for all **Commands**. |
| UsdStageHelper | Keeps the stage ID or returns the stage from the current context | |
omni.usd.commands.ClearCurvesSplitsOverridesCommand.md | # ClearCurvesSplitsOverridesCommand
## ClearCurvesSplitsOverridesCommand
```python
class ClearCurvesSplitsOverridesCommand(Command):
```
Clear Curves Splits Overrides Command.
### Methods
| Name | Description |
| --- | --- |
| `do()` | |
```python
def __init__(self):
``` |
omni.usd.commands.ClearRefinementOverridesCommand.md | # ClearRefinementOverridesCommand
## ClearRefinementOverridesCommand
Bases: `Command`
Clear Refinement Overrides **Command**.
### Methods
- `__init__()`
- `do()`
- `undo()`
#### `__init__()`
``` |
omni.usd.commands.CopyPrimCommand.md | # CopyPrimCommand
## CopyPrimCommand
```python
class omni.usd.commands.CopyPrimCommand:
def __init__(
path_from: str,
path_to: Optional[str] = None,
duplicate_layers: bool = False,
combine_layers: bool = False,
exclusive_select: bool = True,
usd_context_name: str = None
):
```
```
```
<span class="n">
<span class="pre">
str
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
''
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
flatten_references
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
False
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
copy_to_introducing_layer
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
False
</span>
</span>
</em>
)
<a class="headerlink" href="#omni.usd.commands.CopyPrimCommand" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
Bases:
<code>
Command
</code>
</p>
<p>
Copy primitive undoable
<strong>
Command
</strong>
.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
path_from
</strong>
(
<em>
str
</em>
) – Path to copy from.
</p>
</li>
<li>
<p>
<strong>
path_to
</strong>
(
<em>
str
</em>
) – Path to copy to. If `None` next free path is generated.
</p>
</li>
<li>
<p>
<strong>
duplicate_layers
</strong>
(
<em>
bool
</em>
) – Duplicate layers on copy.
</p>
</li>
<li>
<p>
<strong>
combine_layers
</strong>
(
<em>
bool
</em>
) – Combine layers on copy. When it’s in omni.usd.LayerEditMode.AUTO_AUTHORING mode, this will always be true.
</p>
</li>
<li>
<p>
<strong>
exclusive_select
</strong>
(
<em>
bool
</em>
) – If to exclusively select (clear old selections) the newly create object.
</p>
</li>
<li>
<p>
<strong>
flatten_references
</strong>
(
<em>
bool
</em>
) – Flatten references during copy. It’s only valid when combine_layers is True, and not in AUTO_AUTHORING mode.
</p>
</li>
<li>
<p>
<strong>
copy_to_introducing_layer
</strong>
(
<em>
bool
</em>
) – If to copy it to the introducing layer, or the current edit target. By default, it’s current edit target.
</p>
</li>
</ul>
</dd>
</dl>
<p class="rubric">
Methods
</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>
__init__
</code>
(path_from[, path_to, ...])
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr class="row-even">
<td>
<p>
<code>
do
</code>
()
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr class="row-odd">
<td>
<p>
<code>
modify_callback_info
</code>
(cb_type, cmd_args)
</p>
</td>
<td>
<p>
Returns a dictionary of information to be passed to callbacks of the given type.
</p>
</td>
</tr>
<tr class="row-even">
<td>
<p>
<code>
undo
</code>
()
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="omni.usd.commands.CopyPrimCommand.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
path_from
</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">
path_to
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Optional
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
str
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
,
<em class="sig-param">
duplicate_layers: bool = False
combine_layers: bool = False
exclusive_select: bool = True
usd_context_name: str = ''
flatten_references: bool = False
copy_to_introducing_layer: bool = False
modify_callback_info(cb_type: str, cmd_args: Dict[str, Any]) -> Dict[str, Any]
- Returns a dictionary of information to be passed to callbacks of the given type.
- By default callbacks are passed a copy of the arguments which were passed to execute() when the command was invoked. This method can be overridden to modify that information for specific callback types.
- Parameters
- cb_type – Type of callback the information will be passed to.
- args – A dictionary containing a copy of the arguments with which the command was invoked. This is a shallow copy so implementations may add, remove or replace dictionary elements but should not
## Function Documentation
### `register_callback_type`
```
register_callback_type(type: str) -> dict
```
#### Description
Registers a new callback type. Once a callback type is registered, it can be used to register callbacks, and no other code can modify any of the objects contained within it.
#### Returns
A dictionary of information to be passed to callbacks of the specified type.
``` |
omni.usd.commands.CopyPrimsCommand.md | # CopyPrimsCommand
## Overview
```python
class omni.usd.commands.CopyPrimsCommand:
def __init__(
self,
paths_from: List[str],
paths_to: Optional[List[str]] = None,
duplicate_layers: bool = False,
combine_layers: bool = False,
flatten_references: bool = False
):
pass
```
### Parameters
- `paths_from`: A list of strings representing the source paths.
- `paths_to`: An optional list of strings representing the destination paths. Default is None.
- `duplicate_layers`: A boolean indicating whether to duplicate layers. Default is False.
- `combine_layers`: A boolean indicating whether to combine layers. Default is False.
- `flatten_references`: A boolean indicating whether to flatten references. Default is False.
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
False
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
copy_to_introducing_layer
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
False
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Bases:
<code>
Command
</code>
</p>
<p>
Copy multiple primitives undoable
<strong>
Command
</strong>
.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
List
</strong>
<strong>
[
</strong>
<strong>
str
</strong>
<strong>
]
</strong>
(
<em>
paths_to
</em>
) – Paths to copy from.
</p>
</li>
<li>
<p>
<strong>
List
</strong>
<strong>
[
</strong>
<strong>
str
</strong>
<strong>
]
</strong>
– Paths to copy to. If `None` or length smaller than paths_from, then next free path is generated for missing paths.
</p>
</li>
<li>
<p>
<strong>
duplicate_layers
</strong>
(
<em>
bool
</em>
) – Duplicate layers on copy.
</p>
</li>
<li>
<p>
<strong>
combine_layers
</strong>
(
<em>
bool
</em>
) – Combine layers on copy.
</p>
</li>
<li>
<p>
<strong>
flatten_references
</strong>
(
<em>
bool
</em>
) – Flatten references during copy. It’s only valid when combine_layers is True, and not in AUTO_AUTHORING mode.
</p>
</li>
<li>
<p>
<strong>
copy_to_introducing_layer
</strong>
(
<em>
bool
</em>
) – If to copy it to the introducing layer, or the current edit target. By default, it’s current edit target.
Its’s valid only when combine_layers is true.
</p>
</li>
</ul>
</dd>
</dl>
<p class="rubric">
Methods
</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>
__init__
</code>
(paths_from[, paths_to, ...])
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr class="row-even">
<td>
<p>
<code>
do
</code>
()
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr class="row-odd">
<td>
<p>
<code>
undo
</code>
()
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="omni.usd.commands.CopyPrimsCommand.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
paths_from
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
List
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
str
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
paths_to
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Optional
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
List
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
str
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
duplicate_layers
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
False
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
combine_layers
</span>
:bool = False
,
:flatten_references:bool = False
,
:copy_to_introducing_layer:bool = False |
omni.usd.commands.CreateAudioPrimFromAssetPathCommand.md | # CreateAudioPrimFromAssetPathCommand
## CreateAudioPrimFromAssetPathCommand
```
class omni.usd.commands.CreateAudioPrimFromAssetPathCommand(usd_context: omni.usd.UsdContext, path_to: Path, asset_path: str, select_prim: bool = True)
```
Bases: `CreatePrimCommandBase`
Create reference undoable **Command**.
It creates a new Audio prim.
### Parameters
- **usd_context** (omni.usd.UsdContext) – UsdContext this command to run on.
- **path_to** (Sdf.Path) – Path to create a new prim.
- **asset_path** (str) – The asset path to create the prim from.
- **select_prim** (bool) – Whether to select the new prim after creation. Default is True.
```
**asset_path** (*str*) – The asset it’s necessary to add to references.
**select_prim** (*bool*) – = True, Whether to select the newly created UsdPrim or not.
### Methods
| Method | Description |
| --- | --- |
| `__init__(usd_context, path_to, asset_path[, ...])` | |
| `do()` | |
#### __init__(usd_context: UsdContext, path_to: Path, asset_path: str, select_prim: bool = True)
``` |
omni.usd.commands.CreateDefaultXformOnPrimCommand.md | # CreateDefaultXformOnPrimCommand
## CreateDefaultXformOnPrimCommand
```
class omni.usd.commands.CreateDefaultXformOnPrimCommand(prim_path: str, stage: Stage)
```
**Bases:** `Command`
Create DefaultXform On Prim undoable **Command**.
**Parameters**
- **prim_path** (str) – Path of the primitive to be create xform attribtues
**Methods**
- `__init__(prim_path, stage)`
- `do()`
- `undo()`
```
:
str
,
stage
:
Stage
) |
omni.usd.commands.CreateInstanceCommand.md | # CreateInstanceCommand
## CreateInstanceCommand
```python
class omni.usd.commands.CreateInstanceCommand(path_from: str)
```
**Bases:** `Command`
Instance primitive undoable **Command**.
It creates a new prim, adds the master object to references, and flags this prim as instanceable. If the prim is Xform, this command copies the transforms from the current frame. If the source prim is already instanceable, it tries to find master prim of this prim and uses it, so it’s perfectly safe to press Ctrl-I multiple times.
**Parameters:**
- **path_from** (str) – Path to instance from.
**Methods:**
- `__init__(path_from)`
- `do()`
- `undo()`
```
<section name="omni.usd.commands">
<dl class="function">
<dt id="omni.usd.commands.CreateInstanceCommand.__init__">
<em>
<span class="pre">def </span>
<span class="pre">__init__</span>
<span class="sig-paren">(</span>
<span class="pre">self</span>
<span class="sig-paren">,</span>
<span class="pre">usd_prim</span>
<span class="sig-paren">:</span>
<span class="pre">Usd.Prim</span>
<span class="sig-paren">)</span>
<span class="pre">-></span>
<span class="pre">None</span>
<span class="sig-paren">:</span>
<span class="pre">
str
</span>
</em>
</dt>
<dd>
</dd>
</dl>
</section> |
omni.usd.commands.CreateInstancesCommand.md | # CreateInstancesCommand
## CreateInstancesCommand
Instance multiple primitives undoable **Command**.
### Parameters
- **List** **[str]** (paths_from) – Paths to instance from.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(paths_from)` | |
| `do()` | |
| `undo()` | |
List
[
str
] |
omni.usd.commands.CreateMdlMaterialPrimCommand.md | # CreateMdlMaterialPrimCommand
## Overview
The `CreateMdlMaterialPrimCommand` class is a part of the `omni.usd.commands` module. This class is used to create a new MDL material prim.
## Class Definition
```python
class omni.usd.commands.CreateMdlMaterialPrimCommand:
def __init__(
self,
mtl_url: str,
mtl_name: str,
mtl_path: str,
select_new_prim: bool = False,
stage: Optional[Stage] = None,
context_name: Optional[str] = None
):
# Class implementation details
```
### Parameters
- `mtl_url`: The URL of the material.
- `mtl_name`: The name of the material.
- `mtl_path`: The path where the material prim will be created.
- `select_new_prim`: A boolean indicating whether to select the new prim after creation. Default is `False`.
- `stage`: An optional Stage object. If not provided, the current stage will be used.
- `context_name`: An optional string representing the context name.
## Usage
To use this class, you need to instantiate it with the required parameters and call its methods as needed.
```python
# Example usage
cmd = omni.usd.commands.CreateMdlMaterialPrimCommand(
mtl_url="http://example.com/material.mdl",
mtl_name="MyMaterial",
mtl_path="/World/Materials/MyMaterial",
select_new_prim=True
)
cmd.execute()
```
## Notes
- Ensure that the `mtl_url` is accessible and the material file exists at the specified URL.
- The `mtl_path` should be a valid path within the USD stage.
- If `select_new_prim` is set to `True`, the newly created prim will be selected in the viewport.
## CreateMdlMaterialPrimCommand
### Bases
- Command
- UsdStageHelper
### Description
Create Mdl Material undoable **Command**.
### Parameters
- **mtl_url** (str) –
- **mtl_name** (str) –
- **mtl_path** (str) –
- **select_new_prim** (bool) –
- **stage** (Optional[Usd.Stage]) – Stage to operate. Optional.
- **context_name** (Optional[str]) – The usd context to operate. Optional.
### Methods
- `__init__(mtl_url, mtl_name, mtl_path, select_new_prim=False, stage=None, context_name=None)`
- `do()`
- `undo()`
None
) |
omni.usd.commands.CreateMtlxMaterialPrimCommand.md | # CreateMtlxMaterialPrimCommand
## Overview
The `CreateMtlxMaterialPrimCommand` class is a part of the `omni.usd.commands` module. This class is used to create a material prim from a mtlx file.
### Parameters
- **mtlx_url** (`str`): The URL of the mtlx file.
- **base_path** (`str`): The base path for the mtlx file.
- **select_new_prim** (`bool`): A boolean indicating whether to select the new prim. Default is `False`.
- **stage** (`Optional[Stage]`): The stage where the prim will be created. Default is `None`.
- **context_name** (`Optional[str]`): The context name for the operation. Default is `None`.
### Usage
```python
# Example usage of CreateMtlxMaterialPrimCommand
from omni.usd.commands import CreateMtlxMaterialPrimCommand
command = CreateMtlxMaterialPrimCommand(
mtlx_url="path/to/mtlx/file.mtlx",
base_path="base/path",
select_new_prim=True,
stage=some_stage,
context_name="context_name"
)
```
This command will create a new material prim from the specified mtlx file and place it on the given stage. If `select_new_prim` is set to `True`, the newly created prim will be selected.
Bases:
```python
Command
```
,
```python
UsdStageHelper
```
Create MaterialX Material undoable **Command**.
Field List:
- Parameters
- **mtlx_url** (str) –
- **base_path** (str) –
- **select_new_prim** (bool) –
- **stage** (Usd.Stage) – Stage to operate. Optional.
- **context_name** (str) – The usd context to operate. Optional.
Methods:
- `__init__(mtlx_url, base_path[, ...])`
- `do()`
- `undo()`
Method Details:
```python
__init__(mtlx_url: str, base_path: str, select_new_prim: bool = False, stage: Optional[Stage] = None, context_name: Optional[str] = None)
```
``` |
omni.usd.commands.CreatePayloadCommand.md | # CreatePayloadCommand
## Description
```python
class omni.usd.commands.CreatePayloadCommand:
def __init__(
usd_context: omni.usd.UsdContext,
path_to: Path,
asset_path: Optional[str] = None,
prim_path: Optional[Path] = None,
instanceable: bool = True,
select_prim: bool = True
)
```
## Attributes
- **usd_context** (*omni.usd.UsdContext*): The USD context.
- **path_to** (*Path*): The path to the payload.
- **asset_path** (*Optional\[str\]*): The path to the asset, optional.
- **prim_path** (*Optional\[Path\]*): The primary path, optional.
- **instanceable** (*bool*): Whether the prim is instanceable, default is True.
- **select_prim** (*bool*): Whether to select the prim, default is True.
## CreatePayloadCommand
### Description
Create payload undoable **Command**. It creates a new prim and adds the asset and path as payloads.
### Bases
- `CreatePrimCommandBase`
### Parameters
- **usd_context** (`omni.usd.UsdContext`) – UsdContext this command to run on.
- **path_to** (`Sdf.Path`) – Path to create a new prim.
- **asset_path** (`str`) – The asset it’s necessary to add to payloads.
- **prim_path** (`Sdf.Path`) – The prim in asset to payload.
- **instanceable** (`bool`) – Whether to set the prim instanceable. It works together with `/persistent/app/stage/instanceableOnCreatingReference` setting.
- **select_prim** (`bool`) – = True, Whether to select the newly created UsdPrim or not.
### Methods
- `__init__(usd_context, path_to, [asset_path=None], [prim_path=None], instanceable=True, select_prim=True)`
- `do()`
- `undo()`
<dl class="method">
<dt class="sig sig-object" id="omni.usd.commands.CreatePayloadCommand.__init__">
<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.usd.commands.CreatePayloadCommand
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
enable_prim
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
True
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
select_prim
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
True
</span>
</span>
</em>
)
</dt>
<dd>
</dd>
</dl> |
omni.usd.commands.CreatePreviewSurfaceMaterialPrimCommand.md | # CreatePreviewSurfaceMaterialPrimCommand
## CreatePreviewSurfaceMaterialPrimCommand
```python
class omni.usd.commands.CreatePreviewSurfaceMaterialPrimCommand(mtl_path: str, shader_prim_name: str = 'Shader', select_new_prim: bool = False)
```
Bases: `Command`
Create Preview Surface Material undoable **Command**.
### Parameters
- **mtl_path** (str) – The material path to create.
- **shader_prim_name** (str) – The name of the root shader prim. Optional
- **select_new_prim** (bool) – Optional
### Methods
- `__init__`
```
| 操作 | 描述 |
|------|------|
| `do` | () |
| `undo` | () |
```python
__init__(mtl_path: str, shader_prim_name: str = 'Shader', select_new_prim: bool = False)
``` |
omni.usd.commands.CreatePreviewSurfaceTextureMaterialPrimCommand.md | # CreatePreviewSurfaceTextureMaterialPrimCommand
## CreatePreviewSurfaceTextureMaterialPrimCommand
```python
class omni.usd.commands.CreatePreviewSurfaceTextureMaterialPrimCommand(mtl_path, select_new_prim: bool = False)
```
Bases: `Command`
Create Preview Surface Texture Material undoable **Command**.
### Parameters
- **mtl_path** (str) –
- **select_new_prim** (bool) –
### Methods
- `__init__(mtl_path[, select_new_prim])`
- `do()`
- `undo()`
```
__init__(mtl_path, select_new_prim: bool = False) |
omni.usd.commands.CreatePrimCommand.md | # CreatePrimCommand
## Overview
The `CreatePrimCommand` class is a part of the `omni.usd.commands` module. This class is used to create a new primitive in the scene.
## Class Definition
```python
class omni.usd.commands.CreatePrimCommand(prim_type: str, prim_path: Optional[str] = None, select_new_prim: bool = True, attributes: Dict[str, Any] = {}, create_default_xform: bool = True)
```
### Parameters
- **prim_type** (`str`): The type of the primitive to be created.
- **prim_path** (`Optional[str]`): The path where the primitive will be created. Default is `None`.
- **select_new_prim** (`bool`): Whether to select the newly created primitive. Default is `True`.
- **attributes** (`Dict[str, Any]`): A dictionary of attributes to be assigned to the primitive. Default is an empty dictionary `{}`.
- **create_default_xform** (`bool`): Whether to create a default xform for the primitive. Default is `True`.
### omni.usd.commands.CreatePrimCommand
**Parameters**
- **prim_type** (`str`) – Primitive type, e.g. “Sphere”, “Cube” etc.
- **prim_path** (`Optional[str]`) – Path of the primitive to be created at. If None is provided, it will be placed at stage root or under default prim using Type name.
- **select_new_prim** (`bool`) – Whether to select the prim after it’s created.
- **attributes** (`Dict[str, Any]`) – optional attributes dict to set after creation.
**Methods**
- `__init__(prim_type, prim_path=None, select_new_prim=True, attributes=None)`
**Description**
Create primitive undoable **Command**. It is same as `CreatePrimWithDefaultXformCommand`. Kept for backward compatibility.
**Bases**
- `CreatePrimWithDefaultXformCommand`
**Parameters:**
- `prim_path`: str
- default value: {}
- `create_default_xform`: bool
- default value: True
- `stage`: Optional[Stage]
- default value: None
- `context_name`: Optional[str]
- default value: None |
omni.usd.commands.CreatePrimCommandBase.md | # CreatePrimCommandBase
## Overview
Base class to create a prim (and remove when undo)
### Parameters
- **usd_context** (`omni.usd.UsdContext`) – UsdContext this command to run on.
- **path_to** (`Sdf.Path`) – Path to create a new prim.
- **asset_path** (`str`) – The asset it’s necessary to add to references.
- **select_prim** (`bool = True`) – (Default is True)
</em>) – = True, Whether to select the newly created UsdPrim or not.
## Methods
| Method | Description |
| --- | --- |
| `__init__(usd_context, path_to, asset_path[, ...])` | |
| `do()` | |
| `undo()` | |
### __init__(usd_context, path_to, asset_path, select_prim=True)
- `usd_context`: [UsdContext](../omni.usd/omni.usd.UsdContext.html#omni.usd.UsdContext)
- `path_to`: Path
- `asset_path`: str
- `select_prim`: bool = True |
omni.usd.commands.CreatePrimsCommand.md | # CreatePrimsCommand
## CreatePrimsCommand
```python
class omni.usd.commands.CreatePrimsCommand(prim_types: List[str], usd_context_name: Optional[str] = None)
```
**Bases:** `Command`
Create multiple primitives undoable **Command**.
Example of command which calls other commands. Undo/Redo grouping handled automatically.
**Parameters**
- **prim_types** (`List[str]`) – List of primitive types to create, e.g [“Sphere”, “Cone”].
**Methods**
- `__init__(prim_types[, usd_context_name])`
```
| do |
| --- |
| undo |
__init__(prim_types: List[str], usd_context_name: Optional[str] = None) |
omni.usd.commands.CreatePrimWithDefaultXformCommand.md | # CreatePrimWithDefaultXformCommand
## Overview
The `CreatePrimWithDefaultXformCommand` class is a part of the `omni.usd.commands` module. It is used to create a prim with a default xform.
### Class Definition
```python
class omni.usd.commands.CreatePrimWithDefaultXformCommand(prim_type: str, prim_path: Optional[str] = None, select_new_prim: bool = True, attributes: Dict[str, Any] = {}, create_default_xform: bool = True)
```
### Parameters
- **prim_type** (`str`): The type of the prim to be created.
- **prim_path** (`Optional[str]`): The path where the prim should be created. Defaults to `None`.
- **select_new_prim** (`bool`): Whether to select the newly created prim. Defaults to `True`.
- **attributes** (`Dict[str, Any]`): A dictionary of attributes to be set on the prim. Defaults to an empty dictionary.
- **create_default_xform** (`bool`): Whether to create a default xform for the prim. Defaults to `True`.
### Usage
Here is an example of how to use the `CreatePrimWithDefaultXformCommand` class:
```python
from omni.usd.commands import CreatePrimWithDefaultXformCommand
# Create a cube at the root path with default xform and select it
CreatePrimWithDefaultXformCommand(prim_type="Cube", prim_path="/", select_new_prim=True, attributes={"size": 1.0}, create_default_xform=True)
```
This will create a cube at the root path with a default xform and select it for further operations.
### Parameters
- **prim_type** (str) – Primitive type, e.g. "Sphere", "Cube" etc.
- **prim_path** (Optional[str]) – Path of the primitive to be created at. If None is provided, it will be placed at stage root or under default prim using Type name.
- **select_new_prim** (bool) – Whether to select the prim after it’s created.
- **attributes** (Dict[str, object]) – optional attributes dict to set after creation.
### Methods
- **__init__(prim_type[, prim_path, select_new_prim=True, attributes=None])**
- **do()**
- **undo()**
attributes : Dict[str, Any] = {}
create_default_xform = True
stage : Optional[Stage] = None
context_name : Optional[str] = None |
omni.usd.commands.CreateReferenceCommand.md | # CreateReferenceCommand
## Overview
The `CreateReferenceCommand` class is a part of the `omni.usd.commands` module, which is used to create references in the USD (Universal Scene Description) context.
## Class Definition
```
class omni.usd.commands.CreateReferenceCommand(usd_context: omni.usd.UsdContext, path_to: Path, asset_path: Optional[str] = None, prim_path: Optional[Path] = None, instanceable: bool = True)
```
### Parameters
- `usd_context`: An instance of `omni.usd.UsdContext` which provides the USD context.
- `path_to`: A `Path` object specifying the path where the reference should be created.
- `asset_path`: An optional string specifying the path to the asset to be referenced. Default is `None`.
- `prim_path`: An optional `Path` object specifying the path to the prim. Default is `None`.
- `instanceable`: A boolean indicating whether the prim should be instanceable. Default is `True`.
```
## CreateReferenceCommand
### Bases
- `CreatePrimCommandBase`
### Description
Create reference undoable **Command**. It creates a new prim and adds the asset and path as references.
### Parameters
- **usd_context** (`omni.usd.UsdContext`) – UsdContext this command to run on.
- **path_to** (`Sdf.Path`) – Path to create a new prim.
- **asset_path** (`str`) – The asset it’s necessary to add to references.
- **prim_path** (`Sdf.Path`) – The prim in asset to reference.
- **instanceable** (`bool`) – Whether to set the prim instanceable. It works together with `/persistent/app/stage/instanceableOnCreatingReference` setting.
- **select_prim** (`bool`) – = True, Whether to select the newly created UsdPrim or not.
### Methods
- `__init__(usd_context, path_to, [asset_path=None], [prim_path=None], [instanceable=None], [select_prim=True])`
- `do()`
- `undo()`
bool : bool = True,
select_prim : bool = True |
omni.usd.commands.CreateShaderPrimFromSdrCommand.md | # CreateShaderPrimFromSdrCommand
## Overview
The `CreateShaderPrimFromSdrCommand` class is a part of the `omni.usd.commands` module. This class is used to create a shader primitive from an SDR (Shader Descriptor) command.
## Class Definition
```python
class omni.usd.commands.CreateShaderPrimFromSdrCommand:
def __init__(self, parent_path: str, identifier: str, name: Optional[str] = None, select_new_prim: bool = False, stage_or_context: Optional[Union[str, Stage, UsdContext]] = None):
```
### Parameters
- `parent_path` (str): The path of the parent prim.
- `identifier` (str): The identifier for the new prim.
- `name` (Optional[str]): The name of the new prim. Default is None.
- `select_new_prim` (bool): If True, select the newly created prim. Default is False.
- `stage_or_context` (Optional[Union[str, Stage, UsdContext]]): The stage or context where the prim is created. Default is None.
## Usage
Here is an example of how to use the `CreateShaderPrimFromSdrCommand` class:
```python
from omni.usd.commands import CreateShaderPrimFromSdrCommand
# Create a new shader prim
command = CreateShaderPrimFromSdrCommand("/path/to/parent", "shader_identifier")
command.execute()
```
This will create a new shader primitive under the specified parent path with the given identifier.
## CreateShaderPrimFromSdrCommand
### Bases:
- `Command`
### Description:
Load the shader specified by ‘identifier’ from the SDR registry and create and a shader prim under the location specified by parent_path. The parent location must be of type UsdShade.Material or UsdShade.NodeGraph.
### Parameters:
- **parent_path** (str) – The path of the parent UsdShade.Material or UsdShade.NodeGraph.
- **identifier** (str) – The identifer of the node Sdr registry which will be used to define the shader.
- **name** (str) – The name of the UsdShade.Shader prim to be created, if empty identifier will be used. Optional.
- **select_new_prim** (bool) – Optional.
- **stage_or_context** – (Union[str, Usd.Stage, omni.usd.UsdContext]): Stage or UsdContext applies the changes to. It can be instance of Usd.Stage or omni.usd.UsdContext, or context name. By default, it will apply the changes to the stage in default UsdContext.
### Methods:
- `__init__(parent_path, identifier[, name, ...])`
- `do()`
- `undo()`
### Detailed Method Description:
- `__init__(parent_path: str, identifier: str, name: Optional[str] = None, select_new_prim: bool = False, stage_or_context: Optional[Union[str, Stage, omni.usd.UsdContext]] = None)`
,
UsdContext
]
]
=
None
) |
omni.usd.commands.CreateUsdAttributeCommand.md | # CreateUsdAttributeCommand
## CreateUsdAttributeCommand
```python
class omni.usd.commands.CreateUsdAttributeCommand(prim: Prim, attr_name: str, attr_type: ValueTypeName, custom: bool = True, variability: Variability = Sdf.VariabilityVarying, attr_value: Optional[Any] = None)
```
This class represents a command to create a USD attribute.
### Parameters
- **prim** (`Prim`): The prim on which to create the attribute.
- **attr_name** (`str`): The name of the attribute.
- **attr_type** (`ValueTypeName`): The type of the attribute.
- **custom** (`bool`, optional): Whether the attribute is custom. Default is `True`.
- **variability** (`Variability`, optional): The variability of the attribute. Default is `Sdf.VariabilityVarying`.
- **attr_value** (`Optional[Any]`, optional): The initial value of the attribute. Default is `None`.
Bases:
```python
Command
```
Create USD Attribute
**Command**.
Parameters:
- **prim** (`Usd.Prim`) – Usd.Prim that will get a new attribute.
- **attr_name** (`str`) – New attribute’s name.
- **attr_type** (`Sdf.ValueTypeName`) – New attribute’s type.
- **custom** (`bool`) – If the attribute is custom.
- **variability** (`Sdf.Variability`) – whether the attribute may vary over time and value coordinates, and if its value comes through authoring or from its owner.
- **attr_value** (`Any`, optional) – New attribute’s value. Leave it as None to use default value.
Example of usage:
```python
omni.kit.commands.execute("CreateUsdAttribute",
prim=prim,
attr_name="custom",
attr_type=Sdf.ValueTypeNames.Double3)
```
Methods:
- `__init__(prim: Prim, attr_name: str, attr_type: ValueTypeName, custom: bool = True, variability: Variability = Sdf.VariabilityVarying, attr_value: Optional[Any] = None)`
- `do()`
- `undo()`
# 欢迎来到我的网站
## 关于我们
我们是一个专业的团队，致力于提供高质量的服务。
### 服务内容
- 服务1
- 服务2
## 联系我们
- 邮箱：[email protected]
- 电话：1234567890
## 版权信息
© 2023 我的网站 |
omni.usd.commands.CreateUsdAttributeOnPathCommand.md | # CreateUsdAttributeOnPathCommand
## Overview
The `CreateUsdAttributeOnPathCommand` class is a part of the `omni.usd.commands` module. It is used to create a USD attribute on a specified path.
## Class Definition
```python
class omni.usd.commands.CreateUsdAttributeOnPathCommand(attr_path: Union[Path, str], attr_type: ValueTypeName, custom: bool = True, variability: Variability = Sdf.VariabilityVarying, attr_value: Optional[Any] = None)
```
### Parameters
- **attr_path** (`Union[Path, str]`): The path where the attribute will be created.
- **attr_type** (`ValueTypeName`): The type of the attribute to be created.
- **custom** (`bool`, optional): Indicates if the attribute is custom. Default is `True`.
- **variability** (`Variability`, optional): The variability of the attribute. Default is `Sdf.VariabilityVarying`.
- **attr_value** (`Optional[Any]`, optional): The initial value of the attribute. Default is `None`.
<em class="sig-param">
<span class="n">
<span class="pre">
usd_context_name
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
str
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
''
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
</dt>
<dd>
<p>
Bases:
<code class="xref py py-class docutils literal notranslate">
<span class="pre">
Command
</span>
</code>
</p>
<p>
Create USD Attribute
<strong>
Command
</strong>
.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Parameters
</dt>
<dd class="field-odd">
<ul class="simple">
<li>
<p>
<strong>
attr_path
</strong>
(
<em>
Union
</em>
<em>
[
</em>
<em>
Sdf.Path
</em>
<em>
,
</em>
<em>
str
</em>
<em>
]
</em>
) – Path to the new attribute to be created. The prim of this path must already exist.
</p>
</li>
<li>
<p>
<strong>
attr_type
</strong>
(
<em>
Sdf.ValueTypeName
</em>
) – New attribute’s type.
</p>
</li>
<li>
<p>
<strong>
custom
</strong>
(
<em>
bool
</em>
) – If the attribute is custom.
</p>
</li>
<li>
<p>
<strong>
variability
</strong>
(
<em>
Sdf.Variability
</em>
) – whether the attribute may vary over time and value coordinates, and if its value comes through authoring or from its owner.
</p>
</li>
<li>
<p>
<strong>
attr_value
</strong>
(
<em>
Any
</em>
<em>
,
</em>
<em>
optional
</em>
) – New attribute’s value. Leave it as None to use default value.
</p>
</li>
<li>
<p>
<strong>
usd_context_name
</strong>
(
<em>
str
</em>
) – Name of the usd context to execute the command on.
</p>
</li>
</ul>
</dd>
</dl>
<dl class="simple">
<dt>
Example of usage:
</dt>
<dd>
<dl class="simple">
<dt>
omni.kit.commands.execute(“CreateUsdAttribute”,
</dt>
<dd>
<p>
prim=prim,
attr_name=”custom”,
attr_type=Sdf.ValueTypeNames.Double3)
</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">
Methods
</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">
__init__
</span>
</code>
(attr_path, attr_type[, custom, ...])
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
<tr class="row-even">
<td>
<p>
<code class="xref py py-obj docutils literal notranslate">
<span class="pre">
do
</span>
</code>
()
</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">
undo
</span>
</code>
()
</p>
</td>
<td>
<p>
</p>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt class="sig sig-object py" id="omni.usd.commands.CreateUsdAttributeOnPathCommand.__init__">
<span class="sig-name descname">
<span class="pre">
__init__
</span>
</span>
<span class="sig-paren">
(
</span>
<em class="sig-param">
<span class="n">
<span class="pre">
attr_path
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Union
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
Path
</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>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
attr_type
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
ValueTypeName
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
custom
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
True
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
variability
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Variability
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
Sdf.VariabilityVarying,
attr_value: Optional[Any] = None,
usd_context_name: str = '' |
omni.usd.commands.DeletePrimsCommand.md | # DeletePrimsCommand
## DeletePrimsCommand
```pre
Command
```
,
```pre
UsdStageHelper
```
Delete primitives undoable
**Command**.
**Parameters**
- **paths** (**List**[**str**]) – Paths to prims to delete.
- **destructive** –
- If it’s false, the delete will only happen in the current target, and follows:
1. If the prim spec is a def, it will remove the prim spec.
2. If the prim spec is a over, it will only deactivate this prim.
3. If the prim spec is not existed, it will create over prim and deactivate it.
4. If there is an overridden in a stronger layer, it will report errors.
- If it’s true, it will remove all prim specs in all local layers.
- By default, it’s True and means the delete operation is destructive for back-compatibility.
- **stage** (**Usd.Stage**) – Stage to operate. Optional.
- **context_name** (**str**) – The usd context to operate. Optional.
**Methods**
- ```pre
__init__
``` (paths[, destructive, stage, ...])
- ```pre
do
``` ()
- ```pre
undo
``` ()
**__init__** (paths: List[Union[str, Path]], destructive=True, stage: Optional[Stage]=None, context_name: Optional[str]=None) |
Subsets and Splits