Cloning Prims
When to Use
Use this skill when the user asks to clone, duplicate, copy a prim, or create instances of existing geometry.
Inputs
Resolve inputs in this order: existing repository files and referenced snippets, explicit user request, then broader agent context.
- Target API surface: Python, C/C++, or both.
- Source prim path to clone and one or more destination prim paths to create.
- Desired execution mode: Python sync, Python async, or C async clone.
- Whether the request is actually a clone, USD reference, instance, or new-geometry authoring workflow.
- Repository source snippets referenced below. Treat these snippets as the API source of truth.
Prerequisites
- Use an ovrtx checkout that contains the referenced examples and docs tests.
- Read the relevant
> **Source:** snippet before writing or explaining API usage.
- Confirm the source prim already exists on the runtime stage and destination paths do not conflict with existing prims unless replacement is intended.
Instructions
- Identify the source prim path and every destination path the caller wants to create.
- Confirm whether the workflow needs a synchronous Python clone, Python async clone, or C async clone.
- Read the matching snippet and preserve its source-path, destination-list, wait, and error-checking pattern.
- Do not use cloning when the caller actually needs USD instancing, references, or authoring new geometry from scratch; route to the loading or writing skills instead.
- When changing code, run the stage-mutation docs test that owns the clone snippet whenever practical.
Output Format
- For explanations, cite the relevant API names, source snippets, and caveats.
- For code changes, summarize the files changed, snippets affected, and validation run.
Scripts
This skill has no scripts.
Limitations
- The referenced snippets remain the source of truth; update or add tested snippets before documenting new API usage.
Overview
clone_usd creates copies of an existing prim subtree at one or more new target paths in the runtime stage. This is useful for duplicating geometry, creating arrays of objects, or spawning instances from a template.
Python
Clone to a single target
Source: tests/docs/python/test_stage_mutation.py snippet doc-clone-usd
Clone to multiple targets
Source: tests/docs/python/test_stage_mutation.py snippet doc-clone-usd
Async clone
Source: tests/docs/python/test_stage_mutation.py snippet doc-clone-usd-async
C
Clone to multiple targets
Source: tests/docs/c/test_stage_mutation.cpp snippet doc-clone-usd-c
Wait for completion
Source: tests/docs/c/test_stage_mutation.cpp snippet doc-clone-usd-c
Key Types / Functions
| Python |
C |
renderer.clone_usd(source, targets) |
ovrtx_clone_usd(renderer, source, targets, count) |
renderer.clone_usd_async(source, targets) |
ovrtx_clone_usd() (always async in C) |
Troubleshooting
- The source path must exist in the stage.
- The target paths must not already exist in the stage.
- Cloning copies the entire subtree under the source path, including all children.
- In Python,
clone_usd() blocks until the operation completes. Use clone_usd_async() for non-blocking behavior.
- In C,
ovrtx_clone_usd() is always asynchronous. You must wait on the returned op_index with ovrtx_wait_op() before using the cloned prims (e.g., writing attributes or stepping).
References
- Use the
> **Source:** directives in this skill to locate tested snippets before reusing API patterns.
- Keep related skills, docs, and snippets synchronized when changing the workflow.
1---2name: cloning-prims3description: Cloning USD subtrees to create copies at new paths. Use when user asks to clone, duplicate, copy a prim, or create instances of existing geometry.4license: LicenseRef-NvidiaProprietary5---67# Cloning Prims89## When to Use1011Use this skill when the user asks to clone, duplicate, copy a prim, or create instances of existing geometry.1213## Inputs1415Resolve inputs in this order: existing repository files and referenced snippets, explicit user request, then broader agent context.1617- Target API surface: Python, C/C++, or both.18- Source prim path to clone and one or more destination prim paths to create.19- Desired execution mode: Python sync, Python async, or C async clone.20- Whether the request is actually a clone, USD reference, instance, or new-geometry authoring workflow.21- Repository source snippets referenced below. Treat these snippets as the API source of truth.2223## Prerequisites2425- Use an ovrtx checkout that contains the referenced examples and docs tests.26- Read the relevant `> **Source:**` snippet before writing or explaining API usage.27- Confirm the source prim already exists on the runtime stage and destination paths do not conflict with existing prims unless replacement is intended.2829## Instructions30311. Identify the source prim path and every destination path the caller wants to create.322. Confirm whether the workflow needs a synchronous Python clone, Python async clone, or C async clone.333. Read the matching snippet and preserve its source-path, destination-list, wait, and error-checking pattern.344. Do not use cloning when the caller actually needs USD instancing, references, or authoring new geometry from scratch; route to the loading or writing skills instead.355. When changing code, run the stage-mutation docs test that owns the clone snippet whenever practical.3637## Output Format3839- For explanations, cite the relevant API names, source snippets, and caveats.40- For code changes, summarize the files changed, snippets affected, and validation run.4142## Scripts4344This skill has no scripts.4546## Limitations4748- The referenced snippets remain the source of truth; update or add tested snippets before documenting new API usage.4950## Overview5152`clone_usd` creates copies of an existing prim subtree at one or more new target paths in the runtime stage. This is useful for duplicating geometry, creating arrays of objects, or spawning instances from a template.5354## Python5556### Clone to a single target5758> **Source:** `tests/docs/python/test_stage_mutation.py` snippet `doc-clone-usd`5960### Clone to multiple targets6162> **Source:** `tests/docs/python/test_stage_mutation.py` snippet `doc-clone-usd`6364### Async clone6566> **Source:** `tests/docs/python/test_stage_mutation.py` snippet `doc-clone-usd-async`6768## C6970### Clone to multiple targets7172> **Source:** `tests/docs/c/test_stage_mutation.cpp` snippet `doc-clone-usd-c`7374### Wait for completion7576> **Source:** `tests/docs/c/test_stage_mutation.cpp` snippet `doc-clone-usd-c`7778## Key Types / Functions7980| Python | C |81|--------|---|82| `renderer.clone_usd(source, targets)` | `ovrtx_clone_usd(renderer, source, targets, count)` |83| `renderer.clone_usd_async(source, targets)` | `ovrtx_clone_usd()` (always async in C) |8485## Troubleshooting8687- The source path **must exist** in the stage.88- The target paths **must not already exist** in the stage.89- Cloning copies the entire subtree under the source path, including all children.90- In Python, `clone_usd()` blocks until the operation completes. Use `clone_usd_async()` for non-blocking behavior.91- In C, `ovrtx_clone_usd()` is always asynchronous. You **must** wait on the returned `op_index` with `ovrtx_wait_op()` before using the cloned prims (e.g., writing attributes or stepping).9293## References9495- Use the `> **Source:**` directives in this skill to locate tested snippets before reusing API patterns.96- Keep related skills, docs, and snippets synchronized when changing the workflow.
NVIDIA-Omniverse