file_path
stringlengths 5
148
| content
stringlengths 0
526k
|
|---|---|
omni.usd.commands.ensure_parents_are_active.md | # ensure_parents_are_active
## ensure_parents_are_active
```python
omni.usd.commands.ensure_parents_are_active(stage, path)
```
OM-70901: It will ensure parents are active. If they are not, it will change the active flag into active, and instead all of their children will be marked to inactive. This is normally used when it’s to create materials under /World/Looks, as it’s possible /World/Looks is deactivated. While creating a prim under an inactive parent will throw exceptions by USD. |
omni.usd.commands.FramePrimsCommand.md | # FramePrimsCommand
## FramePrimsCommand
### FramePrimsCommand
### Parameters
- **prim_to_move** – Path to the primitive that is being moved.
- **prims_to_frame** (Sequence[Union[str, Sdf.Path]]) – Sequence of primitives to use to calculate the bounds to frame.
- **time_code** (Usd.TimeCode) – Timecode to set values at.
- **usd_context_name** (str) – Name of the usd context to work on.
- **aspect_ratio** (float) – Width / Height of the final image.
- **use_horizontal_fov** (Optional[bool]) – Whether to use a camera’s horizontal or vertical field of view for framing.
- **horizontal_fov** (float) – Default horizontal field-of-view to use for framing if one cannot be calculated.
- **zoom** (float) – Final zoom in or out of the framed box. Values above 0.5 move further away and below 0.5 go closer.
### Methods
- `__init__(prim_to_move[, prims_to_frame, ...])`
- `do()`
- `undo()`
__init__(
prim_to_move: Union[str, Path],
prims_to_frame: Optional[Sequence[Union[str, Path]]] = None,
time_code: Optional[TimeCode] = None,
usd_context_name: str = '',
aspect_ratio: float = 1,
use_horizontal_fov: Optional[bool] = None,
zoom: float = 0.45,
horizontal_fov: float = 0.20656116130367255
)
</footer>
</div>
</div>
</section>
</div> |
omni.usd.commands.Functions.md | # omni.usd.commands Functions
## Functions Summary:
| Function | Description |
|----------|-------------|
| [active_edit_context](#) | |
| [ensure_parents_are_active](#) | OM-70901: It will ensure parents are active. If they are not, it will change the active |
| [get_default_camera_rotation_order_str](#) | |
| [get_default_rotation_order_str](#) | |
| [get_default_rotation_order_type](#) | |
| [post_notification](#) | |
| [prim_can_be_removed_without_destruction](#) | A destructive remove is one that will not only edit current edit target, |
| [remove_prim_spec](#) | Removes prim spec from layer. |
| [write_refinement_override_enabled_hint](#) | | |
omni.usd.commands.get_default_camera_rotation_order_str.md | # get_default_camera_rotation_order_str
## get_default_camera_rotation_order_str
### omni.usd.commands.get_default_camera_rotation_order_str |
omni.usd.commands.get_default_rotation_order_str.md | # get_default_rotation_order_str
## get_default_rotation_order_str
```python
omni.usd.commands.get_default_rotation_order_str()
```
```
``` |
omni.usd.commands.get_default_rotation_order_type.md | # get_default_rotation_order_type
## get_default_rotation_order_type
```python
omni.usd.commands.get_default_rotation_order_type(is_camera: bool = False)
```
This function retrieves the default rotation order type.
``` |
omni.usd.commands.GroupPrimsCommand.md | # GroupPrimsCommand
## Class Definition
```python
class omni.usd.commands.GroupPrimsCommand(prim_paths: List[Union[str, Path]], stage: Optional[Stage] = None, context_name: Optional[str] = None, destructive: bool = True)
```
### Parameters
- **prim_paths**: List of prim paths, which can be strings or Path objects.
- **stage**: Optional Stage object. Default is None.
- **context_name**: Optional string for context name. Default is None.
- **destructive**: Boolean indicating whether the operation is destructive. Default is True.
```
### Description
Bases:
```
# Command
UsdStageHelper
## Group primitive undoable Command
### Parameters
- **prim_paths** (List[str]) – Prim paths that will be grouped.
- **stage** (Usd.Stage) – Stage to operate. Optional.
- **context_name** (str) – The usd context to operate. Optional.
- **destructive** (bool) – If it’s true, it will group all prims and remove original prims, which may edit other layers that are not edit target currently. If it’s false, all changes will made only to the current edit target without touching other layers. By default, it’s true for back compatibility.
## Methods
| Method | Description |
| ------ | ----------- |
| `__init__(prim_paths[, stage, context_name, ...])` | |
| `do()` | |
| `undo()` | |
### `__init__(prim_paths: List[Union[str, Path]], stage: Optional[Stage] = None, context_name: Optional[str] = None, destructive: bool = True)`
- **prim_paths**: List of strings or Paths.
- **stage**: Optional Stage. Default is None.
- **context_name**: Optional string. Default is None.
- **destructive**: Default is True. |
omni.usd.commands.MovePrimCommand.md | # MovePrimCommand
## MovePrimCommand
```python
class omni.usd.commands.MovePrimCommand(path_from: Union[str, Path], path_to: Union[str, Path], time_code: TimeCode = Usd.TimeCode.Default(), keep_world_transform: bool = True, on_move_fn: Optional[Callable] = None)
```
```
Move primitive undoable **Command**.
Bases: `Command`
Parameters:
- **path_from** (str) – Path to move prim from.
- **path_to** (str) – Path to move prim to.
- **time_code** (Usd.TimeCode) – Current timecode of the stage.
- **keep_world_transform** (bool) – True to keep world transform after prim path is moved. False to keep local transfrom only.
- **on_move_fn** (Callable) – Function to call when prim is renamed
- **destructive** (bool) – If it’s false, it will not remove original prim but deactivate it. By default, it’s true for back compatibility.
- **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__(path_from, path_to[, time_code, ...])`
- `do()`
- `modify_callback_info(cb_type, cmd_args)` – Returns a dictionary of information to be passed to callbacks of the given type.
- `undo()`
(
source_path: Union[str, Path],
path_to: Union[str, Path],
time_code: TimeCode = Usd.TimeCode.Default(),
keep_world_transform: bool = True,
on_move_fn: Optional[Callable] = None,
destructive: bool = True,
stage_or_context: Optional[Union[str, Stage, UsdContext]] = None,
resolve_reference: bool = True
)
modify_callback_info(
cb_type: str
)
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 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.MovePrimsCommand.md | # MovePrimsCommand
## MovePrimsCommand
MovePrimsCommand(
paths_to_move: Dict[str, str],
time_code: TimeCode = Usd.TimeCode.Default(),
keep_world_transform: bool = True,
destructive: bool = True,
stage_or_context: Union[str, Stage, UsdContext] = None
)
Bases: Command
Move primitives undoable Command.
Parameters:
- paths_to_move (Dict[str, str]) – dictionary containing entry of path_from : path_to.
- time_code (Usd.TimeCode) – Current timecode of the stage.
- keep_world_transform (bool) – True to keep world transform after prim path is moved. False to keep local transform only.
- destructive (bool) – If it’s false, it will not remove original prim but deactivate it. By default, it’s true for back compatibility.
- stage_or_context – (Union[str, Stage, UsdContext]): Stage or UsdContext applies the changes to. It can be instance of Stage or UsdContext, or context name. By default, it will apply the changes to the stage in default UsdContext.
Methods:
- __init__(paths_to_move[, time_code, ...])
- do()
- undo()
,
**on_move_fn** : Optional[Callable] = None,
**destructive** = True,
**stage_or_context** : Optional[Union[str, Stage, UsdContext]] = None
) |
omni.usd.commands.ParentPrimsCommand.md | # ParentPrimsCommand
## Class Definition
```python
class omni.usd.commands.ParentPrimsCommand(parent_path: str, child_paths: List[str], on_move_fn: Optional[callable] = None, keep_world_transform: bool = True, stage_or_context: Optional[Union[str, Stage]] = None)
```
### Parameters
- **parent_path** (`str`): The path of the parent prim.
- **child_paths** (`List[str]`): A list of paths for the child prims to be parented.
- **on_move_fn** (`Optional[callable]`): An optional callback function to be executed during the move operation.
- **keep_world_transform** (`bool`): If `True`, the world transform of the child prims will be preserved.
- **stage_or_context** (`Optional[Union[str, Stage]]`): An optional stage or context for the operation.
## Methods
### `__init__`
Move prims into children of "parent" primitives undoable **Command**.
### `do`
### `undo`
### Parameters
- **parent_path** – prim path to become parent of child_paths
- **child_paths** – prim paths to become children of parent_prim
- **keep_world_transform** – If it needs to keep the world transform after parenting.
- **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. |
omni.usd.commands.PayloadCommandBase.md | # PayloadCommandBase
## PayloadCommandBase
```
```markdown
class omni.usd.commands.PayloadCommandBase(stage, prim_path: Path, payload: Payload)
```
```markdown
Bases: Command
### Methods
| Method | Description |
| --- | --- |
| `__init__(stage, prim_path, payload)` | |
| `undo()` | |
```
```markdown
def __init__(stage, prim_path: Path, payload: Payload)
```
``` |
omni.usd.commands.post_notification.md | # post_notification
## post_notification
```python
omni.usd.commands.post_notification(message: str, info: bool = False, duration: int = 3)
```
--- |
omni.usd.commands.prim_can_be_removed_without_destruction.md | # prim_can_be_removed_without_destruction
## omni.usd.commands.prim_can_be_removed_without_destruction
```python
omni.usd.commands.prim_can_be_removed_without_destruction(usd_context_or_stage, prim_path)
```
A destructive remove is one that will not only edit current edit target, but also other non-anonymous layers. Why anonymous layers is not counted is because anonymous layers are writable in Kit, and it’s only existed when it’s a new stage or under session layer. Any deltas inside those anonymous layers can be safely removed. Otherwise, this function will return false, which means it will not remove prim specs in all layers, but deactivates them to avoid editing non-anonymous layers except current edit target. |
omni.usd.commands.ReferenceCommandBase.md | # ReferenceCommandBase
## Methods
- `__init__(stage, prim_path, reference)`
- `undo()`
# ReferenceCommandBase
## Methods
### \_\_init\_\_ |
omni.usd.commands.RelationshipTargetBase.md | # RelationshipTargetBase
## RelationshipTargetBase
```python
class omni.usd.commands.RelationshipTargetBase(relationship: Relationship, target: Path)
```
Bases: `Command`
### Methods
| Method | Description |
|--------|-------------|
| `__init__(relationship: Relationship, target: Path)` | |
| `undo()` | |
### `__init__(relationship: Relationship, target: Path)`
``` |
omni.usd.commands.RemovePayloadCommand.md | # RemovePayloadCommand
## RemovePayloadCommand
```python
class omni.usd.commands.RemovePayloadCommand(stage, prim_path: Path, payload: Payload)
```
Bases: `PayloadCommandBase`
### Methods
| Method | Description |
|--------|-------------|
| `__init__(stage, prim_path, payload)` | |
| `do()` | |
```python
def __init__(stage, prim_path: Path, payload: Payload)
```
```
:
Payload
) |
omni.usd.commands.RemovePropertyCommand.md | # RemovePropertyCommand
## Class Definition
```python
class omni.usd.commands.RemovePropertyCommand(prop_path: Union[Path, str], usd_context_name: str = '', remove_from_layers: Optional[Union[List[Union[str, Layer]], str, Layer]] = None)
```
## Description
The `RemovePropertyCommand` class is used to remove a property from a USD (Universal Scene Description) object. It takes the following parameters:
- `prop_path`: The path of the property to be removed. It can be a `Path` object or a string.
- `usd_context_name`: The name of the USD context. It is a string and has a default value of an empty string.
- `remove_from_layers`: An optional parameter specifying the layers from which the property should be removed. It can be a list of strings or `Layer` objects, a single string, or a `Layer` object. The default value is `None`.
## RemovePropertyCommand
### Bases
```python
Command
```
### Description
Remove Property **Command**.
### Parameters
- **prop_path** (str) – Path of the property to be removed.
- **usd_context_name** (str) – Usd context name to run the command on.
- **remove_from_layers** (Optional[Union[List[Union[str, Layer]], str, Layer]]) – Specific layers to remove the property from. Default to None, which removes the property from all layers.
### Methods
- **__init__(prop_path[, usd_context_name, ...])**
- **do()**
- **undo()**
#### __init__ Method
```python
__init__(prop_path: Union[Path, str], usd_context_name: str = '', remove_from_layers: Optional[Union[List[Union[str, Layer]], str, Layer]] = None)
```
这是一个带有[链接]的段落。
![描述图片的文本] |
omni.usd.commands.RemoveReferenceCommand.md | # RemoveReferenceCommand
## Class Overview
```python
class omni.usd.commands.RemoveReferenceCommand(stage, prim_path: Path, reference: Reference)
```
Bases: `ReferenceCommandBase`
### Methods
| Method | Description |
|--------|-------------|
| `__init__(stage, prim_path, reference)` | |
| `do()` | |
### Detailed Method Descriptions
#### `__init__(stage, prim_path, reference)`
```python
def __init__(stage, prim_path: Path, reference: Reference):
# Method implementation
```
#### `do()`
```python
def do():
# Method implementation
```
Reference |
omni.usd.commands.RemoveRelationshipTargetCommand.md | # RemoveRelationshipTargetCommand
## RemoveRelationshipTargetCommand
```python
class omni.usd.commands.RemoveRelationshipTargetCommand(relationship: Relationship, target: Path)
```
Bases: `RelationshipTargetBase`
Remove target from a relationship
### Methods
| Method | Description |
| --- | --- |
| `__init__(relationship, target)` | |
| `do()` | |
```python
def __init__(relationship: Relationship, target: Path)
```
```
Path |
omni.usd.commands.remove_prim_spec.md | # remove_prim_spec
## remove_prim_spec
```python
omni.usd.commands.remove_prim_spec(layer: Layer, prim_spec_path: str)
```
Removes prim spec from layer.
``` |
omni.usd.commands.RenamePrimCommand.md | # RenamePrimCommand
## RenamePrimCommand
```python
class omni.usd.commands.RenamePrimCommand(prim_path: str, new_name: str)
```
**Bases:** `Command`
Rename a primitive undoable **Command**.
**Parameters:**
- **prim_path** (str) – path of prim to be renamed.
- **new_name** (str) – new name.
**Methods:**
- `__init__(prim_path, new_name)`
- `do()`
- `undo()`
```
prim_path : str,
new_name : str |
omni.usd.commands.ReplacePayloadCommand.md | # ReplacePayloadCommand
## Class Definition
```python
class omni.usd.commands.ReplacePayloadCommand(stage, prim_path: Path, old_payload: Payload, new_payload: Payload)
```
**Bases:** [PayloadCommandBase](omni.usd.commands.PayloadCommandBase.html#omni.usd.commands.PayloadCommandBase)
### Methods
| Method | Description |
|--------|-------------|
| `__init__(stage, prim_path, old_payload, new_payload)` | Initialize the ReplacePayloadCommand. |
| `do()` | Execute the command. |
```
Path: Payload, old_payload: Payload, new_payload: Payload) |
omni.usd.commands.ReplaceReferenceCommand.md | # ReplaceReferenceCommand
## Class Definition
```python
class omni.usd.commands.ReplaceReferenceCommand(stage, prim_path: Path, old_reference: Reference, new_reference: Reference)
```
**Bases:** [ReferenceCommandBase](omni.usd.commands.ReferenceCommandBase.html#omni.usd.commands.ReferenceCommandBase)
### Methods
| Method | Description |
|--------|-------------|
| `__init__(stage, prim_path, old_reference, new_reference)` | |
| `do()` | |
```
Path: Path
old_reference: Reference
new_reference: Reference |
omni.usd.commands.ReplaceReferencesCommand.md | # ReplaceReferencesCommand
## Summary
Clears/Add references undoable Command.
NOTE: THIS COMMAND HAS A LOT OF ISSUES AND IS DEPRECATED. PLEASE USE ReplaceReferenceCommand instead!
### Parameters
- **path** (str) – Prim path.
- **old_url** (str) – Url to be replaced.
- **new_url** (str) – Replacement url.
### Methods
- **__init__**(path, old_url, new_url)
- **do**() |
omni.usd.commands.SelectPrimsCommand.md | # SelectPrimsCommand
## SelectPrimsCommand
```python
class omni.usd.commands.SelectPrimsCommand(old_selected_paths: typing.List[str], new_selected_paths: typing.List[str], expand_in_stage: bool = True, source: omni.usd._usd.Selection.SourceType = <SourceType.USD: 1>)
```
Bases: `Command`
Select primitives undoable **Command**.
### Parameters
- **old_selected_paths** (List[str]) – Old selected prim paths.
- **new_selected_paths** (List[str]) – Prim paths to be selected.
- **expand_in_stage** (bool, DEPRECATED) – Whether to expand the path in Stage Window on selection.
- **compatibility.** (This param is left for) –
- **source** (omni.usd.Selection.SourceType) – USD/FABRIC/ALL, indicates which stage selection should be set to
REMINDER: Both params old_selected_paths and new_selected_paths should be const out of the command. And it’s caller’s responsibility to maintain that. Otherwise, undo will not return to its original state.
```
## Methods
| Method | Description |
| --- | --- |
| `__init__(old_selected_paths, new_selected_paths)` | |
| `do()` | |
| `undo()` | |
### __init__(old_selected_paths: List[str], new_selected_paths: List[str], expand_in_stage: bool = True, source: SourceType = SourceType.USD) |
omni.usd.commands.SetMaterialStrengthCommand.md | # SetMaterialStrengthCommand
## SetMaterialStrengthCommand
```
class omni.usd.commands.SetMaterialStrengthCommand(rel, strength)
```
**Bases:** `Command`
Set material binding strength undoable **Command**.
**Parameters**
- **rel** – Material binding relationship.
- **strength** (float) – Strength.
**Methods**
- `__init__(rel, strength)`
- `do()`
- `undo()`
```
def __init__(rel, strength)
```
```
# 欢迎来到我们的文档
## 目录
- [简介](#简介)
- [安装指南](#安装指南)
- [使用教程](#使用教程)
## 简介
欢迎阅读我们的文档。在这里，您将找到所有必要的信息来开始使用我们的产品。
## 安装指南
请按照以下步骤安装我们的产品：
1. 下载最新版本
2. 解压文件
3. 运行安装程序
## 使用教程
一旦安装完成，您可以开始使用我们的产品。以下是一些基本的使用步骤：
1. 打开应用程序
2. 创建新项目
3. 添加内容
---
感谢您阅读我们的文档。如果您有任何问题，请随时联系我们。 |
omni.usd.commands.SetPayLoadLoadSelectedPrimsCommand.md | # SetPayLoadLoadSelectedPrimsCommand
## SetPayLoadLoadSelectedPrimsCommand
```
```markdown
class omni.usd.commands.SetPayLoadLoadSelectedPrimsCommand(selected_paths: List[str], value: bool, stage_or_context: Optional[Union[str, Stage, UsdContext]] = None)
```
```markdown
Bases: Command
```
```markdown
Methods
```
```markdown
Table of Methods
```
```markdown
| Method | Description |
| --- | --- |
| __init__ | Description of __init__ method |
```python
__init__
```
(selected_paths, value[, ...])
Set the load/unload payload of the selected primitives undoable **Command**.
```python
do
```
()
```python
undo
```
()
```python
__init__
```
(selected_paths: List[str], value: bool, stage_or_context: Optional[Union[str, Stage, UsdContext]] = None)
Set the load/unload payload of the selected primitives undoable **Command**.
**Parameters**
- **selected_paths** – Old selected prim paths.
- **value** – True = load, False = unload
- **stage_or_context** (Union[str, Stage, 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.
``` |
omni.usd.commands.SetRelationshipTargetsCommand.md | # SetRelationshipTargetsCommand
## Class: omni.usd.commands.SetRelationshipTargetsCommand
**Bases:** [RelationshipTargetBase](omni.usd.commands.RelationshipTargetBase.html#omni.usd.commands.RelationshipTargetBase)
Set target(s) to a relationship
### Methods
| Method | Description |
|--------|-------------|
| `__init__(relationship: Relationship, targets: List[Path])` | Initialize the command with a relationship and targets. |
| `do()` | Execute the command. |
targets:
List[Path] |
omni.usd.commands.ToggleActivePrimsCommand.md | # ToggleActivePrimsCommand
## ToggleActivePrimsCommand
```code
Command
```
Undoable command to toggle the active state of prims.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(prim_paths[, stage_or_context, active])` | Constructor. |
| `do()` | |
| `undo()` | |
#### `__init__(prim_paths, stage_or_context=None, active=None)`
Constructor.
**Parameters:**
- **prim_paths** (`List[Path]`) – A list of prim paths.
- **stage_or_context** (`Union[str, Stage, 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.
- **active** (`Union[bool, None]`) – If active flag is not None, it will set the active states to the value specified by it. Otherwise, it will revert the active states of prims.
# 标题1
这是一个段落，包含一个链接：Example Link。
```
这是一段代码。
print("Hello, World!")
```
- 列表项1
- 列表项2 |
omni.usd.commands.TogglePayLoadLoadSelectedPrimsCommand.md | # TogglePayLoadLoadSelectedPrimsCommand
## TogglePayLoadLoadSelectedPrimsCommand
Toggles the load/unload payload of the selected primitives undoable **Command**.
```
do
```
()
```
undo
```
()
```python
__init__(selected_paths: List[str], stage_or_context: Optional[Union[str, Stage, UsdContext]] = None)
```
Toggles the load/unload payload of the selected primitives undoable **Command**.
**Parameters**
- **selected_paths** – Old selected prim paths.
- **stage_or_context** (Union[str, Stage, 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.
``` |
omni.usd.commands.ToggleVisibilitySelectedPrimsCommand.md | # ToggleVisibilitySelectedPrimsCommand
## Class Definition
```python
class omni.usd.commands.ToggleVisibilitySelectedPrimsCommand(selected_paths: List[str], stage: Optional[Stage] = None, visible: Optional[bool] = None)
```
**Bases:** `Command`
**Description:**
Toggles the visibility of the selected primitives undoable **Command**.
**Parameters:**
- **selected_paths** (List[str]): The paths of the selected primitives.
- **stage** (Optional[Stage]): The stage to operate on. Default is None.
- **visible** (Optional[bool]): The visibility state to set. Default is None.
### Parameters
- **selected_paths** (List[str]) – A list of prim paths.
- **stage** (Usd.Stage) – The optional stage handle. By default, it’s the stage inside the default UsdContext.
- **visible** (Optional[bool]) – By default, it’s None that means to invert the visibility state for each prim. When it’s set as a bool value, it will set all visibilities to the specified value instead of inverting them.
### Methods
- `__init__(selected_paths[, stage, visible])`
- `do()`
- `undo()`
### __init__ Method
```python
def __init__(selected_paths: List[str], stage: Optional[Stage] = None, visible: Optional[bool] = None)
```
``` |
omni.usd.commands.TransformPrimCommand.md | # TransformPrimCommand
## Class Overview
The `TransformPrimCommand` class is part of the `omni.usd.commands` module. It is used to transform a prim using a new transform matrix, optionally comparing it with an old transform matrix, at a specified time code.
### Constructor
```python
class omni.usd.commands.TransformPrimCommand(
path: str,
new_transform_matrix: Matrix4d,
old_transform_matrix: Optional[Matrix4d] = None,
time_code: TimeCode = Usd.TimeCode.Default(),
had_transform_at_key: bool = False,
usd_context_name: str = ""
)
```
#### Parameters
- **path** (`str`): The path of the prim to transform.
- **new_transform_matrix** (`Matrix4d`): The new transform matrix to apply to the prim.
- **old_transform_matrix** (`Optional[Matrix4d]`): The old transform matrix of the prim. If not provided, it defaults to `None`.
- **time_code** (`TimeCode`): The time code at which the transformation is to be applied. Defaults to `Usd.TimeCode.Default()`.
- **had_transform_at_key** (`bool`): Indicates whether the prim had a transform at the specified key. Defaults to `False`.
- **usd_context_name** (`str`): The USD context name. Defaults to an empty string.
```
## TransformPrimCommand
### Description
Transform primitive undoable **Command**.
### Bases
- `Command`
### Parameters
- **path** (str) – Prim path.
- **new_transform_matrix** – New transform matrix.
- **old_transform_matrix** – Optional old transform matrix to undo to. If `None`, use the current transform.
### Methods
- `__init__(path, new_transform_matrix[, ...])`
- `do()`
- `undo()`
#### `__init__` Method
- **Parameters**
- `path`: str
- `new_transform_matrix`: Matrix4d
- `old_transform_matrix`: Optional[Matrix4d] = None
- `time_code`: TimeCode = Usd.TimeCode.Default()
- `had_transform_at_key`: bool = False
- `usd_context_name`: str = '' |
omni.usd.commands.TransformPrimsCommand.md | # TransformPrimsCommand
## TransformPrimsCommand
```python
class omni.usd.commands.TransformPrimsCommand(prims_to_transform: List[Tuple[str, Matrix4d, Matrix4d, TimeCode]])
```
**Bases:** `Command`
**Description:** Transform multiple primitives undoable **Command**.
**Undo/Redo grouping handled automatically.**
**Parameters:**
- **prims_to_transform** – List of primitive to transform in a tuple of (path, new_transform, old_transform).
**Methods:**
- `__init__(prims_to_transform)`
- `do()`
```
<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.TransformPrimsCommand.__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">
prims_to_transform
</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">
Tuple
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
str
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
Matrix4d
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
Matrix4d
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="pre">
TimeCode
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
</em>
<span class="sig-paren">
)
</span>
<a class="headerlink" href="#omni.usd.commands.TransformPrimsCommand.__init__" title="Permalink to this definition">
</a>
</dt>
<dd>
</dd>
</dl>
</dd>
</dl>
</section>
</div>
</div>
<footer>
<hr/>
</footer>
</div>
</div>
</section>
</div> |
omni.usd.commands.TransformPrimSRTCommand.md | # TransformPrimSRTCommand
## TransformPrimSRTCommand
```python
class omni.usd.commands.TransformPrimSRTCommand(path: str, new_translation: Optional[Vec3d] = None, new_rotation_euler: Optional[Vec3d] = None, new_scale: Optional[Vec3d] = None, new_rotation_order: Optional[str] = None)
```
### Description
This class represents a command to transform a prim using translation, rotation, and scale.
### Parameters
- **path** (`str`): The path to the prim.
- **new_translation** (`Optional[Vec3d]`): The new translation vector.
- **new_rotation_euler** (`Optional[Vec3d]`): The new Euler rotation angles.
- **new_scale** (`Optional[Vec3d]`): The new scale vector.
- **new_rotation_order** (`Optional[str]`): The order of rotation.
```
[Vec3i] = None,
old_translation: Optional[Vec3d] = None,
old_rotation_euler: Optional[Vec3d] = None,
old_rotation_order: Optional[Vec3i] = None,
old_scale: Optional[Vec3d] = None,
time_code: TimeCode = Usd.TimeCode.Default(),
had_transform_at_key: bool = False,
usd_context_name: str = ''
)
Bases: Command
Transform primitive undoable Command.
Parameters:
- **path** (str) – Prim path.
- **new_translation** (Gf.Vec3d) – New local translation.
- **new_rotation_euler** (Gf.Vec3d) – New local rotation euler angles (in degree).
- **new_scale** (Gf.Vec3d) – New scale.
- **new_rotation_order** (Gf.Vec3i) – New rotation order (e.g. (0, 1, 2) means XYZ). Set to None to stay the same.
### Parameters
- **old_translation** (`Gf.Vec3d`) – Old local translation. Leave to None to use current value.
- **old_rotation_euler** (`Gf.Vec3d`) – Old local rotation euler angles. Leave to None to use current value.
- **old_rotation_order** (`Gf.Vec3i`) – Old local rotation order. Leave to None to use current value.
- **old_scale** (`Gf.Vec3d`) – Old scale. Leave to None to use current value.
- **time_code** (`Usd.TimeCode`) – TimeCode to set transform to.
- **had_transform_at_key** (`bool`) – If there’s key for transform.
- **usd_context_name** (`str`) – Usd context name to run the command on.
### Methods
- `__init__(path[, new_translation, ...])`
- `do()`
- `undo()`
### Detailed Method Signature
```python
__init__(
path: str,
new_translation: Optional[Vec3d] = None,
new_rotation_euler: Optional[Vec3d] = None,
new_scale: Optional[Vec3d] = None,
new_rotation_order: Optional[Vec3i] = None
)
```
old_translation: Optional[Vec3d] = None
old_rotation_euler: Optional[Vec3d] = None
old_rotation_order: Optional[Vec3i] = None
old_scale: Optional[Vec3d] = None
time_code: TimeCode = Usd.TimeCode.Default()
had_transform_at_key: bool = False
usd_context_name: str = '' |
omni.usd.commands.TransformPrimsSRTCommand.md | # TransformPrimsSRTCommand
## TransformPrimsSRTCommand
```
class omni.usd.commands.TransformPrimsSRTCommand
(
prims_to_transform : List[Tuple[str, Vec3d, Vec3d, Vec3i, Vec3d, Vec3d, Vec3d, Vec3i, Vec3d, TimeCode, bool]]
)
```
Bases: `Command`
Transform multiple primitives undoable **Command**.
Undo/Redo grouping handled automatically.
**Parameters**
### prims_to_transform
- List of primitive to transform in a tuple of (path, new_translation, new_rotation_euler, new_rotation_order, new_scale, old_translation, old_rotation_euler, old_rotation_order, old_scale, time_code, had_transform_at_key).
### Methods
| Method | Description |
|--------|-------------|
| `__init__(prims_to_transform)` | |
| `do()` | |
| `undo()` | |
### __init__(prims_to_transform)
- Parameters:
- `prims_to_transform`: List[Tuple[str, Vec3d, Vec3d, Vec3i, Vec3d, Vec3d, Vec3d, Vec3i, Vec3d, TimeCode, bool]] |
omni.usd.commands.UngroupPrimsCommand.md | # UngroupPrimsCommand
## UngroupPrimsCommand
```python
class omni.usd.commands.UngroupPrimsCommand(prim_paths: List[Union[str, Path]], stage: Optional[Stage] = None, context_name: Optional[str] = None, destructive: bool = True)
```
Bases:
```
```
Command
```
,
```
UsdStageHelper
```
Ungroup primitive undoable **Command**.
### Parameters
- **prim_paths** (List[str]) – Prim paths that will be grouped.
- **stage** (Usd.Stage) – Stage to operate. Optional.
- **context_name** (str) – The usd context to operate. Optional.
- **destructive** (bool) – If it’s true, it will ungroup all prims and remove original prims, which may edit other layers that are not edit target currently. If it’s false, all changes will made only to the current edit target without touching other layers. By default, it’s true for back compatibility.
### Methods
- **__init__**(prim_paths[, stage, context_name, ...])
- **do**()
- **undo**()
#### __init__(prim_paths: List[Union[str, Path]], stage: Optional[Stage] = None, context_name: Optional[str] = None, destructive: bool = True)
- **prim_paths**: List[Union[str, Path]]
- **stage**: Optional[Stage] = None
- **context_name**: Optional[str] = None
- **destructive**: bool = True
``` |
omni.usd.commands.UnhideAllPrimsCommand.md | # UnhideAllPrimsCommand
## UnhideAllPrimsCommand
```python
class omni.usd.commands.UnhideAllPrimsCommand(Command)
```
### Methods
| Method | Description |
|--------|-------------|
| `do()` | |
| `undo()` | |
### `__init__()`
```
```
```
--- |
omni.usd.commands.UnparentPrimsCommand.md | # UnparentPrimsCommand
## Overview
The `UnparentPrimsCommand` class is a part of the `omni.usd.commands` module. This class is used to unparent prims from their current parent.
### Class Definition
```python
class omni.usd.commands.UnparentPrimsCommand(paths: List[str], on_move_fn: Optional[callable] = None, keep_world_transform: bool = True, stage_or_context: Optional[Union[str, Stage, UsdContext]] = None)
```
### Parameters
- **paths** (`List[str]`): A list of paths of the prims to be unparented.
- **on_move_fn** (`Optional[callable]`): A callback function to be called when the prims are moved. Defaults to `None`.
- **keep_world_transform** (`bool`): If `True`, the world transform of the prims will be preserved. Defaults to `True`.
- **stage_or_context** (`Optional[Union[str, Stage, UsdContext]]`): The stage or context in which the operation is performed. Defaults to `None`.
```
### UnparentPrimsCommand
Bases: `Command`
#### Methods
- `__init__(paths[, on_move_fn, ...])`
- Move prims into "/" primitives undoable `Command`.
- `do()`
- `undo()`
#### `__init__`
Move prims into “/” primitives undoable `Command`.
**Parameters**
- **paths** – prim path to become parent of child_paths
- **keep_world_transform** – If it needs to keep the world transform after parenting.
- **stage_or_context** – (Union [ str , Stage , UsdContext ])
</em>
<em>
Usd.Stage
</em>
<em>
,
</em>
<em>
omni.usd.UsdContext
</em>
<em>
]
</em>
) – 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. |
omni.usd.commands.UsdStageHelper.md | # UsdStageHelper
## UsdStageHelper
```python
class omni.usd.commands.UsdStageHelper(stage: Optional[Stage] = None, context_name: Optional[str] = None)
```
Bases: `object`
Keeps the stage ID or returns the stage from the current context
### Methods
- `__init__(stage, context_name)`
```
Optional[Stage] = None,
context_name: Optional[str] = None |
omni.usd.commands.write_refinement_override_enabled_hint.md | # write_refinement_override_enabled_hint
## write_refinement_override_enabled_hint |
omni.usd.copy_timesamples_from_weaker_layer.md | # copy_timesamples_from_weaker_layer
## copy_timesamples_from_weaker_layer |
omni.usd.correct_filename_case.md | # correct_filename_case
## correct_filename_case
```python
omni.usd.correct_filename_case(file: str) -> str
```
```
```
--- |
omni.usd.create_context.md | # create_context
## create_context
```python
omni.usd.create_context(name: str = '') -> omni.usd._usd.UsdContext
```
Creates a new UsdContext.
``` |
omni.usd.create_material_input.md | # create_material_input
## create_material_input
```
- **Parameters**:
- `prim`
- `name`
- `value`
- `vtype`
- `def_value` (optional, default: `None`)
- `min_value` (optional, default: `None`)
- `max_value` (optional, default: `None`)
- `display_name` (optional, default: `None`)
- `display_group` (optional, default: `None`)
- `color_space` (optional, default: `None`)
This function is used to create a material input. |
omni.usd.destroy_context.md | # destroy_context
## destroy_context
Destroys specified UsdContext. |
omni.usd.duplicate_prim.md | # duplicate_prim
## duplicate_prim
```python
omni.usd.duplicate_prim(stage: Stage, prim_path: Union[str, Path], path_to: Union[str, Path], duplicate_layers: bool = True)
```
Duplicate prim.
**Parameters**
- **stage** (`Usd.Stage`) – Stage handle.
- **prim_path** (`Union[str, Path]`) – Prim path.
- **path_to** (`Union[str, Path]`) – Path to.
- **duplicate_layers** (`bool`) – Duplicate layers, default is `True`.
- **path_to** (`Union[str, Sdf.Path]`) – Copy to path.
- **duplicate_layers** (`bool`) – True if it’s to duplicate this prim in all local layers. False if it’s to duplicate this prim to the current edit target. And it depends on whether the prim is defined or not. If it’s not defined, it will only copy the opinions in the current edit target if it exists. Otherwise, it will copy the def to the current edit target, even it’s from other layers instead of the current edit target. If you want to collapse all overrides inside all local layers for the prim, see omni.usd.stitch_prim_specs for reference.
**Returns**
- True if successful, or false otherwise. |
omni.usd.editor.get_display_name.md | # get_display_name
## get_display_name
```python
omni.usd.editor.get_display_name(prim) -> str
```
Gets display name from the metadata of the prim.
``` |
omni.usd.editor.is_always_pick_model.md | # is_always_pick_model
## is_always_pick_model
```python
omni.usd.editor.is_always_pick_model(prim: Prim) -> bool
```
Whether selecting this prim should always pick the enclosing prim with kind:model or not.
``` |
omni.usd.editor.is_hide_in_stage_window.md | # is_hide_in_stage_window
## is_hide_in_stage_window
```python
def is_hide_in_stage_window(prim: Prim) -> bool:
```
Whether the prim should be hidden in the stage window or not.
``` |
omni.usd.editor.is_hide_in_ui.md | # is_hide_in_ui
## is_hide_in_ui
```python
omni.usd.editor.is_hide_in_ui(prim: Prim) -> bool
```
Whether the prim should be hidden or not.
``` |
omni.usd.editor.is_no_delete.md | # is_no_delete
## is_no_delete
```python
omni.usd.editor.is_no_delete(prim: Prim) -> bool
```
Whether the prim should be removed or not.
```
```
``` |
omni.usd.editor.set_always_pick_model.md | # set_always_pick_model
## set_always_pick_model
```python
omni.usd.editor.set_always_pick_model(prim: Prim, pick_model: bool)
```
Sets metadata for prim to instruct selection whether it should always pick the enclosing prim with kind:model or not.
``` |
omni.usd.editor.set_display_name.md | # set_display_name
## set_display_name
```python
omni.usd.editor.set_display_name(prim: Prim, name: str)
```
Sets an user readable name for the prim to instruct UI to display it.
``` |
omni.usd.editor.set_hide_in_stage_window.md | # set_hide_in_stage_window
## set_hide_in_stage_window
```python
omni.usd.editor.set_hide_in_stage_window(prim: Prim, hide: bool)
```
Sets metadata for prim to instruct stage window to display/hide the prim.
``` |
omni.usd.editor.set_hide_in_ui.md | # set_hide_in_ui
## set_hide_in_ui
```python
def set_hide_in_ui(prim: Prim, value: bool)
```
Sets metadata for the prim to instruct UI whether it should be hidden in the UI or not.
``` |
omni.usd.editor.set_no_delete.md | # set_no_delete
## set_no_delete
```python
omni.usd.editor.set_no_delete(prim: Prim, no_delete: bool)
```
Sets metadata for prim to instruct UI whether the prim can be removed or not. |
omni.usd.EngineCreationConfig.md | # EngineCreationConfig
## EngineCreationConfig
```python
class omni.usd.EngineCreationConfig(pybind11_object)
```
EngineCreationConfig structure.
### Methods
| Method | Description |
|--------|-------------|
| `__init__(self)` | |
### Attributes
| Attribute | Description |
|-----------|-------------|
| `device_mask` | |
| `flags` | |
| `tickrate_in_hz` | |
```python
def __init__(self: omni.usd._usd.EngineCreationConfig) -> None:
pass
```
---
title: "示例文档"
author: "作者姓名"
date: "2023-01-01"
---
# 引言
这是一个示例文档，用于展示如何将HTML格式转换为Markdown格式。
## 目录
1. [简介](#简介)
2. [正文](#正文)
3. [结论](#结论)
## 简介
这里是简介部分，介绍文档的主要内容和目的。
## 正文
### 代码示例
```python
def example_function():
print("这是一个代码示例")
```
### 表格
| 列1 | 列2 | 列3 |
| --- | --- | --- |
| 数据1 | 数据2 | 数据3 |
| 数据4 | 数据5 | 数据6 |
## 结论
这里是结论部分，总结文档的主要发现和建议。
---
## 参考文献
- [参考文献1](#)
- [参考文献2](#)
## 致谢
感谢所有贡献者。
---
## 附录
这里是附录部分，包含额外的信息和数据。
---
## 联系信息
- 邮箱: [email protected]
- 电话: 123-456-7890
---
## 版权信息
© 2023 示例文档. All rights reserved.
---
## 脚注
这里是脚注信息。
---
## 底部信息
这里是底部信息。
---
## 页脚
这里是页脚信息。
--- |
omni.usd.EngineCreationFlags.md | # EngineCreationFlags
## Class Definition
```python
class omni.usd.EngineCreationFlags(pybind11_object)
```
### Description
Specifies the flags for the hydra engine creation.
### Members
- NONE
- MOTION_RAYTRACING_ENABLED
- SKIP_ON_WORKER_PROCESS
### Methods
- `__init__(self, value)`
### Attributes
- `MOTION_RAYTRACING_ENABLED`
- `NONE`
- `SKIP_ON_WORKER_PROCESS`
- `name`
- `value`
(
self: omni.usd._usd.EngineCreationFlags,
value: int
) → None
property name |
omni.usd.find_path_in_nodes.md | # find_path_in_nodes — Omniverse Kit 1.10.39 documentation
## find_path_in_nodes
```python
omni.usd.find_path_in_nodes(node, set_fn)
```
- **node**:
- **set_fn**:
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
``` |
omni.usd.find_spec_on_session_or_its_sublayers.md | # find_spec_on_session_or_its_sublayers
## find_spec_on_session_or_its_sublayers
```
```python
omni.usd.find_spec_on_session_or_its_sublayers(stage: Stage, path: Path, predicate: Optional[Callable[[Spec], bool]] = None)
```
- **Description:**
Finds spec in the session layer or its sublayers.
- **Parameters:**
- **stage** (`Usd.Stage`) – Stage instance.
- **path** (`Sdf.Path`) – Spec path to find.
- **predicate** (`Callable[[Sdf.Spec], bool]`) – Optional predicate function to filter specs. Default is `None`.
## Description
### Parameters
#### predicate
- **Type**: `(Sdf.Path, Sdf.Spec) -> bool`
- **Description**: If it’s provided, the spec to find must pass the predicate.
### Returns
- **Description**: Layer that the spec resides in, and the spec handle. Or (None, None) if it cannot be found.
- **Return type**: (Sdf.Layer, Sdf.Spec) |
omni.usd.Functions.md | # omni.usd Functions
## Functions Summary:
- [attr_has_timesample_on_key](#)
- [can_be_copied](#)
- [can_prim_have_children](#)
- [check_ancestral](#)
- [clear_attr_val_at_time](#) - Clears attribute at specified timecode.
- [copy_timesamples_from_weaker_layer](#)
- [correct_filename_case](#)
- [create_material_input](#)
- [duplicate_prim](#) - Duplicate prim.
- [find_path_in_nodes](#)
- [find_spec_on_session_or_its_sublayers](#) - Finds spec in the session layer or its sublayers.
- [gather_default_attributes](#)
- [get_all_sublayers](#) - Gets all sublayers from local layer stack of the stage ranking from strongest to weakest.
get_attribute_effective_defaultvalue_layer_info
get_attribute_effective_timesample_layer_info
get_attribute_effective_value_layer_info
get_authored_prim
get_composed_payloads_from_prim
get_composed_references_from_prim
get_context_from_stage
get_dirty_layers
get_edit_target_identifier
get_frame_time
get_frame_time_code
get_geometry_standard_prim_list
get_introducing_layer
get_light_prim_list
get_local_transform_SRT
get_local_transform_matrix
get_prim_at_path
get_prim_descendents
get_prop_at_path
get_prop_auto_target_session_layer
get_sdf_layer
get_shader_from_material
get_stage_next_free_path
get_subidentifier_from_material
<p>
get_subidentifier_from_mdl
</p>
<p>
get_timesamples_count_in_authoring_layer
</p>
<p>
get_url_from_prim
</p>
<p>
Returns url of Prim when authored reference or None
</p>
<p>
get_world_transform_matrix
</p>
<p>
handle_exception
</p>
<p>
Decorator to print exception in async functions
</p>
<p>
is_ancestor_prim_type
</p>
<p>
is_child_type
</p>
<p>
is_hidden_type
</p>
<p>
is_layer_locked
</p>
<p>
Checks if layer is locked or not in this usd context. Layer lock is a customized
</p>
<p>
is_layer_writable
</p>
<p>
Checks if layer is writable on file system.
</p>
<p>
is_path_valid
</p>
<p>
is_prim_material_supported
</p>
<p>
is_usd_readable_filetype
</p>
<p>
Whether the given file path is a supported readable USD file or not.
</p>
<p>
is_usd_writable_filetype
</p>
<p>
Whether the given file path is a supported writable USD file or not.
</p>
<p>
make_path_relative_to_current_edit_target
</p>
<p>
on_layers_saved_result
</p>
<p>
on_stage_result
</p>
<p>
readable_usd_dotted_file_exts
</p>
<p>
Gets a list of file extensions about readable USD formats.
</p>
<p>
readable_usd_file_exts
</p>
<p>
Gets a list of file extensions (without dots) about readable USD formats.
</p>
<p>
readable_usd_file_exts_str
</p>
<p>
Gets a string that includes all readable USD file formats supported by Kit.
</p>
<p>
readable_usd_files_desc
</p>
<p>
Gets a description of all readable USD file formats.
</p>
<p>
readable_usd_re
</p>
<p>
Gets the regex that matches readable USD files.
</p>
<p>
remove_property
</p>
<p>
Removes specified property from the prim.
</p>
<p>
set_attr_val
</p>
Deprecated. See :func:`.set_prop_val` instead.
set_edit_target_by_identifier
Sets the edit target of stage by layer identifier.
set_prop_val
Sets the value of property.
stitch_prim_specs
Sitches prim specs specified by path scattered in all sublayers
writable_usd_dotted_file_exts
Gets a list of file extensions about writable USD formats.
writable_usd_file_exts
Gets a list of file extensions (without dots) about writable USD formats.
writable_usd_file_exts_str
Gets a string that includes all writable USD file formats supported by Kit.
writable_usd_files_desc
Gets a description of all writable USD file formats.
writable_usd_re
Gets the regex that matches writable USD files.
add_hydra_engine
add_hydra_engine(name: str, context: omni.usd._usd.UsdContext) -> omni.usd._usd.OpaqueSharedHydraEngineContext
attach_all_hydra_engines
attach_all_hydra_engines(context: omni.usd._usd.UsdContext) -> None
create_context
create_context(name: str = '') -> omni.usd._usd.UsdContext
destroy_context
destroy_context(name: str = '') -> bool
get_context
get_context(name: str = '') -> omni.usd._usd.UsdContext
get_context_from_stage_id
get_context_from_stage_id(stage_id: int) -> omni.usd._usd.UsdContext
get_or_create_hydra_engine
get_or_create_hydra_engine(arg0: str, arg1: omni.usd._usd.UsdContext, arg2: omni.usd._usd.EngineCreationConfig) -> omni.usd._usd.OpaqueSharedHydraEngineContext
merge_layers
merge_layers(dst_layer_identifier: str, src_layer_identifier: str, dst_is_stronger_than_src: bool = True, src_layer_offset: float = 0.0, src_layer_scale: float = 1.0) -> bool
merge_prim_spec
merge_prim_spec(dst_layer_identifier: str, src_layer_identifier: str, prim_spec_path: str, dst_is_stronger_than_src: bool = True, target_prim_path: str = '') -> None
release_all_hydra_engines
release_all_hydra_engines(context: omni.usd._usd.UsdContext = None) -> None
release_hydra_engine
release_hydra_engine(arg0: omni.usd._usd.UsdContext, arg1: omni.usd._usd.OpaqueSharedHydraEngineContext) -> bool
resolve_paths
resolve_paths(src_layer_identifier: str, dst_layer_identifier: str, store_relative_path: bool = True, relative_to_src_layer: bool = False, copy_sublayer_offsets: bool = False) -> None
| resolve_prim_path_references | resolve_prim_path_references(layer: str, old_prim_path: str, new_prim_path: str) -> None |
|-------------------------------|-----------------------------------------------------------------------------------------------|
| resolve_prim_paths_references | resolve_prim_paths_references(layer: str, old_prim_paths: List[str], new_prim_paths: List[str]) -> None |
| shutdown_usd | shutdown_usd() -> None | |
omni.usd.gather_default_attributes.md | # gather_default_attributes
## gather_default_attributes |
omni.usd.get_all_sublayers.md | # get_all_sublayers
## get_all_sublayers
### get_all_sublayers
#### get_all_sublayers
##### get_all_sublayers
###### get_all_sublayers |
omni.usd.get_attribute_effective_defaultvalue_layer_info.md | # get_attribute_effective_defaultvalue_layer_info
## get_attribute_effective_defaultvalue_layer_info
```python
omni.usd.get_attribute_effective_defaultvalue_layer_info(stage, attr: Attribute)
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
``` |
omni.usd.get_attribute_effective_timesample_layer_info.md | # get_attribute_effective_timesample_layer_info
## get_attribute_effective_timesample_layer_info
### omni.usd.get_attribute_effective_timesample_layer_info
```python
omni.usd.get_attribute_effective_timesample_layer_info(stage, attr: Attribute)
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
``` |
omni.usd.get_attribute_effective_value_layer_info.md | # get_attribute_effective_value_layer_info
## get_attribute_effective_value_layer_info
```python
omni.usd.get_attribute_effective_value_layer_info(stage, attr: Attribute)
```
```
```
--- |
omni.usd.get_authored_prim.md | # get_authored_prim
## get_authored_prim |
omni.usd.get_composed_payloads_from_prim.md | # get_composed_payloads_from_prim
## get_composed_payloads_from_prim
### omni.usd.get_composed_payloads_from_prim
#### omni.usd.get_composed_payloads_from_prim
##### omni.usd.get_composed_payloads_from_prim
###### omni.usd.get_composed_payloads_from_prim
####### omni.usd.get_composed_payloads_from_prim
###### omni.usd.get_composed_payloads_from_prim
##### omni.usd.get_composed_payloads_from_prim
#### omni.usd.get_composed_payloads_from_prim
### omni.usd.get_composed_payloads_from_prim
## omni.usd.get_composed_payloads_from_prim
# get_composed_payloads_from_prim
|
omni.usd.get_composed_references_from_prim.md | # get_composed_references_from_prim
## get_composed_references_from_prim
```python
omni.usd.get_composed_references_from_prim(prim: Prim, fix_slashes: bool = True) -> List[Tuple[Reference, Layer]]
```
Gets composed reference list from prim.
**Parameters:**
- **prim** (Usd.Prim) – Handle of Usd.Prim.
**Returns:**
- List of reference items. Each item is a tuple that includes reference handle, and the layer it’s from.
``` |
omni.usd.get_context.md | # get_context
## get_context
```python
omni.usd.get_context(name: str = '') -> omni.usd._usd.UsdContext
```
Gets UsdContext instance.
``` |
omni.usd.get_context_from_stage.md | # get_context_from_stage
## get_context_from_stage
```python
omni.usd.get_context_from_stage(stage)
```
Gets corresponding UsdContext of the stage if it’s found.
```
``` |
omni.usd.get_context_from_stage_id.md | # get_context_from_stage_id
## get_context_from_stage_id
- **Function**: `omni.usd.get_context_from_stage_id(stage_id: int) -> omni.usd._usd.UsdContext`
- **Description**: Finds UsdContext instance with specified stage id. |
omni.usd.get_dirty_layers.md | # get_dirty_layers
## get_dirty_layers
```python
omni.usd.get_dirty_layers(stage: Stage, include_root_layer=True)
```
Gets all dirty layers that have unsaved changes.
```
```
``` |
omni.usd.get_edit_target_identifier.md | # get_edit_target_identifier
## get_edit_target_identifier
```python
omni.usd.get_edit_target_identifier(stage: Stage) -> str
```
Gets the layer identifier of current edit target.
**Parameters**
- **stage** (Usd.Stage) – Stage handle
**Returns**
- Layer identifier or empty string if edit target is not set. |
omni.usd.get_frame_time.md | # get_frame_time
## get_frame_time |
omni.usd.get_frame_time_code.md | # get_frame_time_code
## get_frame_time_code
### omni.usd.get_frame_time_code |
omni.usd.get_geometry_standard_prim_list.md | # get_geometry_standard_prim_list
## get_geometry_standard_prim_list
### omni.usd.get_geometry_standard_prim_list |
omni.usd.get_introducing_layer.md | # get_introducing_layer
## get_introducing_layer
This function will find the local layer that defines this prim, or the first introducing layer that introduces the prim into the local layer stack if prim is defined in a reference or payload. An introducting layer is the layer that adds the prim into the composition graph.
The difference of this function to Usd.PrimCompositionQuery is that it will return the first local layer where the prim is defined. If it’s not defined locally, it will find the reference or payload arcs with Usd.PrimCompositionQuery to find the first introducing layer and its introducing prim path in the local layer stack.
### Parameters
- **prim** (Usd.Prim) – Prim handle
### Returns
- Introducing layer and its introducing prim path.
### Return type
- Tuple[Sdf.Layer, Sdf.Path] |
omni.usd.get_light_prim_list.md | # get_light_prim_list
## get_light_prim_list |
omni.usd.get_local_transform_matrix.md | # get_local_transform_matrix
## get_local_transform_matrix
```
```python
omni.usd.get_local_transform_matrix(prim: Prim, time_code: TimeCode = Usd.TimeCode.Default()) |
omni.usd.get_local_transform_SRT.md | # get_local_transform_SRT
## get_local_transform_SRT
```python
omni.usd.get_local_transform_SRT(prim, time=Usd.TimeCode.Default())
```
- **Parameters**:
- `prim`:
- `time`: (default is `Usd.TimeCode.Default()`)
- **Returns**:
- Tuple[
pxr.Gf.Vec3d | pxr.Gf.Vec3f | pxr.Gf.Vec3h,
pxr.Gf.Vec3d | pxr.Gf.Vec3f | pxr.Gf.Vec3h,
Vec3i,
pxr.Gf.Vec3d | pxr.Gf.Vec3f | pxr.Gf.Vec3h
]
- **Description**:
Return a tuple of [scale, rotation, rotation_order, translate] for given prim. |
omni.usd.get_or_create_hydra_engine.md | # get_or_create_hydra_engine
## get_or_create_hydra_engine
```python
omni.usd.get_or_create_hydra_engine(arg0: str, arg1: omni.usd._usd.UsdContext, arg2: omni.usd._usd.EngineCreationConfig) -> omni.usd._usd.OpaqueSharedHydraEngineContext
```
``` |
omni.usd.get_prim_at_path.md | # get_prim_at_path
## get_prim_at_path
### omni.usd.get_prim_at_path
omni.usd.get_prim_at_path(path: Path, usd_context_name: Union[str, Stage] = '') → Prim
|
omni.usd.get_prim_descendents.md | # get_prim_descendents
## get_prim_descendents
```python
omni.usd.get_prim_descendents(root_prim)
```
```
``` |
omni.usd.get_prop_at_path.md | # get_prop_at_path
## get_prop_at_path
### omni.usd.get_prop_at_path
#### Parameters
- `path`: Path
- `usd_context_name`: Union[str, Stage] = ''
#### Returns
- Property |
omni.usd.get_prop_auto_target_session_layer.md | # get_prop_auto_target_session_layer
## get_prop_auto_target_session_layer
Get property auto retarget layer.
### Parameters
- **stage** (`Usd.Stage`) – Usd stage
- **prop_path** (`Sdf.Path`) – property path |
omni.usd.get_sdf_layer.md | # get_sdf_layer
## get_sdf_layer |
omni.usd.get_shader_from_material.md | # get_shader_from_material
## get_shader_from_material |
omni.usd.get_stage_next_free_path.md | # get_stage_next_free_path
## get_stage_next_free_path
### Function Signature
```python
omni.usd.get_stage_next_free_path(stage: Stage, path: Union[str, Path], prepend_default_prim: bool)
```
### Description
Gets a new prim path that doesn’t exist in the stage given a base path. If the given path doesn’t exist in the stage already, it returns the given path directly. Otherwise, it appends a suffix with number index to the given path until it finds a path that’s not taken.
### Parameters
- **stage** (Usd.Stage) – The stage handle.
- **path** (Union[str, Sdf.Path]) – Base prim path.
- **prepend_default_prim** (bool) – Whether it should prepend default prim name to the path or not.
### Raises
- **ValueError** – Path is not a valid prim path.
### Returns
- prim path that doesn’t exist in the stage.
### Return type
- Sdf.Path
# 标题
这是一些文本内容，其中包含了一些特殊字符，比如：<、>、&。
## 子标题
这里是更多的文本内容，可能包含一些代码示例：
```python
print("Hello, world!")
```
还有一些列表：
- 列表项1
- 列表项2
- 列表项3
以及一些引用：
> 这是一个引用。
还有一些链接，但链接本身已被删除，只保留了链接文本：
- 链接文本1
- 链接文本2
还有一些图片，但图片本身已被删除：
还有一些表格：
| 表头1 | 表头2 |
|-------|-------|
| 内容1 | 内容2 |
| 内容3 | 内容4 |
还有一些分割线：
---
还有一些脚注：
--- |
omni.usd.get_subidentifier_from_material.md | # get_subidentifier_from_material
## get_subidentifier_from_material
```markdown
async omni.usd.get_subidentifier_from_material(prim: Prim, on_complete_fn: Optional[Callable] = None)
```
Deprecated. Use `omni.kit.material.library.get_subidentifier_from_material` instead.
``` |
omni.usd.get_subidentifier_from_mdl.md | # get_subidentifier_from_mdl
## get_subidentifier_from_mdl
```python
async omni.usd.get_subidentifier_from_mdl(mdl_file: str, on_complete_fn: Optional[Callable] = None)
```
This function retrieves subidentifiers from a Material Definition Library (MDL) file.
- **mdl_file**: The path to the MDL file.
- **on_complete_fn**: An optional callback function to be executed after the operation completes.
``` |
omni.usd.get_timesamples_count_in_authoring_layer.md | # get_timesamples_count_in_authoring_layer
## get_timesamples_count_in_authoring_layer
```python
omni.usd.get_timesamples_count_in_authoring_layer(stage, attr_path: Path)
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
```
``` |
omni.usd.get_url_from_prim.md | # get_url_from_prim
## get_url_from_prim
Returns url of Prim when authored reference or None
### get_url_from_prim |
omni.usd.get_world_transform_matrix.md | # get_world_transform_matrix
## get_world_transform_matrix
```python
omni.usd.get_world_transform_matrix(prim: Prim, time_code: TimeCode = Usd.TimeCode.Default())
```
--- |
omni.usd.handle_exception.md | # handle_exception
## handle_exception |
omni.usd.is_ancestor_prim_type.md | # is_ancestor_prim_type
## is_ancestor_prim_type
```python
omni.usd.is_ancestor_prim_type(stage: Stage, prim_path: Path, prim_type: SchemaBase)
```
This function checks if the specified prim type is an ancestor of the given prim path in the stage. |
omni.usd.is_child_type.md | # is_child_type
## is_child_type |
omni.usd.is_hidden_type.md | # is_hidden_type
## is_hidden_type |
omni.usd.is_layer_locked.md | # is_layer_locked
## is_layer_locked
```python
omni.usd.is_layer_locked(usd_context, layer_identifier: str) -> bool
```
Checks if layer is locked or not in this usd context. Layer lock is a customized concept in Kit that’s not from USD. It’s used to complement the concept of file permission. Unlike the writable permission on file system, lock is bound to stage. So a layer may be locked in this stage, but not for other stages. Lock status is persistent across sessions, and saved as a flag inside the custom data of root layer. |
omni.usd.is_layer_writable.md | # is_layer_writable
Checks if layer is writable on file system.
## Description
```python
omni.usd.is_layer_writable(layer_identifier: str) -> bool
```
Checks if the specified layer is writable on the file system.
``` |
Subsets and Splits