file_path stringlengths 5 148 | content stringlengths 150 498k | size int64 150 498k |
|---|---|---|
carter-urdf-example_index.md | # Omniverse URDF Importer
## Omniverse URDF Importer
The URDF Importer Extension is used to import URDF representations of robots. Unified Robot Description Format (URDF) is an XML format for representing a robot model in ROS.
### Getting Started
1. Clone the GitHub repo to your local machine.
2. Open a command promp... | 10,902 |
Categories.md | # Node Categories
An OmniGraph node can have one or more categories associated with it, giving the UI a method of presenting large lists of nodes or node types in a more organized manner.
## Category Specification In .ogn File
For now the node categories are all specified through the .ogn file, so the node will inhe... | 11,946 |
changes.md | ## Changed
- OVCC-1497: `tsc_clock` was moved from the `carb::time` namespace to `carb::clock`, though it is also available from within the `time` namespace for historical consistency. The `time` namespace was conflicting in some cases with the `time()` function.
- OM-122864: update freetype to version 2.13.2.
- OVCC-1... | 216,625 |
changetracking.md | # Change Tracking in USDRT
USDRT offers an option for tracking changes to Fabric scene data with the RtChangeTracker class, which is available for users in both C++ and Python. Like the rest of the USDRT Scenegraph API, RtChangeTracker aims to leverage the performance gains of Fabric while remaining accessible for USD... | 5,290 |
class-list_Overview.md | # Overview
An extension wraps around RTX Raycast Query to provide simpler raycast interface into the stage.
## Class List
- **IRaycastQuery**: Interface class for Raycast Query operations. This class represents the interface for performing Raycast Query operations in the current scene. This class is thread-safe and ... | 1,943 |
classes.md | # Classes
- **omni::avreality::rain::IPuddleBaker**: Bakes puddle into dynamic textures.
- **omni::avreality::rain::IWetnessController**: Controller scene level wetness parameters.
- **omni::avreality::rain::PuddleBaker**: Bake puddles into dynamic textures.
- **omni::avreality::rain::WetnessController**: Controller f... | 354 |
classomni_1_1avreality_1_1rain_1_1_puddle_baker.md | # omni::avreality::rain::PuddleBaker
Defined in [omni/avreality/rain/PuddleBaker.h](#puddle-baker-8h)
## Functions
- [PuddleBaker()=delete](#classomni_1_1avreality_1_1rain_1_1_puddle_baker_1a5471be17f6dcaa1d8b80fd9e419cf5cb) : Creates a new PuddleBaker.
- [assignShadersAccumulationMapTextureNames(gsl::span< std::... | 3,982 |
classomni_1_1avreality_1_1rain_1_1_wetness_controller.md | # omni::avreality::rain::WetnessController
Defined in [omni/avreality/rain/WetnessController.h](#)
## Functions
- **WetnessController(omni::usd::UsdContext *usdContext=nullptr)** : Create a new scene wetness controller.
- **applyGlobalPorosity(float porosity)** : Apply porosity value `porosity` to all SimPBR primiti... | 3,548 |
class_structomni_1_1avreality_1_1rain_1_1_i_puddle_baker.md | # omni::avreality::rain::IPuddleBaker
Defined in omni/avreality/rain/IPuddleBaker.h
## Variables
- **assignShadersAccumulationMapTextureNames**: Assign dynamic textures to the water accumulation entry in the provided shader list.
- **bake**:
## Class Definition
```cpp
class IPuddleBaker
```
Bakes puddle into dynamic... | 1,754 |
class_structomni_1_1avreality_1_1rain_1_1_i_wetness_controller.md | # omni::avreality::rain::IWetnessController
Defined in [omni/avreality/rain/IWetnessController.h](#i-wetness-controller-8h)
## Variables
- **applyGlobalPorosity**: Apply porosity value `porosity` to all SimPBR primitives supporting wetness.
- **applyGlobalPorosityScale**: Apply porosity scale value `porosityScale` t... | 2,940 |
cleaning-up_ext_serialization.md | # Serialization (NvBlastExtSerialization)
## Introduction
This extension defines the Nv::Blast::ExtSerialization class, a modular serialization manager which can be extended to handle data types from different Blast modules (such as low-level and Tk).
An ExtSerialization manager is created using the global function N... | 7,136 |
cli.md | # Omni Asset Validator (CLI)
## Command Line Interface
Utility for USD validation to ensure layers run smoothly across all Omniverse products. Validation is based on the USD ComplianceChecker (i.e. the same backend as the usdchecker commandline tool), and has been extended with additional rules as follows:
- Addition... | 6,491 |
client_library_api.md | # Omniverse Client Library API
## Class Hierarchy
- struct OmniClientAclEntry
- struct OmniClientAuthDeviceFlowParams
- struct OmniClientBookmark
- struct OmniClientBranchAndCheckpoint
- struct OmniClientContent
- struct OmniClientCredentials
- struct OmniClientListEntry
- struct OmniClientLiveUpdateInfo
- struct Omn... | 20,423 |
clone-the-kit-app-template-github-repository_developer_setup.md | # Project Setup
## Visual Studio Code
Download and install Visual Studio Code. Standard installation works for this tutorial.
## Clone the kit-app-template GitHub Repository
Use a preferred method to download the repo. Here is how clone kit-app-template from within Visual Studio:
1. Open VSCode.
2. Open the command ... | 3,174 |
CODING.md | # Coding Style Guidelines
This document covers style guidelines for the various programming languages used in the Carbonite codebase.
## C/C++ Coding Conventions
This covers the basic coding conventions and guidelines for all C/C++ code that is submitted to this repository.
- It’s expected that you will not love ev... | 68,335 |
commands.md | # Commands
Like other extensions, the OmniGraph extensions expose undoable functionality through some basic commands. A lot of the functionality of the commands can be accessed from the `og.Controller` object, described above.
OmniGraph has created a shortcut to allow more natural expression of command execution. The... | 1,374 |
compatibility_index.md | # NVIDIA RTX Remix
## Introduction
RTX Remix is a modding platform for remastering a catalog of fixed-function DirectX 8 and 9 games with cutting edge graphics. With NVIDIA RTX Remix, experienced modders can upgrade textures with AI, easily replace game assets with high fidelity assets built with physically accurate ... | 15,172 |
CompoundNodes.md | # Compound Nodes
Compound nodes are nodes whose execution is defined by the evaluation of an `OmniGraph`. Compound nodes can be used to encapsulate complex functionality into a single node, or to create a node that can be reused. The existing release of OmniGraph supports Compound Subgraphs, which allow the user to co... | 8,786 |
configuration-options_index.md | # Omniverse MJCF Importer
## Omniverse MJCF Importer
The MJCF Importer Extension is used to import MuJoCo representations of scenes. MuJoCo Modeling XML File (MJCF), is an XML format for representing a scene in the MuJoCo simulator.
## Getting Started
1. Clone the GitHub repo to your local machine.
2. Open a comman... | 4,816 |
configuration_overview.md | # Scene Optimizer Service
The Scene Optimizer Service uses the [Scene Optimizer Extension](https://docs.omniverse.nvidia.com/prod_extensions/prod_extensions/ext_scene-optimizer.html) (omni.kit.services.scene.optimizer) to optimize USD files to improve performance.
Example use cases for the service:
- **Automated UV g... | 1,438 |
configuring-assets-and-adding-them-to-a-stage_Overview.md | # SimReady Explorer Developer Guide
## Overview
SimReady Assets are the building blocks of industrial virtual worlds. They are built on top of the Universal Scene Description (USD) platform and have accurate physical properties, behaviors, and connected data streams. They are comprised on multiple files such as USD la... | 4,700 |
configuring-rules-with-carbonite-settings_index.md | # Omni Asset Validator (Core)
Validates assets against Omniverse specific rules to ensure they run smoothly across all Omniverse products.
It includes the following components:
- A **rule interface** and **registration mechanism** that can be called from external python modules.
- An **engine** that runs the rules o... | 4,329 |
configuring-the-omni-kit-telemetry-extension_KitTelemetry.md | # Configuring the `omni.kit.telemetry` Extension
## Overview
The `omni.kit.telemetry` extension is responsible for a few major tasks. These largely occur in the background and require no direct interaction from the rest of the app. All of this behavior occurs during the startup of the extension automatically. The maj... | 22,540 |
configuring.md | # Configuration
Kit comes with a very rich and flexible configuration system based on Carbonite settings. Settings is a runtime representation of typical configuration formats (like json, toml, xml), and is basically a nested dictionary of values.
## Quick Start
When you run a kit executable, it doesn’t load any kit... | 15,595 |
containers.md | # Containers
Container is the base class for grouping items. It’s possible to add children to the container with Python’s `with` statement. It’s not possible to reparent items. Instead, it’s necessary to remove the item and recreate a similar item under another parent.
## Transform
Transform is the container that pr... | 1,045 |
content.md | # Repo Overview
## Extensions
During build phase extensions are built (native), staged (copied and linked) into `_build/{platform}/{config}/exts` folder. Custom app (`.kit` file config) is used to enable those extensions.
Each extension is a folder (or zip archive) in the end. You can write user code in python code ... | 3,891 |
contents_index.md | # Omniverse Carbonite SDK
## Omniverse Carbonite SDK
The Omniverse Carbonite SDK is the foundational software layer for Omniverse applications, microservices, tools, plugins, Connectors, and SDKs.
The Omniverse Carbonite SDK provides the following high-level features:
### ABI Stable Interfaces
The core of Carbonite ... | 2,271 |
content_install.md | # 3D Content Pack Installation
For our Omniverse customers who need to run in a firewalled environment, here is how to configure the sample 3D content that comes with the Omniverse foundation applications. As there is currently a total of roughly 260GB of USD samples, materials and environments available, this documen... | 24,603 |
context-menu_Overview.md | # Overview — Omniverse Kit 1.7.8 documentation
## Overview
The layer widget extension provides a widget for viewing and interacting with the USD layers in the local layer stack. By default, the widget displays the current layer prim hierarchy, with one column, namely the prim name.
### Functionality
#### Searching
In... | 1,109 |
contributing.md | # Contributing to the URDF Importer Extension
## Did you find a bug?
- Check in the GitHub Issues if a report for your bug already exists.
- If the bug has not been reported yet, open a new Issue.
- Use a short and descriptive title which contains relevant keywords.
- Write a clear description of the bug.
- Document t... | 1,546 |
contributing_index.md | # Kit C++ Extension Template
## Omniverse Kit C++ Extension Template
This project contains everything necessary to develop extensions that contain C++ code, along with a number of examples demonstrating best practices for creating them.
### What Are Extensions?
While an extension can consist of a single `extension.... | 5,881 |
Controller.md | # Controller Class
The primary interface you can use for interacting with OmniGraph is the `omni.graph.core.Controller`. It is accessible through the main module like this:
```python
import omni.graph.core as og
keys = og.Controller.Keys # Usually handy to keep this name short as it is used often
controller = og.Co... | 45,821 |
Conventions.md | # Conventions
## Naming Conventions
### File And Class Names
Class and file naming is `InterCaps` with the prefix `Ogn`. For example, *OgnMyNode.ogn*, *OgnYourNode.py*, *class OgnMyNode*, and *OgnHerNode.cpp*.
As with regular writing, active phrasing (verb-noun) is preferred over passive phrasing when a node name re... | 26,973 |
ConvertActionGraphNodesToAPI.md | # Converting Action Graph Nodes to IActionGraph
This document describes how to convert Action Graph nodes written using the legacy method of manipulating execution attributes to the currently recommended approach using `omni::graph::action::IActionGraph_abi` introduced in kit-sdk 105.1.
## What Changed
The mechanism... | 3,288 |
coordinate-systems_Overview.md | # Overview — kit-omnigraph 1.109.1 documentation
## Overview
This extension contains the base functionality that is shared by editors of OmniGraph. It is based on `omni.kit.graph.editor.core` and provides base implementations which are intended to be specialized by editor windows for particular graph types.
### Coord... | 1,454 |
core-converter_Overview.md | # Hoops Converter
## Overview
The Hoops Converter extension enables conversion for many common CAD file formats to USD.
USD Explorer includes the Hoops Converter extension enabled by default.
## Supported CAD file formats
The following file formats are supported by Hoops Converter:
- CATIA V5 Files (`*.CATPart, *.C... | 1,442 |
CoreConcepts.md | # Core Concepts
## Graph
The graph comprises two conceptual pieces - the [Authoring Graph](Glossary.html#term-Authoring-Graph) and the [Execution Graph](Glossary.html#term-Execution-Graph). The term is often used to refer to one or both of these graphs, though among users and casual developers it most commonly refers... | 11,926 |
CrashReporter.md | # Carbonite Crash Reporter
## Overview
The crash reporter is intended to catch and handle exceptions and signals that are produced at runtime by any app that loads it. On startup, if configured to do so, the crash reporter will install itself in the background and wait for an unhandled exception or signal to occur. T... | 58,701 |
create-a-material-and-bind-to-world-plane-method-1_Overview.md | # Overview — Omniverse Kit 1.4.2 documentation
## Overview
omni.kit.material.library is library of python functions for materials. Provides simple interface with hydra and neuraylib low level extensions, for creating materials as prims, binding materials to “bindable” prims, material UI, material “Create” menus, mater... | 4,192 |
create-a-material-and-bind-to-world-plane-method-2_Overview.md | # Overview
## Extension
: omni.kit.material.library-1.4.2
## Documentation Generated
: May 08, 2024
## Overview
omni.kit.material.library is library of python functions for materials. Provides simple interface with hydra and neuraylib low level extensions, for creating materials as prims, binding materials to “binda... | 4,292 |
create-a-material-and-modify-created-material_Overview.md | # Overview — Omniverse Kit 1.4.2 documentation
## Overview
omni.kit.material.library is library of python functions for materials. Provides simple interface with hydra and neuraylib low level extensions, for creating materials as prims, binding materials to “bindable” prims, material UI, material “Create” menus, mater... | 1,692 |
create-an-extension_create_from_usd_explorer.md | # Develop a USD Explorer App
## Important
The Omniverse USD Explorer Application is composed of many curated Extensions from Kit SDK. These have been been through quality control to ensure they work together in concert with the specific settings of the USD Explorer Application.
In this tutorial, we encourage develope... | 23,698 |
create.md | # Create a Project
Before development can begin, you must first create a new Project. There are many ways to create an Omniverse Project, and the method you choose depends on what you intend to build and how you prefer to work. Projects tend to align within distinct categories, yet there remains remarkable flexibility... | 11,687 |
create_docs.md | # Document
This document that you are reading was built from files and tools inside the kit-app-template project.
The `.md` and `.toml` files in the `.\docs` directory is the source for this webpage. There’s some images in that directory as well.
Using the same tools - with your own markdown files - you can create d... | 821 |
creating-and-registering-custom-actions_Overview.md | # Overview — Kit Extension Template C++ 1.0.1 documentation
## Overview
An example C++ extension that can be used as a reference/template for creating new extensions.
Demonstrates how to create actions in C++ that can then be executed from either C++ or Python.
See the omni.kit.actions.core extension for extensive d... | 5,368 |
CreatingCppNodes.md | # Creating C++ Nodes
## Setting Up Your Extension
This is a guide to writing a node in C++, including how to set up and structure everything you need in your extension so that the node can be delivered to others in a consistent way. You may already have some of the pieces in place - feel free to skip ahead to just th... | 2,238 |
CreatingPythonNodes.md | # Creating Python Nodes
This is a guide to writing a node in Python, including how to set up and structure everything you need in your extension so that the node can be delivered to others in a consistent way. You may already have some of the pieces in place - feel free to skip ahead to just the parts you will need.
... | 3,161 |
custom-protocol-commands.md | # Custom Protocol Commands — Omniverse Launcher latest documentation
## Custom Protocol Commands
Launcher supports deep linking which allows using custom URLs to point to specific Launcher screens or run various Launcher commands. Deep linking is built on top of custom protocol URLs that start with `omniverse-launche... | 4,154 |
CustomizeTabs.md | # Welcome screen: Customize tabs
Tabs can be specified in `[[settings.app.welcome.page]]` sections.
Here are default tabs:
```toml
[[settings.app.welcome.page]]
text = "Open"
icon = "${omni.kit.welcome.window}/icons/open_inactive.png"
active_icon = "${omni.kit.welcome.window}/icons/open_active.png"
extension_id = "o... | 1,322 |
customizing-the-dialog_Overview.md | # Overview — Omniverse Kit 1.1.12 documentation
## Overview
The file_importer extension provides a standardized dialog for importing files. It is a wrapper around the `FilePickerDialog`, but with reasonable defaults for common settings, so it’s a higher-level entry point to that interface. Nevertheless, users will sti... | 5,936 |
customizing-the-prompt_Overview.md | # Overview
The widget extension provides a simple dialog for prompt. Users have the ability to customize buttons on it.
## Quickstart
```c++
prompt = Prompt("title", "message to user", on_closed_fn=lambda: print("prompt close"))
prompt.show()
```
## Customizing the Prompt
You can customize these parts of t... | 1,766 |
damage-application_structcarb_1_1blast_1_1_blast.md | # carb::blast::Blast
Defined in [Blast.h](#file-blast-h)
## structcarb::blast::Blast
Plugin interface for the omni.blast extension.
### Destructible Authoring Commands
```cpp
const char* ( *combinePrims )( const char* *paths, size_t numPaths, float defaultContactThreshold, const carb::blast::DamageParameters& );
`... | 15,056 |
data-collection-faq.md | # Omniverse Data Collection & Use FAQ
NVIDIA Omniverse Enterprise is a simple to deploy, end-to-end collaboration and true-to-reality simulation platform that fundamentally transforms complex design workflows for organizations of any scale.
In order to improve the product, Omniverse software collects usage and perfor... | 3,159 |
data-files_Overview.md | # Overview
## Overview
In order to effectively test the OmniGraph access to nodes and scripts that are not necessary for the graph to operate correctly. In order to minimize the unnecessary files, yet still have nodes and files explicitly for testing, all of that functionality has been broken out into this extension.
... | 5,263 |
data-types.md | # Data Types — Omniverse Kit 1.140.0 documentation
## Data Types
The Python module `omni.graph.core.types` contains definitions for Python type annotations that correspond to all of the data types used by Omnigraph. The annotation can be used to check that data extracted from the OmniGraph Python APIs for retrieving ... | 14,712 |
debug.md | # Debug a Build
Recognizing the critical role of debugging in development, Omniverse offers tools and automation to streamline and simplify debugging workflows. In combination with third-party tools, Omniverse accelerates bug and anomaly detection, aiming for steady increases in project stability throughout the develo... | 973 |
Debugging.md | # Debugging
When things are not behaving as expected, it is good to start by understanding the topology of the execution graph. As described in the [Graph Concepts](#ef-graph-concepts) section, the execution graph is built of many nested graphs. The framework allows you to visualize a flattened versions of this graph.... | 1,009 |
declarative-syntax_Overview.md | # Overview
## Extension
: omni.ui.scene-1.10.3
## Documentation Generated
: May 08, 2024
### Overview
SceneUI helps build great-looking 3d manipulators and 3d helpers with as little code as possible. It provides shapes and controls for declaring the UI in 3D space.
### Declarative syntax
SceneUI uses declarative sy... | 1,221 |
default-prim-only-mode_Overview.md | # Overview
**Extension** : omni.kit.usd.collect-2.2.21
**Documentation Generated** : May 08, 2024
## Overview
`omni.kit.usd.collect` provides the core API for collecting a USD file with all of its dependencies that are scattered around different locations.
```python
from omni.kit.usd.collect import Collector
...
... | 2,528 |
defining-commands_Overview.md | # Overview
An example C++ extension that can be used as a reference/template for creating new extensions.
Demonstrates how to create commands in C++ that can then be executed from either C++ or Python.
See the omni.kit.commands extension for extensive documentation about commands themselves.
# C++ Usage Examples
#... | 3,990 |
defining-custom-actions_Overview.md | # Overview — Kit Extension Template C++ 1.0.1 documentation
## Overview
An example C++ extension that can be used as a reference/template for creating new extensions.
Demonstrates how to create actions in C++ that can then be executed from either C++ or Python.
See the omni.kit.actions.core extension for extensive d... | 3,680 |
defining-pybind-module_Overview.md | # Overview
An example C++ extension that can be used as a reference/template for creating new extensions.
Demonstrates how to reflect C++ code using pybind11 so that it can be called from Python code.
The IExampleBoundInterface located in `include/omni/example/cpp/pybind/IExampleBoundInterface.h` is:
- Implemented i... | 3,431 |
DefinitionCreation.md | # Definition Creation
This is a practitioner’s guide to using the Execution Framework. Before continuing, it is recommended you first review the Execution Framework Overview along with basic topics such as Graphs Concepts, Pass Concepts, and Execution Concepts.
Definitions in the Execution Framework define the work e... | 10,125 |
definitions.md | # Definitions
- **exact coverage**: the condition that a walk from any leaf chunk to its ancestor root chunk will always encounter exactly one support chunk
- **family**: the memory allocated when an asset is instanced into its initial set of actors, and all descendant actors formed from fracturing the initial set, re... | 790 |
demo-app_Overview.md | # Overview — Omniverse Kit 2.0.24 documentation
## Overview
A set of simple Popup Dialogs for passing user inputs. All of these dialogs subclass from the base PopupDialog, which provides OK and Cancel buttons. The user is able to re-label these buttons as well as associate callbacks that execute upon being clicked.
W... | 3,536 |
Deploying.md | # Deploying a Carbonite Application
Applications developed with the Carbonite SDK will need to redistribute some of its components to function correctly.
The Carbonite package for applications is `carb_sdk+plugins.${platform}` and is distributed via Packman. You can use the Packman search tool to find package version... | 6,611 |
depth-compositing_Overview.md | # Overview
## Introduction
The `omni.kit.scene_view.opengl` module provides an OpenGL drawing backend for `omni.ui.scene`. The usage is the same as `omni.ui.scene` for creating items, the only difference is in how the top-level `SceneView` object is created.
## How to create a simple OpenGLSceneView
### Python
1. ... | 3,413 |
design_manual.md | # WRAPP CLI usage
WRAPP provides a command line tool helping with asset packaging and publishing operations for assets stored in Nucleus servers or file systems. It encourages a structured workflow for defining the content of an asset package, and methods to publish and consume those packages in a version-safe manner.... | 27,202 |
destructible-path-utilities_structcarb_1_1blast_1_1_blast.md | # carb::blast::Blast
Defined in [Blast.h](file_Blast.h)
## Destructible Authoring Commands
```cpp
const char* combinePrims(const char** paths, size_t numPaths, float defaultContactThreshold, const carb::blast::DamageParameters& damageParameters);
```
### DamageParameters
* damageParameters,
* float defaultMaxContact... | 16,416 |
dev-1-2023-12-01_CHANGELOG.md | # [201.1.0-dev.8] - 2024-05-06
## Updated
- OM-123014 - Converters now take absolute usd file output path as input.
# [201.1.0-dev.7] - 2024-04-30
## Updated
- OM-122942 - Refactored to share code in omni.kit.converter.common
# [201.1.0-dev.6] - 2024-04-30
## Updated
- OM-124420 - Renamed cad_core to hoops_core
#... | 3,586 |
develop.md | # Develop a Project
After creating a new Project, the development phase begins. In this phase, you configure and use an assortment of tools and extensions, along with automated documentation features to fit the needs of your project.
## Sidebar
As a reminder, you can find additional documentation in the left-hand me... | 11,704 |
DeveloperReference.md | # Developer Reference
OmniGraph development can be done by users with a wide variety of programming proficiency. A basic familiarity with the Python scripting language is enough to get you started. If you know how to create optimized CUDA code for high throughput machine learning data analysis we’ve got you covered th... | 2,384 |
dgn-converter-config-file-inputs_Overview.md | # Overview — omni.kit.converter.dgn_core 201.1.0-dev.8 documentation
## Overview
```
```plaintext
omni.kit.converter.dgn_core
```
uses the ODA Kernel and Drawings SDKs to convert the DGN data format to USD.
When this extension loads, it will register itself with the CAD Converter service (
```plaintext
omni.services.... | 2,909 |
dgn-converter_Overview.md | # DGN Converter
## Overview
The DGN Converter extension enables conversion for DGN file formats to USD.
USD Explorer includes the DGN Converter extension enabled by default.
## Supported CAD file formats
The following file formats are supported by DGN Converter:
- DGN (`*.DGN`)
> Note: The file formats *.fbx, *.obj,... | 1,913 |
dictionary_settings.md | # Dictionaries and Settings
Settings is a generalized subsystem designed to provide a simple to use interface to Kit’s various subsystems, which can be automated, enumerated, serialized and so on. It is accessible from both C++ and scripting bindings such as Python bindings. `carb.settings` is a Python namespace (and,... | 4,665 |
directories.md | # Directories
- [8fa04669143f4cb0](#dir-0612118555fae677dced868d63781571)
- [8fa04669143f4cb0/_build](#dir-8a2f7be843a233509bb1bc1ed4f4bc15)
- [8fa04669143f4cb0/_build/target-deps](#dir-deb636f69a2bc2a7bceab692952225ef)
- [8fa04669143f4cb0/_build/target-deps/hoops_exchange_cad_converter_release](#dir-1eb887b6b7b0977ac... | 800 |
DirectoryStructure.md | # Directory Structure
It is advantageous to consider nodes as a separate type of thing and structure your directories to make them easier to find. While it’s not required in order to make the build work, it’s recommended in order to keep the location of files consistent.
The standard Kit extension layout has these di... | 2,421 |
dir_8fa04669143f4cb0__build_target-deps.md | # 8fa04669143f4cb0/_build/target-deps
## Directories
- [hoops_exchange_cad_converter_release](dir_8fa04669143f4cb0__build_target-deps_hoops_exchange_cad_converter_release.html#dir-1eb887b6b7b0977ac20ac43bf8332669) | 215 |
dir_8fa04669143f4cb0__build_target-deps_hoops_exchange_cad_converter_release.md | # 8fa04669143f4cb0/_build/target-deps/hoops_exchange_cad_converter_release
## Directories
- [hoops_exchange_cad_converter](dir_8fa04669143f4cb0__build_target-deps_hoops_exchange_cad_converter_release_hoops_exchange_cad_converter.html#dir-ec03f3037ed32d3c17f34b738179950d) | 272 |
documentation_index.md | # Omniverse USD Resolver
This is a USD plugin that allows for working with files in Omniverse
## Documentation
The latest documentation can be found at
## Getting
You can get the latest build from Packman. There are separate packages for each usd flavor, python version, and platform.
They are all named:
omni_usd_... | 3,541 |
documentation_Overview.md | # Overview
This extension is the gold-standard for an extension that contains only OmniGraph Python nodes without a build process to create the generated OmniGraph files. They will be generated at run-time when the extension is enabled.
## The Files
To use this template first copy the entire directory into a locatio... | 6,810 |
DocumentingPython.md | # Documenting
This guide is for developers who write API documentation. To build documentation run:
```bash
repo docs
```
in the repo and you will find the output under `_build/docs/carbonite/latest/`.
## Documenting Python API
The best way to document our Python API is to do so directly in the code. That way it’s alw... | 5,861 |
documenting_exts.md | # Documenting Extensions
This guide is for developers who write API documentation. To build the documentation, run:
```shell
repo.{sh|bat} docs
```
Add the `-o` flag to automatically open the resulting docs in the browser. If multiple projects of documentation are generated, each one will be opened.
Add the `--proj... | 14,798 |
EditHotkey.md | # Edit Hotkey
## Edit Hotkey
Select or mouse hover a row will show. Click to show the edit bar.
Press keyboard to change key binding
Click to change trigger option: On Press or On Release
Click to save changes and exit, including key binding and trigger option
Click to exit without change | 295 |
ef-definition_GraphConcepts.md | # Graph Concepts
This article covers core graph concepts found in EF. Readers are encouraged to review the [Execution Framework Overview](Overview.html#ef-framework) before diving into this article.
,
[Graph Concepts](#ef-graph-concepts),
and
[Pass Concepts](#ef-pass-concepts)
before diving into this article.
Execution Framework (i.e. EF) contains many classes with a... | 20,650 |
ef-framework_Overview.md | # Execution Framework Overview
The Omniverse ecosystem enjoys a bevy of software components (e.g. PhysX, RTX, USD, OmniGraph, etc). These software components can be assembled together to form domain specific applications and services. One of the powerful concepts of the Omniverse ecosystem is that the assembly of thes... | 7,250 |
ef-graph-traversal-guide_GraphTraversalGuide.md | # Graph Traversal Guide
This is a practitioner’s guide to using the Execution Framework. Before continuing, it is recommended you first review the [Execution Framework Overview](#ef-framework) along with basic topics such as [Graphs Concepts](#ef-graph-concepts), [Pass Concepts](#ef-pass-concepts), and [Execution Conc... | 14,974 |
ef-pass-concepts_PassConcepts.md | # Pass Concepts
This article covers core concepts found in EF’s passes/graph transformations. Readers are encouraged to review both the [Execution Framework Overview](Overview.html#ef-framework) and [Graph Concepts](GraphConcepts.html#ef-graph-concepts) before diving into this article.
Now that we understand the unde... | 7,645 |
ef-plugin-creation_PluginCreation.md | # Plugin Creation
This is a practitioner’s guide to using the Execution Framework. Before continuing, it is recommended you first review the Execution Framework Overview along with basic topics such as Graphs Concepts, Pass Concepts, and Execution Concepts.
The Execution Framework is a graph of graphs. EF allows user... | 13,044 |
embedded_kit_python.md | # Embedded Python
## Hello Python
Run `> kit.exe --exec your_script.py` to run your script using **Kit** Python.
## Using system Python
When the Python interpreter is initialized, system-defined environment variables (like `PYTHONHOME`, `PYTHONPATH`) are ignored. Instead, the following setting is used for python home... | 6,549 |
enabling-the-extension_overview.md | # Overview
## Overview
Viewport Next is a preview of the next generation of Kit’s Viewport. It was designed to be as light as possible, providing a way to isolate features and compose them as needed to create unique experiences.
This documentation will walk through a few simple examples using this technology, as well... | 3,732 |
enterprise-install.md | # Enterprise Install Guide
## Licensing
Need walkthrough steps on setting up your Omniverse Enterprise account and getting your licenses in order? Review the Omniverse Enterprise Licensing Quick Start Guide for more information.
## Enterprise Nucleus Server
The following documentation is available to help you properl... | 1,872 |
ErrorHandling.md | # Error Handling
This document outlines the how the Execution Framework (i.e. EF) handles errors. EF errors fit into one of the following broad categories:
- Memory allocation errors.
- Invalid pointers passed to the API.
- Unmet API preconditions.
- Failure to build the execution graph.
- Failure to execute.
- Fail... | 11,433 |
event_streams.md | # Event streams
## API/design overview
The singleton `IEvents` interface is used to create `IEventStream` objects. Whenever an event is being pushed into an event stream, the **immediate** callback is triggered, and the event stream stores the event in the internal event queue. Then, events can be popped from the que... | 5,504 |
example-multiple-projects-in-a-repo_index.md | # Example: Multiple Projects in a Repo
This is an example of a nested documentation project. This project was defined as follows in `repo.toml`:
```toml
[repo_docs.projects.nested-project]
# example-begin version_selector_enabled
version_selector_enabled = false
# example-end version_selector_enabled
name_in_nav_bar... | 1,266 |
example-project-with-extra-builds_index.md | # Example: Project with Extra Builds
This is an example of a project (i.e. “project-with-extra-builds” in `repo.toml`) that defines multiple builds.
The project defines two builds:
- public
- internal
```toml
# this defines the "public" build
[repo_docs.projects.project-with-extra-builds]
docs_root = "examples/proje... | 1,758 |
Example.md | # Examples
## Simplified submenu creation with build_submenu_dict
This creates a dictionary of lists from the `name` paths in MenuItemDescription, expanding the path and creating (multiple, if required) sub_menu lists. The last item on the path is assumed to be not a sub_menu item.
```python
menu_dict = omni.kit.men... | 5,512 |
example.python_ext.HelloPythonExtension.md | # HelloPythonExtension
## HelloPythonExtension
```
class example.python_ext.HelloPythonExtension
```
Bases:
```
omni.ext._extensions.IExt
```
### Methods
| Method | Description |
| ------ | ----------- |
| `on_shutdown()` | |
| `on_startup(ext_id)` | |
```
def __init__(self: omni.ext._extensions.IExt) -> None
`... | 326 |
example.python_ext.md | # example.python_ext
## Submodules
Summary:
| Module | Description |
|--------|-------------|
| example.python_ext.python_ext | No submodule docstring provided |
## Classes
Summary:
| Class | Description |
|-------|-------------|
| HelloPythonExtension | |
## Functions
Summary:
| Function | Description |
|------... | 367 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.