file_path
stringlengths 21
202
| content
stringlengths 19
1.02M
| size
int64 19
1.02M
| lang
stringclasses 8
values | avg_line_length
float64 5.88
100
| max_line_length
int64 12
993
| alphanum_fraction
float64 0.27
0.93
|
|---|---|---|---|---|---|---|
NVIDIA-Omniverse/kit-workshop-siggraph2022/exts/omni.example.ui_scene.manipulator_tool/Workshop/Siggraph2022_Manipulator_Tools_Workshop.md |
# NVIDIA OMNIVERSE
# How to Build Custom 3D Scene Manipulator Tools on NVIDIA Omniverse
See how you can build advanced tools on the modular, easily extensible Omniverse platform. You’ll learn from the Omniverse developer ecosystem team how you can extend and enhance the 3D tools you know and love today.
# Learning Objectives
- Enable Extension
- Attach `scale` function to Slider Widget
<video width="560" height="315" controls>
<source src="https://d36m44n9vdbmda.cloudfront.net/assets/x-ov-06-v1/sceneManipulatorIntro.mp4" type="video/mp4">
</video>
# UI Scene_Widget Info
## Section I
<video width="560" height="315" controls>
<source src="https://d36m44n9vdbmda.cloudfront.net/assets/x-ov-06-v1/sceneManipulator1.mp4" type="video/mp4">
</video>
### Step 1: Open the Workshop Stage
#### <b>Step 1.1: Download the Stage from the Link Provided</b>
[Stage Link](https://dli-lms.s3.amazonaws.com/assets/x-ov-06-v1/Stage.zip)
#### <b> Step 1.2: Unzip Stage Using Extract All...
This creates an unzipped file folder called `Stage`.
#### <b> Step 1.3: Open Stage in Omniverse
Navigate inside Omniverse Code's `Content tab` to the stage file's location on your system.
(i.e. C:/Users/yourName/Downloads/Stage)
**Double Click** `Stage.usd` in the center window pane of the `Content tab` at the bottom of the Omniverse Code Console and it will appear in the viewport.
### Step 2: Install the Widget Extension
#### <b>Step 2.1: Open the Extensions Tab</b>
Click on `Extensions` Manager Tab
#### <b>Step 2.2: Filter by Community / Third Party Extensions</b>
Select `Community / Third Party` tab
<br>
<br>
#### <b>Step 2.3: Search for Widget Info</b>
Search for `Widget Info` and click on `Omni UI Scene Object Info With Widget Example`
#### <b>Step 2.4: Install/Enable the Extension</b>
Click on the extension and then click `Install` in the right console. Once installed, enable the extension.
><span>❗</span> You may get a warning that this extension is not verified. It is safe to install this extension.
<br>
#### <b>Step 2.5: Check that the Widget is Working</b>
Navigate to `Viewport` then select a `prim` in the hierarchy.
A `prim` is short for primitive. The prim is the fundamental unit in Omniverse. Anything imported or created in a `USD`, Universal Scene Description, scene. This includes camera, sounds, lights, meshes, etc.
You should see the following widget appear in the viewport above the `prim`:
<br>
<br>
><span>❓</span> Did you notice?
>- The path of the prim is displayed in the widget.
>- There is a scale slider in the widget but it doesn't work! We will fix this in the next section.
<br>
#### <b>Step 3: Find the Play Button</b>
Locate the `Play` button in the viewport and see what happens when you click it! Don't forget to hit the `Stop` button when you are finished.
<details>
<summary>Click here to see where the button is located </summary>
</details>
<br>
>#### <span>🧠</span><b>Challenge Step 4: Brainstorm Use Cases</b>
><i>All Challenges in this workshop are optional</i>
>
>Think of 3 ways a widget could be used. For example, you noticed that the path of the prim is displayed, what else could you display about the prim in the widget? Brain storm with your peers and think of how it can be used for your industry! We will have a group discussion about this later on.
<br>
<br>
>### <span>⛔</span> Stop here and wait to move on to Section II
<br>
## Section II
<video width="560" height="315" controls>
<source src="https://d36m44n9vdbmda.cloudfront.net/assets/x-ov-06-v1/sceneManipulator2Intro.mp4" type="video/mp4">
</video>
<video width="560" height="315" controls>
<source src="https://d36m44n9vdbmda.cloudfront.net/assets/x-ov-06-v1/sceneManipulator2.mp4" type="video/mp4">
</video>
### Step 5: Find your Work Files
#### <b>Step 5.1: Open Visual Studio</b>
Go to the `Extensions` tab.
Click the `Widget Info` extension to open the extension overview to the right.
Click the `VS Code` icon next to the folder icon:
<br>
<br>
`VS Code` will pop up separately and look like this:
<br>
#### <b>Step 5.2: Locate Manipulator Script</b>
Locate the files you need for this session in the left column drop-down menus at:
`exts -> omni.example.ui_scene.widget_info\omni\example\ui_scene\widget_info`
You are working in
`widget_info_manipulator.py`
<br>
<br>
### Step 6: Fix the Broken Slider
>#### Step 6.1: Add a New Import
Locate the `imports` at the top of the script.
Add the new import:
```python
from pxr import Gf
```
The imports will now look like this:
<br>
In the following steps, you will use `Graphics Foundation`, or Gf, which is a package of fundamental graphics types and operations.
#### <b>Step 6.2: Find the Function Update_Scale</b>
Locate the following function at the bottom of the script:
```python
# Update the slider
def update_scale(prim_name, value):
```
This function updates the slider in the Widget. However, it currently does not have any logic to update the scale. Let's start adding the code we need to get that working!
#### <b>Step 6.3: Get the Current Stage</b>
Inside of `update_scale` function, find the `print` call.
Define the `stage` variable underneath this call, like so:
```python
stage = self.model.usd_context.get_stage()
```
From the USD context we grab the active stage and store it into the stage variable.
The `Stage` is where your prims are nested in the hierarchy.
So now, `update_scale` should look like this:
<br>
><span>❗</span> Make sure your new stage variable is lined up with the print call. If it is not, add or delete tabs until it is.
<br>
#### <b>Step 6.4: Get the Selected Prim</b>
Next, add a variable underneath the stage variable for the currently selected prim:
```python
prim = stage.GetPrimAtPath(self.model._current_path)
```
`update_scale` will now look like this:
><span>❗</span> This prim variable should be lined up with the stage and print call above it.
<br>
#### <b>Step 6.5: Update the Scale </b>
Add a new scale variable on the next line.
In this variable you will get the scale `attribute` of the `xform` and the scale's Vector3 value, like so:
```python
scale = prim.GetAttribute("xformOp:scale")
scale.Set(Gf.Vec3d(value, value, value))
```
Now, your completed `update_scale` function will look like this:
><span>❗</span>The scale variable should be lined up with the variables above it.
<br>
### Step 7: Did it work?
#### <b>Step 7.1: Save and Test! </b>
Save your manipulator script and check that the scale slider works in your widget!
><span>❗</span> When you save, you may notice that the widget disappears in the viewport. This is to be expected, click the prim again to show the widget.
Your slider is now being udpated by the function `update_scale`, where you added properties that grab the `Stage` and the currently selected `prim` that the widget is displayed on, then calls the scale vector3 when the slider is moved to scale the prim in all directions.
><span>❗</span> Not Working? Check the `Console` to debug any errors.
>
>
<br>
>#### :bell:<b>Challenge Step 8: Scale Larger</b>
><i>All Challenges in this workshop are optional</i>
>
>Can you change the function to scale the prim larger than 1.0?
>
><details>
><summary> Click here for the answer </summary>
>
>Set a `value` variable and multiply a number by value.
>
>For example:
>
>```python
> def update_scale(prim_name, value):
> if value <= 0:
> value = 0.01
> print(f"changing scale of {prim_name}, {value}")
> ## NEW VALUE VARIABLE ADDED BELOW
> value = 10*value
> stage = self.model.usd_context.get_stage()
> prim = stage.GetPrimAtPath(self.model._current_path)
> scale = prim.GetAttribute("xformOp:scale")
> scale.Set(Gf.Vec3d(value, value, value))
> if self._slider_model:
> self._slider_subscription = None
> self._slider_model.as_float = 1.0
> self._slider_subscription = self._slider_model.subscribe_value_changed_fn(
> lambda m, p=self.model.get_item("name"): update_scale(p, m.as_float)
> )
>```
>
></details>
<br>
>#### <span>🧠</span><b>Challenge Step 9: What other properties might you want to control with the widget?</b>
><i>All Challenges in this workshop are optional</i>
>
> Brainstorm 3-5 other properties that you could add to this widget. We will have an open discussion later on.
<br>
>### <span>⛔</span> Stop here and wait to move on to Section III
<br>
## Section III:
<video width="560" height="315" controls>
<source src="https://d36m44n9vdbmda.cloudfront.net/assets/x-ov-06-v1/sceneManipulator3.mp4" type="video/mp4">
</video>
### Step 10: Create your scene
#### <b>Step 10.1: Scale Everything!</b>
Play around in your scene and scale the prims in various sizes, such as a very large marble or a tiny jar.
How can you make your scene unique?
><span>⭐</span> Press the `Play` button when you are finished!
>
>
<br>
<br>
>#### <span>🧠</span><b>Challenge Step 11: Scale in One Axis</b>
><i>All Challenges in this workshop are optional</i>
>
>Can you change the function to scale the prim in only one axis?
>
><details>
><summary> Click here for the answer </summary>
>
>Change the value's to 1 in `scale.Set(Gf.Vec3d(value,value,value))` of the axes that you do not want to scale in.
>
>For example:
>
>```python
>scale.Set(Gf.Vec3d(value,1,1))
>```
>
>Which, would change the scale in the X axis as the Y and Z axis will remain at a value of 1 and the X axis will change.
>
></details>
<br>
>#### <span>🧠</span><b>Challenge Step 12: Turn on the Light Manipulator</b>
><i>All Challenges in this workshop are optional</i>
>
>Turn on the Light Manipulator Extension and click on the Rect Light.
>
>How can you change the intensity of the light using the tool?
>
><details>
><summary>Click here for the answer</summary>
>
>In the `Extensions` tab, search for Light in the `Community / Third Party` and install/enable the `Omni.Ui Scene Sample for Manipulating Select Light` extension.
>
>
>
><br>
>
>Select one of the Rect Lights in the hierarchy.
>
>
>
><br>
>
>Use your cursor to grab the edges of the Light tool and change the intensity by dragging forward or backward.
>
>
>
></details>
<br>
## Congratulations!
You have completed this workshop! We hope you have enjoyed learning and playing with Omniverse!
[Join us on Discord to extend the conversation!](https://discord.com/invite/nvidiaomniverse)
| 13,812 | Markdown | 33.5325 | 295 | 0.72437 |
NVIDIA-Omniverse/deep-dive-into-microservices/README.md | # Companion Code to *A Deep Dive into Building Microservices with Omniverse*
This companion code project contains the resources developed during the [*Deep Dive into Building Microservices with Omniverse*](https://www.nvidia.com/en-us/on-demand/session/gtcfall21-a31204/) session presented during GTC November 2021.
While there is no better way to learn that to jump in an try writing your own microservice from the sample template for Kit extensions, we also know that having an example to get started can be a valuable resource. Our hope is that these sample extensions, along with the background information of the GTC session, will fast-forward you on your development journey in Omniverse.
[](https://www.nvidia.com/en-us/on-demand/session/gtcfall21-a31204/)
Let us know about what this inspired you to create! [We'd love to hear from you!](https://forums.developer.nvidia.com/c/omniverse/showcase/362)
## About
This project contains the 2 extensions created during the conversation on microservices, which serve as a demonstration of the flexibility of this architecture.
Using the example of a 3D asset pipeline, these extensions illustrate the scalability and reusability of loosely coupled components by:
1. **Creating a microservice to validate conformity of a USD scene.** This illustrates how a studio may scale and distribute automated tasks, allowing creators to focus on doing what they excel at, and relieve them from manual tasks.
2. **Exposing a microservice to convert 3D assets from one format to another.** Independently from the previous microservice, this service can be configured to be as broad or as narrow as necessary to adapt to the needs a studio may have. Separate teams could even reuse and deploy the microservice to serve their unique needs: while artists may need UI integrated into their favorite content creation tools, pipeline developers may also automate the batch import of content shared by partners.
3. **Assembling both services together and recording the status of conversion tasks.** By storing the result of conversion tasks in a database, one can imagine evolving this simple pipeline into an automated system exposing a dashboard where artists could monitor the status of their conversions tasks processing in the background, or adding features such as notifications when a task is completed.
## Configuration
To get started:
1. Download a copy of this repository to your machine.
2. From the [Omniverse Launcher](https://www.nvidia.com/en-us/omniverse), download *Create* and *Farm Queue*.
To load this project in *Create* (or any *Omniverse Kit*-based application such as *View*, *Machinima* or *Isaac Sim*), add a link from this repository to the application using the provided `link_app` script:
**On Windows:**
```batch
link_app.bat C:/Users/<username>/AppData/Local/ov/pkg/create-2021.3.7
```
**On Linux:**
```bash
./link_app.sh ~/.local/share/ov/pkg/create-2021.3.7
```
If the operation completed successfully, an *./app* folder should appear, linking the root of this repository to the install location of the Kit-based application from the Omniverse Launcher.
## Executing the sample
Once configured, this sample project can be executed by launching an instance of Create or any Kit-based application, and submitting a task to the endpoint exposed by the `omni.service.assets.convert` service.
**On Windows:**
```batch
REM Launch Create, with the extension enabled:
app/omni.create.bat ^
--ext-folder C:\Users\<username>\AppData\Local\ov\pkg\farm-queue-102.1.0\exts-farm-queue ^
--ext-folder ./exts ^
--enable omni.services.assets.convert
```
**On Linux:**
```shell
# Launch Create, with the extension enabled:
./app/omni.create.sh \
--ext-folder ~/.local/share/ov/pkg/farm-queue-102.1.0/exts-farm-queue \
--ext-folder ./exts \
--enable omni.services.assets.convert
```
Once the application is launched, a conversion task can be submitted to the service by using the web interface listing all the exposed microservices. This interactive interface is exposed at the following location:
* For *Kit*: http://localhost:8011/docs
* For *Create*: http://localhost:8111/docs
* For *Isaac Sim*: http://localhost:8211/docs
## Additional resources
* [Presentation slides](https://drive.google.com/file/d/1lThTzjQqnGOgVE6GddwKhsl_f4f1vVsm/view?usp=sharing)
* [NVIDIA Omniverse Platform](https://developer.nvidia.com/nvidia-omniverse-platform)
* [NVIDIA Omniverse Developer Resource Center](https://developer.nvidia.com/nvidia-omniverse-developer-resource-center)
* *Getting started* documentation:
* [NVIDIA Omniverse Microservices](https://docs.omniverse.nvidia.com/services)
* [NVIDIA Omniverse Farm](https://docs.omniverse.nvidia.com/farm)
| 4,887 | Markdown | 64.173332 | 495 | 0.777369 |
NVIDIA-Omniverse/deep-dive-into-microservices/tools/scripts/link_app.py | # Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
import argparse
import os
import packmanapi
if __name__ == "__main__":
parser = argparse.ArgumentParser(description="Create folder link to Kit App installed from Omniverse Launcher.")
parser.add_argument(
"path",
help="Path to Kit App installed from Omniverse Launcher, e.g.: 'C:/Users/bob/AppData/Local/ov/pkg/create-2021.3.4'",
)
args = parser.parse_args()
if not os.path.exists(args.path):
print(f"Provided path doesn't exist: \"{args.path}\"")
else:
SCRIPT_ROOT = os.path.dirname(os.path.realpath(__file__))
packmanapi.link(f"{SCRIPT_ROOT}/../../app", args.path)
| 1,062 | Python | 36.964284 | 124 | 0.711864 |
NVIDIA-Omniverse/deep-dive-into-microservices/exts/omni.services.assets.convert/config/extension.toml | [package]
version = "1.0.0"
title = "Asset conversion service"
description = "A simple demonstration of an asset conversion microservice."
authors = ["Omniverse Kit Team"]
preview_image = "data/preview_image.png"
readme = "docs/README.md"
changelog = "docs/CHANGELOG.md"
repository = ""
category = "Example"
keywords = ["kit", "service", "asset", "conversion", "example"]
[dependencies]
"omni.client" = {}
"omni.kit.asset_converter" = {}
"omni.kit.pip_archive" = {}
"omni.services.assets.validate" = {}
"omni.services.core" = {}
"omni.services.facilities.database.manager" = {}
# The main Python module this extension provides, it will be publicly available as
# "import omni.services.assets.convert":
[[python.module]]
name = "omni.services.assets.convert"
[settings.exts."omni.services.assets.convert"]
# URL prefix where the conversion service will be mounted:
url_prefix = "/assets"
# Database settings, using an SQLite database for demonstration purposes:
[settings.exts."omni.services.assets.convert".dbs.asset-conversions]
connection_string = "sqlite:///${data}/asset-conversions.db"
| 1,095 | TOML | 32.21212 | 82 | 0.73516 |
NVIDIA-Omniverse/deep-dive-into-microservices/exts/omni.services.assets.convert/omni/services/assets/convert/extension.py | # Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
import asyncio
import carb
import omni.ext
from omni.services.core import main
from omni.services.facilities.database.manager import DatabaseManagerFacility
from .services import router
class AssetConversionServiceExtension(omni.ext.IExt):
"""Asset conversion extension."""
def on_startup(self, ext_id) -> None:
ext_name = ext_id.split("-")[0]
url_prefix = carb.settings.get_settings_interface().get(f"exts/{ext_name}/url_prefix")
# Setup the database facility:
self._database_facility = DatabaseManagerFacility(ext_name=ext_name)
self._db_ready = asyncio.ensure_future(self._initialize_db())
# Register the database facility with the router, so it can be used by service endpoints:
router.register_facility("db_manager", self._database_facility)
main.register_router(router=router, prefix=url_prefix, tags=["Assets"])
main.get_app().title = "Omniverse Farm"
main.get_app().description = "A microservice-based framework for distributed task execution."
tags_metadata = {
"name": "Assets",
"description": "Manage assets submitted to the Queue."
}
if not main.get_app().openapi_tags:
main.get_app().openapi_tags = []
main.get_app().openapi_tags.append(tags_metadata)
def on_shutdown(self) -> None:
if self._db_ready:
self._db_ready.cancel()
self._db_ready = None
main.deregister_router(router=router)
async def _initialize_db(self) -> None:
"""Initialize the database to be used to store asset conversion results."""
async with self._database_facility.get("asset-conversions") as db:
table_columns = [
"id INTEGER PRIMARY KEY AUTOINCREMENT",
"source_asset VARCHAR(256) NOT NULL",
"destination_asset VARCHAR(256) NOT NULL",
"success BOOLEAN NOT NULL",
]
await db.execute(query=f"CREATE TABLE IF NOT EXISTS AssetConversions ({', '.join(table_columns)});")
| 2,511 | Python | 39.516128 | 112 | 0.66826 |
NVIDIA-Omniverse/deep-dive-into-microservices/exts/omni.services.assets.convert/omni/services/assets/convert/services/convert.py | # Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
from typing import Dict
from pydantic import BaseModel, Field
from omni.services.client import AsyncClient
from omni.services.core import routers
import omni.usd
router = routers.ServiceAPIRouter()
class ConversionRequestModel(BaseModel):
"""Model describing the request to convert a given asset to a different format."""
import_path: str = Field(
...,
title="Path of the source asset to be converted",
description="Location where the asset to convert can be located by an Agent.",
)
output_path: str = Field(
...,
title="Output path where to store the converted asset",
description="Location where to place the converted asset.",
)
converter_settings: Dict = Field(
{},
title="Converter settings",
description="Settings to provide to the Kit Asset Converter extension in order to perform the conversion.",
)
class ConversionResponseModel(BaseModel):
"""Model describing the response to the request to convert a given USD asset."""
status: str = Field(
...,
title="Conversion status",
description="Status of the conversion of the given asset.",
)
@router.post(
path="/convert",
summary="Convert assets to a different format",
description="Convert the given asset into a different format.",
response_model=ConversionResponseModel,
)
@router.post("/convert")
async def run(
req: ConversionRequestModel,
db_manager=router.get_facility("db_manager"),
) -> ConversionResponseModel:
# Convert the given asset:
task = omni.kit.asset_converter.get_instance().create_converter_task(
import_path=req.import_path,
output_path=req.output_path,
progress_callback=lambda current, total: print(f"Conversion progress: {current/total*100.0}%"),
asset_converter_context=req.converter_settings,)
success = await task.wait_until_finished()
if not success:
detailed_status_code = task.get_status()
detailed_status_error_string = task.get_detailed_error()
raise Exception(f"Failed to convert \"{req.import_path}\". Error: {detailed_status_code}, {detailed_status_error_string}")
# Execute the validation service exposed by the "omni.service.assets.validate" extension:
client = AsyncClient("local://")
validation_result = await client.assets.validate(
scene_path=req.import_path,
expected_camera_count=5,
)
# Record the result of the validation in the database:
query = """
INSERT INTO AssetConversions (source_asset, destination_asset, success)
VALUES (:source_asset, :destination_asset, :success)
"""
values = {
"source_asset": req.import_path,
"destination_asset": req.output_path,
"success": 1 if validation_result["success"] else 0,
}
async with db_manager.get("asset-conversions") as db:
await db.execute(query=query, values=values)
return ConversionResponseModel(status="finished")
| 3,449 | Python | 35.315789 | 130 | 0.696724 |
NVIDIA-Omniverse/deep-dive-into-microservices/exts/omni.services.assets.convert/docs/CHANGELOG.md | # Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.0.0] - 2021-11-10
### Added
- Initial release for GTC November 2021.
| 328 | Markdown | 31.899997 | 168 | 0.728659 |
NVIDIA-Omniverse/deep-dive-into-microservices/exts/omni.services.assets.convert/docs/README.md | # Asset Conversion Service [omni.services.assets.convert]
## About
A simple extension demonstrating writing a microservice to convert assets using Omniverse Kit-based applications.
## Usage
Once enabled, the extension will expose a `/assets/convert` service endpoint, which can be explored from the list of available microservice endpoints exposed by the application:
* For *Kit*: http://localhost:8011/docs
* For *Create*: http://localhost:8111/docs
* For *Isaac Sim*: http://localhost:8211/docs
## Running the extension
To enable and execute the extension, from the root of the repository:
**On Windows:**
```batch
REM Link the extension against a Kit-based application from the Launcher:
link_app.bat C:/Users/<username>/AppData/Local/ov/pkg/create-2021.3.7
REM Launch Create, with the extension enabled:
app/omni.create.bat ^
--ext-folder C:\Users\<username>\AppData\Local\ov\pkg\farm-queue-102.1.0\exts-farm-queue ^
--ext-folder ./exts ^
--enable omni.services.assets.convert
```
**On Linux:**
```shell
# Link the extension against a Kit-based application from the Launcher:
./link_app.sh ~/.local/share/ov/pkg/create-2021.3.7
# Launch Create, with the extension enabled:
./app/omni.create.sh \
--ext-folder ~/.local/share/ov/pkg/farm-queue-102.1.0/exts-farm-queue \
--ext-folder ./exts \
--enable omni.services.assets.convert
```
To launch this small demo pipeline, all that remains is integrating some UI components to let Users submit tasks to the service, or start one from the command-line:
```shell
curl -X 'POST' \
'http://localhost:8011/assets/convert' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"import_path": "/full/path/to/source_content.usd",
"output_path": "/full/path/to/destination_content.obj",
"converter_settings": {}
}'
```
| 1,836 | Markdown | 32.399999 | 177 | 0.724401 |
NVIDIA-Omniverse/deep-dive-into-microservices/exts/omni.services.assets.validate/config/extension.toml | [package]
version = "1.0.0"
title = "Asset validation service"
description = "A simple demonstration of an asset validation microservice."
authors = ["Omniverse Kit Team"]
preview_image = "data/preview_image.png"
readme = "docs/README.md"
changelog = "docs/CHANGELOG.md"
repository = ""
category = "Example"
keywords = ["kit", "service", "asset", "validation", "example"]
[dependencies]
"omni.services.core" = {}
"omni.usd" = {}
# The main Python module this extension provides, it will be publicly available as
# "import omni.services.assets.validate":
[[python.module]]
name = "omni.services.assets.validate"
[settings.exts."omni.services.assets.validate"]
# URL prefix where the validation service will be mounted:
url_prefix = "/assets"
| 744 | TOML | 28.799999 | 82 | 0.729839 |
NVIDIA-Omniverse/deep-dive-into-microservices/exts/omni.services.assets.validate/omni/services/assets/validate/extension.py | # Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
import carb
import omni.ext
from omni.services.core import main
from .services import router
class AssetValidationServiceExtension(omni.ext.IExt):
"""Asset validation extension."""
def on_startup(self, ext_id) -> None:
ext_name = ext_id.split("-")[0]
url_prefix = carb.settings.get_settings_interface().get(f"exts/{ext_name}/url_prefix")
main.register_router(router=router, prefix=url_prefix, tags=["Assets"])
main.get_app().title = "Omniverse Farm"
main.get_app().description = "A microservice-based framework for distributed task execution."
tags_metadata = {
"name": "Assets",
"description": "Manage assets submitted to the Queue."
}
if not main.get_app().openapi_tags:
main.get_app().openapi_tags = []
main.get_app().openapi_tags.append(tags_metadata)
def on_shutdown(self) -> None:
main.deregister_router(router=router)
| 1,388 | Python | 35.552631 | 101 | 0.693804 |
NVIDIA-Omniverse/deep-dive-into-microservices/exts/omni.services.assets.validate/omni/services/assets/validate/services/validate.py | # Copyright (c) 2021, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
import asyncio
from typing import List, Optional
from pxr import UsdGeom
from pydantic import BaseModel, Field
import carb
from omni.services.core import routers
import omni.usd
router = routers.ServiceAPIRouter()
class ValidationRequestModel(BaseModel):
"""Model describing the request to validate a given USD stage."""
scene_path: str = Field(
...,
title="USD scene path",
description="Full path to the USD scene to validate, hosted on a location accessible to the Agent.",
)
expected_camera_count: int = Field(
...,
title="Expected number of cameras",
description="Expected number of cameras to find in the scene.",
)
class ValidationResponsetModel(BaseModel):
"""Model describing the response to the request to validate a given USD stage."""
success: bool = Field(
...,
title="Success",
description="Flag indicating if the validation was successful.",
)
actual_camera_count: int = Field(
...,
title="Number of cameras found",
description="Actual number of cameras found in the scene.",
)
async def load_usd_stage(usd_file: str, stage_load_timeout: Optional[float] = None) -> bool:
"""
Load the given USD stage into the Kit runtime.
Args:
usd_file (str): Location of the stage to open.
stage_load_timeout (Optional[float]): Maximum duration for which to wait before considering a loading timeout.
Returns:
bool: A flag indicating whether or not the given USD stage was successfully loaded.
"""
success, error = await omni.usd.get_context().open_stage_async(usd_file)
if not success:
carb.log_error(f"Unable to open \"{usd_file}\": {str(error)}")
raise Exception(f"Unable to open \"{usd_file}\".")
carb.log_info("Stage opened. Waiting for \"ASSETS_LOADED\" event.")
usd_context = omni.usd.get_context()
if usd_context.get_stage_state() != omni.usd.StageState.OPENED:
while True:
try:
event, _ = await asyncio.wait_for(usd_context.next_stage_event_async(), timeout=stage_load_timeout)
if event == int(omni.usd.StageEventType.ASSETS_LOADED):
carb.log_info(f"Assets for \"{usd_file}\" loaded")
return True
except asyncio.TimeoutError:
_, files_loaded, total_files = usd_context.get_stage_loading_status()
if files_loaded == total_files:
carb.log_warn("Timed out waiting for \"ASSETS_LOADED\" event but all files seem to have loaded.")
return False
raise Exception(f"Timed out waiting for \"ASSETS_LOADED\" event for \"{usd_file}\". Aborting.")
def get_all_stage_cameras() -> List[UsdGeom.Camera]:
"""
Return the list of all USD cameras found the current USD stage.
Args:
None
Returns:
List[UsdGeom.Camera]: The list of all USD cameras found in the current USD stage.
"""
cameras: List[UsdGeom.Camera] = []
stage = omni.usd.get_context().get_stage()
for prim in stage.TraverseAll():
if prim.IsA(UsdGeom.Camera):
cameras.append(UsdGeom.Camera(prim))
return cameras
@router.post(
path="/validate",
summary="Validate assets for conformity",
description="Validate that the USD Stage at the given location conforms to pre-determined validation rules.",
response_model=ValidationResponsetModel,
)
async def run(req: ValidationRequestModel) -> ValidationResponsetModel:
# Load the USD stage:
await load_usd_stage(usd_file=req.scene_path)
# Perform the validation.
#
# NOTE: For demonstration purposes, we are only considering the number of cameras present in the given USD scene to
# demonstrate integration with tools and workflows.
stage_cameras = get_all_stage_cameras()
camera_count = len(stage_cameras)
validation_success = camera_count == req.expected_camera_count
# Return the validation results:
return ValidationResponsetModel(
success=validation_success,
actual_camera_count=camera_count,
)
| 4,606 | Python | 34.167939 | 119 | 0.668693 |
NVIDIA-Omniverse/deep-dive-into-microservices/exts/omni.services.assets.validate/docs/README.md | # Asset Validation Service [omni.services.assets.validate]
## About
A simple extension demonstrating writing a microservice to validate assets using Omniverse Kit-based applications.
## Usage
Once enabled, the extension will expose a `/assets/validate` service endpoint, which can be explored from the list of available microservice endpoints exposed by the application:
* For *Kit*: http://localhost:8011/docs
* For *Create*: http://localhost:8111/docs
* For *Isaac Sim*: http://localhost:8211/docs
## Running the extension
To enable and execute the extension, from the root of the repository:
**On Windows:**
```batch
REM Link the extension against a Kit-based application from the Launcher:
link_app.bat C:/Users/<username>/AppData/Local/ov/pkg/create-2021.3.7
REM Launch Create, with the extension enabled:
app/omni.create.bat ^
--ext-folder ./exts ^
--enable omni.services.assets.validate
```
**On Linux:**
```shell
# Link the extension against a Kit-based application from the Launcher:
./link_app.sh ~/.local/share/ov/pkg/create-2021.3.7
# Launch Create, with the extension enabled:
./app/omni.create.sh \
--ext-folder ./exts \
--enable omni.services.assets.validate
```
| 1,208 | Markdown | 29.224999 | 178 | 0.741722 |
NVIDIA-Omniverse/kit-extension-sample-csv-reader/README.md | # CSV Reader Extension Sample
## [CSV Reader (omni.csv.reader)](exts/omni.csv.reader)
### About
This sample extension presents, as a CSV reader extension, how to read a csv file, to populate a 3D scene with prims at X, Y, Z coordinates given by the CSV file data, as well as color(s). Generated prims rely on USD referencing.
### [README](exts/omni.csv.reader)
See the [README for this extension](exts/omni.csv.reader) to learn more about it including how to use it.
### [Tutorial](tutorial/tutorial.md)
Follow a [step-by-step tutorial](tutorial/tutorial.md) that walks you through the creation of `generate()` to open, read and populate the 3D scene, grouping objects by cluster or not, and with different colors.
## Adding This Extension
To add this extension to your Omniverse app:
1. Go into: Extension Manager -> Gear Icon -> Extension Search Path
2. Add this as a search path: `git://github.com/NVIDIA-Omniverse/kit-extension-sample-csv-reader?branch=main&dir=exts`
## Linking with an Omniverse app
For a better developer experience, it is recommended to create a folder link named `app` to the *Omniverse Kit* app installed from *Omniverse Launcher*. A convenience script to use is included.
Run:
```bash
> link_app.bat
```
There is also an analogous `link_app.sh` for Linux. If successful you should see `app` folder link in the root of this repo.
If multiple Omniverse apps is installed script will select recommended one. Or you can explicitly pass an app:
```bash
> link_app.bat --app code
```
You can also just pass a path to create link to:
```bash
> link_app.bat --path "C:/Users/bob/AppData/Local/ov/pkg/create-2022.1.3"
```
## Contributing
The source code for this repository is provided as-is and we are not accepting outside contributions.
| 1,863 | Markdown | 35.549019 | 229 | 0.749866 |
NVIDIA-Omniverse/kit-extension-sample-csv-reader/tutorial/tutorial.md | 
# Create a CVS Reader Omniverse Kit Extension
**CSV** File, or **C**omma **S**eparated **V**alues, is the simplest form for storing data/information separated by commas. You can learn more about them in this [Wikipedia article](https://en.wikipedia.org/wiki/Comma-separated_values).
CSV files are commonly used to exchange data of various type and are broadly used. For example, you code CSV data for:
- the position of radio antennas and their types spread across one town/region
- the position of hotels in Paris and their grade
In this case the CSV file contains X, Y, Z information about the position of
some elements to be placed in a 3D environment, as well as a cluster column (representing some extra info), that will be used to color the elements by group.
## Learning Objectives
In this guide, you learn how to:
- Open a CSV file and read it
- Place a prim at an X, Y, Z position given by the CSV File
- Create USD references for the prims
- Color the prims based on data retrieved from the CSV file
<p align="center">
<img width=75% src="images/OV_CSVReader_WhatToExpect.png">
<p>
## Prerequisites
- Omniverse Code 2022.1 or above
- [Omniverse compatible GPU](https://docs.omniverse.nvidia.com/app_view/common/technical-requirements.html)
- Working knowledge of Python
- Working knowledge of USD in particular the notion of references
- [PIXAR USD Tutorial referencing](https://graphics.pixar.com/usd/release/tut_referencing_layers.html)
- [NVIDIA Developer page](https://developer.nvidia.com/usd/tutorials)
- [NVIDIA DLI Course](https://courses.nvidia.com/courses/course-v1:DLI+S-FX-02+V1/)
- [CSV](https://en.wikipedia.org/wiki/Comma-separated_values)
## Step 1: Download the Starter Project
In this section, you download and familiarize yourself with the starter project you use throughout this tutorial.
To get the starting code for this hands-on lab, please clone the `tutorial-start` branch of `kit-extension-sample-csv-reader` [github repository](https://github.com/NVIDIA-Omniverse/kit-extension-sample-csv-reader/tree/tutorial-start).
```shell
git clone -b tutorial-start https://github.com/NVIDIA-Omniverse/kit-extension-sample-csv-reader.git
```
This repository contains the assets you use in this tutorial.
### Step 1.1: Load the Extension
In the _Extensions_ tab, click on the **gear**. Next, in the **extension search path**, add the path to the `exts` sub-folder where you cloned the git repository. Then, search for **CSV** in the _Extensions_ tab, and enable the extension by clicking on its toggle button.
<p align="center">
<img width="75%" src="images/LoadExt.png">
<p>
To learn more about the other files in the repository, please check the [Build an Omniverse Extension in less than 10 Minutes](https://www.nvidia.com/en-us/on-demand/session/omniverse2020-om1483/), which explains how to create on extension.
### Step 1.2: Open `models.py`
This tutorial will focus on the `models.py` file found in the `exts/omni.csv.reader/omni/csv/reader/` directory, and in particular, on `generate()`. The starting point of `generate()` is included below for your reference:
```python
def generate(self):
# Clear the stage
# create a new stage with Y up and in meters
# set the up axis
# set the unit of the world
# add a light
# check that CSV exists
# Read CSV file
# Iterate over each row in the CSV file
# Skip the header row
# Don't read more than the max number of elements
# Create the shape with the appropriate color at each coordinate
# root prim
# add group to path if the user has selected that option
# create the prim if it does not exist
# Create prim to add the reference to.
# Add the reference
# Get mesh from shape instance
# Set location
# Set Color
pass
```
> 📝 **Note:** CSV Sample Files are provided within the _data_ folder of this extension
## Step 2: Prepare the Stage
This section demonstrates how to prepare a stage for shapes to be imported from a CSV file.
### Step 2.1: Clear the Stage
The first step is to clear the stage in order to remove any data from previous runs of this tool. This is done with the following code:
```python
def generate(self):
# Clear the stage
stage = omni.usd.get_context().get_stage()
root_prim = stage.GetPrimAtPath(self.root_path)
if (root_prim.IsValid()):
stage.RemovePrim(self.root_path)
```
The first statement gets the current stage. The second statement gets te prim path to the root prim, and if that prim is valid it is cleared.
### Step 2.2: Create a New Stage
Next, a new stage is created with the following statements:
```python
# create a new stage with Y up and in meters
if omni.usd.get_context().new_stage() is False:
carb.log_warn(f"Failed creating a new stage.")
return
stage = omni.usd.get_context().get_stage()
```
Here, a new stage is created. If that fails a warning is printed to the console and `generate()` returns early. Otherwise, the new stage is used going forward.
### Step 2.3: Set Stage Parameters
Then, the parameters for the stage are set with the statements below:
```python
# set the up axis
UsdGeom.SetStageUpAxis(stage, UsdGeom.Tokens.y)
# set the unit of the world
UsdGeom.SetStageMetersPerUnit(stage, self.stage_unit_per_meter)
stage.SetDefaultPrim(root_prim)
```
In these statements, the `y` axis is set to up, the stage units are set to meters, the root prim is set as the default prim. These steps are all necessary so that when you import shapes from a CSV file they have the up-direction you expect, are the correct size, and are added to the correct location within the stage tree.
### Step 2.4: Add a light
Finally, a light is added so that the shapes are visible once imported:
```python
# add a light
light_prim_path = self.root_path + '/DistantLight'
light_prim = UsdLux.DistantLight.Define(stage, light_prim_path)
light_prim.CreateAngleAttr(0.53)
light_prim.CreateColorAttr(Gf.Vec3f(1.0, 1.0, 0.745))
light_prim.CreateIntensityAttr(5000.0)
```
## Step 3: CSV file
This section demonstrates how to open and read from a CSV file.
### Step 3.1: CSV File Format
CSV Files are a common file format used by data scientists to store data. Two sample CSV files are shown below:
<p align="center">
<img width="75%" src="images/CSV_Sample_both.png">
<p>
the common format for CSV files contains a header in the first line with names for the different fields and any number of following lines which contain values for each column. Each row represents one element in the list.
The rest of this section will outline how to open and read the data from a CSV file.
### Step 3.2: Check that the File Exists
It is good practice to check that a file exists before trying to open it as shown below:
```python
# check that CSV exists
if os.path.exists(self.csv_file_path):
```
If the file exists, then continue. If not, gracefully exit the routine and preferably notify the user that the file does not exist.
### Step 3.3: Read the CSV file
To open and read a CSV file, use Python’s built-in [**_csv_**](https://docs.python.org/3/library/csv.html) module as demonstrated in the following snippet:
```python
# Read CSV file
with open(self.csv_file_path, newline='') as csvfile:
csv_reader = csv.reader(csvfile, delimiter=',')
i = 1
```
Here the file is opened with the `open` statement and then then `csv.reader` reads the file's contents into a list. The iterator, `i`, will be used later to name each shape.
### Step 3.4: Process the CSV file
Each line of the CSV is processed using the following code block:
```python
# Iterate over each row in the CSV file
# Skip the header row
# Don't read more than the max number of elements
# Create the shape with the appropriate color at each coordinate
for row in itertools.islice(csv_reader, 1, self.max_elements):
name = row[0]
x = float(row[1])
y = float(row[2])
z = float(row[3])
cluster = row[4]
```
In the first statement, the `itertools` module is used to process only the correct rows. `islice()` will take rows from `csv_reader` starting at the index 1 (this skips the header) and until the end of the list or `self.max_elements`, whichever comes first.
The next few statements retrieve the name, coordinates, and cluster id from the given row.
If you would like to print out information as it runs in order to debug the code, you could add the following code:
```python
carb.log_info(f"X: {x} Y: {y} Z: {z}")
```
This would print the coordinates from each row to the console. Remove those lines after validating that reading was successful - no need to keep that kind of debugging in the final code.
## Step 4: Create each shape
This section will go through the creation of each shape at the correct location in the correct color.
### Step 4.1: Determine the Prim Path
The prim path is determined using the following code:
```python
# root prim
cluster_prim_path = self.root_path
# add group to path if the user has selected that option
if self.group_by_cluster:
cluster_prim_path += self.cluster_layer_root_path + cluster
cluster_prim = stage.GetPrimAtPath(cluster_prim_path)
# create the prim if it does not exist
if not cluster_prim.IsValid():
UsdGeom.Xform.Define(stage, cluster_prim_path)
shape_prim_path = cluster_prim_path + '/box_%d' % i
i += 1
```
First, all prims share the same root so the path of each shape prim is create using the root prim's path. Second, if the user has selected to have the prims grouped, a group is appended to the path. Next, if that cluster does not exist yet it is created. Finally, the name of the individual prim is appended to the end of the path and the iterator is incremented.
In the code above, prims are grouped if the user has selected the grouping option. Imagine that the `cluster` refers to the type of object (ie. `cluster 6` refers to `street lights` and `cluster 29` to mail boxes). In that situation grouping can be very useful because instead of selecting each `street light` one by one in the stage scene, their group can be selected instead. This would let a user easily hide/show the entire group or edit the group in some other way.
<p align="center">
<img width="75%" src="images/TheMagicEye.png">
<p>
### Step 4.2: Create a Reference
When working with USD scene composition, using a _reference_ helps refer to the same "asset" multiple times. You can read more References in the [USD Glossary](https://graphics.pixar.com/usd/docs/USD-Glossary.html#USDGlossary-References).
Here, instead of creating one prim per line in the CSV, a single prim is created and then a reference to that shape is made for each line in the CSV. This has several benefits:
1. If the referred shape is changed, all elements would also change.
2. If saved, the output file will be smaller
This is done with the following code:
```python
# Create prim to add the reference to.
ref_shape = stage.OverridePrim(shape_prim_path)
# Add the reference
ref_shape.GetReferences().AddReference(str(self.shape_file_path), '/MyRef/RefMesh')
```
Here the reference is created and then used.
### Step 4.3: Set the Position of the Prim
Next, the position of the prim is set as follows:
```python
# Get mesh from shape instance
next_shape = UsdGeom.Mesh.Get(stage, shape_prim_path)
# Set location
next_shape.AddTranslateOp().Set(
Gf.Vec3f(
self.scale_factor*x,
self.scale_factor*y,
self.scale_factor*z))
```
In the first statement, you get a `UsdGeom.Mesh` representation of the prim and assign it to the `next_shape` variable. In the next statement, it is transformed according to the data read from the CSV file. Note that each is scaled by a constant value. This is simply because the shapes are large relative to the values of in the CSV file and so the translations are scaled up until the shapes are separated by a reasonable amount of space.
### Step 4.4: Color the Shapes
Finally, the shapes are colored with this code:
```python
# Set Color
next_shape.GetDisplayColorAttr().Set(
category_colors[int(cluster) % self.max_num_clusters])
```
Here, the color display attribute is set on each prim according to its cluster attribute read from the CSV file.
## Step 5: Conclusions
The final result should match the block below:
```python
def generate(self):
# Clear the stage
stage = omni.usd.get_context().get_stage()
root_prim = stage.GetPrimAtPath(self.root_path)
if (root_prim.IsValid()):
stage.RemovePrim(self.root_path)
# create a new stage with Y up and in meters
if omni.usd.get_context().new_stage() is False:
carb.log_warn(f"Failed creating a new stage.")
return
stage = omni.usd.get_context().get_stage()
# set the up axis
UsdGeom.SetStageUpAxis(stage, UsdGeom.Tokens.y)
# set the unit of the world
UsdGeom.SetStageMetersPerUnit(stage, self.stage_unit_per_meter)
stage.SetDefaultPrim(root_prim)
# add a light
light_prim_path = self.root_path + '/DistantLight'
light_prim = UsdLux.DistantLight.Define(stage, light_prim_path)
light_prim.CreateAngleAttr(0.53)
light_prim.CreateColorAttr(Gf.Vec3f(1.0, 1.0, 0.745))
light_prim.CreateIntensityAttr(5000.0)
# check that CSV exists
if os.path.exists(self.csv_file_path):
# Read CSV file
with open(self.csv_file_path, newline='') as csvfile:
csv_reader = csv.reader(csvfile, delimiter=',')
i = 1
# Iterate over each row in the CSV file
# Skip the header row
# Don't read more than the max number of elements
# Create the shape with the appropriate color at each coordinate
for row in itertools.islice(csv_reader, 1, self.max_elements):
name = row[0]
x = float(row[1])
y = float(row[2])
z = float(row[3])
cluster = row[4]
# root prim
cluster_prim_path = self.root_path
# add group to path if the user has selected that option
if self.group_by_cluster:
cluster_prim_path += self.cluster_layer_root_path + cluster
cluster_prim = stage.GetPrimAtPath(cluster_prim_path)
# create the prim if it does not exist
if not cluster_prim.IsValid():
UsdGeom.Xform.Define(stage, cluster_prim_path)
shape_prim_path = cluster_prim_path + '/box_%d' % i
i += 1
# Create prim to add the reference to.
ref_shape = stage.OverridePrim(shape_prim_path)
# Add the reference
ref_shape.GetReferences().AddReference(str(self.shape_file_path), '/MyRef/RefMesh')
# Get mesh from shape instance
next_shape = UsdGeom.Mesh.Get(stage, shape_prim_path)
# Set location
next_shape.AddTranslateOp().Set(
Gf.Vec3f(
self.scale_factor*x,
self.scale_factor*y,
self.scale_factor*z))
# Set Color
next_shape.GetDisplayColorAttr().Set(
category_colors[int(cluster) % self.max_num_clusters])
```
This tutorial has demonstrated how to read a CSV file and use its data to place shape prims in a scene. Rather than place many unique shapes, the tutorial used references to place copies of the same shape. The shapes were located and colored based on data in the CSV file.
| 16,093 | Markdown | 38.738272 | 470 | 0.690424 |
NVIDIA-Omniverse/kit-extension-sample-csv-reader/exts/omni.csv.reader/config/extension.toml | [package]
# Semantic Versionning is used: https://semver.org/
version = "1.0.0"
# The title and description fields are primarily for displaying extension info in UI
title = "Extension for reading CSV file"
description="This extension is to read a CSV file and then display elements (cubes/quad/...) at the XYZ given in the CSV file, + color if any. For now CSV files contain X,Y,Z and cluster keywords"
# Path (relative to the root) or content of readme markdown file for UI.
readme = "docs/README.md"
changelog="docs/CHANGELOG.md"
# URL of the extension source repository.
repository = ""
# One of categories for UI.
category = "Other"
# Keywords for the extension
keywords = ["kit", "example", "CSV"]
# Preview image. Folder named "data" automatically goes in git lfs (see .gitattributes file).
preview_image = "data/OV_CSVReader_WhatToExpect.png"
icon = "data/CSV_reader_ico.png"
# Use omni.ui to build simple UI
[dependencies]
"omni.kit.uiapp" = {}
# Main python module this extension provides, it will be publicly available as "import omni.hello.world".
[[python.module]]
name = "omni.csv.reader"
| 1,111 | TOML | 32.696969 | 196 | 0.738074 |
NVIDIA-Omniverse/kit-extension-sample-csv-reader/exts/omni.csv.reader/omni/csv/reader/extension.py | ###############################################################################
#
# Copyright 2020 NVIDIA Corporation
#
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
# the Software, and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
###############################################################################
###############################################################################
#
# Extension create by BB.CM.EB June 2022 for CSV Reader_extension
# Target : read a CSV file and populate the 3D environment
# with shapes at location X,Y,Z
# Known limitations - June/07
# - CSV files must contains X,Y,Z and[optional] cluster columns
# - nothing happens if no CSV file (not found/wrong type/etc...)
#
###############################################################################
import carb
import omni.ext
from .models import MainModel
from .views import MainView
# Any class derived from `omni.ext.IExt` in top level module (defined in `python.modules` of `extension.toml`)
# will be instantiated when extension gets enabled and `on_startup(ext_id)` will be called.
# Later when extension gets disabled on_shutdown() is called
class MyExtension(omni.ext.IExt):
# ext_id is current extension id. It can be used with extension manager to query additional information, like where
# this extension is located on filesystem.
def on_startup(self, ext_id):
carb.log_info(f"[CSV_Reader] MyExtension startup")
Model = MainModel()
self._window = MainView(Model)
def on_shutdown(self):
carb.log_info(f"[CSV_Reader] MyExtension shutdown")
self._window.destroy()
self._window = None
| 2,630 | Python | 45.982142 | 119 | 0.647529 |
NVIDIA-Omniverse/kit-extension-sample-csv-reader/exts/omni.csv.reader/omni/csv/reader/models.py | # Model related
# Python built-in
import os.path
import carb
from pathlib import Path
# external python lib
import csv
import itertools
# USD imports
from pxr import Gf, UsdGeom, UsdLux
# omniverse
import omni.client
import omni.kit.app
from omni.kit.window.file_importer import get_file_importer
CURRENT_PATH = Path(__file__).parent
DATA_PATH = CURRENT_PATH.parent.parent.parent.joinpath("data")
category_colors = {
0: [(1, 0, 0)],
1: [(0, 1, 0)],
2: [(0, 0.4, 0)],
3: [(0, 0, 1)],
4: [(0.3, 0.5, 1)],
5: [(.5, .5, .5)],
6: [(0, 0, 0)],
7: [(0, 1, 1)],
8: [(.8, .5, .25)],
9: [(1, .5, 0)],
10: [(1, 1, 1)],
}
shape_usda_name = {
"cube": "BasicCubeAsRef.usda",
"sphere": "BasicSphereAsRef.usda",
}
class MainModel():
def __init__(self):
#root prim paths
self.root_path = '/World'
self.cluster_layer_root_path = '/Class_'
# stage_unit defines the number of unit per meter
self.stage_unit_per_meter = 1
# Default CSV Path (sample file deployed with extension)
self.csv_file_path = DATA_PATH.joinpath('CSVSample.csv')
# path to basic shape
self.shape_file_name = "BasicCubeAsRef.usda"
self.shape_file_path = DATA_PATH.joinpath(self.shape_file_name)
# Scale factor so that the shapes are well spaced
self.scale_factor = 100.0
# limit the number of rows read
self.max_elements = 5000
# whether or not the shapes should be grouped by cluster
self.group_by_cluster = False
# max number of different color clusters
self.max_num_clusters = 10
def generate(self):
# Clear the stage
stage = omni.usd.get_context().get_stage()
root_prim = stage.GetPrimAtPath(self.root_path)
if (root_prim.IsValid()):
stage.RemovePrim(self.root_path)
# create a new stage with Y up and in meters
if omni.usd.get_context().new_stage() is False:
carb.log_warn(f"Failed creating a new stage.")
return
stage = omni.usd.get_context().get_stage()
# set the up axis
UsdGeom.SetStageUpAxis(stage, UsdGeom.Tokens.y)
# set the unit of the world
UsdGeom.SetStageMetersPerUnit(stage, self.stage_unit_per_meter)
stage.SetDefaultPrim(root_prim)
# add a light
light_prim_path = self.root_path + '/DistantLight'
light_prim = UsdLux.DistantLight.Define(stage, light_prim_path)
light_prim.CreateAngleAttr(0.53)
light_prim.CreateColorAttr(Gf.Vec3f(1.0, 1.0, 0.745))
light_prim.CreateIntensityAttr(5000.0)
# check that CSV exists
if os.path.exists(self.csv_file_path):
# Read CSV file
with open(self.csv_file_path, newline='') as csvfile:
csv_reader = csv.reader(csvfile, delimiter=',')
i = 1
# Iterate over each row in the CSV file
# Skip the header row
# Don't read more than the max number of elements
# Create the shape with the appropriate color at each coordinate
for row in itertools.islice(csv_reader, 1, self.max_elements):
name = row[0]
x = float(row[1])
y = float(row[2])
z = float(row[3])
cluster = row[4]
# root prim
cluster_prim_path = self.root_path
# add group to path if the user has selected that option
if self.group_by_cluster:
cluster_prim_path += self.cluster_layer_root_path + cluster
cluster_prim = stage.GetPrimAtPath(cluster_prim_path)
# create the prim if it does not exist
if not cluster_prim.IsValid():
UsdGeom.Xform.Define(stage, cluster_prim_path)
shape_prim_path = cluster_prim_path + '/box_%d' % i
i += 1
# Create prim to add the reference to.
ref_shape = stage.OverridePrim(shape_prim_path)
# Add the reference
ref_shape.GetReferences().AddReference(str(self.shape_file_path), '/MyRef/RefMesh')
# Get mesh from shape instance
next_shape = UsdGeom.Mesh.Get(stage, shape_prim_path)
# Set location
next_shape.AddTranslateOp().Set(
Gf.Vec3f(
self.scale_factor*x,
self.scale_factor*y,
self.scale_factor*z))
# Set Color
next_shape.GetDisplayColorAttr().Set(
category_colors[int(cluster) % self.max_num_clusters])
# Handles the change between a cube and sphere shape in the UI
def shape_changed(self, choice):
chosen_key = list(shape_usda_name.keys())[choice]
self.shape_file_name = shape_usda_name[chosen_key]
self.shape_file_path = DATA_PATH.joinpath(self.shape_file_name)
# Handles the change of the 'group by cluster' checkbox
def group_by_cluster_changed(self, do_clustering):
self.group_by_cluster = do_clustering
# Handles the click of the Load button
def select_file(self):
self.file_importer = get_file_importer()
self.file_importer.show_window(
title="Select a CSV File",
import_button_label="Select",
import_handler=self._on_click_open,
file_extension_types=[(".csv", "CSV Files (*.csv)")],
file_filter_handler=self._on_filter_item
)
# Handles the click of the open button within the file importer dialog
def _on_click_open(self, filename: str, dirname: str, selections):
# File name should not be empty.
filename = filename.strip()
if not filename:
carb.log_warn(f"Filename must be provided.")
return
# create the full path to csv file
if dirname:
fullpath = f"{dirname}{filename}"
else:
fullpath = filename
self.csv_file_path = fullpath
self.csv_field_model.set_value(str(fullpath))
# Handles the filtering of files within the file importer dialog
def _on_filter_item(self, filename: str, filter_postfix: str, filter_ext: str) -> bool:
if not filename:
return True
# Show only .csv files
_, ext = os.path.splitext(filename)
if ext == filter_ext:
return True
else:
return False
| 6,976 | Python | 34.596939 | 103 | 0.544151 |
NVIDIA-Omniverse/kit-extension-sample-csv-reader/exts/omni.csv.reader/omni/csv/reader/views.py | # import from omniverse
import omni.ui as ui
from omni.ui.workspace_utils import TOP
# import from other extension py
from .models import MainModel
class MainView():
def __init__(self, csvmodel: MainModel):
self._window = ui.Window("CSV Reader", width=800, height=600, dockPreference=ui.DockPreference.RIGHT_TOP)
self._window.visible = True
csvmodel.csv_field_model = None
with self._window.frame:
with ui.VStack(alignment=TOP, style={"margin":5}):
# 2 - parameters to be set, in case not default values
with ui.VStack():
with ui.HStack(height=20):
ui.Label("CSV file path:", height=10, width=120)
self.csv_field = ui.StringField(height=10)
self.csv_field.enabled = False
self.csv_field.model.set_value(str(csvmodel.csv_file_path))
csvmodel.csv_field_model = self.csv_field.model
ui.Button("Load",
width=40,
clicked_fn=lambda: csvmodel.select_file())
with ui.HStack(height=20):
ui.Label("Shape:", height=0)
shape_combo = ui.ComboBox(0, "cube", "sphere")
shape_combo.model.add_item_changed_fn(
lambda m,
f=shape_combo: csvmodel.shape_changed(m.get_item_value_model().get_value_as_int()))
with ui.HStack(height=20):
ui.Label("Group By Cluster:", height=0)
cluster_cb = ui.CheckBox(width=20)
cluster_cb.model.add_value_changed_fn(
lambda a: csvmodel.group_by_cluster_changed(a.get_value_as_bool()))
ui.Line(style={"color": 0xff00b976}, height=20)
# 3 - button to populate the 3D scene
ui.Button( "Generate", height=50, clicked_fn=lambda: csvmodel.generate())
def destroy(self):
self._window.destroy()
self._window = None
| 2,199 | Python | 46.826086 | 113 | 0.51387 |
NVIDIA-Omniverse/kit-extension-sample-csv-reader/exts/omni.csv.reader/docs/CHANGELOG.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [1.0.0] - 2022-07-01
### Known limitations
- CSV files must contains X,Y,Z and cluster columns
- nothing happens if no CSV file (not found/wrong type/etc...)
- for now, the scene is reset prior generating the overlay...to be updated in next version
| 348 | Markdown | 30.72727 | 90 | 0.718391 |
NVIDIA-Omniverse/kit-extension-sample-csv-reader/exts/omni.csv.reader/docs/README.md | # CSV Reader Extension (omni.csv.reader)
## Overview
The CSV Reader extension offers the possibility for users to populate the scene with some default shapes (Cubes or Spheres) at locations X, Y, Z found in the CSV file.
Colors are also added depending on the _cluster_ values given as well in the CSV file.
## [Tutorial](../../../tutorial/tutorial.md)
This extension sample also includes a step-by-step tutorial to accelerate your growth as you learn to build your own
Omniverse Kit extensions. [Get started with the tutorial.](../../../tutorial/tutorial.md)
## Usage
### Prerequisites :
1) CSV Files place : either use the ones by default in the _data_ folder - or make sure to specify its place in the field of the UI
2) Note that the CSV file should contain X, Y, Z and cluster columns. Please look at examples provided in the _data_ folder
### Workflow using the extension:
Click on 'Generate' -> that will create elements here and there based on the info from the CSV file.
1. [Optional] : In the parameters UI window, select the location of your CSV, the type of shape, and if you want to be grouped by class/_cluster_...
2. If required : you can export/save the USD stage with the 'File->Save As...' option.
3. The scene is reset every time you press on Generate.
| 1,352 | Markdown | 42.64516 | 167 | 0.741864 |
NVIDIA-Omniverse/kit-extension-sample-csv-reader/exts/omni.csv.reader/docs/index.rst | CVS_Reader_ext
########################
This extension allows to read one CSV file (UI to enter the path to it)
and then generate the creation of one 3D map of the spatial representation
with X,Y,Z given by the CSV (and colors/Class/Cluster)
This extension is a service of NVIDIA's Developer Programs organization and is in first version.
Extensions Loaded
=================
.. toctree::
:maxdepth: 1
CHANGELOG
| 424 | reStructuredText | 21.36842 | 96 | 0.686321 |
NVIDIA-Omniverse/extension-contest/README.md | <!-- markdownlint-disable -->
<h1 align="center">
NVIDIA Omniverse Developer Contest
<br>
#ExtendOmniverse | Submissions Now Closed
</h1>
<h3 align="center">
Extend the Omniverse and Win
</h3>
<p align="center">Thank you to all of the incredible developers who used Omniverse Code to create an extension. Winners will be announced at the <a href="https://www.nvidia.com/gtc/session-catalog/?search=SE41388&search=SE41388%2C+SE41388&tab.catalogallsessionstab=16566177511100015Kus#/session/1658438748728001JAUi">Omniverse User Group</a> at GTC on September 20th at 3pm PDT, so be sure to register to find out if you won!
</p>
<p align="center">
<a href="https://www.nvidia.com/extend-omniverse-contest/"><img src="images/ov-dev-contest-1920x1080.jpg"></a>
</p>
<p align="center">
We are looking for extensions that fall into one of the three categories:
</p>
<p align="center">
<strong>
Layout or scene authoring tools
</strong>
</p>
<p align="center">
<strong>
Scene modifier or manipulator tools
</strong>
</p>
<p align="center">
<strong>
Use of Omni.ui
</strong>
</p>
## Getting Started
Ready to build your first extension? Check out the steps below to get up and running in no time. For additional details on prizes, eligibility, and requirements for the contest, visit the [official landing page](https://www.nvidia.com/en-us/omniverse/apps/code/developer-contest/) or the [announcement blog](https://developer.nvidia.com/blog/build-tools-for-the-3d-world-with-the-extend-the-omniverse-contest/).
### Installation Prerequisites
:heavy_check_mark: Install [NVIDIA Omniverse](https://www.nvidia.com/en-us/omniverse/download/)
:heavy_check_mark: Install [Omniverse Code](https://developer.nvidia.com/nvidia-omniverse-platform/code-app)
:heavy_check_mark: Install [Visual Studio Code](https://code.visualstudio.com/download)
### Building Your First Extension
Once the steps above are complete, getting started is easy. Simply launch Omniverse Code from the NVIDIA Omniverse Launcher, then navigate to the Extensions tab.
Click the green + icon in the top left corner to create an extension from the template.
Choose the directory you'd like to create your extension, then provide a folder & project namespace to complete the project.
Visual Studio Code should automatically open with your newly created project, and you're ready to begin developing your first extension! Navigate to `exts\[your.project.namespace]\your\project\namespace\extension.py` to review the placeholder code and observe the extension window that is now open in Omniverse Code.
You can also check out our [Spawn Primitives Extension Sample](https://github.com/NVIDIA-Omniverse/kit-extension-sample-spawn-prims) tutorial for getting up and running within 10 minutes.
## Samples & Resources
Below are a number of resources that will help accelerate your learning journey.
### Extension Samples
Kit comes bundled with a number of extensions, which can be found inside `app/kit/exts`, `app/kit/extscore`, and `app/exts`. Most of these are in Python, and the source is available for your continued learning
**Layout & Scene Authoring Samples**
* [Spawn Primitives Sample](https://github.com/NVIDIA-Omniverse/kit-extension-sample-spawn-prims) - Leverage the Command tab to spawn a set of primitives within your scene
* [Scatter Tool Sample](https://github.com/NVIDIA-Omniverse/kit-extension-sample-scatter) - Randomly distribute primitives within a given bounds
* [CSV Reader Sample](https://github.com/NVIDIA-Omniverse/kit-extension-sample-csv-reader) - Learn how to populate a scene using data from a CSV file
**Scene Modifier, Manipulator Tool Samples**
* [Viewport Info & Manipulator Samples](https://github.com/NVIDIA-Omniverse/kit-extension-sample-ui-scene) - A collection of samples demonstrating how to render additional metadata and create custom manipluators within the Omniverse viewport
* [Viewport Reticle Sample](https://github.com/NVIDIA-Omniverse/kit-extension-sample-reticle) - Use `omni.scene.ui` to draw GUI reticles & compositions within the Omniverse viewport
**Styling Samples**
* [UI Window Samples](https://github.com/NVIDIA-Omniverse/kit-extension-sample-ui-window) - A collection of samples demonstrating how to layout and style custom dialog windows using Omniverse Kit
### Technical Documentation
* [Omniverse Code Overview](https://www.youtube.com/watch?v=j1Pwi1KRkhk) - The Omniverse Code app contains interactive documentation experimenting with key building blocks available in Kit
* [Python Kit API Reference & Technical Documentation](https://docs.omniverse.nvidia.com/py/kit/index.html)
* [NVIDIA Omniverse Resource Center - Extensions](https://developer.nvidia.com/nvidia-omniverse-developer-resource-center#extensions) - includes videos and additional resources for learning how to develop extensions
### Additional Resources
We have a fantastic community of active developers in our forums and the official Omniverse Discord channel. See the links below for support and connecting with the broader Omniverse developer community:
* [Omniverse Extension Forums](https://forums.developer.nvidia.com/c/omniverse/extension/399)
* [NVIDIA Omniverse Discord](https://forums.developer.nvidia.com/t/omniverse-discord-server-is-live/178422)
## Submitting Your Extension
Below is a high level checklist of what you'll need to do in order to submit your entry. You can also check out the [How to Submit](https://www.youtube.com/watch?v=z8khQyHT_44) video for detailed instructions on how to correctly publish your extension.
### Prepare
:heavy_check_mark: Developer & test your extension
:heavy_check_mark: Update your `extension.toml` config file found in `exts\[project]\config`
:heavy_check_mark: Update your extension's `README.md` & `CHANGELOG.md` found in `exts\[project]\docs`
:heavy_check_mark: Update your extension's icon.png & preview.png images found in `exts\[project]\data`
### Publish
:heavy_check_mark: Publish your project to a public repo on GitHub. Ensure your repo's `root` directory contains the `exts\` folder (see our [template](https://github.com/NVIDIA-Omniverse/kit-extension-template) as an example)
:heavy_check_mark: Add the `omniverse-kit-extension` [Topic](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) to your repo so that it shows up [here](https://github.com/topics/omniverse-kit-extension)
:heavy_check_mark: Publish a [Release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) for your project
:heavy_check_mark: Download and unzip your release's `source.zip` file to ensure the the root directory contains the `exts\` folder
### Submit
:heavy_check_mark: Create a short video demonstrating what your extension does
:heavy_check_mark: Complete the submission form from the contest landing page [here](https://www.nvidia.com/en-us/omniverse/apps/code/developer-contest/)
| 7,316 | Markdown | 67.383177 | 425 | 0.773783 |
NVIDIA-Omniverse/usd-plugin-samples/CHANGES.md | # Changelog
## 3.0.0
- Added several examples for Hydra 2 scene index plugins
- Fixed issue in build plugInfo.json file configuration for debug builds
- Updated dependencies to stock USD 23.05
- Updated openssl and libcurl dependencies
## 2.0.0
- Added support for general USD plugins beyond schemas
- Updated repo_usd to support flexible build files
- Updated dependencies to USD 22.11 and Python 3.10
- Added sample for dynamic payloads and file format plugins
## 1.0.0
- Initial open source release | 507 | Markdown | 25.736841 | 72 | 0.773176 |
NVIDIA-Omniverse/usd-plugin-samples/repo.toml | # common settings for repo_usd for all USD plug-ins
[repo_usd]
usd_root = "${root}/_build/usd-deps/nv-usd/%{config}"
usd_python_root = "${root}/_build/usd-deps/python"
generate_plugin_buildfiles = true
plugin_buildfile_format = "cmake"
generate_root_buildfile = true
# this tells repo_usd about our codeful schema extension
[repo_usd.plugin.omniExampleSchema]
schema_file = "${root}/src/usd-plugins/schema/omniExampleSchema/schema.usda"
plugin_dir = "${root}/src/usd-plugins/schema/omniExampleSchema"
generate_dir = "${root}/src/usd-plugins/schema/omniExampleSchema/generated"
install_root = "${root}/_install/%{platform}/%{config}/omniExampleSchema"
library_prefix = "OmniExample"
usd_lib_dependencies = [
"arch",
"tf",
"vt",
"sdf",
"usd"
]
# this tells repo_usd about our codeless schema extension
[repo_usd.plugin.omniExampleCodelessSchema]
schema_file = "${root}/src/usd-plugins/schema/omniExampleCodelessSchema/schema.usda"
plugin_dir = "${root}/src/usd-plugins/schema/omniExampleCodelessSchema"
generate_dir = "${root}/src/usd-plugins/schema/omniExampleCodelessSchema/generated"
install_root = "${root}/_install/%{platform}/%{config}/omniExampleCodelessSchema"
is_codeless = true
# this tells repo_usd about the codeless schema for use by
# our file format / dynamic payload infrastructure
[repo_usd.plugin.omniMetSchema]
schema_file = "${root}/src/usd-plugins/schema/omniMetSchema/schema.usda"
plugin_dir = "${root}/src/usd-plugins/schema/omniMetSchema"
generate_dir = "${root}/src/usd-plugins/schema/omniMetSchema/generated"
install_root = "${root}/_install/%{platform}/%{config}/omniMetSchema"
is_codeless = true
# this tells repo_usd about our file format plugin
[repo_usd.plugin.edfFileFormat]
plugin_dir = "${root}/src/usd-plugins/fileFormat/edfFileFormat"
install_root = "${root}/_install/%{platform}/%{config}/edfFileFormat"
include_dir = "include/edfFileFormat"
additional_include_dirs = [
"../../../../_build/usd-deps/nv_usd/%{config}/include/tbb"
]
public_headers = [
"api.h",
"iEdfDataProvider.h",
"edfDataProviderFactory.h"
]
private_headers = [
"edfData.h",
"edfPluginManager.h",
"edfFileFormat.h"
]
cpp_files = [
"edfData.cpp",
"edfDataProviderFactory.cpp",
"edfPluginManager.cpp",
"edfFileFormat.cpp",
"iEdfDataProvider.cpp"
]
resource_files = [
"plugInfo.json"
]
usd_lib_dependencies = [
"arch",
"tf",
"plug",
"vt",
"gf",
"sdf",
"js",
"pcp"
]
# this tells repo_usd about our EDF provider implementing the back-end
# functionality to fulfill the dynamic payload
[repo_usd.plugin.omniMetProvider]
plugin_dir = "${root}/src/usd-plugins/dynamicPayload/omniMetProvider"
install_root = "${root}/_install/%{platform}/%{config}/omniMetProvider"
include_dir = "include/omniMetProvider"
additional_include_dirs = [
"../../../../src/usd-plugins/fileFormat/edfFileFormat",
"../../../../_build/target-deps/libcurl/include"
]
preprocessor_defines = [
"CURL_STATICLIB"
]
depends_on = [
"edfFileFormat"
]
private_headers = [
"api.h",
"omniMetProvider.h"
]
cpp_files = [
"omniMetProvider.cpp"
]
resource_files = [
"plugInfo.json"
]
usd_lib_dependencies = [
"arch",
"tf",
"plug",
"vt",
"gf",
"sdf",
"js",
"pcp",
"usd"
]
[repo_usd.plugin.omniMetProvider."platform:windows-x86_64"]
additional_libs = [
"edfFileFormat",
"zlib",
"ws2_32",
"crypt32"
]
additional_static_libs = [
"libcurl"
]
additional_library_dirs = [
"../../../../_install/%{platform}/%{config}/edfFileFormat/lib",
"../../../../_build/target-deps/libcurl/lib",
"../../../../_build/target-deps/zlib/lib/rt_dynamic/release"
]
[repo_usd.plugin.omniMetProvider."platform:linux-x86_64"]
additional_libs = [
"edfFileFormat"
]
additional_static_libs = [
"curl",
"ssl",
"crypto",
"z"
]
additional_library_dirs = [
"../../../../_install/%{platform}/%{config}/edfFileFormat/lib",
"../../../../_build/target-deps/libcurl/lib",
"../../../../_build/target-deps/zlib/lib",
"../../../../_build/target-deps/openssl/lib"
]
[repo_usd.plugin.omniMetProvider."platform:linux-aarch64"]
additional_libs = [
"edfFileFormat"
]
additional_static_libs = [
"curl",
"ssl",
"crypto",
"z"
]
additional_library_dirs = [
"../../../../_install/%{platform}/%{config}/edfFileFormat/lib",
"../../../../_build/target-deps/libcurl/lib",
"../../../../_build/target-deps/zlib/lib",
"../../../../_build/target-deps/openssl/lib"
]
[repo_usd.plugin.omniGeoSceneIndex]
plugin_dir = "${root}/src/hydra-plugins/omniGeoSceneIndex"
install_root = "${root}/_install/%{platform}/%{config}/omniGeoSceneIndex"
include_dir = "include/omniGeoSceneIndex"
private_headers = [
"api.h",
"computedDependentDataSource.h",
"computedPrimDataSource.h",
"geospatialDataSource.h",
"geospatialSceneIndex.h",
"geospatialSceneIndexPlugin.h",
"localPositionAPIAdapter.h",
"localPositionDataSource.h",
"localPositionSchema.h",
"referencePositionAPIAdapter.h",
"referencePositionDataSource.h",
"referencePositionSchema.h"
]
cpp_files = [
"computedDependentDataSource.cpp",
"computedPrimDataSource.cpp",
"geospatialDataSource.cpp",
"geospatialSceneIndex.cpp",
"geospatialSceneIndexPlugin.cpp",
"localPositionAPIAdapter.cpp",
"localPositionDataSource.cpp",
"localPositionSchema.cpp",
"referencePositionAPIAdapter.cpp",
"referencePositionDataSource.cpp",
"referencePositionSchema.cpp"
]
resource_files = [
"plugInfo.json"
]
usd_lib_dependencies = [
"arch",
"tf",
"work",
"plug",
"vt",
"gf",
"hd",
"hf",
"sdf",
"usd",
"usdGeom",
"usdImaging"
]
additional_include_dirs = [
"${root}/_build/target-deps/omni-geospatial/include"
]
additional_library_dirs = [
"${root}/_build/target-deps/omni-geospatial/bin"
]
additional_libs = [
"omniGeospatial"
]
[repo_usd.plugin.omniMetricsAssembler]
plugin_dir = "${root}/src/hydra-plugins/omniMetricsAssembler"
install_root = "${root}/_install/%{platform}/%{config}/omniMetricsAssembler"
include_dir = "include/omniMetricsAssembler"
private_headers = [
"api.h",
"metricsAdapter.h",
"metricsDataSource.h",
"metricsDoubleDataSource.h",
"metricsSceneIndex.h",
"metricsSceneIndexPlugin.h",
"metricsSchema.h"
]
cpp_files = [
"metricsAdapter.cpp",
"metricsDataSource.cpp",
"metricsDoubleDataSource.cpp",
"metricsSceneIndex.cpp",
"metricsSceneIndexPlugin.cpp",
"metricsSchema.cpp"
]
resource_files = [
"plugInfo.json"
]
usd_lib_dependencies = [
"arch",
"tf",
"work",
"plug",
"vt",
"gf",
"hd",
"hf",
"sdf",
"usd",
"usdGeom",
"usdImaging"
]
[repo_usd.plugin.omniWarpSceneIndex]
plugin_dir = "${root}/src/hydra-plugins/omniWarpSceneIndex"
schema_file = "${root}/src/hydra-plugins/omniWarpSceneIndex/schema.usda"
library_prefix = "OmniWarpSceneIndex"
install_root = "${root}/_install/%{platform}/%{config}/omniWarpSceneIndex"
include_dir = "include/omniWarpSceneIndex"
private_headers = [
"api.h",
"tokens.h",
"warpComputationAPI.h",
"warpComputationAPIAdapter.h",
"warpComputationSchema.h",
"warpPythonModule.h",
"warpSceneIndex.h",
"warpSceneIndexPlugin.h"
]
cpp_files = [
"tokens.cpp",
"warpComputationAPI.cpp",
"warpComputationAPIAdapter.cpp",
"warpComputationSchema.cpp",
"warpPythonModule.cpp",
"warpSceneIndex.cpp",
"warpSceneIndexPlugin.cpp",
"moduleDeps.cpp"
]
pymodule_cpp_files = [
"module.cpp",
"wrapTokens.cpp",
"wrapWarpComputationAPI.cpp"
]
pymodule_files = [
"__init__.py",
"oceanSim/__init__.py",
"oceanSim/preferences.py",
"oceanSim/preferencesUI.py",
"warpModules/__init__.py",
"warpModules/cloth.py",
"warpModules/deform01.py",
"warpModules/deform02.py",
"warpModules/ocean.py",
"warpModules/particles.py"
]
resource_files = [
"plugInfo.json",
"schema.usda"
]
usd_lib_dependencies = [
"arch",
"tf",
"gf",
"plug",
"trace",
"vt",
"work",
"hio",
"garch",
"glf",
"hd",
"hdsi",
"hdx",
"hf",
"pxOsd",
"sdf",
"sdr",
"usd",
"usdGeom",
"usdShade",
"usdImaging",
] | 8,346 | TOML | 23.991018 | 84 | 0.654325 |
NVIDIA-Omniverse/usd-plugin-samples/src/kit-extension/exts/omni.example.schema/config/extension.toml | [core]
# tells kit that we shouldn't hot reload this extension
reloadable = false
# Load at the start, load all schemas with order -100 (with order -1000 the USD libs are loaded)
# this is necessary (as it to set the extension to auto load)
# so that the schemas get loaded into the UsdSchemaRegistry early enough
order = -100
[package]
# all packages should have this information so it is displayed in the UI properly
author = "NVIDIA USD Core Team"
repository = "https://github.com/NVIDIA-Omniverse/kit-sample-usd-schema"
category = "USD"
title = "USD Example Schema"
version = "1.0.0"
description="Kit extension illustrating how to package a schema extension for use in kit."
keywords = ["schema", "usd"]
readme = "docs/README.md"
changelog = "docs/CHANGES.md"
icon = "data/icon.png"
[dependencies]
# depends on core USD libraries being loaded
"omni.usd.libs" = {}
# when an extension is requested to be enabled, kit will load the python modules
# that are specified here in the order they are specified
# we specify two different python modules, the first is the module we create
# this one will register the plugin with USD so it knows in what module to
# find our schema types
[[python.module]]
name = "omni.example.schema"
# the second extension is the schema python module itself
# this is the module that developers will import to use the schema in Python
[[python.module]]
name = "OmniExampleSchema"
# this tells kit to load these C++ libraries when the extension loads
# (kit will also try to unload them when the extension is unloaded)
# note that this is required to also make loading the schema python module work
# (importing the schema python module will look for the C++ library as a dependency)
# if you don't load the C++ lib here, your PATH / LD_LIBRARY_PATH variables
# should contain the path to your C++ dll otherwise the python module will
# not load properly!
[[native.library]]
path = "OmniExampleSchema/lib/${lib_prefix}omniExampleSchema${lib_ext}" | 1,982 | TOML | 40.312499 | 96 | 0.757316 |
NVIDIA-Omniverse/usd-plugin-samples/src/kit-extension/exts/omni.example.schema/omni/example/schema/__init__.py | # Copyright 2023 NVIDIA CORPORATION
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import os
from pxr import Plug
# this extension is responsible for loading both plug-ins that represent the
# example codeful and codeless schema extensions
plugin_root = os.path.join(os.path.dirname(__file__), "..", "..",
"..", "OmniExampleSchema", "resources")
Plug.Registry().RegisterPlugins(plugin_root)
plugin_root = os.path.join(os.path.dirname(__file__), "..", "..",
"..", "OmniExampleCodelessSchema", "resources") | 1,012 | Python | 41.208332 | 76 | 0.737154 |
NVIDIA-Omniverse/usd-plugin-samples/src/kit-extension/exts/omni.example.schema/docs/CHANGES.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [1.0.0] - 2023-01-19
- Initial version of an illustrative example of a kit extension loading a set of USD schema extensions | 222 | Markdown | 30.857138 | 102 | 0.734234 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/api.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_METRICS_ASSEMBLER_API_H
#define OMNI_METRICS_ASSEMBLER_API_H
#include "pxr/base/arch/export.h"
#if defined(PXR_STATIC)
# define OMNIMETRICSASSEMBLER_API
# define OMNIMETRICSASSEMBLER_API_TEMPLATE_CLASS(...)
# define OMNIMETRICSASSEMBLER_API_TEMPLATE_STRUCT(...)
# define OMNIMETRICSASSEMBLER_LOCAL
#else
# if defined(OMNIMETRICSASSEMBLER_EXPORTS)
# define OMNIMETRICSASSEMBLER_API ARCH_EXPORT
# define OMNIMETRICSASSEMBLER_API_TEMPLATE_CLASS(...) ARCH_EXPORT_TEMPLATE(class, __VA_ARGS__)
# define OMNIMETRICSASSEMBLER_API_TEMPLATE_STRUCT(...) ARCH_EXPORT_TEMPLATE(struct, __VA_ARGS__)
# else
# define OMNIMETRICSASSEMBLER_API ARCH_IMPORT
# define OMNIMETRICSASSEMBLER_API_TEMPLATE_CLASS(...) ARCH_IMPORT_TEMPLATE(class, __VA_ARGS__)
# define OMNIMETRICSASSEMBLER_API_TEMPLATE_STRUCT(...) ARCH_IMPORT_TEMPLATE(struct, __VA_ARGS__)
# endif
# define OMNIMETRICSASSEMBLER_LOCAL ARCH_HIDDEN
#endif
#endif // OMNI_METRICS_ASSEMBLER_API_H
| 1,592 | C | 40.921052 | 102 | 0.743719 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsDataSource.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef HD_OMNI_METRICS_DATA_SOURCE_H_
#define HD_OMNI_METRICS_DATA_SOURCE_H_
#include <pxr/imaging/hd/dataSource.h>
#include <pxr/imaging/hd/dataSourceTypeDefs.h>
#include <pxr/imaging/hd/sceneIndex.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
//-----------------------------------------------------------------------------
#define HDOMNIMETRICSDATASOURCE_TOKENS \
(metricsPreservedXform)
TF_DECLARE_PUBLIC_TOKENS(HdOmniMetricsDataSourceTokens, OMNIMETRICSASSEMBLER_API,
HDOMNIMETRICSDATASOURCE_TOKENS);
//-----------------------------------------------------------------------------
/// \class HdOmniMetricsDataSource
///
/// A datasource representing a wrapped view of an existing flattened
/// datasource where the xform token is intercepted and a new metric-corrected
/// transform matrix is dynamically computed.
///
class HdOmniMetricsDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(HdOmniMetricsDataSource);
HdOmniMetricsDataSource(const HdSceneIndexBase& sceneIndex, const SdfPath& primPath,
HdContainerDataSourceHandle wrappedDataSource);
void UpdateWrappedDataSource(HdContainerDataSourceHandle wrappedDataSource);
// data source overrides
TfTokenVector GetNames() override;
HdDataSourceBaseHandle Get(const TfToken& name) override;
// determines if the data source would be dirtied based on the locators given
bool IsPrimDirtied(const HdDataSourceLocatorSet& locators);
private:
bool _HasMetricsInformation(HdContainerDataSourceHandle dataSource);
HdBoolDataSourceHandle _GetInputResetXformStackSource();
HdDataSourceBaseHandle _ComputeCorrectedXform();
private:
const HdSceneIndexBase& _sceneIndex;
SdfPath _primPath;
HdContainerDataSourceHandle _wrappedDataSource;
// cached computed datasources
HdContainerDataSourceAtomicHandle _computedCorrectedXformDataSource;
class _MetricsCorrectedMatrixDataSource : public HdMatrixDataSource
{
public:
HD_DECLARE_DATASOURCE(_MetricsCorrectedMatrixDataSource);
_MetricsCorrectedMatrixDataSource(HdContainerDataSourceHandle inputDataSource,
HdContainerDataSourceHandle parentDataSource,
bool isMetricsCorrectiveSource);
// typed sampled data source overrides
VtValue GetValue(Time shutterOffset) override;
GfMatrix4d GetTypedValue(Time shutterOffset) override;
bool GetContributingSampleTimesForInterval(
Time startTime,
Time endTime,
std::vector<Time>* outSampleTimes) override;
private:
HdMatrixDataSourceHandle _GetInputMatrixDataSource() const;
HdMatrixDataSourceHandle _GetParentMatrixDataSource() const;
HdMatrixDataSourceHandle _GetMetricsPreservedMatrixDataSource() const;
HdMatrixDataSourceHandle _GetParentMetricsPreservedMatrixDataSource() const;
GfMatrix4d _ComputeCorrectedMatrix(Time shutterOffset);
GfMatrix4d _GetMpuCorrective();
HdContainerDataSourceHandle _inputDataSource;
HdContainerDataSourceHandle _parentDataSource;
bool _isMetricsCorrectiveSource;
};
HD_DECLARE_DATASOURCE_HANDLES(_MetricsCorrectedMatrixDataSource);
};
HD_DECLARE_DATASOURCE_HANDLES(HdOmniMetricsDataSource);
PXR_NAMESPACE_CLOSE_SCOPE
#endif // HD_OMNI_METRICS_DATA_SOURCE_H_ | 3,949 | C | 34.267857 | 88 | 0.736389 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsSceneIndexPlugin.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/imaging/hd/sceneIndexPluginRegistry.h>
#include "metricsSceneIndexPlugin.h"
#include "metricsSceneIndex.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PRIVATE_TOKENS(
_tokens,
((sceneIndexPluginName, "OmniMetricsSceneIndexPlugin"))
);
TF_REGISTRY_FUNCTION(TfType)
{
HdSceneIndexPluginRegistry::Define<OmniMetricsSceneIndexPlugin>();
}
TF_REGISTRY_FUNCTION(HdSceneIndexPlugin)
{
const HdSceneIndexPluginRegistry::InsertionPhase insertionPhase = 1;
// register this scene index plugin with all renderers
// and try to insert ourselves early in the phases at the start
HdSceneIndexPluginRegistry::GetInstance().RegisterSceneIndexForRenderer(
"",
_tokens->sceneIndexPluginName,
nullptr,
insertionPhase,
HdSceneIndexPluginRegistry::InsertionOrderAtStart);
}
OmniMetricsSceneIndexPlugin::OmniMetricsSceneIndexPlugin() = default;
HdSceneIndexBaseRefPtr OmniMetricsSceneIndexPlugin::_AppendSceneIndex(
const HdSceneIndexBaseRefPtr& inputScene,
const HdContainerDataSourceHandle& inputArgs)
{
return OmniMetricsSceneIndex::New(inputScene, inputArgs);
}
PXR_NAMESPACE_CLOSE_SCOPE | 1,755 | C++ | 31.518518 | 76 | 0.768091 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsSchema.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/imaging/hd/retainedDataSource.h>
#include "metricsSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PUBLIC_TOKENS(HdOmniMetricsSchemaTokens, HDOMNI_METRICS_SCHEMA_TOKENS);
HdOmniMetricsSchema::HdOmniMetricsSchema(HdContainerDataSourceHandle container) :
HdSchema(container)
{
}
HdDoubleDataSourceHandle HdOmniMetricsSchema::GetLayerMpu()
{
return _GetTypedDataSource<HdDoubleDataSource>(HdOmniMetricsSchemaTokens->layerMpu);
}
HdDoubleDataSourceHandle HdOmniMetricsSchema::GetStageMpu()
{
return _GetTypedDataSource<HdDoubleDataSource>(HdOmniMetricsSchemaTokens->stageMpu);
}
HdContainerDataSourceHandle HdOmniMetricsSchema::BuildRetained(
const HdDoubleDataSourceHandle& layerMpu,
const HdDoubleDataSourceHandle& stageMpu)
{
TfToken names[2];
HdDataSourceBaseHandle values[2];
size_t count = 0;
if(layerMpu != nullptr)
{
names[count] = HdOmniMetricsSchemaTokens->layerMpu;
values[count++] = layerMpu;
}
if (stageMpu != nullptr)
{
names[count] = HdOmniMetricsSchemaTokens->stageMpu;
values[count++] = stageMpu;
}
return HdRetainedContainerDataSource::New(count, names, values);
}
HdOmniMetricsSchema HdOmniMetricsSchema::GetFromParent(const HdContainerDataSourceHandle& fromParentContainer)
{
return HdOmniMetricsSchema(fromParentContainer ?
HdContainerDataSource::Cast(fromParentContainer->Get(HdOmniMetricsSchemaTokens->metrics))
: nullptr);
}
const HdDataSourceLocator& HdOmniMetricsSchema::GetDefaultLocator()
{
static const HdDataSourceLocator locator(HdOmniMetricsSchemaTokens->metrics);
return locator;
}
HdOmniMetricsSchema::Builder& HdOmniMetricsSchema::Builder::SetLayerMpu(const HdDoubleDataSourceHandle& layerMpu)
{
_layerMpu = layerMpu;
return *this;
}
HdOmniMetricsSchema::Builder& HdOmniMetricsSchema::Builder::SetStageMpu(const HdDoubleDataSourceHandle& stageMpu)
{
_stageMpu = stageMpu;
return *this;
}
HdContainerDataSourceHandle HdOmniMetricsSchema::Builder::Build()
{
return HdOmniMetricsSchema::BuildRetained(
_layerMpu,
_stageMpu
);
}
PXR_NAMESPACE_CLOSE_SCOPE | 2,762 | C++ | 28.08421 | 113 | 0.761405 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsSceneIndexPlugin.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_METRICS_SCENE_INDEX_PLUGIN_H_
#define OMNI_METRICS_SCENE_INDEX_PLUGIN_H_
#include <pxr/pxr.h>
#include <pxr/imaging/hd/sceneIndexPlugin.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
///
/// \class OmniMetricsSceneIndexPlugin
///
/// Defines the Hydra 2.0 scene index plugin that creates
/// the OmniMetricsSceneIndex.
///
class OmniMetricsSceneIndexPlugin : public HdSceneIndexPlugin
{
public:
OmniMetricsSceneIndexPlugin();
protected:
HdSceneIndexBaseRefPtr _AppendSceneIndex(const HdSceneIndexBaseRefPtr& inputScene,
const HdContainerDataSourceHandle& inputArgs) override;
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif // OMNI_METRICS_SCENE_INDEX_PLUGIN_H_ | 1,275 | C | 29.380952 | 86 | 0.763137 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsDoubleDataSource.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef HD_OMNI_METRICS_DOUBLE_DATA_SOURCE_H_
#define HD_OMNI_METRICS_DOUBLE_DATA_SOURCE_H_
#include <pxr/imaging/hd/dataSource.h>
#include <pxr/imaging/hd/dataSourceTypeDefs.h>
PXR_NAMESPACE_OPEN_SCOPE
///
/// \class HdOmniMetricsDoubleDataSource
///
/// Concrete implementation for a simple data source that
/// holds a uniform double value.
///
class HdOmniMetricsDoubleDataSource : public HdDoubleDataSource
{
public:
HD_DECLARE_DATASOURCE(HdOmniMetricsDoubleDataSource);
VtValue GetValue(Time shutterOffset) override;
double GetTypedValue(Time shutterOffset) override;
bool GetContributingSampleTimesForInterval(
Time startTime,
Time endTime,
std::vector<Time>* outSampleTimes) override;
private:
HdOmniMetricsDoubleDataSource(double value);
double _value;
};
HD_DECLARE_DATASOURCE_HANDLES(HdOmniMetricsDoubleDataSource);
PXR_NAMESPACE_CLOSE_SCOPE
#endif // HD_OMNI_METRICS_DOUBLE_DATA_SOURCE_H_ | 1,550 | C | 29.411764 | 75 | 0.759355 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsDoubleDataSource.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "metricsDoubleDataSource.h"
PXR_NAMESPACE_OPEN_SCOPE
HdOmniMetricsDoubleDataSource::HdOmniMetricsDoubleDataSource(double value) : _value(value)
{
}
VtValue HdOmniMetricsDoubleDataSource::GetValue(Time shutterOffset)
{
return VtValue(this->GetTypedValue(shutterOffset));
}
double HdOmniMetricsDoubleDataSource::GetTypedValue(Time shutterOffset)
{
return _value;
}
bool HdOmniMetricsDoubleDataSource::GetContributingSampleTimesForInterval(
Time startTime,
Time endTime,
std::vector<Time>* outSampleTimes)
{
return false;
}
PXR_NAMESPACE_CLOSE_SCOPE | 1,178 | C++ | 27.756097 | 90 | 0.773345 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsSchema.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_METRICS_SCHEMA_H_
#define OMNI_METRICS_SCHEMA_H_
#include <pxr/imaging/hd/schema.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
//-----------------------------------------------------------------------------
#define HDOMNI_METRICS_SCHEMA_TOKENS \
(metrics) \
(layerMpu) \
(stageMpu)
TF_DECLARE_PUBLIC_TOKENS(HdOmniMetricsSchemaTokens, OMNIMETRICSASSEMBLER_API,
HDOMNI_METRICS_SCHEMA_TOKENS);
//-----------------------------------------------------------------------------
class HdOmniMetricsSchema : public HdSchema
{
public:
HdOmniMetricsSchema(HdContainerDataSourceHandle container);
OMNIMETRICSASSEMBLER_API
HdDoubleDataSourceHandle GetLayerMpu();
OMNIMETRICSASSEMBLER_API
HdDoubleDataSourceHandle GetStageMpu();
OMNIMETRICSASSEMBLER_API
static HdContainerDataSourceHandle
BuildRetained(
const HdDoubleDataSourceHandle& layerMpu,
const HdDoubleDataSourceHandle& stageMpu);
class Builder
{
public:
OMNIMETRICSASSEMBLER_API
Builder& SetLayerMpu(const HdDoubleDataSourceHandle& layerMpu);
OMNIMETRICSASSEMBLER_API
Builder& SetStageMpu(const HdDoubleDataSourceHandle& stageMpu);
OMNIMETRICSASSEMBLER_API
HdContainerDataSourceHandle Build();
private:
HdDoubleDataSourceHandle _layerMpu;
HdDoubleDataSourceHandle _stageMpu;
};
OMNIMETRICSASSEMBLER_API
static HdOmniMetricsSchema GetFromParent(
const HdContainerDataSourceHandle& fromParentContainer);
OMNIMETRICSASSEMBLER_API
static const HdDataSourceLocator& GetDefaultLocator();
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif // end OMNI_METRICS_SCHEMA_H_ | 2,292 | C | 28.025316 | 79 | 0.692845 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsAdapter.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/usd/usd/stage.h>
#include <pxr/usd/usdGeom/xformable.h>
#include <pxr/usd/usdGeom/sphere.h>
#include <pxr/imaging/hd/retainedDataSource.h>
#include <pxr/imaging/hd/overlayContainerDataSource.h>
#include <pxr/imaging/hd/xformSchema.h>
#include "metricsAdapter.h"
#include "metricsDoubleDataSource.h"
#include "metricsSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_REGISTRY_FUNCTION(TfType)
{
typedef OmniMetricsAssemblerAdapter Adapter;
TfType t = TfType::Define<Adapter, TfType::Bases<Adapter::BaseAdapter> >();
t.SetFactory<UsdImagingAPISchemaAdapterFactory<Adapter> >();
}
OmniMetricsAssemblerAdapter::~OmniMetricsAssemblerAdapter()
{
}
HdContainerDataSourceHandle OmniMetricsAssemblerAdapter::GetImagingSubprimData(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const UsdImagingDataSourceStageGlobals& stageGlobals)
{
if (prim.IsA<UsdGeomSphere>())
{
double stageMpu = 0.0;
UsdStageRefPtr stage = prim.GetStage();
if (!this->_GetMpuFromLayer(stage->GetRootLayer(), stageMpu))
{
// no explicitly authored MPU, so assume the documented
// default value of centimeters
// Open Issue: interesting case is when it isn't defined on
// another layer - should we assume documented default of cm
// or assume this means we should use the stage MPU?
stageMpu = 0.01;
}
// this PoC only looks at Spheres as a simplification of a much more general problem
// in this case, an MPU divergence is defined as layer.MPU != stage.MPU for the layer
// containing the site of the strongest opinion of the `radius` property of the sphere
UsdGeomSphere sphere = UsdGeomSphere(prim);
UsdAttribute radiusAttr = sphere.GetRadiusAttr();
// GetPropertyStack will give us the property specs for the attribute
// in strongest to weakest order
SdfPropertySpecHandleVector propertySpecs = radiusAttr.GetPropertyStack(UsdTimeCode::Default());
if (propertySpecs.size() != 0)
{
// only need to process if there are any property specs for the attribute
// and we only want the strongest
// Open Issue: may need to take into account whether the property is blocked
// which would indicate that it has no authored value
SdfPropertySpecHandle strongestSpec = propertySpecs[0];
SdfLayerHandle targetLayer = strongestSpec->GetLayer();
double layerMpu = 0.0;
if (!this->_GetMpuFromLayer(targetLayer, layerMpu))
{
// no explicitly authored layerMpu, so assume
// it's in the same MPU as the stage
return nullptr;
}
// are the layer MPU and stage MPU different? if so, we have a metrics divergence
if (layerMpu != stageMpu)
{
// there is a divergence, we record this information
// in a hydra data source and send that data source back
HdDataSourceBaseHandle metricsDataSource = HdOmniMetricsSchema::Builder()
.SetLayerMpu(HdOmniMetricsDoubleDataSource::New(layerMpu))
.SetStageMpu(HdOmniMetricsDoubleDataSource::New(stageMpu))
.Build();
return HdRetainedContainerDataSource::New(
HdOmniMetricsSchemaTokens->metrics,
metricsDataSource);
}
}
else
{
// in this case, there are no authored values for the property spec
// this one is semantically tricky, because we rely on a (potential)
// fallback value from the schema - but we have no layer target on which
// this is technically assigned. As such, we assume tha the fallback
// value is defined on the root layer itself.
TF_STATUS("No property specs in the property stack for the radius attribute!");
}
}
return nullptr;
}
HdDataSourceLocatorSet OmniMetricsAssemblerAdapter::InvalidateImagingSubprim(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const TfTokenVector& properties)
{
if (prim.IsA<UsdGeomSphere>())
{
// invalidate the prim by invalidating its xform
static const HdDataSourceLocatorSet locators {
HdXformSchema::GetDefaultLocator()
};
return locators;
}
return HdDataSourceLocatorSet();
}
bool OmniMetricsAssemblerAdapter::_GetMpuFromLayer(const SdfLayerHandle& layer, double& mpu)
{
SdfDataRefPtr metadata = layer->GetMetadata();
VtValue mpuValue;
if (metadata->Has(SdfPath::AbsoluteRootPath(), UsdGeomTokens->metersPerUnit, &mpuValue))
{
mpu = mpuValue.Get<double>();
}
else
{
TF_WARN("Unable to retrieve MPU metadata from layer!");
return false;
}
return true;
}
PXR_NAMESPACE_CLOSE_SCOPE | 5,659 | C++ | 36.986577 | 104 | 0.661778 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsSceneIndex.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_METRICS_SCENE_INDEX_H_
#define OMNI_METRICS_SCENE_INDEX_H_
#include <pxr/pxr.h>
#include <pxr/usd/sdf/pathTable.h>
#include <pxr/imaging/hd/filteringSceneIndex.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DECLARE_REF_PTRS(OmniMetricsSceneIndex);
///
/// \class OmniMetricsSceneIndex
///
/// A scene index responsible for observing an input flattened scene
/// index and producing a comparable scene in which metrics correctives
/// have been added to the appropriate places in the scene hiearchy
/// to correct for metrics divergences.
///
/// Note that with Render Delegate 2.0 and the ability to pull data
/// from a non-flattened scene, this implementation will have to be
/// revisited to work with the unflattened xform representation of
/// the hydra prims.
///
class OmniMetricsSceneIndex : public HdSingleInputFilteringSceneIndexBase
{
public:
OMNIMETRICSASSEMBLER_API
static OmniMetricsSceneIndexRefPtr New(const HdSceneIndexBaseRefPtr& inputSceneIndex,
const HdContainerDataSourceHandle& inputArgs = nullptr);
OMNIMETRICSASSEMBLER_API
~OmniMetricsSceneIndex() override;
OMNIMETRICSASSEMBLER_API
HdSceneIndexPrim GetPrim(const SdfPath& primPath) const override;
OMNIMETRICSASSEMBLER_API
SdfPathVector GetChildPrimPaths(const SdfPath& primPath) const override;
protected:
OmniMetricsSceneIndex(const HdSceneIndexBaseRefPtr& inputSceneIndex,
const HdContainerDataSourceHandle& inputArgs);
// these three are provided by HdSingleInputFilteringSceneIndexBase
// and must be overridden by inheritors
virtual void _PrimsAdded(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::AddedPrimEntries& entries) override;
virtual void _PrimsRemoved(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::RemovedPrimEntries& entries) override;
virtual void _PrimsDirtied(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::DirtiedPrimEntries& entries) override;
private:
void _DirtyHierarchy(const SdfPath& primPath, const HdDataSourceLocatorSet& locators, HdSceneIndexObserver::DirtiedPrimEntries* dirtyEntries);
void _WrapPrimsRecursively(const SdfPath& primPath);
private:
// wraps all prims in the scene with a metrics data source
SdfPathTable<HdSceneIndexPrim> _wrappedPrims;
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif | 2,972 | C | 33.97647 | 146 | 0.773217 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsAdapter.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_METRICS_ASSEMBLER_ADAPTER_H_
#define OMNI_METRICS_ASSEMBLER_ADAPTER_H_
#include <pxr/pxr.h>
#include <pxr/usdImaging/usdImaging/apiSchemaAdapter.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
///
/// \class OmniMetricsAssemblerAdapter
///
/// Stage scene index adapter which has the opportunity to evaluate each
/// prim in a scene to determine if the prim has divergent metrics present.
///
/// We use a trick here that a null adapter, while deriving from UsdImagingAPISchemaAdapter
/// gets a call for each USD prim traversed in the scene by the stage scene index. These
/// are known as "keyless adapters" and are supported by the UsdImagingAdapterRegistry.
///
class OmniMetricsAssemblerAdapter : public UsdImagingAPISchemaAdapter
{
public:
OMNIMETRICSASSEMBLER_API
~OmniMetricsAssemblerAdapter() override;
using BaseAdapter = UsdImagingAPISchemaAdapter;
OMNIMETRICSASSEMBLER_API
HdContainerDataSourceHandle GetImagingSubprimData(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const UsdImagingDataSourceStageGlobals& stageGlobals
) override;
OMNIMETRICSASSEMBLER_API
HdDataSourceLocatorSet InvalidateImagingSubprim(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const TfTokenVector& properties
) override;
private:
///
/// Retrieves the MPU value from the layer and returns it in mpu.
///
/// Returns true if the MPU value was able to be retrieved from the layer
/// and false otherwise.
///
bool _GetMpuFromLayer(const SdfLayerHandle& layer, double& mpu);
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif // OMNI_METRICS_ASSEMBLER_ADAPTER_H_ | 2,348 | C | 31.178082 | 91 | 0.739779 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsDataSource.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/imaging/hd/xformSchema.h>
#include "metricsDataSource.h"
#include "metricsSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PUBLIC_TOKENS(HdOmniMetricsDataSourceTokens,
HDOMNIMETRICSDATASOURCE_TOKENS);
HdOmniMetricsDataSource::HdOmniMetricsDataSource(const HdSceneIndexBase& index, const SdfPath& primPath,
HdContainerDataSourceHandle wrappedDataSource) :
_sceneIndex(index),
_primPath(primPath),
_wrappedDataSource(wrappedDataSource)
{
}
void HdOmniMetricsDataSource::UpdateWrappedDataSource(
HdContainerDataSourceHandle wrappedDataSource)
{
_wrappedDataSource = wrappedDataSource;
}
TfTokenVector HdOmniMetricsDataSource::GetNames()
{
// this will return everything supported by the wrapped
// data source - in some cases (xform) we will
// intercept, but most will be pass through
// we keep access to the underlying wrapped xform
// via a new token added by this datasource (this is required
// for computations involving a parent that has already
// been corrected)
TfTokenVector result = (_wrappedDataSource == nullptr) ? TfTokenVector() : _wrappedDataSource->GetNames();
result.push_back(HdOmniMetricsDataSourceTokens->metricsPreservedXform);
return result;
}
HdDataSourceBaseHandle HdOmniMetricsDataSource::Get(const TfToken& name)
{
if (name == HdXformSchemaTokens->xform)
{
// this is an intercept of the flattened transform matrix
// we need to (potentially) compute a metrics-corrected
// flattened transform matrix
return this->_ComputeCorrectedXform();
}
else if (name == HdOmniMetricsDataSourceTokens->metricsPreservedXform)
{
// this would be the original flattened matrix of the wrapped data source
if (_wrappedDataSource != nullptr)
{
return _wrappedDataSource->Get(HdXformSchemaTokens->xform);
}
}
// all other token values should be defer to the wrapped data source (if any)
if (_wrappedDataSource != nullptr)
{
return _wrappedDataSource->Get(name);
}
return nullptr;
}
bool HdOmniMetricsDataSource::IsPrimDirtied(const HdDataSourceLocatorSet& locators)
{
static const HdContainerDataSourceHandle containerNull(nullptr);
if (locators.Intersects(HdXformSchema::GetDefaultLocator()))
{
if (HdContainerDataSource::AtomicLoad(_computedCorrectedXformDataSource) != nullptr)
{
HdContainerDataSource::AtomicStore(_computedCorrectedXformDataSource, containerNull);
return true;
}
}
return false;
}
HdDataSourceBaseHandle HdOmniMetricsDataSource::_ComputeCorrectedXform()
{
// there are two cases to consider on the underlying wrapped data source:
// 1. The wrapped data source has metrics information.
// This means that the adapter determined there was a metrics
// divergence in the layers for the stage and the strongest
// opinionated layer for the xformOpOrder attribute. In this case
// it means that we have to correct the divergence directly by
// computing a new flattened local transform for the hydra prim
// 2. The wrapped data source does not have metrics information.
// This means that either the underlying prim has no Xformable data
// at all or that there was no metrics divergence detected.
// However, it could be the child of a divergent prim, and since
// all xforms have been flattened by the flattening scene index
// prior to us wrapping the data, we need to compute a new flattened
// matrix that takes into account the changes on the parent.
//
// the tricky thing is the dirtying associated with the cached data -
// computing whether a prim with divergence changed directly is easy
// but that change also invalidates the children (recusrively)
// if we have already cached the value, and the cache is valid
// return the computed cached value rather than recompute it
HdContainerDataSourceHandle computedCorrectedXformDataSource =
HdContainerDataSource::AtomicLoad(_computedCorrectedXformDataSource);
if (computedCorrectedXformDataSource != nullptr)
{
return computedCorrectedXformDataSource;
}
if (this->_HasMetricsInformation(_wrappedDataSource))
{
// in this case, we need the parent's flattened transform to recover
// the original local transform of the prim, once we have the original
// local transform we can apply the corrective as the last xformOp
// then reflatten by multiplying the parent transform again
SdfPath parentPath = _primPath.GetParentPath();
HdSceneIndexPrim parentPrim = _sceneIndex.GetPrim(parentPath);
computedCorrectedXformDataSource = HdXformSchema::Builder()
.SetMatrix(HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::New(
_wrappedDataSource, parentPrim.dataSource, true))
.SetResetXformStack(this->_GetInputResetXformStackSource())
.Build();
}
else
{
HdContainerDataSourceHandle metricsDataSource = nullptr;
if (_primPath == SdfPath::AbsoluteRootPath())
{
// just directly get whatever the absolute root path has
computedCorrectedXformDataSource = HdContainerDataSource::Cast(_wrappedDataSource->Get(HdXformSchemaTokens->xform));
}
else
{
for(SdfPath p = _primPath.GetParentPath(); p != SdfPath::AbsoluteRootPath(); p = p.GetParentPath())
{
HdSceneIndexPrim prim = _sceneIndex.GetPrim(p);
if (this->_HasMetricsInformation(prim.dataSource))
{
// a parent along the chain did have a metrics
// corrected xform, so we will need to recompute
metricsDataSource = prim.dataSource;
break;
}
}
if (metricsDataSource != nullptr)
{
// compute a new flattened xform from the parent
SdfPath parentPath = _primPath.GetParentPath();
HdSceneIndexPrim parentPrim = _sceneIndex.GetPrim(parentPath);
computedCorrectedXformDataSource = HdXformSchema::Builder()
.SetMatrix(HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::New(
_wrappedDataSource, parentPrim.dataSource, false))
.SetResetXformStack(this->_GetInputResetXformStackSource())
.Build();
}
else
{
// no parent in the chain had a metrics corrected xform
// so the result is really just the original flattened matrix
computedCorrectedXformDataSource = HdContainerDataSource::Cast(_wrappedDataSource->Get(HdXformSchemaTokens->xform));
}
}
}
// cache the data source we intend to use
HdContainerDataSource::AtomicStore(_computedCorrectedXformDataSource, computedCorrectedXformDataSource);
return computedCorrectedXformDataSource;
}
bool HdOmniMetricsDataSource::_HasMetricsInformation(HdContainerDataSourceHandle handle)
{
HdOmniMetricsSchema metricsSchema = HdOmniMetricsSchema::GetFromParent(handle);
return metricsSchema.IsDefined();
}
HdBoolDataSourceHandle HdOmniMetricsDataSource::_GetInputResetXformStackSource()
{
if (_wrappedDataSource != nullptr)
{
return HdBoolDataSource::Cast(
_wrappedDataSource->Get(HdXformSchemaTokens->resetXformStack)
);
}
return nullptr;
}
HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::_MetricsCorrectedMatrixDataSource(
HdContainerDataSourceHandle inputDataSource,
HdContainerDataSourceHandle parentDataSource,
bool isMetricsCorrectiveSource) :
_inputDataSource(inputDataSource),
_parentDataSource(parentDataSource),
_isMetricsCorrectiveSource(isMetricsCorrectiveSource)
{
}
VtValue HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::GetValue(Time shutterOffset)
{
return VtValue(this->GetTypedValue(shutterOffset));
}
GfMatrix4d HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::GetTypedValue(Time shutterOffset)
{
return this->_ComputeCorrectedMatrix(shutterOffset);
}
bool HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::GetContributingSampleTimesForInterval(
Time startTime,
Time endTime,
std::vector<Time>* outSampleTimes)
{
HdSampledDataSourceHandle sources[] = {
this->_GetInputMatrixDataSource(),
this->_GetParentMatrixDataSource()
};
return HdGetMergedContributingSampleTimesForInterval(
TfArraySize(sources),
sources,
startTime,
endTime,
outSampleTimes
);
}
HdMatrixDataSourceHandle HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::_GetParentMetricsPreservedMatrixDataSource() const
{
HdOmniMetricsDataSourceHandle metricsDataSource = HdOmniMetricsDataSource::Cast(_parentDataSource);
if (metricsDataSource != nullptr)
{
HdContainerDataSourceHandle xformDataSource =
HdContainerDataSource::Cast(
metricsDataSource->Get(HdOmniMetricsDataSourceTokens->metricsPreservedXform));
if (xformDataSource == nullptr)
{
return this->_GetParentMatrixDataSource();
}
HdMatrixDataSourceHandle matrixDataSource = HdMatrixDataSource::Cast(
xformDataSource->Get(HdXformSchemaTokens->matrix));
if (matrixDataSource == nullptr)
{
TF_WARN("Xform schema not defined on preserved container data source!");
}
return (matrixDataSource != nullptr) ? matrixDataSource : this->_GetParentMatrixDataSource();
}
// if it didn't have metrics information attached
// just get the original matrix
return this->_GetParentMatrixDataSource();
}
HdMatrixDataSourceHandle HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::_GetParentMatrixDataSource() const
{
HdXformSchema xformSchema = HdXformSchema::GetFromParent(_parentDataSource);
if (xformSchema.IsDefined())
{
return xformSchema.GetMatrix();
}
return nullptr;
}
HdMatrixDataSourceHandle HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::_GetInputMatrixDataSource() const
{
return HdXformSchema::GetFromParent(_inputDataSource).GetMatrix();
}
GfMatrix4d HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::_ComputeCorrectedMatrix(Time shutterOffset)
{
// since we are dealing with flattened transformations, we have to recover
// the local transform of the input data source in question
// we can do this by knowing the prim's flattened transform
// and the original transform of its parent (the _parentDataSource)
// Let FT be the flattened transform, P be the transform of the parent,
// and LT be the child's local transform. The flattened transform would
// then have been computed as FT = (P)(LT), thus to recover LT we divide
// out by P, which results in LT = (FT) / (P) = FT * (P)^-1
// so we need the inverse of the original parent transform
HdMatrixDataSourceHandle parentPreservedMatrixDataSource = this->_GetParentMetricsPreservedMatrixDataSource();
HdMatrixDataSourceHandle parentMatrixDataSource = this->_GetParentMatrixDataSource();
HdMatrixDataSourceHandle inputMatrixDataSource = this->_GetInputMatrixDataSource();
GfMatrix4d parentMatrix = (parentPreservedMatrixDataSource != nullptr) ?
parentPreservedMatrixDataSource->GetTypedValue(shutterOffset) :
GfMatrix4d(1.0);
GfMatrix4d currentFlattenedTransform = inputMatrixDataSource->GetTypedValue(shutterOffset);
GfMatrix4d inverseParentMatrix = parentMatrix.GetInverse();
GfMatrix4d originalLocalTransform = currentFlattenedTransform * inverseParentMatrix;
// do we need to apply a corrective?
if (_isMetricsCorrectiveSource)
{
// this is a computation requiring a new metrics corrected local
// transform computed from the original data rather than the
// flattened transform already there
GfMatrix4d mpuCorrective = this->_GetMpuCorrective();
GfMatrix4d correctedTransform = originalLocalTransform * mpuCorrective;
// now apply the parent transform to get the new flattened child transform
GfMatrix4d parentMatrix = (parentMatrixDataSource != nullptr) ?
parentMatrixDataSource->GetTypedValue(shutterOffset) :
GfMatrix4d(1.0);
return parentMatrix * correctedTransform;
}
else
{
// no local corrective necessary, just reconcatenate with the new parent
// transform to form the final new flattened child
GfMatrix4d parentUpdatedMatrix = (parentMatrixDataSource != nullptr) ?
parentMatrixDataSource->GetTypedValue(shutterOffset) :
GfMatrix4d(1.0);
return parentUpdatedMatrix * originalLocalTransform;
}
}
GfMatrix4d HdOmniMetricsDataSource::_MetricsCorrectedMatrixDataSource::_GetMpuCorrective()
{
// retrieve the layer and stage MPU values from the wrapped prim
HdOmniMetricsSchema metricsSchema = HdOmniMetricsSchema::GetFromParent(_inputDataSource);
if (!metricsSchema.IsDefined())
{
TF_WARN("MPU divergency was detected but data source has no metrics information!");
return GfMatrix4d(1.0);
}
double mpuCorrectiveValue = metricsSchema.GetLayerMpu()->GetTypedValue(0.0) /
metricsSchema.GetStageMpu()->GetTypedValue(0.0);
GfMatrix4d uniformScaleTransform(1.0);
uniformScaleTransform.SetScale(mpuCorrectiveValue);
return uniformScaleTransform;
}
PXR_NAMESPACE_CLOSE_SCOPE | 14,468 | C++ | 38.859504 | 135 | 0.709773 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniMetricsAssembler/metricsSceneIndex.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/base/work/utils.h>
#include <pxr/imaging/hd/xformSchema.h>
#include "metricsSceneIndex.h"
#include "metricsDataSource.h"
PXR_NAMESPACE_OPEN_SCOPE
OmniMetricsSceneIndexRefPtr OmniMetricsSceneIndex::New(
const HdSceneIndexBaseRefPtr& inputSceneIndex,
const HdContainerDataSourceHandle& inputArgs)
{
return TfCreateRefPtr(new OmniMetricsSceneIndex(inputSceneIndex, inputArgs));
}
OmniMetricsSceneIndex::OmniMetricsSceneIndex(const HdSceneIndexBaseRefPtr& inputSceneIndex,
const HdContainerDataSourceHandle& inputArgs) :
HdSingleInputFilteringSceneIndexBase(inputSceneIndex)
{
_WrapPrimsRecursively(SdfPath::AbsoluteRootPath());
}
OmniMetricsSceneIndex::~OmniMetricsSceneIndex() = default;
HdSceneIndexPrim OmniMetricsSceneIndex::GetPrim(const SdfPath &primPath) const
{
// if we have the prim wrapped, return the wrapped one
const auto it = _wrappedPrims.find(primPath);
if (it != _wrappedPrims.end())
{
return it->second;
}
// there shouldn't be a scenario where the prim isn't wrapped
// but in case there is, we return whatever the base scene index
// gives back
return this->_GetInputSceneIndex()->GetPrim(primPath);
}
SdfPathVector OmniMetricsSceneIndex::GetChildPrimPaths(const SdfPath& primPath) const
{
// no change in topology occurs as part of this scene index
// so we can ask the input scene to get the child prim paths directly
return this->_GetInputSceneIndex()->GetChildPrimPaths(primPath);
}
void OmniMetricsSceneIndex::_PrimsAdded(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::AddedPrimEntries& entries)
{
HdSceneIndexObserver::DirtiedPrimEntries dirtyEntries;
for(const HdSceneIndexObserver::AddedPrimEntry& entry : entries)
{
HdSceneIndexPrim sceneIndexPrim = this->_GetInputSceneIndex()->GetPrim(entry.primPath);
HdContainerDataSourceHandle dataSource = sceneIndexPrim.dataSource;
// attempt to insert a wrapped version for this prim
auto it = _wrappedPrims.insert(
{
entry.primPath,
HdSceneIndexPrim()
});
// get a reference to the inserted prim
// this will be the existing one if insertion failed
HdSceneIndexPrim &prim = it.first->second;
prim.primType = entry.primType;
// if the wrapper does exist, we have to update the data source
if (prim.dataSource != nullptr)
{
HdOmniMetricsDataSource::Cast(prim.dataSource)->UpdateWrappedDataSource(dataSource);
}
else
{
// new insertion, so it wasn't wrapped previously
// wrap the data source here
prim.dataSource = HdOmniMetricsDataSource::New(*this, entry.primPath, dataSource);
}
// if this was a new insertion in the middle of the hieararchy
// we need to invalidate descendent flattened attributes
if (!it.second)
{
// Open Issue: we don't handle this here, because it's just a PoC
// looking at spheres, but in general, we would need to build a set
// containing the locators we are interested in (at minimum this would
// be the transform of the prim itself, HdXformSchemaTokens->xform)
// and make sure the entire prim hierarchy is dirtied if the data source
// associated is dirtied based on that locator
// since this likely requires a plug-in system to solve metrics assembly
// generically, we defer this to a more general solution
}
}
// forward on the notification
this->_SendPrimsAdded(entries);
// also, if we had to dirty entries because of an insertion in the middle
// of the stage hierarchy, send those along too
if (!dirtyEntries.empty())
{
this->_SendPrimsDirtied(dirtyEntries);
}
}
void OmniMetricsSceneIndex::_PrimsRemoved(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::RemovedPrimEntries& entries)
{
for (const HdSceneIndexObserver::RemovedPrimEntry& entry : entries)
{
if (entry.primPath.IsAbsoluteRootPath())
{
// removing the whole scene
_wrappedPrims.ClearInParallel();
TfReset(_wrappedPrims);
}
else
{
auto startEndRangeIterator = _wrappedPrims.FindSubtreeRange(entry.primPath);
for (auto it = startEndRangeIterator.first; it != startEndRangeIterator.second; it++)
{
WorkSwapDestroyAsync(it->second.dataSource);
}
if(startEndRangeIterator.first != startEndRangeIterator.second)
{
_wrappedPrims.erase(startEndRangeIterator.first);
}
}
}
_SendPrimsRemoved(entries);
}
void OmniMetricsSceneIndex::_PrimsDirtied(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::DirtiedPrimEntries& entries)
{
HdSceneIndexObserver::DirtiedPrimEntries dirtyEntries;
for (const HdSceneIndexObserver::DirtiedPrimEntry& entry : entries)
{
HdDataSourceLocatorSet locators;
if (entry.dirtyLocators.Intersects(HdXformSchema::GetDefaultLocator()))
{
locators.insert(HdXformSchema::GetDefaultLocator());
}
// Open Issue: what about the radius locator? we would need that, but
// it depends on where our scene index resides - it may already have
// been converted by the ImplicitSceneIndex into a mesh (and it's hard
// to know where exactly our scene index will be inserted)
// we don't solve it here because a general metrics assembler wouldn't
// be considering spheres only, so we defer that to a more general solution
if (!locators.IsEmpty())
{
this->_DirtyHierarchy(entry.primPath, locators, &dirtyEntries);
}
}
_SendPrimsDirtied(entries);
if (!dirtyEntries.empty())
{
_SendPrimsDirtied(dirtyEntries);
}
}
void OmniMetricsSceneIndex::_DirtyHierarchy(const SdfPath& primPath, const HdDataSourceLocatorSet& locators,
HdSceneIndexObserver::DirtiedPrimEntries* dirtyEntries)
{
// find subtree range retrieves a start end pair of children
// in the subtree of the given prim path
auto startEndRangeIterator = _wrappedPrims.FindSubtreeRange(primPath);
for (auto it = startEndRangeIterator.first; it != startEndRangeIterator.second;)
{
HdOmniMetricsDataSourceHandle dataSource = HdOmniMetricsDataSource::Cast(it->second.dataSource);
if (dataSource != nullptr)
{
if (dataSource->IsPrimDirtied(locators))
{
if (it->first != primPath)
{
dirtyEntries->emplace_back(it->first, locators);
}
it++;
}
else
{
it = it.GetNextSubtree();
}
}
else
{
it = it++;
}
}
}
void OmniMetricsSceneIndex::_WrapPrimsRecursively(const SdfPath& primPath)
{
HdSceneIndexPrim prim = this->_GetInputSceneIndex()->GetPrim(primPath);
HdOmniMetricsDataSourceHandle wrappedDataSource = HdOmniMetricsDataSource::New(*this, primPath, prim.dataSource);
_wrappedPrims.insert(
{
primPath,
HdSceneIndexPrim
{
prim.primType,
std::move(wrappedDataSource)
}
}
);
for (const SdfPath& childPath : this->_GetInputSceneIndex()->GetChildPrimPaths(primPath))
{
this->_WrapPrimsRecursively(childPath);
}
}
PXR_NAMESPACE_CLOSE_SCOPE | 8,306 | C++ | 34.5 | 117 | 0.663255 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpPythonModule.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#ifndef OMNI_WARP_SCENE_INDEX_WARP_PYTHON_MODULE_H
#define OMNI_WARP_SCENE_INDEX_WARP_PYTHON_MODULE_H
#include <string>
#include <pxr/pxr.h>
#include <pxr/base/tf/declarePtrs.h>
#include <pxr/base/vt/value.h>
#include <pxr/imaging/hd/meshSchema.h>
#include <pxr/usdImaging/usdImaging/stageSceneIndex.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DECLARE_REF_PTRS(OmniWarpPythonModule);
///
/// \class OmniWarpPythonModule
///
///
///
///
///
class OmniWarpPythonModule
{
public:
OmniWarpPythonModule(const SdfPath &primPath, const std::string& moduleName,
UsdImagingStageSceneIndexConstRefPtr usdImagingSi);
~OmniWarpPythonModule();
void InitMesh(VtIntArray indices, VtVec3fArray vertices,
VtIntArray depIndices, VtVec3fArray depVertices, VtDictionary simParams);
void InitParticles(VtVec3fArray positions,
VtIntArray depIndices, VtVec3fArray depVertices, VtDictionary simParams);
VtVec3fArray ExecSim(VtDictionary simParams);
VtVec3fArray ExecSim(VtDictionary simParams, VtVec3fArray dependentVertices);
private:
std::string _moduleName;
SdfPath _primPath;
UsdImagingStageSceneIndexConstRefPtr _usdImagingSi;
};
using OmniWarpPythonModuleSharedPtr = std::shared_ptr<class OmniWarpPythonModule>;
PXR_NAMESPACE_CLOSE_SCOPE
#endif // OMNI_WARP_SCENE_INDEX_WARP_PYTHON_MODULE_H | 1,956 | C | 29.107692 | 82 | 0.75818 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpSceneIndexPlugin.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include <pxr/imaging/hd/sceneIndexPluginRegistry.h>
#include <pxr/imaging/hio/glslfx.h>
#include "warpSceneIndexPlugin.h"
#include "warpSceneIndex.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PRIVATE_TOKENS(
_tokens,
((sceneIndexPluginName, "Omni_WarpSceneIndexPlugin")));
static const char* const _pluginDisplayName = "GL";
TF_REGISTRY_FUNCTION(TfType)
{
HdSceneIndexPluginRegistry::Define<
Omni_WarpSceneIndexPlugin>();
}
TF_REGISTRY_FUNCTION(HdSceneIndexPlugin)
{
const HdSceneIndexPluginRegistry::InsertionPhase insertionPhase = 0;
HdSceneIndexPluginRegistry::GetInstance().RegisterSceneIndexForRenderer(
_pluginDisplayName, _tokens->sceneIndexPluginName, nullptr,
insertionPhase, HdSceneIndexPluginRegistry::InsertionOrderAtStart);
}
Omni_WarpSceneIndexPlugin::
Omni_WarpSceneIndexPlugin() = default;
Omni_WarpSceneIndexPlugin::
~Omni_WarpSceneIndexPlugin() = default;
HdSceneIndexBaseRefPtr
Omni_WarpSceneIndexPlugin::_AppendSceneIndex(
const HdSceneIndexBaseRefPtr& inputSceneIndex,
const HdContainerDataSourceHandle& inputArgs)
{
TF_UNUSED(inputArgs);
return OmniWarpSceneIndex::New(
inputSceneIndex);
}
PXR_NAMESPACE_CLOSE_SCOPE
| 1,807 | C++ | 28.16129 | 76 | 0.767571 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpComputationSchema.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#ifndef OMNI_WARP_SCENE_INDEX_WARP_COMPUTATION_SCHEMA_H
#define OMNI_WARP_SCENE_INDEX_WARP_COMPUTATION_SCHEMA_H
#include <pxr/imaging/hd/schema.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
//-----------------------------------------------------------------------------
#define OMNIWARPCOMPUTATION_SCHEMA_TOKENS \
(warpComputation) \
(sourceFile) \
(dependentPrims) \
(simulationParams) \
TF_DECLARE_PUBLIC_TOKENS(OmniWarpComputationSchemaTokens, OMNIWARPSCENEINDEX_API,
OMNIWARPCOMPUTATION_SCHEMA_TOKENS);
//-----------------------------------------------------------------------------
class OmniWarpComputationSchema : public HdSchema
{
public:
OmniWarpComputationSchema(HdContainerDataSourceHandle container)
: HdSchema(container) {}
//ACCESSORS
OMNIWARPSCENEINDEX_API
HdStringDataSourceHandle GetSourceFile();
OMNIWARPSCENEINDEX_API
HdPathArrayDataSourceHandle GetDependentPrims();
OMNIWARPSCENEINDEX_API
HdSampledDataSourceHandle GetSimulationParams();
// RETRIEVING AND CONSTRUCTING
/// Builds a container data source which includes the provided child data
/// sources. Parameters with nullptr values are excluded. This is a
/// low-level interface. For cases in which it's desired to define
/// the container with a sparse set of child fields, the Builder class
/// is often more convenient and readable.
OMNIWARPSCENEINDEX_API
static HdContainerDataSourceHandle
BuildRetained(
const HdStringDataSourceHandle &sourceFile,
const HdPathArrayDataSourceHandle &dependentPrims,
const HdSampledDataSourceHandle &simulationParams
);
/// \class OmniWarpComputationSchema::Builder
///
/// Utility class for setting sparse sets of child data source fields to be
/// filled as arguments into BuildRetained. Because all setter methods
/// return a reference to the instance, this can be used in the "builder
/// pattern" form.
class Builder
{
public:
OMNIWARPSCENEINDEX_API
Builder &SetSourceFile(
const HdStringDataSourceHandle &sourceFile);
OMNIWARPSCENEINDEX_API
Builder &SetDependentPrims(
const HdPathArrayDataSourceHandle &dependentPrims);
Builder &SetSimulationParams(
const HdSampledDataSourceHandle &simulationParams);
/// Returns a container data source containing the members set thus far.
OMNIWARPSCENEINDEX_API
HdContainerDataSourceHandle Build();
private:
HdStringDataSourceHandle _sourceFile;
HdPathArrayDataSourceHandle _dependentPrims;
HdSampledDataSourceHandle _simulationParams;
};
/// Retrieves a container data source with the schema's default name token
/// "warpComputation" from the parent container and constructs a
/// OmniWarpComputationSchema instance.
/// Because the requested container data source may not exist, the result
/// should be checked with IsDefined() or a bool comparison before use.
OMNIWARPSCENEINDEX_API
static OmniWarpComputationSchema GetFromParent(
const HdContainerDataSourceHandle &fromParentContainer);
/// Returns a token where the container representing this schema is found in
/// a container by default.
OMNIWARPSCENEINDEX_API
static const TfToken &GetSchemaToken();
/// Returns an HdDataSourceLocator (relative to the prim-level data source)
/// where the container representing this schema is found by default.
OMNIWARPSCENEINDEX_API
static const HdDataSourceLocator &GetDefaultLocator();
/// Returns an HdDataSourceLocator (relative to the prim-level data source)
/// where the source file can be found.
/// This is often useful for checking intersection against the
/// HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
OMNIWARPSCENEINDEX_API
static const HdDataSourceLocator &GetSourceFileLocator();
/// Returns an HdDataSourceLocator (relative to the prim-level data source)
/// where the dependent prims.
/// This is often useful for checking intersection against the
/// HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
OMNIWARPSCENEINDEX_API
static const HdDataSourceLocator &GetDependentPrimsLocator();
/// Returns an HdDataSourceLocator (relative to the prim-level data source)
/// where the simulation params can be found.
/// This is often useful for checking intersection against the
/// HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
OMNIWARPSCENEINDEX_API
static const HdDataSourceLocator &GetSimulationParamsLocator();
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif | 5,329 | C | 36.013889 | 81 | 0.719835 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpComputationAPIAdapter.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#ifndef OMNI_WARP_SCENE_INDEX_WARP_COMPUTATION_API_ADAPTER_H
#define OMNI_WARP_SCENE_INDEX_WARP_COMPUTATION_API_ADAPTER_H
#include <pxr/usdImaging/usdImaging/apiSchemaAdapter.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
class WarpComputationAPIAdapter : public UsdImagingAPISchemaAdapter
{
public:
using BaseAdapter = UsdImagingAPISchemaAdapter;
OMNIWARPSCENEINDEX_API
HdContainerDataSourceHandle GetImagingSubprimData(
UsdPrim const& prim,
TfToken const& subprim,
TfToken const& appliedInstanceName,
const UsdImagingDataSourceStageGlobals &stageGlobals) override;
#if PXR_VERSION < 2308
OMNIWARPSCENEINDEX_API
HdDataSourceLocatorSet InvalidateImagingSubprim(
UsdPrim const& prim,
TfToken const& subprim,
TfToken const& appliedInstanceName,
TfTokenVector const& properties) override;
#else
OMNIWARPSCENEINDEX_API
HdDataSourceLocatorSet InvalidateImagingSubprim(
UsdPrim const& prim,
TfToken const& subprim,
TfToken const& appliedInstanceName,
TfTokenVector const& properties,
UsdImagingPropertyInvalidationType invalidationType) override;
#endif
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif // OMNI_WARP_SCENE_INDEX_WARP_COMPUTATION_API_ADAPTER_H
| 1,927 | C | 31.677966 | 75 | 0.732226 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpSceneIndex.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include <string>
#include <pxr/base/tf/pyInvoke.h>
#include <pxr/base/tf/errorMark.h>
#include <pxr/base/tf/pyExceptionState.h>
#include <pxr/base/tf/pyInterpreter.h>
#include <pxr/imaging/hd/primvarSchema.h>
#include <pxr/imaging/hd/primvarsSchema.h>
#include <pxr/imaging/hd/retainedDataSource.h>
#include <pxr/imaging/hd/tokens.h>
#include <pxr/imaging/hd/meshSchema.h>
#include "pxr/imaging/hd/instancerTopologySchema.h"
#include "warpSceneIndex.h"
#include "tokens.h"
#ifdef PXR_PYTHON_SUPPORT_ENABLED
#include <pxr/base/tf/pyInterpreter.h>
#endif // PXR_PYTHON_SUPPORT_ENABLED
PXR_NAMESPACE_OPEN_SCOPE
static VtDictionary
GetSimulationParams(HdContainerDataSourceHandle ds)
{
VtDictionary vtSimParams;
auto warpContainer = HdContainerDataSource::Cast(ds->Get(OmniWarpComputationSchemaTokens->warpComputation));
if (warpContainer)
{
TfTokenVector names = warpContainer->GetNames();
if (std::find(names.begin(), names.end(), OmniWarpComputationSchemaTokens->simulationParams) != names.end())
{
OmniWarpComputationSchema warpSchema = OmniWarpComputationSchema::GetFromParent(ds);
if (warpSchema)
{
VtValue metaData = warpSchema.GetSimulationParams()->GetValue(0);
if (metaData.IsHolding<VtDictionary>())
{
vtSimParams = metaData.UncheckedGet<VtDictionary>();
}
}
}
}
return vtSimParams;
}
static UsdImagingStageSceneIndexRefPtr
FindUsdImagingSceneIndex(const std::vector<HdSceneIndexBaseRefPtr>& inputScenes)
{
TfRefPtr<UsdImagingStageSceneIndex> retVal;
for (size_t i = 0; i < inputScenes.size(); i++)
{
HdSceneIndexBaseRefPtr const &sceneIdx = inputScenes[i];
if (UsdImagingStageSceneIndexRefPtr const imagingSI = TfDynamic_cast<UsdImagingStageSceneIndexRefPtr>(sceneIdx))
{
retVal = imagingSI;
break;
}
if (HdFilteringSceneIndexBaseRefPtr const filteringSi = TfDynamic_cast<HdFilteringSceneIndexBaseRefPtr>(sceneIdx))
{
retVal = FindUsdImagingSceneIndex(filteringSi->GetInputScenes());
if (retVal)
{
break;
}
}
}
return retVal;
}
OmniWarpSceneIndexRefPtr
OmniWarpSceneIndex::New(
const HdSceneIndexBaseRefPtr &inputSceneIndex)
{
return TfCreateRefPtr(
new OmniWarpSceneIndex(
inputSceneIndex));
}
OmniWarpSceneIndex::OmniWarpSceneIndex(
const HdSceneIndexBaseRefPtr &inputSceneIndex)
: HdSingleInputFilteringSceneIndexBase(inputSceneIndex)
{
}
/// A convenience data source implementing the primvar schema from
/// a triple of primvar value, interpolation and role. The latter two
/// are given as tokens. The value can be given either as data source
/// or as thunk returning a data source which is evaluated on each
/// Get.
class _PrimvarDataSource final : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(_PrimvarDataSource);
TfTokenVector GetNames() override {
return {HdPrimvarSchemaTokens->primvarValue,
HdPrimvarSchemaTokens->interpolation,
HdPrimvarSchemaTokens->role};
}
HdDataSourceBaseHandle Get(const TfToken &name) override {
if (name == HdPrimvarSchemaTokens->primvarValue) {
return _primvarValueSrc;
}
if (name == HdPrimvarSchemaTokens->interpolation) {
return
HdPrimvarSchema::BuildInterpolationDataSource(
_interpolation);
}
if (name == HdPrimvarSchemaTokens->role) {
return
HdPrimvarSchema::BuildRoleDataSource(
_role);
}
return nullptr;
}
private:
_PrimvarDataSource(
const HdDataSourceBaseHandle &primvarValueSrc,
const TfToken &interpolation,
const TfToken &role)
: _primvarValueSrc(primvarValueSrc)
, _interpolation(interpolation)
, _role(role)
{
}
HdDataSourceBaseHandle _primvarValueSrc;
TfToken _interpolation;
TfToken _role;
};
class _PointsDataSource : public HdVec3fArrayDataSource
{
public:
HD_DECLARE_DATASOURCE(_PointsDataSource);
VtValue GetValue(const Time shutterOffset) override {
return VtValue(GetTypedValue(shutterOffset));
}
VtVec3fArray GetTypedValue(const Time shutterOffset) override
{
HdPrimvarsSchema depPrimVarsSchema = HdPrimvarsSchema::GetFromParent(_depDs);
if (depPrimVarsSchema)
{
HdPrimvarSchema depPrimVar = depPrimVarsSchema.GetPrimvar(HdTokens->points);
if (depPrimVar)
{
HdSampledDataSourceHandle valueDataSource = depPrimVar.GetPrimvarValue();
auto pointsVt = valueDataSource->GetValue(0.f);
VtVec3fArray pointsArray = pointsVt.UncheckedGet<VtArray<GfVec3f>>();
return _pythonModule->ExecSim(GetSimulationParams(_simParamsDs), pointsArray);
}
}
return _pythonModule->ExecSim(GetSimulationParams(_simParamsDs));
}
bool GetContributingSampleTimesForInterval(
const Time startTime,
const Time endTime,
std::vector<Time> * const outSampleTimes) override
{
return false;
}
private:
_PointsDataSource(HdPrimvarsSchema &primVarSchema, OmniWarpPythonModuleSharedPtr pythonModule,
const HdContainerDataSourceHandle &simParamsDataSource,
const HdContainerDataSourceHandle &depDataSource)
: _schema(primVarSchema),
_pythonModule(pythonModule),
_simParamsDs(simParamsDataSource),
_depDs(depDataSource)
{
}
HdPrimvarsSchema& _schema;
OmniWarpPythonModuleSharedPtr _pythonModule;
HdContainerDataSourceHandle const _depDs;
HdContainerDataSourceHandle const _simParamsDs;
};
class _InstancePositionsDataSource : public HdVec3fArrayDataSource
{
public:
HD_DECLARE_DATASOURCE(_InstancePositionsDataSource);
VtValue GetValue(const Time shutterOffset) override {
return VtValue(GetTypedValue(shutterOffset));
}
VtVec3fArray GetTypedValue(const Time shutterOffset) override
{
HdPrimvarsSchema depPrimVarsSchema = HdPrimvarsSchema::GetFromParent(_depDs);
if (depPrimVarsSchema)
{
HdPrimvarSchema depPrimVar = depPrimVarsSchema.GetPrimvar(HdTokens->points);
if (depPrimVar)
{
HdSampledDataSourceHandle valueDataSource = depPrimVar.GetPrimvarValue();
auto pointsVt = valueDataSource->GetValue(0.f);
VtVec3fArray pointsArray = pointsVt.UncheckedGet<VtArray<GfVec3f>>();
return _pythonModule->ExecSim(GetSimulationParams(_simParamsDs), pointsArray);
}
}
return _pythonModule->ExecSim(GetSimulationParams(_simParamsDs));
}
bool GetContributingSampleTimesForInterval(
const Time startTime,
const Time endTime,
std::vector<Time> * const outSampleTimes) override
{
return false;
}
private:
_InstancePositionsDataSource(HdPrimvarsSchema &primVarSchema, OmniWarpPythonModuleSharedPtr pythonModule,
const HdContainerDataSourceHandle &depDataSource,
const HdContainerDataSourceHandle &simParamsDataSource)
: _schema(primVarSchema),
_pythonModule(pythonModule),
_depDs(depDataSource),
_simParamsDs(simParamsDataSource)
{
}
HdPrimvarsSchema& _schema;
HdContainerDataSourceHandle _depDs;
HdContainerDataSourceHandle _simParamsDs;
OmniWarpPythonModuleSharedPtr _pythonModule;
};
class _MeshPrimVarsOverrideDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(_MeshPrimVarsOverrideDataSource);
TfTokenVector GetNames() override
{
if (!_inputDs) {
return {};
}
return _inputDs->GetNames();
}
HdDataSourceBaseHandle Get(const TfToken &name) override
{
if (name == HdTokens->points)
{
return _PrimvarDataSource::New(
_PointsDataSource::New(_schema, _pythonModule, _simParamsDs, _depDs),
HdPrimvarSchemaTokens->vertex,
HdPrimvarSchemaTokens->point);
}
HdDataSourceBaseHandle result = _inputDs->Get(name);
return result;
}
private:
_MeshPrimVarsOverrideDataSource(const HdContainerDataSourceHandle &primDataSource,
HdPrimvarsSchema &primVarSchema, OmniWarpPythonModuleSharedPtr pythonModule,
const HdContainerDataSourceHandle &simParamsDataSource,
const HdContainerDataSourceHandle &depDataSource)
: _schema(primVarSchema),
_pythonModule(pythonModule),
_inputDs(primDataSource),
_simParamsDs(simParamsDataSource),
_depDs(depDataSource)
{
}
HdPrimvarsSchema _schema;
OmniWarpPythonModuleSharedPtr _pythonModule;
HdContainerDataSourceHandle const _depDs;
HdContainerDataSourceHandle const _inputDs;
HdContainerDataSourceHandle const _simParamsDs;
};
class _InstancerPrimVarsOverrideDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(_InstancerPrimVarsOverrideDataSource);
TfTokenVector GetNames() override
{
if (!_inputDs) {
return {};
}
return _inputDs->GetNames();
}
HdDataSourceBaseHandle Get(const TfToken &name) override
{
if (name == HdInstancerTokens->translate)
{
return _PrimvarDataSource::New(
_InstancePositionsDataSource::New(_schema, _pythonModule, _depDs, _simParamsDs),
HdPrimvarSchemaTokens->instance,
HdPrimvarRoleTokens->vector);
}
HdDataSourceBaseHandle result = _inputDs->Get(name);
return result;
}
private:
_InstancerPrimVarsOverrideDataSource(const HdContainerDataSourceHandle &primDataSource,
HdPrimvarsSchema &primVarSchema, OmniWarpPythonModuleSharedPtr pythonModule,
const HdContainerDataSourceHandle &depDataSource,
const HdContainerDataSourceHandle &simParamsDataSource)
: _schema(primVarSchema),
_pythonModule(pythonModule),
_inputDs(primDataSource),
_depDs(depDataSource),
_simParamsDs(simParamsDataSource)
{
}
HdPrimvarsSchema _schema;
HdContainerDataSourceHandle _depDs;
OmniWarpPythonModuleSharedPtr _pythonModule;
HdContainerDataSourceHandle const _inputDs;
HdContainerDataSourceHandle const _simParamsDs;
};
class _WarpMeshDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(_WarpMeshDataSource);
TfTokenVector GetNames() override
{
if (!_inputDs) {
return {};
}
// We append our token for the WarpMesh python file token
// We do our init for indices here. Only on reload?
return _inputDs->GetNames();
}
HdDataSourceBaseHandle Get(const TfToken &name) override
{
auto result = _inputDs->Get(name);
if (name == HdPrimvarsSchemaTokens->primvars)
{
auto primVarSchema = HdPrimvarsSchema::GetFromParent(_inputDs);
if (auto primVarContainer = HdContainerDataSource::Cast(result))
{
return _MeshPrimVarsOverrideDataSource::New(primVarContainer, primVarSchema, _pythonModule, _inputDs, _depDs);
}
}
return result;
}
private:
_WarpMeshDataSource(const SdfPath& primPath,
const HdContainerDataSourceHandle &primDataSource,
OmniWarpPythonModuleSharedPtr pythonModule,
const HdContainerDataSourceHandle &depDataSource)
: _primPath(primPath),
_inputDs(primDataSource),
_pythonModule(pythonModule),
_depDs(depDataSource)
{
}
HdContainerDataSourceHandle _depDs;
HdContainerDataSourceHandle _inputDs;
OmniWarpPythonModuleSharedPtr _pythonModule;
const SdfPath& _primPath;
};
class _WarpInstancerDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(_WarpInstancerDataSource);
TfTokenVector GetNames() override
{
if (!_inputDs) {
return {};
}
// We append our token for the WarpMesh python file token
// We do our init for indices here. Only on reload?
return _inputDs->GetNames();
}
HdDataSourceBaseHandle Get(const TfToken &name) override
{
auto result = _inputDs->Get(name);
if (name == HdPrimvarsSchemaTokens->primvars)
{
auto primVarSchema = HdPrimvarsSchema::GetFromParent(_inputDs);
if (auto primVarContainer = HdContainerDataSource::Cast(result))
{
return _InstancerPrimVarsOverrideDataSource::New(primVarContainer, primVarSchema, _pythonModule, _depDs, _simParamsDs);
}
}
return result;
}
private:
_WarpInstancerDataSource(const SdfPath& primPath,
const HdContainerDataSourceHandle &primDataSource,
OmniWarpPythonModuleSharedPtr pythonModule,
const HdContainerDataSourceHandle &depDataSource,
const HdContainerDataSourceHandle &simParamsDataSource)
: _primPath(primPath),
_inputDs(primDataSource),
_pythonModule(pythonModule),
_depDs(depDataSource),
_simParamsDs(simParamsDataSource)
{
}
HdContainerDataSourceHandle _inputDs;
HdContainerDataSourceHandle _depDs;
HdContainerDataSourceHandle _simParamsDs;
OmniWarpPythonModuleSharedPtr _pythonModule;
const SdfPath& _primPath;
};
HdSceneIndexPrim
OmniWarpSceneIndex::GetPrim(const SdfPath& primPath) const
{
HdSceneIndexPrim prim = _GetInputSceneIndex()->GetPrim(primPath);
if (prim.primType == HdPrimTypeTokens->mesh && prim.dataSource)
{
if (OmniWarpComputationSchema warpSchema = OmniWarpComputationSchema::GetFromParent(prim.dataSource))
{
HdContainerDataSourceHandle _depDs;
if (HdPathArrayDataSourceHandle dependentsDs = warpSchema.GetDependentPrims())
{
VtArray<SdfPath> dependentPrims = dependentsDs->GetTypedValue(0);
if (dependentPrims.size())
{
auto depPrim = _GetInputSceneIndex()->GetPrim(dependentPrims[0]);
if (depPrim.dataSource)
{
_depDs = depPrim.dataSource;
}
}
}
prim.dataSource = _WarpMeshDataSource::New(
primPath, prim.dataSource, GetWarpPythonModule(primPath), _depDs);
}
}
else if (prim.primType == HdPrimTypeTokens->instancer && prim.dataSource)
{
HdInstancerTopologySchema topologySchema = HdInstancerTopologySchema::GetFromParent(prim.dataSource);
if (HdPathArrayDataSourceHandle const ds = topologySchema.GetPrototypes())
{
auto protoTypes = ds->GetTypedValue(0.0f);
for (size_t i = 0; i < protoTypes.size(); ++i)
{
auto protoPrim = _GetInputSceneIndex()->GetPrim(protoTypes[i]);
OmniWarpComputationSchema warpSchema = OmniWarpComputationSchema::GetFromParent(protoPrim.dataSource);
if (warpSchema)
{
// Look for particles to be dependent on a mesh
HdContainerDataSourceHandle _depDs;
if (HdPathArrayDataSourceHandle dependentsDs = warpSchema.GetDependentPrims())
{
VtArray<SdfPath> dependentPrims = dependentsDs->GetTypedValue(0);
if (dependentPrims.size())
{
auto depPrim = _GetInputSceneIndex()->GetPrim(dependentPrims[0]);
if (depPrim.dataSource)
{
_depDs = depPrim.dataSource;
}
}
}
prim.dataSource = _WarpInstancerDataSource::New(
primPath, prim.dataSource, GetWarpPythonModule(primPath), _depDs, protoPrim.dataSource);
}
}
}
}
return prim;
}
SdfPathVector
OmniWarpSceneIndex::GetChildPrimPaths(const SdfPath &primPath) const
{
return _GetInputSceneIndex()->GetChildPrimPaths(primPath);
}
void OmniWarpSceneIndex::_PrimsAdded(
const HdSceneIndexBase &sender,
const HdSceneIndexObserver::AddedPrimEntries &entries)
{
if (!_IsObserved()) {
return;
}
for (const HdSceneIndexObserver::AddedPrimEntry& entry : entries)
{
if (entry.primType == HdPrimTypeTokens->mesh)
{
auto prim = _GetInputSceneIndex()->GetPrim(entry.primPath);
HdMeshSchema meshSchema = HdMeshSchema::GetFromParent(prim.dataSource);
HdPrimvarsSchema primVarsSchema = HdPrimvarsSchema::GetFromParent(prim.dataSource);
OmniWarpComputationSchema warpSchema = OmniWarpComputationSchema::GetFromParent(prim.dataSource);
if (meshSchema && warpSchema && primVarsSchema)
{
assert(GetWarpPythonModule(entry.primPath) == nullptr);
HdMeshTopologySchema meshTopologySchema = meshSchema.GetTopology();
UsdImagingStageSceneIndexRefPtr usdImagingSi;
if (auto filteringIdx = dynamic_cast<HdFilteringSceneIndexBase const*>(&sender))
{
// SceneIndexPlugins do not have access to the current stage/frame time.
// Only the UsdImagingStageSceneIndex has this. We store this for each Mesh,
// nullptr is a valid value. If valid, warp simulation can use the exact
// stage time. If null, the warp has to emulate frame time
usdImagingSi = FindUsdImagingSceneIndex(filteringIdx->GetInputScenes());
}
auto vtSimParams = GetSimulationParams(prim.dataSource);
HdPrimvarSchema origPoints = primVarsSchema.GetPrimvar(HdTokens->points);
CreateWarpPythonModule(entry.primPath, warpSchema, meshTopologySchema, origPoints, usdImagingSi, vtSimParams);
}
}
else if (entry.primType == HdPrimTypeTokens->instancer)
{
auto prim = _GetInputSceneIndex()->GetPrim(entry.primPath);
HdPrimvarsSchema primVarSchema = HdPrimvarsSchema::GetFromParent(prim.dataSource);
HdInstancerTopologySchema topologySchema = HdInstancerTopologySchema::GetFromParent(prim.dataSource);
HdPathArrayDataSourceHandle const ds = topologySchema.GetPrototypes();
if (primVarSchema && ds)
{
auto protoTypes = ds->GetTypedValue(0.0f);
for (size_t i = 0; i < protoTypes.size(); ++i)
{
auto protoPrim = _GetInputSceneIndex()->GetPrim(protoTypes[i]);
if (protoPrim.primType == TfToken())
{
continue;
}
OmniWarpComputationSchema warpSchema = OmniWarpComputationSchema::GetFromParent(protoPrim.dataSource);
if (warpSchema)
{
assert(GetWarpPythonModule(entry.primPath) == nullptr);
UsdImagingStageSceneIndexRefPtr usdImagingSi;
if (auto filteringIdx = dynamic_cast<HdFilteringSceneIndexBase const*>(&sender))
{
// SceneIndexPlugins do not have access to the current stage/frame time.
// Only the UsdImagingStageSceneIndex has this. We store this for each Mesh,
// nullptr is a valid value. If valid, warp simulation can use the exact
// stage time. If null, the warp has to emulate frame time
usdImagingSi = FindUsdImagingSceneIndex(filteringIdx->GetInputScenes());
}
auto vtSimParams = GetSimulationParams(protoPrim.dataSource);
HdPrimvarSchema positionsPos = primVarSchema.GetPrimvar(HdInstancerTokens->translate);
CreateWarpPythonModule(entry.primPath, warpSchema, positionsPos, usdImagingSi, vtSimParams);
break;
}
}
}
}
}
_SendPrimsAdded(entries);
return;
}
void
OmniWarpSceneIndex::_PrimsRemoved(
const HdSceneIndexBase &sender,
const HdSceneIndexObserver::RemovedPrimEntries &entries)
{
if (!_IsObserved()) {
return;
}
_WarpPythonModuleMap::iterator it = _pythonModuleMap.begin();
while (it != _pythonModuleMap.end())
{
bool bErased = false;
for (const HdSceneIndexObserver::RemovedPrimEntry& entry : entries)
{
if (it->first.HasPrefix(entry.primPath))
{
bErased = true;
it = _pythonModuleMap.erase(it);
break;
}
}
if (!bErased)
{
it++;
}
}
_SendPrimsRemoved(entries);
}
void
OmniWarpSceneIndex::_PrimsDirtied(
const HdSceneIndexBase &sender,
const HdSceneIndexObserver::DirtiedPrimEntries &entries)
{
if (!_IsObserved()) {
return;
}
// +++ Not sure this is the right locator for points data
static const HdDataSourceLocatorSet pointDeformLocators
{
HdPrimvarsSchema::GetDefaultLocator().Append(
HdPrimvarSchemaTokens->point),
OmniWarpComputationSchema::GetDefaultLocator().Append(
OmniWarpComputationSchema::GetSourceFileLocator())
};
// If mesh original points or python module path changes
// remove our _pythonModule for this prim and allow
// it to be re-created
//+++ Multithreaded access to _pythonModuleMap
_WarpPythonModuleMap::iterator it = _pythonModuleMap.begin();
while (it != _pythonModuleMap.end())
{
bool bErased = false;
for (const HdSceneIndexObserver::DirtiedPrimEntry &entry : entries)
{
if (it->first.HasPrefix(entry.primPath))
{
if (pointDeformLocators.Intersects(entry.dirtyLocators))
{
bErased = true;
it = _pythonModuleMap.erase(it);
break;
}
}
}
if (!bErased)
{
it++;
}
}
_SendPrimsDirtied(entries);
}
OmniWarpPythonModuleSharedPtr
OmniWarpSceneIndex::GetWarpPythonModule(const SdfPath &primPath) const
{
//+++ Multithreaded access to _pythonModuleMap
auto pythonModule = _pythonModuleMap.find(primPath);
if (pythonModule == _pythonModuleMap.end())
{
return OmniWarpPythonModuleSharedPtr(nullptr);
}
return pythonModule->second;
}
OmniWarpPythonModuleSharedPtr
OmniWarpSceneIndex::CreateWarpPythonModule(const SdfPath &primPath,
OmniWarpComputationSchema& warpSchema,
HdMeshTopologySchema& topologySchema,
HdPrimvarSchema& primVarSchema,
UsdImagingStageSceneIndexRefPtr usdImagingSi,
VtDictionary vtSimParams)
{
//+++ Multithreaded access to _pythonModuleMap
std::string moduleName = warpSchema.GetSourceFile()->GetTypedValue(0);
HdIntArrayDataSourceHandle faceIndicesDs = topologySchema.GetFaceVertexIndices();
VtIntArray indices = faceIndicesDs->GetTypedValue(0.f);
HdSampledDataSourceHandle valueDataSource = primVarSchema.GetPrimvarValue();
auto pointsVt = valueDataSource->GetValue(0.f);
VtVec3fArray pointsArray = pointsVt.UncheckedGet<VtArray<GfVec3f>>();
// Force terminate of old module
_pythonModuleMap[primPath] = nullptr;
OmniWarpPythonModuleSharedPtr pythonModule =
std::make_shared<OmniWarpPythonModule>(primPath, moduleName, usdImagingSi);
VtIntArray depIndices;
VtVec3fArray depPointsArray;
GetDependentMeshData(warpSchema, depIndices, depPointsArray);
pythonModule->InitMesh(indices, pointsArray, depIndices, depPointsArray, vtSimParams);
_pythonModuleMap[primPath] = pythonModule;
return _pythonModuleMap.find(primPath)->second;
}
OmniWarpPythonModuleSharedPtr
OmniWarpSceneIndex::CreateWarpPythonModule(const SdfPath &primPath,
OmniWarpComputationSchema& warpSchema,
HdPrimvarSchema& primVarSchema,
UsdImagingStageSceneIndexRefPtr usdImagingSi,
VtDictionary vtSimParams)
{
//+++ Multithreaded access to _pythonModuleMap
std::string moduleName = warpSchema.GetSourceFile()->GetTypedValue(0);
// Force terminate of old module
_pythonModuleMap[primPath] = nullptr;
HdSampledDataSourceHandle valueDataSource = primVarSchema.GetPrimvarValue();
auto positionsVt = valueDataSource->GetValue(0.f);
VtVec3fArray positionsArray = positionsVt.UncheckedGet<VtArray<GfVec3f>>();
OmniWarpPythonModuleSharedPtr pythonModule =
std::make_shared<OmniWarpPythonModule>(primPath, moduleName, usdImagingSi);
VtIntArray indices;
VtVec3fArray pointsArray;
GetDependentMeshData(warpSchema, indices, pointsArray);
pythonModule->InitParticles(positionsArray, indices, pointsArray, vtSimParams);
_pythonModuleMap[primPath] = pythonModule;
return _pythonModuleMap.find(primPath)->second;
}
void
OmniWarpSceneIndex::GetDependentMeshData(OmniWarpComputationSchema warpSchema, VtIntArray& outIndices, VtVec3fArray& outVertices)
{
VtArray<SdfPath> dependentPrims;
if (HdPathArrayDataSourceHandle dependentsDs = warpSchema.GetDependentPrims())
{
dependentPrims = dependentsDs->GetTypedValue(0);
}
if (!dependentPrims.size())
{
return;
}
//+++ Only support a single dependent prim
auto depPrim = _GetInputSceneIndex()->GetPrim(dependentPrims[0]);
if (depPrim.dataSource)
{
HdPrimvarsSchema depPrimVarsSchema = HdPrimvarsSchema::GetFromParent(depPrim.dataSource);
if (depPrimVarsSchema)
{
HdPrimvarSchema depPrimVar = depPrimVarsSchema.GetPrimvar(HdTokens->points);
if (depPrimVar)
{
HdSampledDataSourceHandle valueDataSource = depPrimVar.GetPrimvarValue();
auto pointsVt = valueDataSource->GetValue(0.f);
outVertices = pointsVt.UncheckedGet<VtArray<GfVec3f>>();
}
}
HdMeshSchema meshSchema = HdMeshSchema::GetFromParent(depPrim.dataSource);
if (meshSchema)
{
HdMeshTopologySchema topologySchema = meshSchema.GetTopology();
HdIntArrayDataSourceHandle faceIndicesDs = topologySchema.GetFaceVertexIndices();
outIndices = faceIndicesDs->GetTypedValue(0.f);
}
}
}
PXR_NAMESPACE_CLOSE_SCOPE | 27,828 | C++ | 34.496173 | 135 | 0.650496 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/__init__.py | from pxr import Tf
# PreparePythonModule didn't make it's way into USD
# until 21.08 - older versions import the module
# manually and call PrepareModule
if hasattr(Tf, "PreparePythonModule"):
Tf.PreparePythonModule()
else:
from . import _omniWarpSceneIndex
Tf.PrepareModule(_omniWarpSceneIndex, locals())
del Tf | 327 | Python | 24.230767 | 51 | 0.75841 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpComputationSchema.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include <pxr/base/trace/trace.h>
#include <pxr/imaging/hd/retainedDataSource.h>
#include "warpComputationSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PUBLIC_TOKENS(OmniWarpComputationSchemaTokens,
OMNIWARPCOMPUTATION_SCHEMA_TOKENS);
HdStringDataSourceHandle
OmniWarpComputationSchema::GetSourceFile()
{
return _GetTypedDataSource<HdStringDataSource>(
OmniWarpComputationSchemaTokens->sourceFile);
}
HdPathArrayDataSourceHandle
OmniWarpComputationSchema::GetDependentPrims()
{
return _GetTypedDataSource<HdPathArrayDataSource>(
OmniWarpComputationSchemaTokens->dependentPrims);
}
HdSampledDataSourceHandle
OmniWarpComputationSchema::GetSimulationParams()
{
return _GetTypedDataSource<HdSampledDataSource>(
OmniWarpComputationSchemaTokens->simulationParams);
}
HdContainerDataSourceHandle
OmniWarpComputationSchema::BuildRetained(
const HdStringDataSourceHandle &sourceFile,
const HdPathArrayDataSourceHandle &dependentPrims,
const HdSampledDataSourceHandle &simulationParams
)
{
TfToken names[3];
HdDataSourceBaseHandle values[3];
size_t count = 0;
if (sourceFile) {
names[count] = OmniWarpComputationSchemaTokens->sourceFile;
values[count++] = sourceFile;
}
if (dependentPrims) {
names[count] = OmniWarpComputationSchemaTokens->dependentPrims;
values[count++] = dependentPrims;
}
if (simulationParams) {
names[count] = OmniWarpComputationSchemaTokens->simulationParams;
values[count++] = simulationParams;
}
return HdRetainedContainerDataSource::New(count, names, values);
}
/*static*/
OmniWarpComputationSchema
OmniWarpComputationSchema::GetFromParent(
const HdContainerDataSourceHandle &fromParentContainer)
{
return OmniWarpComputationSchema(
fromParentContainer
? HdContainerDataSource::Cast(fromParentContainer->Get(
OmniWarpComputationSchemaTokens->warpComputation))
: nullptr);
}
/*static*/
const TfToken &
OmniWarpComputationSchema::GetSchemaToken()
{
return OmniWarpComputationSchemaTokens->warpComputation;
}
/*static*/
const HdDataSourceLocator &
OmniWarpComputationSchema::GetDefaultLocator()
{
static const HdDataSourceLocator locator(
OmniWarpComputationSchemaTokens->warpComputation
);
return locator;
}
/*static*/
const HdDataSourceLocator &
OmniWarpComputationSchema::GetSourceFileLocator()
{
static const HdDataSourceLocator locator(
OmniWarpComputationSchemaTokens->warpComputation,
OmniWarpComputationSchemaTokens->sourceFile
);
return locator;
}
/*static*/
const HdDataSourceLocator &
OmniWarpComputationSchema::GetDependentPrimsLocator()
{
static const HdDataSourceLocator locator(
OmniWarpComputationSchemaTokens->warpComputation,
OmniWarpComputationSchemaTokens->dependentPrims
);
return locator;
}
/*static*/
const HdDataSourceLocator &
OmniWarpComputationSchema::GetSimulationParamsLocator()
{
static const HdDataSourceLocator locator(
OmniWarpComputationSchemaTokens->warpComputation,
OmniWarpComputationSchemaTokens->simulationParams
);
return locator;
}
OmniWarpComputationSchema::Builder &
OmniWarpComputationSchema::Builder::SetSourceFile(
const HdStringDataSourceHandle &sourceFile)
{
_sourceFile = sourceFile;
return *this;
}
OmniWarpComputationSchema::Builder &
OmniWarpComputationSchema::Builder::SetDependentPrims(
const HdPathArrayDataSourceHandle &depdendentPrims)
{
_dependentPrims = depdendentPrims;
return *this;
}
OmniWarpComputationSchema::Builder &
OmniWarpComputationSchema::Builder::SetSimulationParams(
const HdSampledDataSourceHandle &simulationParams)
{
_simulationParams = simulationParams;
return *this;
}
HdContainerDataSourceHandle
OmniWarpComputationSchema::Builder::Build()
{
return OmniWarpComputationSchema::BuildRetained(
_sourceFile,
_dependentPrims,
_simulationParams
);
}
PXR_NAMESPACE_CLOSE_SCOPE | 4,653 | C++ | 26.702381 | 75 | 0.762089 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpSceneIndex.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#ifndef OMNI_WARP_SCENE_INDEX_WARP_SCENE_INDEX_H
#define OMNI_WARP_SCENE_INDEX_WARP_SCENE_INDEX_H
#include <pxr/pxr.h>
#include <pxr/imaging/hd/filteringSceneIndex.h>
#include <pxr/usdImaging/usdImaging/stageSceneIndex.h>
#include "pxr/imaging/hd/primvarSchema.h"
#include "pxr/imaging/hd/meshSchema.h"
#include "api.h"
#include "warpPythonModule.h"
#include "warpComputationSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DECLARE_REF_PTRS(OmniWarpSceneIndex);
class _PointsDataSource;
class _WarpMeshDataSource;
///
/// \class OmniWarpSceneIndex
///
///
///
///
///
class OmniWarpSceneIndex :
public HdSingleInputFilteringSceneIndexBase
{
public:
OMNIWARPSCENEINDEX_API
static OmniWarpSceneIndexRefPtr
New(const HdSceneIndexBaseRefPtr &inputSceneIndex);
OMNIWARPSCENEINDEX_API
HdSceneIndexPrim GetPrim(const SdfPath &primPath) const override;
OMNIWARPSCENEINDEX_API
SdfPathVector GetChildPrimPaths(const SdfPath &primPath) const override;
protected:
OmniWarpSceneIndex(
const HdSceneIndexBaseRefPtr &inputSceneIndex);
void _PrimsAdded(
const HdSceneIndexBase &sender,
const HdSceneIndexObserver::AddedPrimEntries &entries) override;
void _PrimsRemoved(
const HdSceneIndexBase &sender,
const HdSceneIndexObserver::RemovedPrimEntries &entries) override;
void _PrimsDirtied(
const HdSceneIndexBase &sender,
const HdSceneIndexObserver::DirtiedPrimEntries &entries) override;
private:
OmniWarpPythonModuleSharedPtr GetWarpPythonModule(const SdfPath &primPath) const;
OmniWarpPythonModuleSharedPtr CreateWarpPythonModule(const SdfPath &primPath,
OmniWarpComputationSchema& warpSchema,
HdMeshTopologySchema& topologySchema,
HdPrimvarSchema& primVarSchema,
UsdImagingStageSceneIndexRefPtr usdImagingSi,
VtDictionary vtSimParams);
OmniWarpPythonModuleSharedPtr CreateWarpPythonModule(const SdfPath &primPath,
OmniWarpComputationSchema& warpSchema,
HdPrimvarSchema& primVarSchema,
UsdImagingStageSceneIndexRefPtr usdImagingSi,
VtDictionary vtSimParams);
void GetDependentMeshData(OmniWarpComputationSchema warpSchema,
VtIntArray& outIndices,
VtVec3fArray& outVertices);
// Each prim with a WarpComputationAPI gets it's own Python Module instance
typedef std::unordered_map<SdfPath, OmniWarpPythonModuleSharedPtr, SdfPath::Hash> _WarpPythonModuleMap;
mutable _WarpPythonModuleMap _pythonModuleMap;
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif // OMNI_WARP_SCENE_INDEX_WARP_SCENE_INDEX_H | 3,199 | C | 31.323232 | 107 | 0.760863 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/wrapTokens.cpp | //
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
// names, trademarks, service marks, or product names of the Licensor
// and its affiliates, except as required to comply with Section 4(c) of
// the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
// GENERATED FILE. DO NOT EDIT.
#include <boost/python/class.hpp>
#include ".//tokens.h"
PXR_NAMESPACE_USING_DIRECTIVE
namespace {
// Helper to return a static token as a string. We wrap tokens as Python
// strings and for some reason simply wrapping the token using def_readonly
// bypasses to-Python conversion, leading to the error that there's no
// Python type for the C++ TfToken type. So we wrap this functor instead.
class _WrapStaticToken {
public:
_WrapStaticToken(const TfToken* token) : _token(token) { }
std::string operator()() const
{
return _token->GetString();
}
private:
const TfToken* _token;
};
template <typename T>
void
_AddToken(T& cls, const char* name, const TfToken& token)
{
cls.add_static_property(name,
boost::python::make_function(
_WrapStaticToken(&token),
boost::python::return_value_policy<
boost::python::return_by_value>(),
boost::mpl::vector1<std::string>()));
}
} // anonymous
void wrapOmniWarpSceneIndexTokens()
{
boost::python::class_<OmniWarpSceneIndexTokensType, boost::noncopyable>
cls("Tokens", boost::python::no_init);
_AddToken(cls, "warpDependentPrims", OmniWarpSceneIndexTokens->warpDependentPrims);
_AddToken(cls, "warpSourceFile", OmniWarpSceneIndexTokens->warpSourceFile);
_AddToken(cls, "OmniWarpComputationAPI", OmniWarpSceneIndexTokens->OmniWarpComputationAPI);
}
| 2,626 | C++ | 35.999999 | 95 | 0.690023 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpComputationAPIAdapter.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include <pxr/base/tf/stringUtils.h>
#include <pxr/imaging/hd/retainedDataSource.h>
#include <pxr/usdImaging/usdImaging/dataSourceAttribute.h>
#include "warpComputationAPIAdapter.h"
#include "warpComputationAPI.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PRIVATE_TOKENS(
_tokens,
(warpComputation)
(sourceFile)
(dependentPrims)
(simulationParams)
);
TF_REGISTRY_FUNCTION(TfType)
{
typedef WarpComputationAPIAdapter Adapter;
TfType t = TfType::Define<Adapter, TfType::Bases<Adapter::BaseAdapter> >();
t.SetFactory< UsdImagingAPISchemaAdapterFactory<Adapter> >();
}
// ----------------------------------------------------------------------------
namespace
{
class SimulationParamsDataSource : public HdSampledDataSource
{
public:
HD_DECLARE_DATASOURCE(SimulationParamsDataSource);
SimulationParamsDataSource(
const VtDictionary &dict)
: _customData(dict)
{
}
VtValue
GetValue(Time shutterOffset)
{
return VtValue(_customData);
}
bool
GetContributingSampleTimesForInterval(
Time startTime,
Time endTime,
std::vector<Time> * outSampleTimes)
{
return false;
}
VtDictionary _customData;
};
class DependentPrimsDataSource : public HdPathArrayDataSource
{
public:
HD_DECLARE_DATASOURCE(DependentPrimsDataSource);
DependentPrimsDataSource(
const UsdRelationship &rel)
: _usdRel(rel)
{
}
VtValue
GetValue(
HdSampledDataSource::Time shutterOffset)
{
return VtValue(GetTypedValue(shutterOffset));
}
VtArray<SdfPath>
GetTypedValue(
HdSampledDataSource::Time shutterOffset)
{
SdfPathVector paths;
_usdRel.GetForwardedTargets(&paths);
VtArray<SdfPath> vtPaths(paths.begin(), paths.end());
return vtPaths;
}
bool
GetContributingSampleTimesForInterval(
HdSampledDataSource::Time startTime,
HdSampledDataSource::Time endTime,
std::vector<HdSampledDataSource::Time> *outSampleTimes)
{
return false;
}
private:
UsdRelationship _usdRel;
};
HD_DECLARE_DATASOURCE_HANDLES(DependentPrimsDataSource);
class _WarpComputationDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(_WarpComputationDataSource);
_WarpComputationDataSource(
const UsdPrim &prim,
const UsdImagingDataSourceStageGlobals &stageGlobals)
: _api(prim)
, _stageGlobals(stageGlobals)
{
}
TfTokenVector GetNames() override
{
TfTokenVector result;
result.reserve(4);
result.push_back(_tokens->warpComputation);
if (UsdAttribute attr = _api.GetSourceFileAttr()) {
result.push_back(_tokens->sourceFile);
VtDictionary customData = attr.GetCustomData();
VtDictionary::iterator iter = customData.begin();
if (iter != customData.end())
{
result.push_back(_tokens->simulationParams);
}
}
if (_api.GetDependentPrimsRel()) {
result.push_back(_tokens->dependentPrims);
}
return result;
}
HdDataSourceBaseHandle Get(const TfToken &name) override {
if (name == _tokens->sourceFile)
{
if (UsdAttribute attr = _api.GetSourceFileAttr())
{
return UsdImagingDataSourceAttributeNew(attr, _stageGlobals);
}
}
else if (name == _tokens->dependentPrims)
{
if (UsdRelationship rel = _api.GetDependentPrimsRel())
{
return DependentPrimsDataSource::New(rel);
}
}
else if (name == _tokens->simulationParams)
{
if (UsdAttribute attr = _api.GetSourceFileAttr())
{
VtDictionary customData = attr.GetCustomData();
VtDictionary::iterator iter = customData.begin();
if (iter != customData.end())
{
return SimulationParamsDataSource::New(customData);
}
}
}
return nullptr;
}
private:
OmniWarpSceneIndexWarpComputationAPI _api;
const UsdImagingDataSourceStageGlobals &_stageGlobals;
};
HD_DECLARE_DATASOURCE_HANDLES(_WarpComputationDataSource);
} // anonymous namespace
// ----------------------------------------------------------------------------
HdContainerDataSourceHandle
WarpComputationAPIAdapter::GetImagingSubprimData(
UsdPrim const& prim,
TfToken const& subprim,
TfToken const& appliedInstanceName,
const UsdImagingDataSourceStageGlobals &stageGlobals)
{
OmniWarpSceneIndexWarpComputationAPI _api(prim);
std::string pythonModuleName;
UsdAttribute attr = _api.GetSourceFileAttr();
attr.Get(&pythonModuleName, 0.f);
if (pythonModuleName.length())
{
return HdRetainedContainerDataSource::New(
_tokens->warpComputation,
_WarpComputationDataSource::New(
prim, stageGlobals));
}
return nullptr;
}
#if PXR_VERSION < 2308
HdDataSourceLocatorSet
WarpComputationAPIAdapter::InvalidateImagingSubprim(
UsdPrim const& prim,
TfToken const& subprim,
TfToken const& appliedInstanceName,
TfTokenVector const& properties)
#else
HdDataSourceLocatorSet
WarpComputationAPIAdapter::InvalidateImagingSubprim(
UsdPrim const& prim,
TfToken const& subprim,
TfToken const& appliedInstanceName,
TfTokenVector const& properties,
const UsdImagingPropertyInvalidationType invalidationType)
#endif
{
#if 0
if (!subprim.IsEmpty() || appliedInstanceName.IsEmpty()) {
return HdDataSourceLocatorSet();
}
std::string prefix = TfStringPrintf(
"collections:%s:", appliedInstanceName.data());
for (const TfToken &propertyName : properties) {
if (TfStringStartsWith(propertyName.GetString(), prefix)) {
return HdDataSourceLocator(
_tokens->usdCollections, appliedInstanceName);
}
}
#endif
return HdDataSourceLocatorSet();
}
PXR_NAMESPACE_CLOSE_SCOPE
| 6,767 | C++ | 25.4375 | 79 | 0.645338 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpPythonModule.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include <pxr/base/tf/pyInvoke.h>
#include <pxr/base/tf/errorMark.h>
#include <pxr/base/tf/pyExceptionState.h>
#include <pxr/base/tf/pyInterpreter.h>
#include <pxr/imaging/hd/tokens.h>
#include "warpPythonModule.h"
#include "tokens.h"
PXR_NAMESPACE_OPEN_SCOPE
OmniWarpPythonModule::OmniWarpPythonModule(const SdfPath &primPath,
const std::string& moduleName, UsdImagingStageSceneIndexConstRefPtr usdImagingSi)
: _primPath(primPath),
_moduleName(moduleName),
_usdImagingSi(usdImagingSi)
{
}
OmniWarpPythonModule::~OmniWarpPythonModule()
{
TfPyLock pyLock;
boost::python::object result;
TfPyInvokeAndReturn(_moduleName.c_str(), "terminate_sim", &result, _primPath);
}
void OmniWarpPythonModule::InitMesh(VtIntArray indices, VtVec3fArray vertices,
VtIntArray depIndices, VtVec3fArray depVertices, VtDictionary simParams)
{
TfPyLock pyLock;
boost::python::object result;
TfPyInvokeAndReturn(_moduleName.c_str(), "initialize_sim_mesh", &result, _primPath, indices, vertices,
depIndices, depVertices, simParams);
}
void OmniWarpPythonModule::InitParticles(
VtVec3fArray positions, VtIntArray depIndices, VtVec3fArray depVertices, VtDictionary simParams)
{
TfPyLock pyLock;
boost::python::object result;
TfPyInvokeAndReturn(_moduleName.c_str(), "initialize_sim_particles", &result,
_primPath, positions, depIndices, depVertices, simParams);
}
VtVec3fArray OmniWarpPythonModule::ExecSim(VtDictionary simParams)
{
return ExecSim(simParams, VtVec3fArray());
}
VtVec3fArray OmniWarpPythonModule::ExecSim(VtDictionary simParams, VtVec3fArray dependentVertices)
{
TfPyLock pyLock;
boost::python::object result;
float dt = 0.f;
if (_usdImagingSi)
{
dt = _usdImagingSi->GetTime().GetValue();
}
if (TfPyInvokeAndReturn(_moduleName.c_str(), "exec_sim", &result, _primPath, dt, dependentVertices, simParams))
{
boost::python::extract<VtVec3fArray> theResults(result);
if (theResults.check())
{
return theResults();
}
}
return VtVec3fArray();
}
PXR_NAMESPACE_CLOSE_SCOPE | 2,735 | C++ | 30.090909 | 115 | 0.729068 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpModules/particles.py | # Copyright 2023 NVIDIA CORPORATION
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import os
import warp as wp
import warp.sim
import warp.sim.render
import numpy as np
from pxr import Vt, Sdf
wp.init()
global_examples = {}
# need radius of spehere
class Example2:
def __init__(self):
self.frame_dt = 1.0 / 60
self.frame_count = 400
self.sim_substeps = 64
self.sim_dt = self.frame_dt / self.sim_substeps
self.sim_steps = self.frame_count * self.sim_substeps
self.sim_time = 0.0
self.radius = 0.1
self.builder = wp.sim.ModelBuilder()
self.builder.default_particle_radius = self.radius
def update(self):
self.model.particle_grid.build(self.state_0.particle_q, self.radius * 2.0)
for s in range(self.sim_substeps):
self.state_0.clear_forces()
self.integrator.simulate(self.model, self.state_0, self.state_1, self.sim_dt)
# swap states
(self.state_0, self.state_1) = (self.state_1, self.state_0)
def terminate_sim(primPath: Sdf.Path):
global global_examples
global_examples[primPath] = None
def initialize_sim_particles(primPath: Sdf.Path,
src_positions: Vt.Vec3fArray, dep_mesh_indices: Vt.IntArray = None, dep_mesh_points: Vt.Vec3fArray = None, sim_params: dict = None):
global global_examples
global_examples[primPath] = Example2()
for pt in src_positions:
global_examples[primPath].builder.add_particle(pt, (5.0, 0.0, 0.0), 0.1)
global_examples[primPath].model = global_examples[primPath].builder.finalize()
global_examples[primPath].model.particle_kf = 25.0
global_examples[primPath].model.soft_contact_kd = 100.0
global_examples[primPath].model.soft_contact_kf *= 2.0
global_examples[primPath].state_0 = global_examples[primPath].model.state()
global_examples[primPath].state_1 = global_examples[primPath].model.state()
global_examples[primPath].integrator = wp.sim.SemiImplicitIntegrator()
def exec_sim(primPath: Sdf.Path, sim_dt: float, dep_mesh_points: Vt.Vec3fArray = None, sim_params: dict = None):
# Not respecting sim_dt at all, using internal time
global global_examples
global_examples[primPath].update()
return Vt.Vec3fArray.FromNumpy(global_examples[primPath].state_0.particle_q.numpy())
| 2,841 | Python | 33.658536 | 136 | 0.697994 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpModules/cloth.py | # Copyright (c) 2022 NVIDIA CORPORATION. All rights reserved.
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
###########################################################################
# Example Sim Cloth
#
# Shows a simulation of an FEM cloth model colliding against a static
# rigid body mesh using the wp.sim.ModelBuilder().
#
###########################################################################
import os
import math
import numpy as np
import warp as wp
import warp.sim
import warp.sim.render
from pxr import Usd, UsdGeom, Vt, Sdf
import sys
wp.init()
global_examples = {}
class Example:
def __init__(self, indices: Vt.IntArray, points: Vt.Vec3fArray):
self.sim_width = 64
self.sim_height = 64
self.frame_dt = 1.0 / 60
self.frame_count = 400
self.sim_substeps = 32
self.sim_dt = self.frame_dt / self.sim_substeps
self.sim_steps = self.frame_count * self.sim_substeps
self.sim_time = 0.0
builder = wp.sim.ModelBuilder()
# sim BCs
clothEdgeBendingStiffness = 0.01
clothEdgeDampingStiffness = 0.0
clothTriAreaStiffness = 1000000.0
clothTriDampingStiffness = 100.0
clothTriElasticStiffness = 1000000.0
colliderContactDistance = 1.0
colliderContactQueryRange = 100.0
contactDampingStiffness = 10000.0
contactElasticStiffness = 500000.0
contactFrictionCoeff = 0.75
contactFrictionStiffness = 10000.0
globalScale = 0.01
# cloth grid
builder.add_cloth_grid(
pos=(0.0, 50.0, -25.0),
rot=wp.quat_from_axis_angle((1.0, 0.0, 0.0), math.pi * 0.5),
vel=(0.0, 0.0, 0.0),
dim_x=self.sim_width,
dim_y=self.sim_height,
cell_x=1.0,
cell_y=1.0,
mass=0.1,
fix_left=True,
tri_ke=clothTriElasticStiffness * globalScale,
tri_ka=clothTriAreaStiffness * globalScale,
tri_kd=clothTriDampingStiffness * globalScale,
edge_ke=clothEdgeBendingStiffness * globalScale,
edge_kd=clothEdgeDampingStiffness * globalScale
)
# add collider (must have identity transform until we xforms piped through Hydra plugin)
mesh = wp.sim.Mesh(points, indices)
builder.add_shape_mesh(
body=-1,
mesh=mesh,
pos=(0.0, 0.0, 0.0),
rot=wp.quat_identity(),
scale=(1.0, 1.0, 1.0),
ke=1.0e2,
kd=1.0e2,
kf=1.0e1,
)
# set sim BCs
self.model = builder.finalize()
self.model.ground = True
self.model.allocate_soft_contacts(self.model.particle_count)
self.model.gravity = (0, -980, 0)
self.model.soft_contact_ke = contactElasticStiffness * globalScale
self.model.soft_contact_kf = contactFrictionStiffness * globalScale
self.model.soft_contact_mu = contactFrictionCoeff
self.model.soft_contact_kd = contactDampingStiffness * globalScale
self.model.soft_contact_margin = colliderContactDistance * colliderContactQueryRange
self.model.particle_radius = colliderContactDistance
self.integrator = wp.sim.SemiImplicitIntegrator()
self.state_0 = self.model.state()
self.state_1 = self.model.state()
def update(self, sim_time: float):
wp.sim.collide(self.model, self.state_0)
for s in range(self.sim_substeps):
self.state_0.clear_forces()
self.integrator.simulate(self.model, self.state_0, self.state_1, self.sim_dt)
(self.state_0, self.state_1) = (self.state_1, self.state_0)
def terminate_sim(primPath: Sdf.Path):
global global_examples
global_examples[primPath] = None
def initialize_sim_mesh(primPath: Sdf.Path, src_indices: Vt.IntArray, src_points: Vt.Vec3fArray,
dep_mesh_indices: Vt.IntArray = None, dep_mesh_points: Vt.Vec3fArray = None, sim_params: dict = None):
global global_examples
global_examples[primPath] = Example(dep_mesh_indices, dep_mesh_points)
def exec_sim(primPath: Sdf.Path, sim_dt: float, dep_mesh_points: Vt.Vec3fArray = None, sim_params: dict = None):
# Not respecting sim_dt at all, using internal time
global global_examples
global_examples[primPath].update(sim_dt)
return Vt.Vec3fArray.FromNumpy(global_examples[primPath].state_0.particle_q.numpy()) | 4,791 | Python | 33.978102 | 112 | 0.625339 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpModules/deform01.py | # Copyright 2023 NVIDIA CORPORATION
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import warp as wp
import numpy as np
from pxr import Vt, Sdf
@wp.kernel
def deform(positions: wp.array(dtype=wp.vec3), t: float):
tid = wp.tid()
x = positions[tid]
offset = -wp.sin(x[0]) * 0.06
scale = wp.sin(t)
x = x + wp.vec3(0.0, offset * scale, 0.0)
positions[tid] = x
class Example:
def __init__(self, indices: Vt.IntArray, points: Vt.Vec3fArray):
self.mesh = wp.Mesh(
points=wp.array(points, dtype=wp.vec3),
indices=wp.array(indices, dtype=int),
)
def update(self, sim_time: float):
wp.launch(kernel=deform, dim=len(self.mesh.points), inputs=[self.mesh.points, sim_time])
# refit the mesh BVH to account for the deformation
self.mesh.refit()
wp.init()
global_examples = {}
def terminate_sim(primPath: Sdf.Path):
global global_examples
global_examples[primPath] = None
def initialize_sim_mesh(primPath: Sdf.Path, src_indices: Vt.IntArray, src_points: Vt.Vec3fArray,
dep_mesh_indices: Vt.IntArray = None, dep_mesh_points: Vt.Vec3fArray = None, sim_params: dict = None):
global global_examples
global_examples[primPath] = Example(src_indices, src_points)
def exec_sim(primPath: Sdf.Path, sim_dt: float, dep_mesh_points: Vt.Vec3fArray = None, sim_params: dict = None):
global global_examples
# Sim expects 60 samples per second (or hydra time of 1.0)
global_examples[primPath].update(sim_dt / 60.0)
return Vt.Vec3fArray.FromNumpy(global_examples[primPath].mesh.points.numpy())
def is_enabled():
return True
| 2,140 | Python | 31.439393 | 112 | 0.693458 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/warpModules/ocean.py | # Copyright 2023 NVIDIA CORPORATION
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import warp as wp
import numpy as np
from pxr import Vt, Sdf
wp.init()
sim_params_global = {
'wave_amplitude': 1.5,
'wave_directionality': 0.0,
'wind_speed': 10.0,
'water_depth': 50.0,
'scale': 1.0,
'direction': 0.0,
}
#warp function definitions
# fractional part of a (w.r.t. floor(a))
@wp.func
def frac(a: float):
return a - wp.floor(a)
# square of a
@wp.func
def sqr(a: float):
return a * a
@wp.func
def alpha_beta_spectrum(omega: float,
peak_omega: float,
alpha: float,
beta: float,
gravity: float):
return ( (alpha * gravity * gravity / wp.pow(omega, 5.0)) * wp.exp(- beta * wp.pow(peak_omega/omega, 4.0)) )
@wp.func
def jonswap_peak_sharpening(omega: float,
peak_omega: float,
gamma: float):
sigma = float(0.07)
if omega > peak_omega:
sigma = float(0.09)
return wp.pow(gamma, wp.exp(- 0.5 * sqr( (omega - peak_omega) / (sigma * peak_omega)) ))
@wp.func
def jonswap_spectrum(omega: float,
gravity: float,
wind_speed: float,
fetch_km: float,
gamma: float):
#https://wikiwaves.org/Ocean-Wave_Spectra#JONSWAP_Spectrum
fetch = 1000.0 * fetch_km
alpha = 0.076 * wp.pow(wind_speed * wind_speed / (gravity * fetch), 0.22)
peak_omega = 22.0 * wp.pow(wp.abs(gravity * gravity / (wind_speed * fetch)), 1.0/3.0)
return (jonswap_peak_sharpening(omega, peak_omega, gamma) * alpha_beta_spectrum(omega, peak_omega, alpha, 1.25, gravity))
@wp.func
def TMA_spectrum(omega: float,
gravity: float,
wind_speed: float,
fetch_km: float,
gamma: float,
waterdepth: float):
#https://dl.acm.org/doi/10.1145/2791261.2791267
omegaH = omega * wp.sqrt(waterdepth/gravity)
omegaH = wp.max(0.0, wp.min(2.2, omegaH))
phi = 0.5 * omegaH * omegaH
if omegaH > 1.0:
phi = 1.0 - 0.5 * sqr(2.0 - omegaH)
return phi * jonswap_spectrum(omega, gravity, wind_speed, fetch_km, gamma);
#warp kernel definitions
@wp.kernel
def update_profile(profile: wp.array(dtype=wp.vec3),
profile_res: int,
profile_data_num: int,
lambdaMin: float,
lambdaMax: float,
profile_extend: float,
time: float,
windspeed: float,
waterdepth: float
):
x = wp.tid()
randself = wp.rand_init(7)
# sampling parameters
omega0 = wp.sqrt(2.0 * 3.14159 * 9.80665 / lambdaMin)
omega1 = wp.sqrt(2.0 * 3.14159 * 9.80665 / lambdaMax)
omega_delta = wp.abs(omega1 - omega0) / float(profile_data_num)
# we blend three displacements for seamless spatial profile tiling
space_pos_1 = profile_extend * float(x) / float(profile_res)
space_pos_2 = space_pos_1 + profile_extend
space_pos_3 = space_pos_1 - profile_extend
p1 = wp.vec2(0.0,0.0)
p2 = wp.vec2(0.0,0.0)
p3 = wp.vec2(0.0,0.0)
for i in range(0, profile_data_num):
omega = wp.abs(omega0 + (omega1 - omega0) * float(i) / float(profile_data_num)) # linear sampling of omega
k = omega * omega / 9.80665
phase = -time * omega + wp.randf(randself) * 2.0 * 3.14159
amplitude = float(10000.0) * wp.sqrt(wp.abs(2.0 * omega_delta * TMA_spectrum(omega, 9.80665, windspeed, 100.0, 3.3, waterdepth)))
p1 = wp.vec2( p1[0] + amplitude * wp.sin(phase + space_pos_1 * k), p1[1] - amplitude * wp.cos(phase + space_pos_1 * k) )
p2 = wp.vec2( p2[0] + amplitude * wp.sin(phase + space_pos_2 * k), p2[1] - amplitude * wp.cos(phase + space_pos_2 * k) )
p3 = wp.vec2( p3[0] + amplitude * wp.sin(phase + space_pos_3 * k), p3[1] - amplitude * wp.cos(phase + space_pos_3 * k) )
# cubic blending coefficients
s = float(float(x) / float(profile_res))
c1 = float(2.0 * s * s * s - 3.0 * s * s + 1.0)
c2 = float(-2.0 * s * s * s + 3.0 * s * s)
disp_out = wp.vec3( (p1[0] + c1 * p2[0] + c2 * p3[0]) / float(profile_data_num), (p1[1] + c1 * p2[1] + c2 * p3[1]) / float(profile_data_num), 0. )
wp.store(profile, x, disp_out)
@wp.kernel
def update_points(out_points: wp.array(dtype=wp.vec3),
in_points: wp.array(dtype=wp.vec3),
profile: wp.array(dtype=wp.vec3),
profile_res: int,
profile_extent: float,
amplitude: float,
directionality: float,
direction: float,
antiAlias: int,
camPosX: float,
camPosY: float,
camPosZ: float):
tid = wp.tid()
p_crd = in_points[tid]
p_crd = wp.vec3(p_crd[0], p_crd[2], p_crd[1])
randself = wp.rand_init(7)
disp_x = float(0.)
disp_y = float(0.)
disp_z = float(0.)
w_sum = float(0.)
direction_count = (int)(128)
for d in range(0, direction_count):
r = float(d) * 2. * 3.14159265359 / float(direction_count) + 0.02
dir_x = wp.cos(r)
dir_y = wp.sin(r)
# directional amplitude
t = wp.abs( direction - r )
if (t > 3.14159265359):
t = 2.0 * 3.14159265359 - t
t = pow(t, 1.2)
dirAmp = (2.0 * t * t * t - 3.0 * t * t + 1.0) * 1.0 + (- 2.0 * t * t * t + 3.0 * t * t) * (1.0 - directionality)
dirAmp = dirAmp / (1.0 + 10.0 * directionality)
rand_phase = wp.randf(randself)
x_crd = (p_crd[0] * dir_x + p_crd[2] * dir_y) / profile_extent + rand_phase
pos_0 = int(wp.floor(x_crd * float(profile_res))) % profile_res
if x_crd < 0.:
pos_0 = pos_0 + profile_res - 1
pos_1 = int(pos_0 + 1) % profile_res
p_disp_0 = profile[pos_0]
p_disp_1 = profile[pos_1]
w = frac( x_crd * float(profile_res) )
prof_height_x = dirAmp * float((1. - w) * p_disp_0[0] + w * p_disp_1[0])
prof_height_y = dirAmp * float((1. - w) * p_disp_0[1] + w * p_disp_1[1])
disp_x = disp_x + dir_x * prof_height_x
disp_y = disp_y + prof_height_y
disp_z = disp_z + dir_y * prof_height_x
w_sum = w_sum + 1.
# simple anti-aliasing: reduce amplitude with increasing distance to viewpoint
if (antiAlias > 0):
v1 = wp.normalize( wp.vec3( p_crd[0] - camPosX, max( 100.0, wp.abs(p_crd[1] - camPosY)), p_crd[2] - camPosZ) )
amplitude *= wp.sqrt( wp.abs(v1[1]) )
# write output vertex position
outP = wp.vec3(p_crd[0] + amplitude * disp_x / w_sum, p_crd[1] + amplitude * disp_y / w_sum, p_crd[2] + amplitude * disp_z / w_sum)
wp.store(out_points, tid, wp.vec3(outP[0], outP[2], outP[1]))
class Example:
def __init__(self, indices: Vt.IntArray, points: Vt.Vec3fArray):
# profile buffer intializations
print('[Ocean deformer] Initializing profile buffer.')
self.profile_extent = 410.0 #physical size of profile, should be around half the resolution
self.profile_res = int(8192)
self.profile_wavenum = int(1000)
self.profile_CUDA = wp.zeros(self.profile_res, dtype=wp.vec3, device="cuda:0")
self.points_in = wp.array(points, dtype=wp.vec3, device="cuda:0")
self.points_out = wp.array(points, dtype=wp.vec3, device="cuda:0")
print(self.points_in)
print(self.points_out)
def update(self, sim_time: float):
global sim_params_global
# params
wave_amplitude = sim_params_global["wave_amplitude"]
wave_directionality = sim_params_global["wave_directionality"]
wind_speed = sim_params_global["wind_speed"]
water_depth = sim_params_global["water_depth"]
scale = sim_params_global["scale"]
direction = sim_params_global["direction"]
# Parameters
time = float(sim_time)
amplitude = max(0.0001, min(1000.0, float(wave_amplitude)))
minWavelength = 0.1
maxWavelength = 250.0
direction = float(direction) % 6.28318530718
directionality = max(0.0, min(1.0, 0.02 * float(wave_directionality)))
windspeed = max(0.0, min(30.0, float(wind_speed)))
waterdepth = max(1.0, min(1000.0, float(water_depth)))
scale = min(10000.0, max(0.001, float(scale)))
antiAlias = int(0)
campos = [0.0, 0.0, 0.0]
# create 1D profile buffer for this timestep using wave paramters stored in internal self CUDA memory
wp.launch(
kernel=update_profile,
dim=self.profile_res,
inputs=[self.profile_CUDA, int(self.profile_res), int(self.profile_wavenum), float(minWavelength), float(maxWavelength), float(self.profile_extent), float(time), float(windspeed), float(waterdepth)],
outputs=[],
device="cuda:0")
# update point positions using the profile buffer created above
wp.launch(
kernel=update_points,
dim=len(self.points_out),
inputs=[self.points_out, self.points_in, self.profile_CUDA, int(self.profile_res), float(self.profile_extent*scale), float(amplitude), float(directionality), float(direction), int(antiAlias), float(campos[0]), float(campos[1]), float(campos[2]) ],
outputs=[],
device="cuda:0")
global_examples = {}
def terminate_sim(primPath: Sdf.Path):
global global_examples
global_examples[primPath] = None
def initialize_sim_mesh(primPath: Sdf.Path, src_indices: Vt.IntArray, src_points: Vt.Vec3fArray,
dep_mesh_indices: Vt.IntArray = None, dep_mesh_points: Vt.Vec3fArray = None, sim_params: dict = None):
global global_examples
global sim_params_global
if sim_params:
sim_params_global = sim_params
global_examples[primPath] = Example(src_indices, src_points)
def exec_sim(primPath: Sdf.Path, sim_dt: float, dep_mesh_points: Vt.Vec3fArray = None, sim_params: dict = None):
global global_examples
global sim_params_global
if sim_params:
sim_params_global = sim_params
# Sim expects 60 samples per second (or hydra time of 1.0)
global_examples[primPath].update(sim_dt / 60.0)
return Vt.Vec3fArray.FromNumpy(global_examples[primPath].points_out.numpy())
| 11,029 | Python | 37.838028 | 260 | 0.580288 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/oceanSim/preferences.py | #
# Copyright 2016 Pixar
#
# Licensed under the Apache License, Version 2.0 (the "Apache License")
# with the following modification; you may not use this file except in
# compliance with the Apache License and the following modification to it:
# Section 6. Trademarks. is deleted and replaced with:
#
# 6. Trademarks. This License does not grant permission to use the trade
# names, trademarks, service marks, or product names of the Licensor
# and its affiliates, except as required to comply with Section 4(c) of
# the License and to reproduce the content of the NOTICE file.
#
# You may obtain a copy of the Apache License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the Apache License with the above modification is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the Apache License for the specific
# language governing permissions and limitations under the Apache License.
#
from pxr.Usdviewq.qt import QtCore, QtGui, QtWidgets
from .preferencesUI import Ui_Preferences
class Preferences(QtWidgets.QDialog):
def __init__(self, parent, attr):
super(Preferences, self).__init__(parent)
self._ui = Ui_Preferences()
self._ui.setupUi(self)
self._attr = attr
metadata = self._attr.GetMetadata("customData")
self._ui.scaleSpinBox.setValue(metadata["scale"])
self._ui.directionSpinBox.setValue(metadata["direction"])
self._ui.windSpeedSpinBox.setValue(metadata["wind_speed"])
self._ui.waterDepthSpinBox.setValue(metadata["water_depth"])
self._ui.waveAmplitudeSpinBox.setValue(metadata["wave_amplitude"])
self._ui.waveDirectionalitySpinBox.setValue(metadata["wave_directionality"])
self._ui.buttonBox.clicked.connect(self._buttonBoxButtonClicked)
def _apply(self):
self._attr.SetMetadataByDictKey('customData', 'scale', self._ui.scaleSpinBox.value())
self._attr.SetMetadataByDictKey('customData', 'direction', self._ui.directionSpinBox.value())
self._attr.SetMetadataByDictKey('customData', 'wind_speed', self._ui.windSpeedSpinBox.value())
self._attr.SetMetadataByDictKey('customData', 'water_depth', self._ui.waterDepthSpinBox.value())
self._attr.SetMetadataByDictKey('customData', 'wave_amplitude', self._ui.waveAmplitudeSpinBox.value())
self._attr.SetMetadataByDictKey('customData', 'wave_directionality', self._ui.waveDirectionalitySpinBox.value())
def _buttonBoxButtonClicked(self, button):
role = self._ui.buttonBox.buttonRole(button)
Roles = QtWidgets.QDialogButtonBox.ButtonRole
if role == Roles.AcceptRole or role == Roles.ApplyRole:
self._apply()
if role == Roles.AcceptRole or role == Roles.RejectRole:
self.close()
| 2,923 | Python | 46.16129 | 120 | 0.718782 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/oceanSim/__init__.py | from pxr import Tf
from pxr.Usdviewq.plugin import PluginContainer
from .preferences import Preferences
def launchPreferences(usdviewApi):
prim = usdviewApi.stage.GetPrimAtPath("/World/grid/Grid")
attr = prim.GetAttribute("warp:sourceFile")
_preferencesDlg = Preferences(usdviewApi.qMainWindow, attr)
_preferencesDlg.show()
_preferencesDlg = None
class OceanSimPluginContainer(PluginContainer):
def registerPlugins(self, plugRegistry, usdviewApi):
self._launchPreferences = plugRegistry.registerCommandPlugin(
"OceanSimPluginContainer.launchPreferences",
"Launch Preferences",
launchPreferences)
def configureView(self, plugRegistry, plugUIBuilder):
tutMenu = plugUIBuilder.findOrCreateMenu("OceanSim")
tutMenu.addItem(self._launchPreferences)
Tf.Type.Define(OceanSimPluginContainer) | 878 | Python | 32.807691 | 69 | 0.749431 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniWarpSceneIndex/oceanSim/preferencesUI_pyside6.py | # -*- coding: utf-8 -*-
################################################################################
## Form generated from reading UI file 'preferencesUI.ui'
##
## Created by: Qt User Interface Compiler version 6.5.1
##
## WARNING! All changes made in this file will be lost when recompiling UI file!
################################################################################
from PySide6.QtCore import (QCoreApplication, QDate, QDateTime, QLocale,
QMetaObject, QObject, QPoint, QRect,
QSize, QTime, QUrl, Qt)
from PySide6.QtGui import (QBrush, QColor, QConicalGradient, QCursor,
QFont, QFontDatabase, QGradient, QIcon,
QImage, QKeySequence, QLinearGradient, QPainter,
QPalette, QPixmap, QRadialGradient, QTransform)
from PySide6.QtWidgets import (QAbstractButton, QApplication, QDialog, QDialogButtonBox,
QDoubleSpinBox, QFrame, QHBoxLayout, QLabel,
QSizePolicy, QSpacerItem, QVBoxLayout, QWidget)
class Ui_Preferences(object):
def setupUi(self, Ocean_Simulation_Settings):
if not Ocean_Simulation_Settings.objectName():
Ocean_Simulation_Settings.setObjectName(u"Ocean_Simulation_Settings")
Ocean_Simulation_Settings.resize(295, 99)
self.verticalLayout = QVBoxLayout()
self.verticalLayout.setObjectName(u"verticalLayout")
self.prefsOverButtonsLayout = QVBoxLayout()
self.prefsOverButtonsLayout.setObjectName(u"prefsOverButtonsLayout")
self.horizontalLayout_3 = QHBoxLayout()
self.horizontalLayout_3.setObjectName(u"horizontalLayout_3")
self.scaleLabel = QLabel()
self.scaleLabel.setObjectName(u"scaleLabel")
self.horizontalLayout_3.addWidget(self.scaleLabel)
self.horizontalSpacer_2a = QSpacerItem(40, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
self.horizontalLayout_3.addItem(self.horizontalSpacer_2a)
self.scaleSpinBox = QDoubleSpinBox()
self.scaleSpinBox.setObjectName(u"scaleSpinBox")
self.scaleSpinBox.setDecimals(2)
self.scaleSpinBox.setMinimum(0.000000000000000)
self.scaleSpinBox.setValue(1.000000000000000)
self.horizontalLayout_3.addWidget(self.scaleSpinBox)
self.prefsOverButtonsLayout.addLayout(self.horizontalLayout_3)
self.horizontalLayout_4 = QHBoxLayout()
self.horizontalLayout_4.setObjectName(u"horizontalLayout_4")
self.directionLabel = QLabel()
self.directionLabel.setObjectName(u"directionLabel")
self.horizontalLayout_4.addWidget(self.directionLabel)
self.horizontalSpacer_2b = QSpacerItem(26, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
self.horizontalLayout_4.addItem(self.horizontalSpacer_2b)
self.directionSpinBox = QDoubleSpinBox()
self.directionSpinBox.setObjectName(u"directionSpinBox")
self.directionSpinBox.setDecimals(2)
self.directionSpinBox.setMinimum(0.000000000000000)
self.directionSpinBox.setValue(0.000000000000000)
self.horizontalLayout_4.addWidget(self.directionSpinBox)
self.prefsOverButtonsLayout.addLayout(self.horizontalLayout_4)
self.horizontalLayout_5 = QHBoxLayout()
self.horizontalLayout_5.setObjectName(u"horizontalLayout_5")
self.windSpeedLabel = QLabel()
self.windSpeedLabel.setObjectName(u"windSpeedLabel")
self.horizontalLayout_5.addWidget(self.windSpeedLabel)
self.horizontalSpacer_2c = QSpacerItem(24, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
self.horizontalLayout_5.addItem(self.horizontalSpacer_2c)
self.windSpeedSpinBox = QDoubleSpinBox()
self.windSpeedSpinBox.setObjectName(u"windSpeedSpinBox")
self.windSpeedSpinBox.setDecimals(2)
self.windSpeedSpinBox.setMinimum(0.000000000000000)
self.windSpeedSpinBox.setValue(10.000000000000000)
self.horizontalLayout_5.addWidget(self.windSpeedSpinBox)
self.prefsOverButtonsLayout.addLayout(self.horizontalLayout_5)
self.horizontalLayout_6 = QHBoxLayout()
self.horizontalLayout_6.setObjectName(u"horizontalLayout_6")
self.waterDepthLabel = QLabel()
self.waterDepthLabel.setObjectName(u"waterDepthLabel")
self.horizontalLayout_6.addWidget(self.waterDepthLabel)
self.horizontalSpacer_2d = QSpacerItem(24, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
self.horizontalLayout_6.addItem(self.horizontalSpacer_2d)
self.waterDepthSpinBox = QDoubleSpinBox()
self.waterDepthSpinBox.setObjectName(u"waterDepthSpinBox")
self.waterDepthSpinBox.setDecimals(2)
self.waterDepthSpinBox.setMinimum(0.000000000000000)
self.waterDepthSpinBox.setValue(50.000000000000000)
self.horizontalLayout_6.addWidget(self.waterDepthSpinBox)
self.prefsOverButtonsLayout.addLayout(self.horizontalLayout_6)
self.horizontalLayout_7 = QHBoxLayout()
self.horizontalLayout_7.setObjectName(u"horizontalLayout_7")
self.waveAmplitudeLabel = QLabel()
self.waveAmplitudeLabel.setObjectName(u"waveAmplitudeLabel")
self.horizontalLayout_7.addWidget(self.waveAmplitudeLabel)
self.horizontalSpacer_2e = QSpacerItem(21, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
self.horizontalLayout_7.addItem(self.horizontalSpacer_2e)
self.waveAmplitudeSpinBox = QDoubleSpinBox()
self.waveAmplitudeSpinBox.setObjectName(u"waveAmplitudeSpinBox")
self.waveAmplitudeSpinBox.setDecimals(2)
self.waveAmplitudeSpinBox.setMinimum(0.000000000000000)
self.waveAmplitudeSpinBox.setValue(1.500000000000000)
self.horizontalLayout_7.addWidget(self.waveAmplitudeSpinBox)
self.prefsOverButtonsLayout.addLayout(self.horizontalLayout_7)
self.horizontalLayout_8 = QHBoxLayout()
self.horizontalLayout_8.setObjectName(u"horizontalLayout_8")
self.waveDirectionalityLabel = QLabel()
self.waveDirectionalityLabel.setObjectName(u"waveDirectionalityLabel")
self.horizontalLayout_8.addWidget(self.waveDirectionalityLabel)
self.horizontalSpacer_2f = QSpacerItem(17, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
self.horizontalLayout_8.addItem(self.horizontalSpacer_2f)
self.waveDirectionalitySpinBox = QDoubleSpinBox()
self.waveDirectionalitySpinBox.setObjectName(u"waveDirectionalitySpinBox")
self.waveDirectionalitySpinBox.setMinimum(0.000000000000000)
self.waveDirectionalitySpinBox.setValue(0.000000000000000)
self.horizontalLayout_8.addWidget(self.waveDirectionalitySpinBox)
self.prefsOverButtonsLayout.addLayout(self.horizontalLayout_8)
self.verticalSpacer = QSpacerItem(20, 40, QSizePolicy.Minimum, QSizePolicy.Expanding)
self.prefsOverButtonsLayout.addItem(self.verticalSpacer)
self.line = QFrame()
self.line.setObjectName(u"line")
self.line.setFrameShape(QFrame.HLine)
self.line.setFrameShadow(QFrame.Sunken)
self.prefsOverButtonsLayout.addWidget(self.line)
self.horizontalLayout_2 = QHBoxLayout()
self.horizontalLayout_2.setObjectName(u"horizontalLayout_2")
self.horizontalSpacer = QSpacerItem(40, 20, QSizePolicy.Expanding, QSizePolicy.Minimum)
self.horizontalLayout_2.addItem(self.horizontalSpacer)
self.buttonBox = QDialogButtonBox()
self.buttonBox.setObjectName(u"buttonBox")
self.buttonBox.setStandardButtons(QDialogButtonBox.Apply|QDialogButtonBox.Cancel|QDialogButtonBox.Ok)
self.horizontalLayout_2.addWidget(self.buttonBox)
self.prefsOverButtonsLayout.addLayout(self.horizontalLayout_2)
self.verticalLayout.addLayout(self.prefsOverButtonsLayout)
self.retranslateUi(Ocean_Simulation_Settings)
QMetaObject.connectSlotsByName(Ocean_Simulation_Settings)
# setupUi
def retranslateUi(self, Ocean_Simulation_Settings):
Ocean_Simulation_Settings.setWindowTitle(QCoreApplication.translate("Preferences", u"Ocean Simulation Settings", None))
Ocean_Simulation_Settings.setProperty("comment", QCoreApplication.translate("Preferences", u"\n"
" Copyright 2020 Pixar \n"
" \n"
" Licensed under the Apache License, Version 2.0 (the \"Apache License\") \n"
" with the following modification; you may not use this file except in \n"
" compliance with the Apache License and the following modification to it: \n"
" Section 6. Trademarks. is deleted and replaced with: \n"
" \n"
" 6. Trademarks. This License does not grant permission to use the trade \n"
" names, trademarks, service marks, or product names of the Licensor \n"
" and its affiliates, except as required to comply with Section 4(c) of \n"
" the License and to reproduce the content of the NOTI"
"CE file. \n"
" \n"
" You may obtain a copy of the Apache License at \n"
" \n"
" http://www.apache.org/licenses/LICENSE-2.0 \n"
" \n"
" Unless required by applicable law or agreed to in writing, software \n"
" distributed under the Apache License with the above modification is \n"
" distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY \n"
" KIND, either express or implied. See the Apache License for the specific \n"
" language governing permissions and limitations under the Apache License. \n"
" ", None))
self.scaleLabel.setText(QCoreApplication.translate("Preferences", u"Scale", None))
self.directionLabel.setText(QCoreApplication.translate("Preferences", u"Direction", None))
self.windSpeedLabel.setText(QCoreApplication.translate("Preferences", u"Wind Speed", None))
self.waterDepthLabel.setText(QCoreApplication.translate("Preferences", u"Water Depth", None))
self.waveAmplitudeLabel.setText(QCoreApplication.translate("Preferences", u"Wave Amplitude", None))
self.waveDirectionalityLabel.setText(QCoreApplication.translate("Preferences", u"Wave Directionality", None))
# retranslateUi
| 10,887 | Python | 46.134199 | 127 | 0.669055 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/computedPrimDataSource.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/base/gf/transform.h>
#include <pxr/usd/usdGeom/tokens.h>
#include <pxr/imaging/hd/xformSchema.h>
#include "computedPrimDataSource.h"
#include "localPositionSchema.h"
#include "referencePositionSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
HdOmniGeospatialComputedPrimDataSource::HdOmniGeospatialComputedPrimDataSource(
HdContainerDataSourceHandle inputDataSource) :
_inputDataSource(inputDataSource)
{
_matrixDataSource =
HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::New(_inputDataSource);
}
#if PXR_VERSION < 2302
bool HdOmniGeospatialComputedPrimDataSource::Has(const TfToken& name)
{
return (name == HdXformSchemaTokens->resetXformStack) ||
(name == HdXformSchemaTokens->matrix);
}
#endif
TfTokenVector HdOmniGeospatialComputedPrimDataSource::GetNames()
{
// this container data source retrieves the xform tokens
TfTokenVector result;
result.push_back(HdXformSchemaTokens->resetXformStack);
result.push_back(HdXformSchemaTokens->matrix);
return result;
}
HdDataSourceBaseHandle HdOmniGeospatialComputedPrimDataSource::Get(const TfToken& name)
{
if (_inputDataSource != nullptr)
{
if (name == HdXformSchemaTokens->resetXformStack)
{
// we don't modify the underlying time-sampled data
// for resetXformStack, so return that directly
HdXformSchema xformSchema = HdXformSchema::GetFromParent(_inputDataSource);
return xformSchema.IsDefined() ? xformSchema.GetResetXformStack() : nullptr;
}
else if (name == HdXformSchemaTokens->matrix)
{
// note even if resetXformStack was true we consider
// the geospatial data to override that
return _matrixDataSource;
}
}
return nullptr;
}
HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GeospatialMatrixDataSource(
HdContainerDataSourceHandle inputDataSource) : _inputDataSource(inputDataSource)
{
}
VtValue HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::GetValue(Time shutterOffset)
{
return VtValue(this->GetTypedValue(shutterOffset));
}
GfMatrix4d HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::GetTypedValue(Time shutterOffset)
{
return this->_ComputeTransformedMatrix(shutterOffset);
}
bool HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::GetContributingSampleTimesForInterval(
Time startTime,
Time endTime,
std::vector<Time>* outSampleTimes)
{
HdSampledDataSourceHandle sources[] = {
this->_GetMatrixSource(),
this->_GetLocalPositionSource()
};
return HdGetMergedContributingSampleTimesForInterval(
TfArraySize(sources),
sources,
startTime,
endTime,
outSampleTimes);
}
HdMatrixDataSourceHandle HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetMatrixSource() const
{
return HdXformSchema::GetFromParent(_inputDataSource).GetMatrix();
}
HdVec3dDataSourceHandle HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetLocalPositionSource() const
{
return HdOmniGeospatialWGS84LocalPositionSchema::GetFromParent(_inputDataSource).GetPosition();
}
HdTokenDataSourceHandle HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetTangentPlaneSource() const
{
return HdOmniGeospatialWGS84ReferencePositionSchema::GetFromParent(_inputDataSource).GetTangentPlane();
}
HdVec3dDataSourceHandle HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetReferencePositionSource() const
{
return HdOmniGeospatialWGS84ReferencePositionSchema::GetFromParent(_inputDataSource).GetReferencePosition();
}
HdVec3dDataSourceHandle HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetOrientationSource() const
{
return HdOmniGeospatialWGS84ReferencePositionSchema::GetFromParent(_inputDataSource).GetOrientation();
}
HdTokenDataSourceHandle HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetStageUpAxisSource() const
{
return HdOmniGeospatialWGS84ReferencePositionSchema::GetFromParent(_inputDataSource).GetStageUpAxis();
}
HdDoubleDataSourceHandle HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetStageMetersPerUnitSource() const
{
return HdOmniGeospatialWGS84ReferencePositionSchema::GetFromParent(_inputDataSource).GetStageMetersPerUnit();
}
GfMatrix4d HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetMatrix(const Time shutterOffset) const
{
HdMatrixDataSourceHandle dataSource = this->_GetMatrixSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(shutterOffset);
}
return GfMatrix4d(1.0);
}
GfVec3d HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetLocalPosition(const Time shutterOffset) const
{
HdVec3dDataSourceHandle dataSource = this->_GetLocalPositionSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(shutterOffset);
}
return GfVec3d(1.0);
}
TfToken HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetTangentPlane() const
{
HdTokenDataSourceHandle dataSource = this->_GetTangentPlaneSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(0.0f);
}
return TfToken();
}
GfVec3d HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetReferencePosition() const
{
HdVec3dDataSourceHandle dataSource = this->_GetReferencePositionSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(0.0f);
}
return GfVec3d(1.0);
}
GfVec3d HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetOrientation() const
{
HdVec3dDataSourceHandle dataSource = this->_GetOrientationSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(0.0f);
}
return GfVec3d(1.0);
}
TfToken HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetStageUpAxis() const
{
HdTokenDataSourceHandle dataSource = this->_GetStageUpAxisSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(0.0f);
}
return UsdGeomTokens->y;
}
double HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GetStageMetersPerUnit() const
{
HdDoubleDataSourceHandle dataSource = this->_GetStageMetersPerUnitSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(0.0f);
}
return 0.01;
}
GfMatrix4d HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_ComputeTransformedMatrix(const Time shutterOffset) const
{
// NOTE: in the case of the geospatially applied prim, we are completely
// ignoring the fact that resetXformStack may be true at any given time sample
// that is, geospatial positioning takes priority over local transformation reset
// to compute the local position, we need to first get the geodetic reference
TfToken targetFrame = this->_GetTangentPlane();
GfVec3d tangentPosition = this->_GetReferencePosition();
GfVec3d orientation = this->_GetOrientation();
GfVec3d localPosition = this->_GetLocalPosition(shutterOffset);
double metersPerUnit = this->_GetStageMetersPerUnit();
TfToken upAxis = this->_GetStageUpAxis();
// calculate the new geodetic translation
auto enu = this->_EcefToEnu(this->_GeodeticToEcef(localPosition), tangentPosition);
GfVec3d translation = this->_EnuToCartesian(enu, upAxis, metersPerUnit, tangentPosition);
// we only want to replace the translation piece
// but since the transform may have orientation and scale
// information, we need to extract that from the existing
// matrix first
GfTransform currentTransform(this->_GetMatrix(shutterOffset));
GfVec3d existingScale = currentTransform.GetScale();
GfRotation existingRotation = currentTransform.GetRotation();
GfRotation existingPivotOrientation = currentTransform.GetPivotOrientation();
GfVec3d existingPivotPosition = currentTransform.GetPivotPosition();
// now combine the new translation with the existing scale / rotation
GfTransform newTransform(existingScale, existingPivotOrientation,
existingRotation, existingPivotPosition, translation);
return newTransform.GetMatrix();
}
// Geospatial transform functions
// For reference:
// https://onlinelibrary.wiley.com/doi/pdf/10.1002/9780470099728.app3
// https://en.wikipedia.org/wiki/Geographic_coordinate_conversion
// Implementation of Ferrari's solution
GfVec3d HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_GeodeticToEcef(const GfVec3d & llh) const
{
double lambda = llh[0] * GeoConstants::radians;
double phi = llh[1] * GeoConstants::radians;
double sin_lambda = sin(lambda);
double N = GeoConstants::semiMajorAxis / sqrt(1 - GeoConstants::eccentricity * sin_lambda * sin_lambda);
double cos_lambda = cos(lambda);
double cos_phi = cos(phi);
double sin_phi = sin(phi);
return PXR_NS::GfVec3d((llh[2] + N) * cos_lambda * cos_phi, (llh[2] + N) * cos_lambda * sin_phi,
(llh[2] + (1 - GeoConstants::eccentricity) * N) * sin_lambda);
}
GfVec3d HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_EcefToEnu(const GfVec3d& ecef, const GfVec3d& llh) const
{
double lambda = llh[0] * GeoConstants::radians;
double phi = llh[1] * GeoConstants::radians;
double sin_lambda = sin(lambda);
double N = GeoConstants::semiMajorAxis / sqrt(1 - GeoConstants::eccentricity * sin_lambda * sin_lambda);
double cos_lambda = cos(lambda);
double cos_phi = cos(phi);
double sin_phi = sin(phi);
PXR_NS::GfVec3d pt((llh[2] + N) * cos_lambda * cos_phi,
(llh[2] + N) * cos_lambda * sin_phi,
(llh[2] + (1 - GeoConstants::eccentricity) * N) * sin_lambda);
auto delta = ecef - pt;
return PXR_NS::GfVec3d(-sin_phi * delta[0] + cos_phi * delta[1],
-cos_phi * sin_lambda * delta[0] - sin_lambda * sin_phi * delta[1] + cos_lambda * delta[2],
cos_lambda * cos_phi * delta[0] + cos_lambda * sin_phi * delta[1] + sin_lambda * delta[2]);
}
GfVec3d HdOmniGeospatialComputedPrimDataSource::_GeospatialMatrixDataSource::_EnuToCartesian(
const GfVec3d& enu,
const TfToken& upAxis,
const double& metersPerUnit,
const GfVec3d& reference) const
{
auto cartesian = GfVec3d(reference[0] < 0.0 ? -enu[0] : enu[0],
upAxis == UsdGeomTokens->y ? enu[2] : enu[1],
upAxis == UsdGeomTokens->z ? enu[2] : enu[1]);
cartesian /= metersPerUnit;
return cartesian;
}
PXR_NAMESPACE_CLOSE_SCOPE | 11,354 | C++ | 35.394231 | 137 | 0.747314 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/referencePositionSchema.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef HD_OMNI_GEOSPATIAL_WGS84_REFERENCE_POSITION_SCHEMA_H_
#define HD_OMNI_GEOSPATIAL_WGS84_REFERENCE_POSITION_SCHEMA_H_
#include <pxr/imaging/hd/schema.h>
#include <pxr/imaging/hd/dataSourceLocator.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
//-----------------------------------------------------------------------------
#define HDOMNIGEOSPATIALWGS84REFERENCEPOSITION_SCHEMA_TOKENS \
(referencePositionApi) \
(tangentPlane) \
(referencePosition) \
(orientation) \
(stageUpAxis) \
(stageMetersPerUnit) \
TF_DECLARE_PUBLIC_TOKENS(HdOmniGeospatialWGS84ReferencePositionSchemaTokens, OMNIGEOSCENEINDEX_API,
HDOMNIGEOSPATIALWGS84REFERENCEPOSITION_SCHEMA_TOKENS);
//-----------------------------------------------------------------------------
class HdOmniGeospatialWGS84ReferencePositionSchema : public HdSchema
{
public:
HdOmniGeospatialWGS84ReferencePositionSchema(HdContainerDataSourceHandle container)
: HdSchema(container) { }
OMNIGEOSCENEINDEX_API
HdTokenDataSourceHandle GetTangentPlane();
OMNIGEOSCENEINDEX_API
HdVec3dDataSourceHandle GetReferencePosition();
OMNIGEOSCENEINDEX_API
HdVec3dDataSourceHandle GetOrientation();
OMNIGEOSCENEINDEX_API
HdTokenDataSourceHandle GetStageUpAxis();
OMNIGEOSCENEINDEX_API
HdDoubleDataSourceHandle GetStageMetersPerUnit();
OMNIGEOSCENEINDEX_API
static HdOmniGeospatialWGS84ReferencePositionSchema GetFromParent(
const HdContainerDataSourceHandle& fromParentContainer);
OMNIGEOSCENEINDEX_API
static const HdDataSourceLocator& GetDefaultLocator();
OMNIGEOSCENEINDEX_API
static HdContainerDataSourceHandle BuildRetained(
const HdTokenDataSourceHandle& tangentPlane,
const HdVec3dDataSourceHandle& referencePosition,
const HdVec3dDataSourceHandle& orientation,
const HdTokenDataSourceHandle& stageUpAxis,
const HdDoubleDataSourceHandle& stageMetersPerUnit
);
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif // HD_OMNI_GEOSPATIAL_WGS84_REFERENCE_POSITION_SCHEMA_H_ | 2,662 | C | 32.70886 | 99 | 0.730278 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/api.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_GEO_SCENE_INDEX_API_H
#define OMNI_GEO_SCENE_INDEX_API_H
#include "pxr/base/arch/export.h"
#if defined(PXR_STATIC)
# define OMNIGEOSCENEINDEX_API
# define OMNIGEOSCENEINDEX_API_TEMPLATE_CLASS(...)
# define OMNIGEOSCENEINDEX_API_TEMPLATE_STRUCT(...)
# define OMNIGEOSCENEINDEX_LOCAL
#else
# if defined(OMNIGEOSCENEINDEX_EXPORTS)
# define OMNIGEOSCENEINDEX_API ARCH_EXPORT
# define OMNIGEOSCENEINDEX_API_TEMPLATE_CLASS(...) ARCH_EXPORT_TEMPLATE(class, __VA_ARGS__)
# define OMNIGEOSCENEINDEX_API_TEMPLATE_STRUCT(...) ARCH_EXPORT_TEMPLATE(struct, __VA_ARGS__)
# else
# define OMNIGEOSCENEINDEX_API ARCH_IMPORT
# define OMNIGEOSCENEINDEX_API_TEMPLATE_CLASS(...) ARCH_IMPORT_TEMPLATE(class, __VA_ARGS__)
# define OMNIGEOSCENEINDEX_API_TEMPLATE_STRUCT(...) ARCH_IMPORT_TEMPLATE(struct, __VA_ARGS__)
# endif
# define OMNIGEOSCENEINDEX_LOCAL ARCH_HIDDEN
#endif
#endif // OMNI_GEO_INDEX_API_H
| 1,544 | C | 39.657894 | 99 | 0.734456 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/localPositionDataSource.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef HD_OMNI_GEOSPATIAL_WGS84_LOCAL_POSITION_DATA_SOURCE_H_
#define HD_OMNI_GEOSPATIAL_WGS84_LOCAL_POSITION_DATA_SOURCE_H_
#include <pxr/imaging/hd/dataSource.h>
#include <pxr/usdImaging/usdImaging/dataSourceStageGlobals.h>
#include <omniGeospatial/wGS84LocalPositionAPI.h>
#include "localPositionSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
class HdOmniGeospatialWGS84LocalPositionDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(HdOmniGeospatialWGS84LocalPositionDataSource);
HdOmniGeospatialWGS84LocalPositionDataSource(const UsdPrim& prim,
const UsdImagingDataSourceStageGlobals& stageGlobals);
TfTokenVector GetNames() override;
HdDataSourceBaseHandle Get(const TfToken& name) override;
#if PXR_VERSION < 2302
bool Has(const TfToken& name) override;
#endif
private:
OmniGeospatialWGS84LocalPositionAPI _localPositionApi;
const UsdImagingDataSourceStageGlobals& _stageGlobals;
};
HD_DECLARE_DATASOURCE_HANDLES(HdOmniGeospatialWGS84LocalPositionDataSource);
PXR_NAMESPACE_CLOSE_SCOPE
#endif // HD_OMNI_GEOSPATIAL_WGS84_LOCAL_POSITION_DATA_SOURCE_H_ | 1,710 | C | 33.219999 | 81 | 0.792398 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/computedDependentDataSource.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef HD_OMNI_GEOSPATIAL_COMPUTED_DEPENDENT_DATA_SOURCE_H_
#define HD_OMNI_GEOSPATIAL_COMPUTED_DEPENDENT_DATA_SOURCE_H_
#include <pxr/imaging/hd/dataSource.h>
#include <pxr/imaging/hd/dataSourceTypeDefs.h>
PXR_NAMESPACE_OPEN_SCOPE
/// \class HdOmniGeospatialComputedDependentDataSource
///
/// A datasource representing a container data source mimicing
/// that of a container data source for xform data, but returning
/// computed values based on geospatial data applied to the parent
/// (or some parent in the hierarchy) of this prim.
///
class HdOmniGeospatialComputedDependentDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(HdOmniGeospatialComputedDependentDataSource);
HdOmniGeospatialComputedDependentDataSource(HdContainerDataSourceHandle inputDataSource,
HdContainerDataSourceHandle parentDataSource);
// data source overrides
TfTokenVector GetNames() override;
HdDataSourceBaseHandle Get(const TfToken& name) override;
#if PXR_VERSION < 2302
bool Has(const TfToken& name) override;
#endif
private:
HdDataSourceBaseHandle _ComputeGeospatiallyAffectedXform();
private:
HdContainerDataSourceHandle _inputDataSource;
HdContainerDataSourceHandle _parentDataSource;
HdMatrixDataSourceHandle _matrixDataSource;
class _GeospatiallyAffectedMatrixDataSource : public HdMatrixDataSource
{
public:
HD_DECLARE_DATASOURCE(_GeospatiallyAffectedMatrixDataSource);
VtValue GetValue(Time shutterOffset) override;
GfMatrix4d GetTypedValue(Time shutterOffset) override;
bool GetContributingSampleTimesForInterval(
Time startTime,
Time endTime,
std::vector<Time>* outSampleTimes) override;
private:
_GeospatiallyAffectedMatrixDataSource(HdContainerDataSourceHandle inputDataSource,
HdContainerDataSourceHandle parentDataSource);
HdMatrixDataSourceHandle _GetMatrixSource() const;
HdBoolDataSourceHandle _GetResetXformStackSource() const;
HdMatrixDataSourceHandle _GetParentMatrixSource() const;
HdMatrixDataSourceHandle _GetParentOriginalMatrixSource() const;
GfMatrix4d _GetMatrix(const Time shutterOffset) const;
bool _GetResetXformStack(const Time shutterOffset) const;
GfMatrix4d _GetParentMatrix(const Time shutterOffset) const;
GfMatrix4d _GetParentOriginalMatrix(const Time shutterOffset) const;
// geospatial transform methods
GfMatrix4d _ComputeTransformedMatrix(const Time shutterOffset) const;
HdContainerDataSourceHandle _inputDataSource;
HdContainerDataSourceHandle _parentDataSource;
};
HD_DECLARE_DATASOURCE_HANDLES(_GeospatiallyAffectedMatrixDataSource);
};
HD_DECLARE_DATASOURCE_HANDLES(HdOmniGeospatialComputedDependentDataSource);
PXR_NAMESPACE_CLOSE_SCOPE
#endif // HD_OMNI_GEOSPATIAL_COMPUTED_DEPENDENT_DATA_SOURCE_H_ | 3,530 | C | 35.402061 | 92 | 0.768272 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/geospatialDataSource.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/imaging/hd/xformSchema.h>
#include "geospatialDataSource.h"
#include "computedPrimDataSource.h"
#include "computedDependentDataSource.h"
#include "localPositionSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PUBLIC_TOKENS(HdOmniGeospatialDataSourceTokens,
HDOMNIGEOSPATIALDATASOURCE_TOKENS);
HdOmniGeospatialDataSource::HdOmniGeospatialDataSource(const HdSceneIndexBase& index, const SdfPath& primPath,
HdContainerDataSourceHandle wrappedDataSource) :
_sceneIndex(index),
_primPath(primPath),
_wrappedDataSource(wrappedDataSource)
{
}
void HdOmniGeospatialDataSource::UpdateWrappedDataSource(
HdContainerDataSourceHandle wrappedDataSource)
{
_wrappedDataSource = wrappedDataSource;
}
#if PXR_VERSION < 2302
bool HdOmniGeospatialDataSource::Has(const TfToken& name)
{
if (name == HdOmniGeospatialDataSourceTokens->geospatialPreservedXform)
{
return true;
}
return (_wrappedDataSource != nullptr) ? _wrappedDataSource->Has(name) : false;
}
#endif
TfTokenVector HdOmniGeospatialDataSource::GetNames()
{
// since we only wrapped Xformables, this should
// also return HdXformSchemaTokens->xform
TfTokenVector result = (_wrappedDataSource == nullptr) ? TfTokenVector() : _wrappedDataSource->GetNames();
result.push_back(HdOmniGeospatialDataSourceTokens->geospatialPreservedXform);
return result;
}
HdDataSourceBaseHandle HdOmniGeospatialDataSource::Get(const TfToken& name)
{
if (name == HdXformSchemaTokens->xform)
{
// this is an intercept of the flattened transform matrix
// we need to dynamically compute a geospatial one
return this->_ComputeGeospatialXform();
}
else if (name == HdOmniGeospatialDataSourceTokens->geospatialPreservedXform)
{
// this would be the original flattened matrix of the wrapped data source
if (_wrappedDataSource != nullptr)
{
return _wrappedDataSource->Get(HdXformSchemaTokens->xform);
}
}
// all other token values should be defer to the wrapped data source (if any)
if (_wrappedDataSource != nullptr)
{
return _wrappedDataSource->Get(name);
}
return nullptr;
}
bool HdOmniGeospatialDataSource::IsPrimDirtied(const HdDataSourceLocatorSet& locators)
{
static const HdContainerDataSourceHandle containerNull(nullptr);
if (locators.Intersects(HdXformSchema::GetDefaultLocator()))
{
if (HdContainerDataSource::AtomicLoad(_computedGeospatialPrimDataSource) != nullptr ||
HdContainerDataSource::AtomicLoad(_computedGeospatialDependentDataSource) != nullptr)
{
HdContainerDataSource::AtomicStore(_computedGeospatialPrimDataSource, containerNull);
HdContainerDataSource::AtomicStore(_computedGeospatialDependentDataSource, containerNull);
return true;
}
}
return false;
}
HdDataSourceBaseHandle HdOmniGeospatialDataSource::_ComputeGeospatialXform()
{
// since matrices are time sampled, we actually don't compute anything
// here, we just setup the right HdMatrixDataSources to be able to
// compute a final value at a specific time sample when asked
// to do that, we have two cases:
// 1. The wrapped prim in question has a local geodetic position applied
// In this case, all of the information we need to compute the position
// is stored inside of the wrapped prim itself (i.e. the geodetic root
// tangentFrame and geodtic position from the applied API schema)
// 2. The wrapped prim in question does not have a local geodetic position
// applied, but it's parent in the stage hierarchy does, which means
// that we need the wrapped prim plus it's parent prim to be able to
// compute the new correct transform
//
// Case 1 is easy - we can detect whether we have the information or not
// and create the right data source to return.
//
// Case 2 is a bit more difficult to do performantly - at the moment
// we will walk the parent prim hierarchy to the root to determine
// this information, but likely you would want to cache this locally
// on the wrapped prim. We can certainly do that, but then we have to
// be concerned about invalidating it at the right time. We'll leave this
// as a TODO for the future.
//
if (this->_HasGeospatialInformation(_wrappedDataSource))
{
// this is case 1, and we can create a data source specifically
// catered to do that computation
HdContainerDataSourceHandle computedGeospatialPrimDataSource =
HdContainerDataSource::AtomicLoad(_computedGeospatialPrimDataSource);
if (computedGeospatialPrimDataSource != nullptr)
{
// we have a previously cached value so can return that directly
return computedGeospatialPrimDataSource;
}
// otherwise we have to compute a new one
// since the container responsible for the xform token
// needs to take into account both resetXform and matrix
// and since both of those can be time-sampled, we have to make
// sure we can respond appropriately to any query
// so we will need a complete view of the wrapped data source
// to perform the computation
computedGeospatialPrimDataSource = HdOmniGeospatialComputedPrimDataSource::New(_wrappedDataSource);
HdContainerDataSource::AtomicStore(_computedGeospatialPrimDataSource, computedGeospatialPrimDataSource);
return computedGeospatialPrimDataSource;
}
else
{
// this is case 2, in order to perform this transformation appropriately
// we have to walk the parent hierarchy to find the parent with a local position
// geospatial API attached to it - if none exists we can return the wrapped
// data source directly, but if one does exist we need a new data source capable
// of handling the dynamic compute at any time sample
HdContainerDataSourceHandle computedGeospatialDependentDataSource =
HdContainerDataSource::AtomicLoad(_computedGeospatialDependentDataSource);
if (computedGeospatialDependentDataSource != nullptr)
{
// we have a previously cached value and can return that directly
return computedGeospatialDependentDataSource;
}
// otherwise we have to compute a new one
// so we need to follow the prim hierarchy up until we reach
// a geospatially applied one (if any)
if (_primPath != SdfPath::AbsoluteRootPath())
{
HdContainerDataSourceHandle geospatialDataSource = nullptr;
for (SdfPath p = _primPath.GetParentPath(); p != SdfPath::AbsoluteRootPath(); p = p.GetParentPath())
{
HdSceneIndexPrim prim = _sceneIndex.GetPrim(p);
if (this->_HasGeospatialInformation(prim.dataSource))
{
// found it!
geospatialDataSource = prim.dataSource;
}
}
// if we didn't find a geospatially applied parent, we don't need to do anything
if (geospatialDataSource == nullptr)
{
if (_wrappedDataSource != nullptr)
{
HdContainerDataSourceHandle dataSource = HdContainerDataSource::Cast(_wrappedDataSource->Get(HdXformSchemaTokens->xform));
if (dataSource != nullptr)
{
HdContainerDataSource::AtomicStore(_computedGeospatialDependentDataSource, dataSource);
return _computedGeospatialDependentDataSource;
}
return nullptr;
}
return nullptr;
}
// otherwise we need a new datasource that can perform the compute between
// the immediate parent and the prim in question
SdfPath parentPath = _primPath.GetParentPath();
HdSceneIndexPrim parentSceneIndexPrim = _sceneIndex.GetPrim(parentPath);
computedGeospatialDependentDataSource = HdOmniGeospatialComputedDependentDataSource::New(_wrappedDataSource,
parentSceneIndexPrim.dataSource);
HdContainerDataSource::AtomicStore(_computedGeospatialDependentDataSource, computedGeospatialDependentDataSource);
return computedGeospatialDependentDataSource;
}
else
{
// it's the root path, and we don't have to do anything here
// NOTE: this makes the assumption that root never has geospatial information applied
if (_wrappedDataSource != nullptr)
{
return _wrappedDataSource->Get(HdXformSchemaTokens->xform);
}
}
}
return nullptr;
}
bool HdOmniGeospatialDataSource::_HasGeospatialInformation(HdContainerDataSourceHandle handle)
{
HdOmniGeospatialWGS84LocalPositionSchema localPositionSchema = HdOmniGeospatialWGS84LocalPositionSchema::GetFromParent(handle);
return localPositionSchema.IsDefined();
}
PXR_NAMESPACE_CLOSE_SCOPE | 9,813 | C++ | 40.235294 | 142 | 0.689086 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/localPositionDataSource.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/usdImaging/usdImaging/dataSourceAttribute.h>
#include "localPositionDataSource.h"
PXR_NAMESPACE_OPEN_SCOPE
HdOmniGeospatialWGS84LocalPositionDataSource::HdOmniGeospatialWGS84LocalPositionDataSource(
const UsdPrim& prim,
const UsdImagingDataSourceStageGlobals& stageGlobals) :
_stageGlobals(stageGlobals)
{
_localPositionApi = OmniGeospatialWGS84LocalPositionAPI(prim);
}
#if PXR_VERSION < 2302
bool HdOmniGeospatialWGS84LocalPositionDataSource::Has(const TfToken& name)
{
return (name == HdOmniGeospatialWGS84LocalPositionSchemaTokens->position);
}
#endif
TfTokenVector HdOmniGeospatialWGS84LocalPositionDataSource::GetNames()
{
// return the hydra attribute names this data source is responsible for
TfTokenVector names;
names.push_back(HdOmniGeospatialWGS84LocalPositionSchemaTokens->position);
return names;
}
HdDataSourceBaseHandle HdOmniGeospatialWGS84LocalPositionDataSource::Get(const TfToken& name)
{
// retrieves the data source values for the attributes this data source
// supports
if (name == HdOmniGeospatialWGS84LocalPositionSchemaTokens->position)
{
return UsdImagingDataSourceAttribute<GfVec3d>::New(
_localPositionApi.GetPositionAttr(), _stageGlobals);
}
// this is a name we don't support
return nullptr;
}
PXR_NAMESPACE_CLOSE_SCOPE | 1,954 | C++ | 32.135593 | 93 | 0.772262 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/computedPrimDataSource.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef HD_OMNI_GEOSPATIAL_COMPUTED_PRIM_DATA_SOURCE_H_
#define HD_OMNI_GEOSPATIAL_COMPUTED_PRIM_DATA_SOURCE_H_
#include <pxr/imaging/hd/dataSource.h>
#include <pxr/imaging/hd/dataSourceTypeDefs.h>
PXR_NAMESPACE_OPEN_SCOPE
/// \class HdOmniGeospatialComputedPrimDataSource
///
/// A datasource representing a container data source mimicing
/// that of a container data source for xform data, but returning
/// computed values based on geospatial data applied to the prim.
///
class HdOmniGeospatialComputedPrimDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(HdOmniGeospatialComputedPrimDataSource);
HdOmniGeospatialComputedPrimDataSource(HdContainerDataSourceHandle inputDataSource);
// data source overrides
TfTokenVector GetNames() override;
HdDataSourceBaseHandle Get(const TfToken& name) override;
#if PXR_VERSION < 2302
bool Has(const TfToken& name) override;
#endif
private:
HdDataSourceBaseHandle _ComputeGeospatialXform();
GfVec3d _GeodeticToEcef(const GfVec3d& llh) const;
GfVec3d _EcefToEnu(const GfVec3d& ecef, const GfVec3d& llh) const;
GfVec3d _EnuToCartesian(const GfVec3d& enu, const TfToken& upAxis, const double& metersPerUnit, const GfVec3d& reference) const;
private:
HdContainerDataSourceHandle _inputDataSource;
HdMatrixDataSourceHandle _matrixDataSource;
class _GeospatialMatrixDataSource : public HdMatrixDataSource
{
public:
HD_DECLARE_DATASOURCE(_GeospatialMatrixDataSource);
VtValue GetValue(Time shutterOffset) override;
GfMatrix4d GetTypedValue(Time shutterOffset) override;
bool GetContributingSampleTimesForInterval(
Time startTime,
Time endTime,
std::vector<Time>* outSampleTimes) override;
private:
_GeospatialMatrixDataSource(HdContainerDataSourceHandle inputDataSource);
HdMatrixDataSourceHandle _GetMatrixSource() const;
HdVec3dDataSourceHandle _GetLocalPositionSource() const;
HdTokenDataSourceHandle _GetTangentPlaneSource() const;
HdVec3dDataSourceHandle _GetReferencePositionSource() const;
HdVec3dDataSourceHandle _GetOrientationSource() const;
HdTokenDataSourceHandle _GetStageUpAxisSource() const;
HdDoubleDataSourceHandle _GetStageMetersPerUnitSource() const;
GfMatrix4d _GetMatrix(const Time shutterOffset) const;
GfVec3d _GetLocalPosition(const Time shutterOffset) const;
TfToken _GetTangentPlane() const;
GfVec3d _GetReferencePosition() const;
GfVec3d _GetOrientation() const;
TfToken _GetStageUpAxis() const;
double _GetStageMetersPerUnit() const;
// geospatial transform methods
GfMatrix4d _ComputeTransformedMatrix(const Time shutterOffset) const;
GfVec3d _GeodeticToEcef(const GfVec3d& llh) const;
GfVec3d _EcefToEnu(const GfVec3d& ecef, const GfVec3d& llh) const;
GfVec3d _EnuToCartesian(const GfVec3d& enu, const TfToken& upAxis, const double& metersPerUnit, const GfVec3d& reference) const;
struct GeoConstants
{
static constexpr double semiMajorAxis = 6378137.0;
static constexpr double semiMinorAxis = 6356752.3142;
static constexpr double flattening = 1.0 / 298.257223563;
static constexpr double eccentricity = flattening * (2 - flattening);
static constexpr double radians = M_PI / 180.0;
static constexpr double degrees = 180.0 / M_PI;
};
HdContainerDataSourceHandle _inputDataSource;
};
HD_DECLARE_DATASOURCE_HANDLES(_GeospatialMatrixDataSource);
};
HD_DECLARE_DATASOURCE_HANDLES(HdOmniGeospatialComputedPrimDataSource);
PXR_NAMESPACE_CLOSE_SCOPE
#endif // HD_OMNI_GEOSPATIAL_COMPUTED_PRIM_DATA_SOURCE_H_ | 4,414 | C | 37.72807 | 136 | 0.738106 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/geospatialSceneIndex.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_GEO_SCENE_INDEX_H_
#define OMNI_GEO_SCENE_INDEX_H_
#include <pxr/pxr.h>
#include <pxr/usd/sdf/pathTable.h>
#include <pxr/imaging/hd/filteringSceneIndex.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DECLARE_REF_PTRS(OmniGeospatialSceneIndex);
///
/// \class OmniGeospatialSceneIndex
///
/// A scene index responsible for observing an input flattened scene
/// index and producing a comparable scene in which geospatial transforms
/// have been applied to prims with geospatial state attached to them
/// and for updating the transform of their children as needed.
///
/// Note that with Render Delegate 2.0 and the ability to pull data
/// from a non-flattened scene, this implementation will have to be
/// revisited to work with the unflattened xform representation of
/// the hydra prims.
///
class OmniGeospatialSceneIndex : public HdSingleInputFilteringSceneIndexBase
{
public:
OMNIGEOSCENEINDEX_API
static OmniGeospatialSceneIndexRefPtr New(const HdSceneIndexBaseRefPtr& inputSceneIndex,
const HdContainerDataSourceHandle& inputArgs = nullptr);
OMNIGEOSCENEINDEX_API
~OmniGeospatialSceneIndex() override;
OMNIGEOSCENEINDEX_API
HdSceneIndexPrim GetPrim(const SdfPath& primPath) const override;
OMNIGEOSCENEINDEX_API
SdfPathVector GetChildPrimPaths(const SdfPath& primPath) const override;
protected:
OmniGeospatialSceneIndex(const HdSceneIndexBaseRefPtr& inputSceneIndex,
const HdContainerDataSourceHandle& inputArgs);
// these three are provided by HdSingleInputFilteringSceneIndexBase
// and must be overridden by inheritors
virtual void _PrimsAdded(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::AddedPrimEntries& entries) override;
virtual void _PrimsRemoved(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::RemovedPrimEntries& entries) override;
virtual void _PrimsDirtied(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::DirtiedPrimEntries& entries) override;
private:
SdfPathTable<HdSceneIndexPrim>::_IterBoolPair _IsPrimWrapped(const SdfPath& primPath) const;
HdSceneIndexPrim& _WrapPrim(const SdfPath& primPath, const HdSceneIndexPrim& hdPrim) const;
void _DirtyHierarchy(const SdfPath& primPath, const HdDataSourceLocatorSet& locators, HdSceneIndexObserver::DirtiedPrimEntries* dirtyEntries);
/*HdContainerDataSourceHandle _ComputeDataSource(
const SdfPath& primPath,
const HdContainerDataSourceHandle& primDataSource) const;
void _ComputeChildDataSources(const SdfPath& parentPath,
const HdContainerDataSourceHandle& parentDataSource) const;
HdContainerDataSourceHandle _ComputeMatrixDependenciesDataSource(
const SdfPath& primPath) const;*/
private:
// marked as mutable because it is an internal cache
// that is written to on-demand from the GetPrim method
// which is a const method by interface definition in HdSceneIndexBase
mutable SdfPathTable<HdSceneIndexPrim> _wrappedPrims;
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif | 3,668 | C | 36.438775 | 146 | 0.773446 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/referencePositionSchema.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/imaging/hd/retainedDataSource.h>
#include "referencePositionSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PUBLIC_TOKENS(HdOmniGeospatialWGS84ReferencePositionSchemaTokens,
HDOMNIGEOSPATIALWGS84REFERENCEPOSITION_SCHEMA_TOKENS);
HdTokenDataSourceHandle HdOmniGeospatialWGS84ReferencePositionSchema::GetTangentPlane()
{
return _GetTypedDataSource<HdTokenDataSource>(
HdOmniGeospatialWGS84ReferencePositionSchemaTokens->tangentPlane);
}
HdVec3dDataSourceHandle HdOmniGeospatialWGS84ReferencePositionSchema::GetReferencePosition()
{
return _GetTypedDataSource<HdVec3dDataSource>(
HdOmniGeospatialWGS84ReferencePositionSchemaTokens->referencePosition);
}
HdVec3dDataSourceHandle HdOmniGeospatialWGS84ReferencePositionSchema::GetOrientation()
{
return _GetTypedDataSource<HdVec3dDataSource>(
HdOmniGeospatialWGS84ReferencePositionSchemaTokens->orientation);
}
HdTokenDataSourceHandle HdOmniGeospatialWGS84ReferencePositionSchema::GetStageUpAxis()
{
return _GetTypedDataSource<HdTokenDataSource>(
HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageUpAxis);
}
HdDoubleDataSourceHandle HdOmniGeospatialWGS84ReferencePositionSchema::GetStageMetersPerUnit()
{
return _GetTypedDataSource<HdDoubleDataSource>(
HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageMetersPerUnit);
}
HdOmniGeospatialWGS84ReferencePositionSchema HdOmniGeospatialWGS84ReferencePositionSchema::GetFromParent(
const HdContainerDataSourceHandle& fromParentContainer)
{
if (fromParentContainer == nullptr)
{
return HdOmniGeospatialWGS84ReferencePositionSchema(nullptr);
}
return HdOmniGeospatialWGS84ReferencePositionSchema(
HdContainerDataSource::Cast(fromParentContainer->Get(
HdOmniGeospatialWGS84ReferencePositionSchemaTokens->referencePositionApi))
);
}
const HdDataSourceLocator& HdOmniGeospatialWGS84ReferencePositionSchema::GetDefaultLocator()
{
static const HdDataSourceLocator locator(
HdOmniGeospatialWGS84ReferencePositionSchemaTokens->referencePositionApi
);
return locator;
}
HdContainerDataSourceHandle HdOmniGeospatialWGS84ReferencePositionSchema::BuildRetained(
const HdTokenDataSourceHandle& tangentPlane,
const HdVec3dDataSourceHandle& referencePosition,
const HdVec3dDataSourceHandle& orientation,
const HdTokenDataSourceHandle& stageUpAxis,
const HdDoubleDataSourceHandle& stageMetersPerUnit)
{
TfToken names[5];
HdDataSourceBaseHandle values[5];
size_t count = 0;
if (tangentPlane != nullptr)
{
names[count] = HdOmniGeospatialWGS84ReferencePositionSchemaTokens->tangentPlane;
values[count] = tangentPlane;
count++;
}
if (referencePosition != nullptr)
{
names[count] = HdOmniGeospatialWGS84ReferencePositionSchemaTokens->referencePosition;
values[count] = referencePosition;
count++;
}
if (orientation != nullptr)
{
names[count] = HdOmniGeospatialWGS84ReferencePositionSchemaTokens->orientation;
values[count] = orientation;
count++;
}
if (stageUpAxis != nullptr)
{
names[count] = HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageUpAxis;
values[count] = stageUpAxis;
count++;
}
if (stageMetersPerUnit != nullptr)
{
names[count] = HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageMetersPerUnit;
values[count] = stageMetersPerUnit;
count++;
}
return HdRetainedContainerDataSource::New(count, names, values);
}
PXR_NAMESPACE_CLOSE_SCOPE | 4,221 | C++ | 33.048387 | 105 | 0.773513 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/localPositionSchema.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef HD_OMNI_GEOSPATIAL_WGS84_LOCAL_POSITION_SCHEMA_H_
#define HD_OMNI_GEOSPATIAL_WGS84_LOCAL_POSITION_SCHEMA_H_
#include <pxr/imaging/hd/schema.h>
#include <pxr/imaging/hd/dataSourceLocator.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
//-----------------------------------------------------------------------------
#define HDOMNIGEOSPATIALWGS84LOCALPOSITION_SCHEMA_TOKENS \
(localPositionApi) \
(position) \
TF_DECLARE_PUBLIC_TOKENS(HdOmniGeospatialWGS84LocalPositionSchemaTokens, OMNIGEOSCENEINDEX_API,
HDOMNIGEOSPATIALWGS84LOCALPOSITION_SCHEMA_TOKENS);
//-----------------------------------------------------------------------------
class HdOmniGeospatialWGS84LocalPositionSchema : public HdSchema
{
public:
HdOmniGeospatialWGS84LocalPositionSchema(HdContainerDataSourceHandle container)
: HdSchema(container) { }
OMNIGEOSCENEINDEX_API
HdVec3dDataSourceHandle GetPosition();
OMNIGEOSCENEINDEX_API
static HdOmniGeospatialWGS84LocalPositionSchema GetFromParent(
const HdContainerDataSourceHandle& fromParentContainer);
OMNIGEOSCENEINDEX_API
static const HdDataSourceLocator& GetDefaultLocator();
OMNIGEOSCENEINDEX_API
static HdContainerDataSourceHandle BuildRetained(
const HdVec3dDataSourceHandle& position
);
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif // HD_OMNI_GEOSPATIAL_WGS84_LOCAL_POSITION_SCHEMA_H_ | 1,985 | C | 32.661016 | 95 | 0.716877 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/referencePositionDataSource.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef HD_OMNI_GEOSPATIAL_WGS84_REFERENCE_POSITION_DATA_SOURCE_H_
#define HD_OMNI_GEOSPATIAL_WGS84_REFERENCE_POSITION_DATA_SOURCE_H_
#include <pxr/imaging/hd/dataSource.h>
#include <pxr/usdImaging/usdImaging/dataSourceStageGlobals.h>
#include <omniGeospatial/wGS84ReferencePositionAPI.h>
#include "referencePositionSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
class HdOmniGeospatialWGS84ReferencePositionDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(HdOmniGeospatialWGS84ReferencePositionDataSource);
HdOmniGeospatialWGS84ReferencePositionDataSource(const UsdPrim& prim,
const UsdImagingDataSourceStageGlobals& stageGlobals);
TfTokenVector GetNames() override;
HdDataSourceBaseHandle Get(const TfToken& name) override;
#if PXR_VERSION < 2302
bool Has(const TfToken& name) override;
#endif
private:
OmniGeospatialWGS84ReferencePositionAPI _referencePositionApi;
const UsdImagingDataSourceStageGlobals& _stageGlobals;
template <typename T>
class _StageDataSource : public HdTypedSampledDataSource<T>
{
public:
HD_DECLARE_DATASOURCE(_StageDataSource<T>);
VtValue GetValue(HdSampledDataSource::Time shutterOffset) override
{
return VtValue(GetTypedValue(shutterOffset));
}
T GetTypedValue(HdSampledDataSource::Time shutterOffset) override
{
return _value;
}
bool GetContributingSampleTimesForInterval(
HdSampledDataSource::Time startTime,
HdSampledDataSource::Time endTime,
std::vector<HdSampledDataSource::Time>* outSampleTimes) override
{
return false;
}
private:
_StageDataSource(const T& value);
T _value;
};
};
HD_DECLARE_DATASOURCE_HANDLES(HdOmniGeospatialWGS84ReferencePositionDataSource);
PXR_NAMESPACE_CLOSE_SCOPE
#endif // HD_OMNI_GEOSPATIAL_WGS84_REFERENCE_POSITION_DATA_SOURCE_H_ | 2,546 | C | 30.060975 | 85 | 0.739199 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/referencePositionAPIAdapter.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/imaging/hd/retainedDataSource.h>
#include <omniGeospatial/wGS84ReferencePositionAPI.h>
#include "referencePositionAPIAdapter.h"
#include "referencePositionDataSource.h"
#include "referencePositionSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_REGISTRY_FUNCTION(TfType)
{
typedef OmniGeospatialWGS84ReferencePositionAPIAdapter Adapter;
TfType t = TfType::Define<Adapter, TfType::Bases<Adapter::BaseAdapter> >();
t.SetFactory<UsdImagingAPISchemaAdapterFactory<Adapter> >();
}
#if PXR_VERSION >= 2302
HdContainerDataSourceHandle OmniGeospatialWGS84ReferencePositionAPIAdapter::GetImagingSubprimData(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const UsdImagingDataSourceStageGlobals& stageGlobals)
#else
HdContainerDataSourceHandle OmniGeospatialWGS84ReferencePositionAPIAdapter::GetImagingSubprimData(
const TfToken& subprim,
const UsdPrim& prim,
const TfToken& appliedInstanceName,
const UsdImagingDataSourceStageGlobals& stageGlobals)
#endif
{
// at the point we are invoked here, the stage scene index has already determined
// that the API schema applies to the prim, so we can safely create our
// data source
if (!subprim.IsEmpty() || !appliedInstanceName.IsEmpty())
{
// there shouldn't be a subprim or an applied instance name
// if there is, we don't really know what to do with it
// so we return null to indicate there is no data source
// for this prim setup
return nullptr;
}
return HdRetainedContainerDataSource::New(
HdOmniGeospatialWGS84ReferencePositionSchemaTokens->referencePositionApi,
HdOmniGeospatialWGS84ReferencePositionDataSource::New(prim, stageGlobals)
);
}
#if PXR_VERSION >= 2302
HdDataSourceLocatorSet OmniGeospatialWGS84ReferencePositionAPIAdapter::InvalidateImagingSubprim(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const TfTokenVector& properties)
#else
HdDataSourceLocatorSet OmniGeospatialWGS84ReferencePositionAPIAdapter::InvalidateImagingSubprim(
const TfToken& subprim,
const TfToken& appliedInstanceName,
const TfTokenVector& properties)
#endif
{
if (!subprim.IsEmpty() || !appliedInstanceName.IsEmpty())
{
return HdDataSourceLocatorSet();
}
TfToken geospatialPrefix("omni:geospatial:wgs84:reference");
for (const TfToken& propertyName : properties)
{
if (TfStringStartsWith(propertyName, geospatialPrefix))
{
return HdOmniGeospatialWGS84ReferencePositionSchema::GetDefaultLocator();
}
}
return HdDataSourceLocatorSet();
}
PXR_NAMESPACE_CLOSE_SCOPE | 3,306 | C++ | 33.810526 | 98 | 0.753781 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/geospatialDataSource.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef HD_OMNI_GEOSPATIAL_DATA_SOURCE_H_
#define HD_OMNI_GEOSPATIAL_DATA_SOURCE_H_
#include <pxr/imaging/hd/dataSource.h>
#include <pxr/imaging/hd/dataSourceTypeDefs.h>
#include <pxr/imaging/hd/sceneIndex.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
//-----------------------------------------------------------------------------
#define HDOMNIGEOSPATIALDATASOURCE_TOKENS \
(geospatialPreservedXform)
TF_DECLARE_PUBLIC_TOKENS(HdOmniGeospatialDataSourceTokens, OMNIGEOSCENEINDEX_API,
HDOMNIGEOSPATIALDATASOURCE_TOKENS);
//-----------------------------------------------------------------------------
/// \class HdOmniGeospatialDataSource
///
/// A datasource representing a wrapped view of an existing flattened
/// data source where the xform token is intercepted and a new geospatial
/// matrix dynamically calculated.
///
class HdOmniGeospatialDataSource : public HdContainerDataSource
{
public:
HD_DECLARE_DATASOURCE(HdOmniGeospatialDataSource);
HdOmniGeospatialDataSource(const HdSceneIndexBase& sceneIndex, const SdfPath& primPath,
HdContainerDataSourceHandle wrappedDataSource);
void UpdateWrappedDataSource(HdContainerDataSourceHandle wrappedDataSource);
// data source overrides
TfTokenVector GetNames() override;
HdDataSourceBaseHandle Get(const TfToken& name) override;
#if PXR_VERSION < 2302
bool Has(const TfToken& name) override;
#endif
// determines if the data source would be dirtied based on the locators given
bool IsPrimDirtied(const HdDataSourceLocatorSet& locators);
private:
bool _HasGeospatialInformation(HdContainerDataSourceHandle dataSource);
HdDataSourceBaseHandle _ComputeGeospatialXform();
private:
const HdSceneIndexBase& _sceneIndex;
SdfPath _primPath;
HdContainerDataSourceHandle _wrappedDataSource;
// cached computed datasources
HdContainerDataSourceAtomicHandle _computedGeospatialPrimDataSource;
HdContainerDataSourceAtomicHandle _computedGeospatialDependentDataSource;
};
HD_DECLARE_DATASOURCE_HANDLES(HdOmniGeospatialDataSource);
PXR_NAMESPACE_CLOSE_SCOPE
#endif // HD_OMNI_GEOSPATIAL_DATA_SOURCE_H_ | 2,737 | C | 31.987951 | 91 | 0.739496 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/localPositionAPIAdapter.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/imaging/hd/retainedDataSource.h>
#include <omniGeospatial/wGS84LocalPositionAPI.h>
#include <omniGeospatial/wGS84ReferencePositionAPI.h>
#include "localPositionAPIAdapter.h"
#include "localPositionDataSource.h"
#include "localPositionSchema.h"
#include "referencePositionDataSource.h"
#include "referencePositionSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_REGISTRY_FUNCTION(TfType)
{
typedef OmniGeospatialWGS84LocalPositionAPIAdapter Adapter;
TfType t = TfType::Define<Adapter, TfType::Bases<Adapter::BaseAdapter> >();
t.SetFactory<UsdImagingAPISchemaAdapterFactory<Adapter> >();
}
#if PXR_VERSION >= 2302
HdContainerDataSourceHandle OmniGeospatialWGS84LocalPositionAPIAdapter::GetImagingSubprimData(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const UsdImagingDataSourceStageGlobals& stageGlobals)
#else
HdContainerDataSourceHandle OmniGeospatialWGS84LocalPositionAPIAdapter::GetImagingSubprimData(
const TfToken& subprim,
const UsdPrim& prim,
const TfToken& appliedInstanceName,
const UsdImagingDataSourceStageGlobals& stageGlobals)
#endif
{
// at the point we are invoked here, the stage scene index has already determined
// that the API schema applies to the prim, so we can safely create our
// data source
if (!subprim.IsEmpty() || !appliedInstanceName.IsEmpty())
{
// there shouldn't be a subprim or an applied instance name
// if there is, we don't really know what to do with it
// so we return null to indicate there is no data source
// for this prim setup
return nullptr;
}
// to make it a bit easier, we will traverse the parent structure here to find a geodetic root
// rather than traversing it in the scene index - this is because we have all of the information
// we need at the point where this prim is getting processed
HdDataSourceBaseHandle referencePositionDataSource = nullptr;
for (UsdPrim parentPrim = prim; !parentPrim.IsPseudoRoot(); parentPrim = parentPrim.GetParent())
{
if (parentPrim.HasAPI<OmniGeospatialWGS84ReferencePositionAPI>())
{
// bake the geodetic root information into this local prim
referencePositionDataSource = HdOmniGeospatialWGS84ReferencePositionDataSource::New(parentPrim, stageGlobals);
break;
}
}
// only process local position if we found a geodetic root - if we didn't
// it means that this is an unrooted local position so we keep whatever
// transform information the prim would have had otherwise
if (referencePositionDataSource != nullptr)
{
return HdRetainedContainerDataSource::New(
HdOmniGeospatialWGS84LocalPositionSchemaTokens->localPositionApi,
HdOmniGeospatialWGS84LocalPositionDataSource::New(prim, stageGlobals),
HdOmniGeospatialWGS84ReferencePositionSchemaTokens->referencePositionApi,
referencePositionDataSource
);
}
return nullptr;
}
#if PXR_VERSION >= 2302
HdDataSourceLocatorSet OmniGeospatialWGS84LocalPositionAPIAdapter::InvalidateImagingSubprim(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const TfTokenVector& properties)
#else
HdDataSourceLocatorSet OmniGeospatialWGS84LocalPositionAPIAdapter::InvalidateImagingSubprim(
const TfToken& subprim,
const TfToken& appliedInstanceName,
const TfTokenVector& properties)
#endif
{
if (!subprim.IsEmpty() || !appliedInstanceName.IsEmpty())
{
return HdDataSourceLocatorSet();
}
TfToken geospatialPrefix("omni:geospatial:wgs84:local");
for (const TfToken& propertyName : properties)
{
if (TfStringStartsWith(propertyName, geospatialPrefix))
{
return HdOmniGeospatialWGS84LocalPositionSchema::GetDefaultLocator();
}
}
return HdDataSourceLocatorSet();
}
PXR_NAMESPACE_CLOSE_SCOPE | 4,574 | C++ | 36.809917 | 122 | 0.740927 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/referencePositionDataSource.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/usd/usdGeom/metrics.h>
#include <pxr/usd/usdGeom/tokens.h>
#include <pxr/usdImaging/usdImaging/dataSourceAttribute.h>
#include "referencePositionDataSource.h"
PXR_NAMESPACE_OPEN_SCOPE
HdOmniGeospatialWGS84ReferencePositionDataSource::HdOmniGeospatialWGS84ReferencePositionDataSource(
const UsdPrim& prim,
const UsdImagingDataSourceStageGlobals& stageGlobals) :
_stageGlobals(stageGlobals)
{
_referencePositionApi = OmniGeospatialWGS84ReferencePositionAPI(prim);
}
#if PXR_VERSION < 2302
bool HdOmniGeospatialWGS84ReferencePositionDataSource::Has(const TfToken& name)
{
return (name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->tangentPlane) ||
(name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->referencePosition) ||
(name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->orientation) ||
(name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageUpAxis) ||
(name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageMetersPerUnit);
}
#endif
TfTokenVector HdOmniGeospatialWGS84ReferencePositionDataSource::GetNames()
{
// return the hydra attribute names this data source is responsible for
TfTokenVector names;
names.push_back(HdOmniGeospatialWGS84ReferencePositionSchemaTokens->tangentPlane);
names.push_back(HdOmniGeospatialWGS84ReferencePositionSchemaTokens->referencePosition);
names.push_back(HdOmniGeospatialWGS84ReferencePositionSchemaTokens->orientation);
names.push_back(HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageUpAxis);
names.push_back(HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageMetersPerUnit);
return names;
}
HdDataSourceBaseHandle HdOmniGeospatialWGS84ReferencePositionDataSource::Get(const TfToken& name)
{
// retrieves the data source values for the attributes this data source
// supports
if (name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->tangentPlane)
{
return UsdImagingDataSourceAttribute<TfToken>::New(
_referencePositionApi.GetTangentPlaneAttr(), _stageGlobals);
}
else if (name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->referencePosition)
{
return UsdImagingDataSourceAttribute<GfVec3d>::New(
_referencePositionApi.GetReferencePositionAttr(), _stageGlobals);
}
else if (name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->orientation)
{
return UsdImagingDataSourceAttribute<GfVec3d>::New(
_referencePositionApi.GetOrientationAttr(), _stageGlobals);
}
else if (name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageUpAxis)
{
TfToken upAxis = UsdGeomTokens->y;
UsdStageWeakPtr stage = _referencePositionApi.GetPrim().GetStage();
if (stage != nullptr)
{
upAxis = UsdGeomGetStageUpAxis(stage);
}
return _StageDataSource<TfToken>::New(upAxis);
}
else if (name == HdOmniGeospatialWGS84ReferencePositionSchemaTokens->stageMetersPerUnit)
{
double mpu = 0.01;
UsdStageWeakPtr stage = _referencePositionApi.GetPrim().GetStage();
if (stage != nullptr)
{
mpu = UsdGeomGetStageMetersPerUnit(stage);
}
return _StageDataSource<double>::New(mpu);
}
// this is a name we don't support
return nullptr;
}
template <typename T>
HdOmniGeospatialWGS84ReferencePositionDataSource::_StageDataSource<T>::_StageDataSource(const T& value) : _value(value)
{
}
PXR_NAMESPACE_CLOSE_SCOPE | 4,155 | C++ | 38.207547 | 119 | 0.754513 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/referencePositionAPIAdapter.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_GEOSPATIAL_WGS84_REFERENCE_POSITION_API_ADAPTER_H_
#define OMNI_GEOSPATIAL_WGS84_REFERENCE_POSITION_API_ADAPTER_H_
#include <pxr/pxr.h>
#include <pxr/usdImaging/usdImaging/apiSchemaAdapter.h>
#include "api.h"
PXR_NAMESPACE_OPEN_SCOPE
class OmniGeospatialWGS84ReferencePositionAPIAdapter : public UsdImagingAPISchemaAdapter
{
public:
using BaseAdapter = UsdImagingAPISchemaAdapter;
#if PXR_VERSION >= 2302
OMNIGEOSCENEINDEX_API
HdContainerDataSourceHandle GetImagingSubprimData(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const UsdImagingDataSourceStageGlobals& stageGlobals
) override;
#else
OMNIGEOSCENEINDEX_API
HdContainerDataSourceHandle GetImagingSubprimData(
const TfToken& subprim,
const UsdPrim& prim,
const TfToken& appliedInstanceName,
const UsdImagingDataSourceStageGlobals& stageGlobals
) override;
#endif
#if PXR_VERSION >= 2302
OMNIGEOSCENEINDEX_API
HdDataSourceLocatorSet InvalidateImagingSubprim(
const UsdPrim& prim,
const TfToken& subprim,
const TfToken& appliedInstanceName,
const TfTokenVector& properties
) override;
#else
OMNIGEOSCENEINDEX_API
HdDataSourceLocatorSet InvalidateImagingSubprim(
const TfToken& subprim,
const TfToken& appliedInstanceName,
const TfTokenVector& properties
) override;
#endif
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif // OMNI_GEOSPATIAL_WGS84_REFERENCE_POSITION_API_ADAPTER_H_ | 2,144 | C | 30.544117 | 88 | 0.747201 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/computedDependentDataSource.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/imaging/hd/xformSchema.h>
#include "geospatialDataSource.h"
#include "computedDependentDataSource.h"
PXR_NAMESPACE_OPEN_SCOPE
HdOmniGeospatialComputedDependentDataSource::HdOmniGeospatialComputedDependentDataSource(
HdContainerDataSourceHandle inputDataSource,
HdContainerDataSourceHandle parentDataSource) :
_inputDataSource(inputDataSource),
_parentDataSource(parentDataSource)
{
_matrixDataSource =
HdOmniGeospatialComputedDependentDataSource::_GeospatiallyAffectedMatrixDataSource::New(
_inputDataSource, parentDataSource);
}
#if PXR_VERSION < 2302
bool HdOmniGeospatialComputedDependentDataSource::Has(const TfToken& name)
{
return (name == HdXformSchemaTokens->resetXformStack) ||
(name == HdXformSchemaTokens->matrix);
}
#endif
TfTokenVector HdOmniGeospatialComputedDependentDataSource::GetNames()
{
// this container data source retrieves the xform tokens
TfTokenVector result;
result.push_back(HdXformSchemaTokens->resetXformStack);
result.push_back(HdXformSchemaTokens->matrix);
return result;
}
HdDataSourceBaseHandle HdOmniGeospatialComputedDependentDataSource::Get(const TfToken& name)
{
if (_inputDataSource != nullptr)
{
if (name == HdXformSchemaTokens->resetXformStack)
{
// we don't modify the underlying time-sampled data
// for resetXformStack, so return that directly
HdXformSchema xformSchema = HdXformSchema::GetFromParent(_inputDataSource);
return xformSchema.IsDefined() ? xformSchema.GetResetXformStack() : nullptr;
}
else if (name == HdXformSchemaTokens->matrix)
{
return _matrixDataSource;
}
}
return nullptr;
}
HdOmniGeospatialComputedDependentDataSource::_GeospatiallyAffectedMatrixDataSource::_GeospatiallyAffectedMatrixDataSource(
HdContainerDataSourceHandle inputDataSource,
HdContainerDataSourceHandle parentDataSource) :
_inputDataSource(inputDataSource),
_parentDataSource(parentDataSource)
{
}
VtValue HdOmniGeospatialComputedDependentDataSource::_GeospatiallyAffectedMatrixDataSource::GetValue(Time shutterOffset)
{
return VtValue(this->GetTypedValue(shutterOffset));
}
GfMatrix4d HdOmniGeospatialComputedDependentDataSource::_GeospatiallyAffectedMatrixDataSource::GetTypedValue(Time shutterOffset)
{
return this->_ComputeTransformedMatrix(shutterOffset);
}
bool HdOmniGeospatialComputedDependentDataSource::_GeospatiallyAffectedMatrixDataSource::GetContributingSampleTimesForInterval(
Time startTime,
Time endTime,
std::vector<Time>* outSampleTimes)
{
HdSampledDataSourceHandle sources[] = {
this->_GetMatrixSource(),
this->_GetParentMatrixSource()
};
return HdGetMergedContributingSampleTimesForInterval(
TfArraySize(sources),
sources,
startTime,
endTime,
outSampleTimes);
}
HdMatrixDataSourceHandle HdOmniGeospatialComputedDependentDataSource::
_GeospatiallyAffectedMatrixDataSource::_GetMatrixSource() const
{
return HdXformSchema::GetFromParent(_inputDataSource).GetMatrix();
}
HdBoolDataSourceHandle HdOmniGeospatialComputedDependentDataSource::
_GeospatiallyAffectedMatrixDataSource::_GetResetXformStackSource() const
{
return HdXformSchema::GetFromParent(_inputDataSource).GetResetXformStack();
}
HdMatrixDataSourceHandle HdOmniGeospatialComputedDependentDataSource::
_GeospatiallyAffectedMatrixDataSource::_GetParentMatrixSource() const
{
return HdXformSchema::GetFromParent(_parentDataSource).GetMatrix();
}
HdMatrixDataSourceHandle HdOmniGeospatialComputedDependentDataSource::
_GeospatiallyAffectedMatrixDataSource::_GetParentOriginalMatrixSource() const
{
// the parent data source here should be a geospatial data source
// but in the even it is not, this method will simply return the same
// matrix as that of _GetParentMatrixSource
HdOmniGeospatialDataSourceHandle geospatialDataSource =
HdOmniGeospatialDataSource::Cast(_parentDataSource);
if (geospatialDataSource != nullptr)
{
HdContainerDataSourceHandle xformDataSource =
HdContainerDataSource::Cast(
geospatialDataSource->Get(HdOmniGeospatialDataSourceTokens->geospatialPreservedXform));
if (xformDataSource == nullptr)
{
TF_WARN("Parent data source could not retrieve preserved xform!");
return this->_GetParentMatrixSource();
}
HdMatrixDataSourceHandle matrixDataSource = HdMatrixDataSource::Cast(
xformDataSource->Get(HdXformSchemaTokens->matrix));
if (matrixDataSource == nullptr)
{
TF_WARN("Xform schema not defined on preserved container data source!");
}
return (matrixDataSource != nullptr) ? matrixDataSource : this->_GetParentMatrixSource();
}
else
{
TF_WARN("Parent data source has no geospatial data source!");
}
return this->_GetParentMatrixSource();
}
GfMatrix4d HdOmniGeospatialComputedDependentDataSource::
_GeospatiallyAffectedMatrixDataSource::_GetMatrix(const Time shutterOffset) const
{
HdMatrixDataSourceHandle dataSource = this->_GetMatrixSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(shutterOffset);
}
return GfMatrix4d(1.0);
}
bool HdOmniGeospatialComputedDependentDataSource::
_GeospatiallyAffectedMatrixDataSource::_GetResetXformStack(const Time shutterOffset) const
{
HdBoolDataSourceHandle dataSource = this->_GetResetXformStackSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(shutterOffset);
}
return false;
}
GfMatrix4d HdOmniGeospatialComputedDependentDataSource::
_GeospatiallyAffectedMatrixDataSource::_GetParentMatrix(const Time shutterOffset) const
{
HdMatrixDataSourceHandle dataSource = this->_GetParentMatrixSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(shutterOffset);
}
return GfMatrix4d(1.0);
}
GfMatrix4d HdOmniGeospatialComputedDependentDataSource::
_GeospatiallyAffectedMatrixDataSource::_GetParentOriginalMatrix(const Time shutterOffset) const
{
HdMatrixDataSourceHandle dataSource = this->_GetParentOriginalMatrixSource();
if (dataSource != nullptr)
{
return dataSource->GetTypedValue(shutterOffset);
}
return GfMatrix4d(1.0);
}
GfMatrix4d HdOmniGeospatialComputedDependentDataSource::
_GeospatiallyAffectedMatrixDataSource::_ComputeTransformedMatrix(const Time shutterOffset) const
{
// this prim did not have geospatial information applied to it,
// but it is the child of one that did, so we compute the updated
// value based on the recomputed value of the parent
// however, we actually only want to do this if this prim does
// not have a resetXformStack applied
bool resetXformStack = this->_GetResetXformStack(shutterOffset);
if (!resetXformStack)
{
// to compute the affected matrix, we first need to acquire the parent information
GfMatrix4d flattenedParentTransform = this->_GetParentMatrix(shutterOffset);
GfMatrix4d originalParentTransform = this->_GetParentOriginalMatrix(shutterOffset);
// since we are dealing with flattened transformations, we have to recover
// the local transform of the prim data source in question
// we can do this by knowing the prim's flattened transform
// and the original transform of its parent (the _dependsOnDataSource)
// Let FT be the flattened transform, P be the transform of the parent,
// and LT be the child's local transform. The flattened transform would
// then have been computed as FT = (P)(LT), thus to recover LT we divide
// out by P, which results in LT = (FT) / (P) = FT * (P)^-1
// so we need the inverse of the original parent transform
GfMatrix4d inverseParentTransform = originalParentTransform.GetInverse();
GfMatrix4d originalChildTransform = this->_GetMatrix(shutterOffset);
GfMatrix4d childLocalTransform = originalChildTransform * inverseParentTransform;
// once we have the local transform, we can re-apply the new
// flattened parent transform - this is the new geospatially affected transform
// of the child
return flattenedParentTransform * childLocalTransform;
}
// if resetXformStack was true, the original flattened transform of
// of the input data source is valid here and we don't recompute
return this->_GetMatrix(shutterOffset);
}
PXR_NAMESPACE_CLOSE_SCOPE | 9,285 | C++ | 35.996016 | 128 | 0.74238 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/localPositionSchema.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/imaging/hd/retainedDataSource.h>
#include "localPositionSchema.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PUBLIC_TOKENS(HdOmniGeospatialWGS84LocalPositionSchemaTokens,
HDOMNIGEOSPATIALWGS84LOCALPOSITION_SCHEMA_TOKENS);
HdVec3dDataSourceHandle HdOmniGeospatialWGS84LocalPositionSchema::GetPosition()
{
return _GetTypedDataSource<HdVec3dDataSource>(
HdOmniGeospatialWGS84LocalPositionSchemaTokens->position);
}
HdOmniGeospatialWGS84LocalPositionSchema HdOmniGeospatialWGS84LocalPositionSchema::GetFromParent(
const HdContainerDataSourceHandle& fromParentContainer)
{
if (fromParentContainer == nullptr)
{
return HdOmniGeospatialWGS84LocalPositionSchema(nullptr);
}
return HdOmniGeospatialWGS84LocalPositionSchema(
HdContainerDataSource::Cast(fromParentContainer->Get(
HdOmniGeospatialWGS84LocalPositionSchemaTokens->localPositionApi))
);
}
const HdDataSourceLocator& HdOmniGeospatialWGS84LocalPositionSchema::GetDefaultLocator()
{
static const HdDataSourceLocator locator(
HdOmniGeospatialWGS84LocalPositionSchemaTokens->localPositionApi
);
return locator;
}
HdContainerDataSourceHandle HdOmniGeospatialWGS84LocalPositionSchema::BuildRetained(
const HdVec3dDataSourceHandle& position)
{
TfToken names[1];
HdDataSourceBaseHandle values[1];
size_t count = 0;
if (position != nullptr)
{
names[count] = HdOmniGeospatialWGS84LocalPositionSchemaTokens->position;
values[count] = position;
count++;
}
return HdRetainedContainerDataSource::New(count, names, values);
}
PXR_NAMESPACE_CLOSE_SCOPE | 2,240 | C++ | 31.955882 | 97 | 0.775 |
NVIDIA-Omniverse/usd-plugin-samples/src/hydra-plugins/omniGeoSceneIndex/geospatialSceneIndex.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/base/work/utils.h>
#include <pxr/imaging/hd/xformSchema.h>
#include <pxr/imaging/hd/retainedDataSource.h>
#include <pxr/imaging/hd/overlayContainerDataSource.h>
#include <pxr/imaging/hd/dependenciesSchema.h>
#include "geospatialSceneIndex.h"
#include "referencePositionSchema.h"
#include "localPositionSchema.h"
#include "geospatialDataSource.h"
PXR_NAMESPACE_OPEN_SCOPE
TF_DEFINE_PRIVATE_TOKENS(
_tokens,
(positionToXform)
);
OmniGeospatialSceneIndexRefPtr OmniGeospatialSceneIndex::New(
const HdSceneIndexBaseRefPtr& inputSceneIndex,
const HdContainerDataSourceHandle& inputArgs)
{
return TfCreateRefPtr(new OmniGeospatialSceneIndex(inputSceneIndex, inputArgs));
}
OmniGeospatialSceneIndex::OmniGeospatialSceneIndex(const HdSceneIndexBaseRefPtr& inputSceneIndex,
const HdContainerDataSourceHandle& inputArgs) :
HdSingleInputFilteringSceneIndexBase(inputSceneIndex)
{
}
OmniGeospatialSceneIndex::~OmniGeospatialSceneIndex() = default;
HdSceneIndexPrim OmniGeospatialSceneIndex::GetPrim(const SdfPath &primPath) const
{
// lookup the prim to see if we have wrapped it yet
auto iterBoolPair = this->_IsPrimWrapped(primPath);
if (iterBoolPair.second)
{
// we have it wrapped already, so return the wrapped prim
return iterBoolPair.first->second;
}
// we haven't wrapped it yet, but we only need to wrap it
// if it is Xformable - geospatial transforms have the potential
// to affect anything that has a transform, so even if it is
// never affected (e.g. resetXform is true or it is not the child
// of a geospatially applied prim) we wrap it here for simplicity
// sake at the cost of an extra HdSceneIndexPrim (as in some cases
// it will even retain its original data source)
// note that unlike the flattening scene index we wrap lazily
// instead of walking the tree at construction time - this is because
// there is a low chance of geospatial information being attached
// to a prim and in cases where the scene isn't goesptially grounded
// but the scene index is still applied we don't want to walk the
// whole scene
HdSceneIndexPrim sceneIndexPrim = this->_GetInputSceneIndex()->GetPrim(primPath);
HdXformSchema xformSchema = HdXformSchema::GetFromParent(sceneIndexPrim.dataSource);
if (xformSchema.IsDefined() && !xformSchema.GetResetXformStack())
{
return this->_WrapPrim(primPath, sceneIndexPrim);
}
// otherwise we don't need to wrap it and can return it directly
return sceneIndexPrim;
}
SdfPathVector OmniGeospatialSceneIndex::GetChildPrimPaths(const SdfPath& primPath) const
{
// no change in topology occurs as part of this scene index
// so we can ask the input scene to get the child prim paths directly
return this->_GetInputSceneIndex()->GetChildPrimPaths(primPath);
}
SdfPathTable<HdSceneIndexPrim>::_IterBoolPair OmniGeospatialSceneIndex::_IsPrimWrapped(const SdfPath& primPath) const
{
bool result = false;
const auto it = _wrappedPrims.find(primPath);
if (it != _wrappedPrims.end())
{
// because SdfPathTable inserts all parents
// when a path gets inserted, there may be an empty
// entry in our cache if a child path was visited first
// to verify we have to check the prim type and data source
if (it->second.primType != TfToken() || it->second.dataSource != nullptr)
{
// not an auto-insertion of the parent
result = true;
}
}
return std::make_pair(it, result);
}
HdSceneIndexPrim& OmniGeospatialSceneIndex::_WrapPrim(const SdfPath& primPath, const HdSceneIndexPrim& hdPrim) const
{
// PRECONDITION: The table must not yet contain a wrapped prim, check via _IsPrimWrapped first!
// wrapping a scene index prim involves creating our geospatial data source to wrap the original
// scene index prim's data source - this will allow us to intercept the xform token to return
// a compute geospatial transform and still provide access to the original xform via the wrapped data source
HdContainerDataSourceHandle wrappedDataSource = HdOmniGeospatialDataSource::New(*this, primPath, hdPrim.dataSource);
const auto it = _wrappedPrims.find(primPath);
if (it != _wrappedPrims.end())
{
// in this case, the entry is there, but it was auto-created
// by SdfPathTable, meaning it should have empty entries
TF_VERIFY(it->second.primType == TfToken());
TF_VERIFY(it->second.dataSource == nullptr);
it->second.primType = hdPrim.primType;
it->second.dataSource = std::move(wrappedDataSource);
return it->second;
}
else
{
auto iterBoolPair = _wrappedPrims.insert(
{
primPath,
HdSceneIndexPrim {
hdPrim.primType,
std::move(wrappedDataSource)
}
}
);
return iterBoolPair.first->second;
}
}
void OmniGeospatialSceneIndex::_PrimsAdded(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::AddedPrimEntries& entries)
{
HdSceneIndexObserver::DirtiedPrimEntries dirtyEntries;
for(const HdSceneIndexObserver::AddedPrimEntry& entry : entries)
{
HdSceneIndexPrim sceneIndexPrim = this->_GetInputSceneIndex()->GetPrim(entry.primPath);
// cache the prim if necessary
HdXformSchema xformSchema = HdXformSchema::GetFromParent(sceneIndexPrim.dataSource);
if (xformSchema.IsDefined() && !xformSchema.GetResetXformStack())
{
auto iterBoolPair = this->_IsPrimWrapped(entry.primPath);
if (iterBoolPair.second)
{
/// we already wrapped this prim, so we need to update it
HdSceneIndexPrim& wrappedPrim = iterBoolPair.first->second;
wrappedPrim.primType = entry.primType;
if (wrappedPrim.dataSource != nullptr)
{
HdOmniGeospatialDataSource::Cast(wrappedPrim.dataSource)->UpdateWrappedDataSource(sceneIndexPrim.dataSource);
}
// if we updated it, we have to now see if we need
// to dirty any cached values alreday in the hierarchy
static HdDataSourceLocatorSet locators = {
HdXformSchema::GetDefaultLocator()
};
this->_DirtyHierarchy(entry.primPath, locators, &dirtyEntries);
}
else
{
// we don't yet have this prim wrapped - do so now
this->_WrapPrim(entry.primPath, sceneIndexPrim);
}
}
}
// forward on the notification
this->_SendPrimsAdded(entries);
// also, if we had to dirty entries because of an insertion in the middle
// of the stage hierarchy, send those along too
if (!dirtyEntries.empty())
{
this->_SendPrimsDirtied(dirtyEntries);
}
}
void OmniGeospatialSceneIndex::_PrimsRemoved(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::RemovedPrimEntries& entries)
{
for (const HdSceneIndexObserver::RemovedPrimEntry& entry : entries)
{
if (entry.primPath.IsAbsoluteRootPath())
{
// removing the whole scene
_wrappedPrims.ClearInParallel();
TfReset(_wrappedPrims);
}
else
{
auto startEndRangeIterator = _wrappedPrims.FindSubtreeRange(entry.primPath);
for (auto it = startEndRangeIterator.first; it != startEndRangeIterator.second; it++)
{
WorkSwapDestroyAsync(it->second.dataSource);
}
if(startEndRangeIterator.first != startEndRangeIterator.second)
{
_wrappedPrims.erase(startEndRangeIterator.first);
}
}
}
_SendPrimsRemoved(entries);
}
void OmniGeospatialSceneIndex::_PrimsDirtied(const HdSceneIndexBase& sender,
const HdSceneIndexObserver::DirtiedPrimEntries& entries)
{
HdSceneIndexObserver::DirtiedPrimEntries dirtyEntries;
for (const HdSceneIndexObserver::DirtiedPrimEntry& entry : entries)
{
HdDataSourceLocatorSet locators;
if (entry.dirtyLocators.Intersects(HdXformSchema::GetDefaultLocator()))
{
locators.insert(HdXformSchema::GetDefaultLocator());
}
if (!locators.IsEmpty())
{
this->_DirtyHierarchy(entry.primPath, locators, &dirtyEntries);
}
}
_SendPrimsDirtied(entries);
if (!dirtyEntries.empty())
{
_SendPrimsDirtied(dirtyEntries);
}
}
void OmniGeospatialSceneIndex::_DirtyHierarchy(const SdfPath& primPath, const HdDataSourceLocatorSet& locators,
HdSceneIndexObserver::DirtiedPrimEntries* dirtyEntries)
{
// find subtree range retrieves a start end pair of children
// in the subtree of the given prim path
auto startEndRangeIterator = _wrappedPrims.FindSubtreeRange(primPath);
for (auto it = startEndRangeIterator.first; it != startEndRangeIterator.second;)
{
// if we have a valid wrapper for the prim, we need to check
// whether it needs to be dirtied - this involves checking the
// data sources to see if they have cached data and if so
// this indicates it needs to be updated
if (it->second.dataSource != nullptr)
{
HdOmniGeospatialDataSourceHandle geospatialDataSource =
HdOmniGeospatialDataSource::Cast(it->second.dataSource);
if (geospatialDataSource != nullptr && geospatialDataSource->IsPrimDirtied(locators))
{
if (it->first != primPath)
{
dirtyEntries->emplace_back(it->first, locators);
}
it++;
}
else
{
it++;
}
}
else
{
it++;
}
}
}
PXR_NAMESPACE_CLOSE_SCOPE | 10,650 | C++ | 36.37193 | 129 | 0.665446 |
NVIDIA-Omniverse/usd-plugin-samples/src/usd-plugins/fileFormat/edfFileFormat/edfFileFormat.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "edfFileFormat.h"
#include "edfData.h"
PXR_NAMESPACE_OPEN_SCOPE
EdfFileFormat::EdfFileFormat() : SdfFileFormat(
EdfFileFormatTokens->Id,
EdfFileFormatTokens->Version,
EdfFileFormatTokens->Target,
EdfFileFormatTokens->Extension)
{
}
EdfFileFormat::~EdfFileFormat()
{
}
bool EdfFileFormat::CanRead(const std::string& filePath) const
{
return true;
}
bool EdfFileFormat::Read(SdfLayer* layer, const std::string& resolvedPath, bool metadataOnly) const
{
// these macros emit methods defined in the Pixar namespace
// but not properly scoped, so we have to use the namespace
// locally here - note this isn't strictly true since we had to open
// the namespace scope anyway because the macros won't allow non-Pixar namespaces
// to be used because of some auto-generated content
PXR_NAMESPACE_USING_DIRECTIVE
if (!TF_VERIFY(layer))
{
return false;
}
// construct the SdfAbstractData object from the file format args
// and set that as the layer data - note this is a different object
// from that constructed in the InitData method - this may or may
// not be an issue, something to be investigated in more detail when
// working through the backend - either way we associate it with the layer
// so we always have a mapping from the dynamic layer and the specific
// set of parameters that created it
const FileFormatArguments& args = layer->GetFileFormatArguments();
SdfAbstractDataRefPtr layerData = this->InitData(args);
// inform the data provider that it's time to read the content
// this is a good time for it to cache data that it needs to generate
// the prim / property specs when asked for them via the data apis
EdfData& edfData = dynamic_cast<EdfData&>(*layerData);
bool readSuccess = edfData.Read();
if (readSuccess)
{
this->_SetLayerData(layer, layerData);
// for now, this is dynamic content read one way from a source external system
// therefore we mark that the layer is read-only
// later we will remove this restriction and explore what it means to edit
// data that is sourced from external data formats
layer->SetPermissionToSave(false);
layer->SetPermissionToEdit(false);
}
return readSuccess;
}
bool EdfFileFormat::WriteToString(const SdfLayer& layer, std::string* str, const std::string& comment) const
{
// this POC doesn't support writing
return false;
}
bool EdfFileFormat::WriteToStream(const SdfSpecHandle& spec, std::ostream& out, size_t indent) const
{
// this POC doesn't support writing
return false;
}
SdfAbstractDataRefPtr EdfFileFormat::InitData(const FileFormatArguments& args) const
{
// create the data parameters object to capture what data was used to create the layer
EdfDataParameters parameters = EdfDataParameters::FromFileFormatArgs(args);
return EdfData::CreateFromParameters(parameters);
}
bool EdfFileFormat::_ShouldSkipAnonymousReload() const
{
return false;
}
bool EdfFileFormat::_ShouldReadAnonymousLayers() const
{
return true;
}
void EdfFileFormat::ComposeFieldsForFileFormatArguments(const std::string& assetPath, const PcpDynamicFileFormatContext& context, FileFormatArguments* args, VtValue* contextDependencyData) const
{
VtValue val;
if (context.ComposeValue(EdfFileFormatTokens->Params, &val) && val.IsHolding<VtDictionary>())
{
// the composition engine has composed the metadata values of the prim appropriately
// for the currently composed stage, we read these metadata values that were composed
// and make them part of the file format arguments to load the dependent layer
VtDictionary dict = val.UncheckedGet<VtDictionary>();
const VtValue* dictVal = TfMapLookupPtr(dict, EdfDataParametersTokens->dataProviderId);
if (dictVal != nullptr)
{
(*args)[EdfDataParametersTokens->dataProviderId] = dictVal->UncheckedGet<std::string>();
}
// unfortunately, FileFormatArguments is a typedef for a map<string, string>
// which means we have to unpack the provider arguments dictionary
// to keep the unpacking simple, we assume for now that the providerArgs
// is itself a dictionary containing only string paris and values
// we can remove this restriction later for simple types (using TfStringify)
// but would need some work (recursively) for embedded lists and dictionary values
dictVal = TfMapLookupPtr(dict, EdfDataParametersTokens->providerArgs);
if (dictVal != nullptr)
{
std::string prefix = EdfDataParametersTokens->providerArgs.GetString();
VtDictionary providerArgs = dictVal->UncheckedGet<VtDictionary>();
for (VtDictionary::iterator it = providerArgs.begin(); it != providerArgs.end(); it++)
{
(*args)[prefix + ":" + it->first] = it->second.UncheckedGet<std::string>();
}
}
}
}
bool EdfFileFormat::CanFieldChangeAffectFileFormatArguments(const TfToken& field, const VtValue& oldValue, const VtValue& newValue, const VtValue& contextDependencyData) const
{
const VtDictionary& oldDictionaryValue = oldValue.IsHolding<VtDictionary>() ?
oldValue.UncheckedGet<VtDictionary>() : VtGetEmptyDictionary();
const VtDictionary& newDictionaryValue = newValue.IsHolding<VtDictionary>() ?
newValue.UncheckedGet<VtDictionary>() : VtGetEmptyDictionary();
// nothing to do if both metadata values are empty
if (oldDictionaryValue.empty() && newDictionaryValue.empty())
{
return false;
}
// our layer is new if:
// 1. there is a new provider
// 2. there is a change to the value of the provider specific data
const VtValue* oldProviderId =
TfMapLookupPtr(oldDictionaryValue, EdfDataParametersTokens->dataProviderId);
const VtValue* newProviderId =
TfMapLookupPtr(newDictionaryValue, EdfDataParametersTokens->dataProviderId);
if (oldProviderId != nullptr && newProviderId != nullptr)
{
if (oldProviderId->UncheckedGet<std::string>() != newProviderId->UncheckedGet<std::string>())
{
// different providers!
return true;
}
else
{
// same provider, but the specific provider metadata may have changed
const VtValue* oldProviderDictionaryValue =
TfMapLookupPtr(oldDictionaryValue, EdfDataParametersTokens->providerArgs);
const VtValue* newProviderDictionaryValue =
TfMapLookupPtr(newDictionaryValue, EdfDataParametersTokens->providerArgs);
const VtDictionary& oldProviderDictionary = oldProviderDictionaryValue->IsHolding<VtDictionary>() ?
oldProviderDictionaryValue->UncheckedGet<VtDictionary>() : VtGetEmptyDictionary();
const VtDictionary& newProviderDictionary = newProviderDictionaryValue->IsHolding<VtDictionary>() ?
newProviderDictionaryValue->UncheckedGet<VtDictionary>() : VtGetEmptyDictionary();
return oldProviderDictionary != newProviderDictionary;
}
}
else
{
// one of them (or both) are nullptrs
if (oldProviderId == nullptr && newProviderId == nullptr)
{
// no change to provider, don't need to check parameters
return false;
}
// otherwise one changed
return true;
}
}
// these macros emit methods defined in the Pixar namespace
// but not properly scoped, so we have to use the namespace
// locally here
TF_DEFINE_PUBLIC_TOKENS(
EdfFileFormatTokens,
((Id, "edfFileFormat"))
((Version, "1.0"))
((Target, "usd"))
((Extension, "edf"))
((Params, "EdfDataParameters"))
);
TF_REGISTRY_FUNCTION(TfType)
{
SDF_DEFINE_FILE_FORMAT(EdfFileFormat, SdfFileFormat);
}
PXR_NAMESPACE_CLOSE_SCOPE | 7,937 | C++ | 35.75 | 194 | 0.754567 |
NVIDIA-Omniverse/usd-plugin-samples/src/usd-plugins/dynamicPayload/omniMetProvider/api.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_OMNIMETPROVIDER_API_H_
#define OMNI_OMNIMETPROVIDER_API_H_
#include "pxr/base/arch/export.h"
#if defined(PXR_STATIC)
# define OMNIMETPROVIDER_API
# define OMNIMETPROVIDER_API_TEMPLATE_CLASS(...)
# define OMNIMETPROVIDER_API_TEMPLATE_STRUCT(...)
# define OMNIMETPROVIDER_LOCAL
#else
# if defined(OMNIMETPROVIDER_EXPORTS)
# define OMNIMETPROVIDER_API ARCH_EXPORT
# define OMNIMETPROVIDER_API_TEMPLATE_CLASS(...) ARCH_EXPORT_TEMPLATE(class, __VA_ARGS__)
# define OMNIMETPROVIDER_API_TEMPLATE_STRUCT(...) ARCH_EXPORT_TEMPLATE(struct, __VA_ARGS__)
# else
# define OMNIMETPROVIDER_API ARCH_IMPORT
# define OMNIMETPROVIDER_API_TEMPLATE_CLASS(...) ARCH_IMPORT_TEMPLATE(class, __VA_ARGS__)
# define OMNIMETPROVIDER_API_TEMPLATE_STRUCT(...) ARCH_IMPORT_TEMPLATE(struct, __VA_ARGS__)
# endif
# define OMNIMETPROVIDER_LOCAL ARCH_HIDDEN
#endif
#endif | 1,498 | C | 38.447367 | 97 | 0.732977 |
NVIDIA-Omniverse/usd-plugin-samples/src/usd-plugins/dynamicPayload/omniMetProvider/omniMetProvider.cpp | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <pxr/base/tf/token.h>
#include <pxr/base/vt/value.h>
#include <pxr/base/js/json.h>
#include <pxr/usd/sdf/path.h>
#include <pxr/usd/sdf/schema.h>
#include <pxr/usd/sdf/payload.h>
#include <pxr/usd/sdf/primSpec.h>
#include <pxr/usd/sdf/attributeSpec.h>
#include <pxr/usd/usd/tokens.h>
#include <edfDataProviderFactory.h>
#include "omniMetProvider.h"
#include <iostream>
#include <curl/curl.h>
PXR_NAMESPACE_OPEN_SCOPE
EDF_DEFINE_DATAPROVIDER(OmniMetProvider);
TF_DEFINE_PUBLIC_TOKENS(
OmniMetProviderProviderArgKeys,
(dataLodLevel)
(deferredRead)
(lod1Count)
);
TF_DEFINE_PRIVATE_TOKENS(
EdfFieldKeys,
(EdfDataParameters)
);
TF_DEFINE_PRIVATE_TOKENS(
OmniMetProviderTypeNames,
(AmaDepartment)
(AmaObject)
);
TF_DEFINE_PRIVATE_TOKENS(
OmniMetProviderFieldKeys,
(departmentId)
(displayName)
(objectID)
(isHighlight)
(accessionNumber)
(accessionYear)
(isPublicDomain)
(primaryImage)
(primaryImageSmall)
(additionalImages)
(constituents)
(department)
(objectName)
(title)
(culture)
(period)
(dynasty)
(reign)
(portfolio)
(artistRole)
(artistPrefix)
(artistDisplayName)
(artistDisplayBio)
(artistSuffix)
(artistAlphaSort)
(artistNationality)
(artistGender)
(artistWikidata_URL)
(artistULAN_URL)
(objectDate)
(objectBeginDate)
(objectEndDate)
(medium)
(dimensions)
(measurements)
(creditLine)
(geographyType)
(city)
(state)
(county)
(country)
(region)
(subregion)
(locale)
(locus)
(excavation)
(river)
(classification)
(rightsAndReproduction)
(linkResource)
(metadataDate)
(repository)
(objectURL)
(objectWikidataURL)
(isTimelineWork)
(galleryNumber)
);
enum struct DataLodLevel
{
Level0 = 0,
Level1 = 1,
Level2 = 2
};
// urls used to retrieve the data
static const std::string DEPARTMENT_URL = "https://collectionapi.metmuseum.org/public/collection/v1/departments";
static const std::string OBJECTS_IN_DEPARTMENT_URL = "https://collectionapi.metmuseum.org/public/collection/v1/objects?departmentIds=";
static const std::string OBJECT_URL = "https://collectionapi.metmuseum.org/public/collection/v1/objects/";
static const SdfPath DATA_ROOT_PATH("/Data");
OmniMetProvider::OmniMetProvider(const EdfDataParameters& parameters) : IEdfDataProvider(parameters)
{
curl_global_init(CURL_GLOBAL_DEFAULT);
}
OmniMetProvider::~OmniMetProvider()
{
curl_global_cleanup();
}
bool OmniMetProvider::Read(std::shared_ptr<IEdfSourceData> sourceData)
{
// this gives the provider a chance to load all data it needs to on first layer read
// if we are parameterized for a deferred read, we do nothing and read on demand
// at first ask, if it's not a deferred read, we load all appropriate content from the
// back-end here
if(!this->IsDeferredRead())
{
// it's not a deferred read, so determine how much data we want to really load
int lodLevel = this->GetDataLodLevel();
if (lodLevel == static_cast<int>(DataLodLevel::Level0))
{
// load the departments
this->_LoadData(false, 0, sourceData);
}
else if (lodLevel == static_cast<int>(DataLodLevel::Level1))
{
// load the departments and their children
// but cap the number of children at the specified level
this->_LoadData(true, this->GetLod1Count(), sourceData);
}
else
{
// max lod level, load everything
this->_LoadData(true, 0, sourceData);
}
}
return true;
}
void OmniMetProvider::_LoadData(bool includeObjects, size_t objectCount, std::shared_ptr<IEdfSourceData> sourceData)
{
// load the department data
std::string departmentData = this->_LoadDepartments();
std::vector<std::pair<std::string, int>> departments = this->_ParseDepartments(departmentData, sourceData);
// do we want to load objects as well?
if (includeObjects)
{
for (auto it = departments.begin(); it != departments.end(); it++)
{
std::vector<std::string> objectData = this->_LoadObjects(TfStringify(it->second), objectCount);
for (auto itt = objectData.begin(); itt != objectData.end(); itt++)
{
this->_ParseObject(*itt, it->first, sourceData);
}
}
}
}
std::string OmniMetProvider::_LoadDepartments()
{
std::string departments;
CURL* departmentCurl = curl_easy_init();
if (departmentCurl != nullptr)
{
CURLcode resultCode;
curl_easy_setopt(departmentCurl, CURLOPT_URL, DEPARTMENT_URL.c_str());
curl_easy_setopt(departmentCurl, CURLOPT_HTTPGET, 1L);
curl_easy_setopt(departmentCurl, CURLOPT_WRITEFUNCTION, OmniMetProvider::_CurlWriteCallback);
// allocate a string that we can append the result onto
std::string* result = new std::string();
curl_easy_setopt(departmentCurl, CURLOPT_WRITEDATA, reinterpret_cast<void*>(result));
resultCode = curl_easy_perform(departmentCurl);
if (resultCode == CURLE_OK)
{
departments = *result;
}
else
{
TF_CODING_ERROR("Unable to load departments from '%s'!", DEPARTMENT_URL.c_str());
}
// done with the callback data
delete result;
// done with the request handle
curl_easy_cleanup(departmentCurl);
}
return departments;
}
std::vector<int> OmniMetProvider::_ParseObjectIds(const std::string& response) const
{
std::vector<int> objectIds;
PXR_NS::JsValue jsValue = PXR_NS::JsParseString(response, nullptr);
if (!jsValue.IsNull())
{
PXR_NS::JsObject rootObject = jsValue.GetJsObject();
PXR_NS::JsObject::iterator it = rootObject.find("objectIDs");
if (it != rootObject.end())
{
PXR_NS::JsArray jsonObjectIdArray = it->second.GetJsArray();
for (auto objectIdIt = jsonObjectIdArray.begin(); objectIdIt != jsonObjectIdArray.end(); objectIdIt++)
{
objectIds.push_back((*objectIdIt).GetInt());
}
}
else
{
TF_CODING_ERROR("Unable to find 'objectIDs' array in returned data '%s'!", response.c_str());
}
}
else
{
TF_CODING_ERROR("Data returned '%s' was not JSON or was empty!", response.c_str());
}
return objectIds;
}
std::vector<std::string> OmniMetProvider::_LoadObjects(const std::string& departmentId, size_t objectCount)
{
// NOTE: this should be updated to make these requests in parallel in the case
// where we aren't doing deferred reads
// ideally we wouldn't want to initialize a new curl handle here, but since this
// call can be made in the parallel prim indexing, we can't share the easy handle
// across threads, so we take the overhead hit here
std::vector<std::string> objects;
CURL* objectCurl = curl_easy_init();
std::string url = OBJECTS_IN_DEPARTMENT_URL + departmentId;
std::string* result = new std::string();
CURLcode resultCode;
*result = "";
curl_easy_setopt(objectCurl, CURLOPT_URL, url.c_str());
curl_easy_setopt(objectCurl, CURLOPT_HTTPGET, 1L);
curl_easy_setopt(objectCurl, CURLOPT_WRITEFUNCTION, OmniMetProvider::_CurlWriteCallback);
curl_easy_setopt(objectCurl, CURLOPT_WRITEDATA, reinterpret_cast<void*>(result));
resultCode = curl_easy_perform(objectCurl);
if (resultCode == CURLE_OK)
{
// process result
std::vector<int> objectIds = this->_ParseObjectIds(*result);
// objectCount = 0 means load all objects
// objectCount > 0 means load max that many objects
size_t counter = 0;
for (auto objectIdIterator = objectIds.begin(); objectIdIterator != objectIds.end() && (objectCount == 0 || counter < objectCount); objectIdIterator++)
{
// reset the URL and result buffer
// NOTE: this should be updated to make these requests in parallel
url = OBJECT_URL + TfStringify(*objectIdIterator);
*result = "";
curl_easy_setopt(objectCurl, CURLOPT_URL, url.c_str());
resultCode = curl_easy_perform(objectCurl);
if (resultCode == CURLE_OK)
{
objects.push_back(*result);
}
counter++;
}
}
// done with the callback data
delete result;
// done with the request handle
curl_easy_cleanup(objectCurl);
return objects;
}
std::vector<std::pair<std::string, int>> OmniMetProvider::_ParseDepartments(const std::string& departmentJson,
std::shared_ptr<IEdfSourceData> sourceData)
{
std::vector<std::pair<std::string, int>> parsedDepartments;
JsValue jsValue = JsParseString(departmentJson, nullptr);
if (!jsValue.IsNull())
{
JsObject rootObject = jsValue.GetJsObject();
JsObject::iterator it = rootObject.find("departments");
if (it != rootObject.end())
{
JsArray departments = it->second.GetJsArray();
std::string parent = DATA_ROOT_PATH.GetAsString();
for (auto departmentIt = departments.begin(); departmentIt != departments.end(); departmentIt++)
{
// for each department, create a prim to represent it
JsObject department = (*departmentIt).GetJsObject();
int departmentId = department[OmniMetProviderFieldKeys->departmentId.GetString()].GetInt();
std::string displayName = department[OmniMetProviderFieldKeys->displayName.GetString()].GetString();
// create the prim
std::string primName = TfMakeValidIdentifier(displayName);
sourceData->CreatePrim(DATA_ROOT_PATH, primName, SdfSpecifier::SdfSpecifierDef,
OmniMetProviderTypeNames->AmaDepartment);
// create the attributes for the prim
SdfPath parentPrim = SdfPath(parent + "/" + primName);
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->departmentId.GetString(),
SdfValueTypeNames->Int, SdfVariability::SdfVariabilityUniform, VtValue(departmentId));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->displayName.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform, VtValue(displayName));
parsedDepartments.push_back(std::make_pair(parentPrim.GetAsString(), departmentId));
}
}
else
{
TF_CODING_ERROR("Unable to find 'departments' array in returned data '%s'!", departmentJson.c_str());
}
}
else
{
TF_CODING_ERROR("Data returned '%s' was not JSON or was empty!", departmentJson.c_str());
}
return parsedDepartments;
}
void OmniMetProvider::_ParseObject(const std::string& objectData, const std::string& parentPath,
std::shared_ptr<IEdfSourceData> sourceData)
{
// from the parent path given and the data contained in the JSON
// object retrieved from the server, we can create the full prim
JsValue jsValue = JsParseString(objectData, nullptr);
if (!jsValue.IsNull())
{
JsObject rootObject = jsValue.GetJsObject();
// the root object contains all of our properties that we now need
// to create a prim spec for the object and a set of property
// specs for it
// NOTE: this code uses the "default value" of a property spec
// to represent the authored value coming from the external system
// We don't need to do sub-composition over the data coming
// from the external system, so we ever only have a value or not
// so if HasDefaultValue is true on the property spec, it means
// there was an authored value that came from the remote system
// One optimization we could do in the layer above (EdfData) is
// to add schema acquisition and checking in the loop. This would allow us
// to create the property spec or not depending on if the value that came in
// is different from the true fallback declared in the schema
// (but we'd have to change the ask for the property to check whether
// the schema has the property rather than if the property spec exists)
std::string objectName = rootObject[OmniMetProviderFieldKeys->objectName.GetString()].GetString();
std::string primName = TfMakeValidIdentifier(objectName) +
TfStringify(rootObject[OmniMetProviderFieldKeys->objectID.GetString()].GetInt());
// create the prim
SdfPath newPrimParentPath(parentPath);
sourceData->CreatePrim(newPrimParentPath, primName, SdfSpecifier::SdfSpecifierDef,
OmniMetProviderTypeNames->AmaObject);
// set the fact that this prim has an API schema attached to it
// usdGenSchema doesn't generate a public token for the actual
// API schema class name, so we hard code that here
SdfPath parentPrim = SdfPath(parentPath + "/" + primName);
TfTokenVector apiSchemas;
apiSchemas.push_back(TfToken("OmniMetArtistAPI"));
VtValue apiSchemasValue(apiSchemas);
sourceData->SetField(parentPrim, UsdTokens->apiSchemas, apiSchemasValue);
// create the attributes for the prim
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->objectID.GetString(),
SdfValueTypeNames->Int, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->objectID.GetString()].GetInt()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->isHighlight.GetString(),
SdfValueTypeNames->Bool, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->isHighlight.GetString()].GetBool()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->accessionNumber.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->accessionNumber.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->accessionYear.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->accessionYear.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->isPublicDomain.GetString(),
SdfValueTypeNames->Bool, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->isPublicDomain.GetString()].GetBool()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->primaryImage.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->primaryImage.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->primaryImageSmall.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->primaryImageSmall.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->department.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->department.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->title.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->title.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->culture.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->culture.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->period.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->period.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->dynasty.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->dynasty.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->reign.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->reign.GetString()].GetString()));
sourceData->CreateAttribute(parentPrim, OmniMetProviderFieldKeys->portfolio.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->portfolio.GetString()].GetString()));
// artist information complying with sample API schema
std::string namespaceFieldPrefix = "omni:met:artist:";
JsObject::const_iterator i = rootObject.find(OmniMetProviderFieldKeys->artistRole.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistRole.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistRole.GetString()].GetString()));
}
i = rootObject.find(OmniMetProviderFieldKeys->artistPrefix.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistPrefix.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistPrefix.GetString()].GetString()));
}
i = rootObject.find(OmniMetProviderFieldKeys->artistDisplayName.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistDisplayName.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistDisplayName.GetString()].GetString()));
}
i = rootObject.find(OmniMetProviderFieldKeys->artistDisplayBio.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistDisplayBio.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistDisplayBio.GetString()].GetString()));
}
i = rootObject.find(OmniMetProviderFieldKeys->artistSuffix.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistSuffix.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistSuffix.GetString()].GetString()));
}
i = rootObject.find(OmniMetProviderFieldKeys->artistAlphaSort.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistAlphaSort.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistAlphaSort.GetString()].GetString()));
}
i = rootObject.find(OmniMetProviderFieldKeys->artistNationality.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistNationality.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistNationality.GetString()].GetString()));
}
i = rootObject.find(OmniMetProviderFieldKeys->artistGender.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistGender.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistGender.GetString()].GetString()));
}
i = rootObject.find(OmniMetProviderFieldKeys->artistWikidata_URL.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistWikidata_URL.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistWikidata_URL.GetString()].GetString()));
}
i = rootObject.find(OmniMetProviderFieldKeys->artistULAN_URL.GetString());
if (i != rootObject.end())
{
sourceData->CreateAttribute(parentPrim, namespaceFieldPrefix + OmniMetProviderFieldKeys->artistULAN_URL.GetString(),
SdfValueTypeNames->String, SdfVariability::SdfVariabilityUniform,
VtValue(rootObject[OmniMetProviderFieldKeys->artistULAN_URL.GetString()].GetString()));
}
// note that there are quite a few additional properties that could be pulled, the above
// represents only a sample of the data that is there - if you'd like to try the rest as an
// exercise, you can enhance the schema attributes and read the remaining ones here
}
else
{
TF_CODING_ERROR("Data returned '%s' was not JSON or was empty!", objectData.c_str());
}
}
bool OmniMetProvider::ReadChildren(const std::string& parentPath, std::shared_ptr<IEdfSourceData> sourceData)
{
// if the parent path is the root, we need to load the departments
// but only if we are in a deferred read scenario
if (this->IsDeferredRead())
{
SdfPath parentPrimPath = SdfPath(parentPath);
int lodLevel = this->GetDataLodLevel();
if (parentPrimPath == DATA_ROOT_PATH)
{
// load the department data
std::cout << "Loading department data..." << std::endl;
std::string departmentData = this->_LoadDepartments();
std::vector<std::pair<std::string, int>> departments = this->_ParseDepartments(departmentData,
sourceData);
}
else
{
VtValue typeNameValue;
if(sourceData->HasField(SdfPath(parentPath), SdfFieldKeys->TypeName, &typeNameValue))
{
if (typeNameValue.UncheckedGet<TfToken>() == OmniMetProviderTypeNames->AmaDepartment &&
this->GetDataLodLevel() != static_cast<int>(DataLodLevel::Level0))
{
// it's a department, we need to load the objects
// associated with the department
std::string departmentIdPath = parentPath + "." + OmniMetProviderFieldKeys->departmentId.GetString();
VtValue departmentId;
if (sourceData->HasAttribute(SdfPath(departmentIdPath), &departmentId))
{
size_t objectCount = 0;
if (lodLevel == static_cast<int>(DataLodLevel::Level1))
{
objectCount = this->GetLod1Count();
}
// load the object data
std::cout << "Loading object data for " + parentPath + "..." << std::endl;
std::vector<std::string> objectData = this->_LoadObjects(TfStringify(departmentId.UncheckedGet<int>()), objectCount);
for (auto it = objectData.begin(); it != objectData.end(); it++)
{
this->_ParseObject(*it, parentPath, sourceData);
}
}
}
}
}
return true;
}
return false;
}
bool OmniMetProvider::IsDataCached() const
{
return !this->IsDeferredRead();
}
int OmniMetProvider::GetDataLodLevel() const
{
int dataLodLevel = 0;
EdfDataParameters parameters = this->GetParameters();
std::unordered_map<std::string, std::string>::const_iterator it = parameters.providerArgs.find(OmniMetProviderProviderArgKeys->dataLodLevel);
if (it != parameters.providerArgs.end())
{
dataLodLevel = TfUnstringify<int>(it->second);
if (dataLodLevel < 0)
{
dataLodLevel = 0;
}
}
return dataLodLevel;
}
size_t OmniMetProvider::GetLod1Count() const
{
// although the incoming string from the parameter set
// might be interpretable as a negative integer
// it doesn't really make practical sense, so if
// it is interpreted as negative, we clamp to 0
// and return an unsigned version to the caller
size_t lod1Count = 0;
EdfDataParameters parameters = this->GetParameters();
std::unordered_map<std::string, std::string>::const_iterator it = parameters.providerArgs.find(OmniMetProviderProviderArgKeys->lod1Count);
if (it != parameters.providerArgs.end())
{
lod1Count = TfUnstringify<int>(it->second);
if (lod1Count < 0)
{
lod1Count = 0;
}
}
return static_cast<size_t>(lod1Count);
}
bool OmniMetProvider::IsDeferredRead() const
{
bool deferredRead = false;
EdfDataParameters parameters = this->GetParameters();
std::unordered_map<std::string, std::string>::const_iterator it = parameters.providerArgs.find(OmniMetProviderProviderArgKeys->deferredRead);
if (it != parameters.providerArgs.end())
{
deferredRead = TfUnstringify<bool>(it->second);
}
return deferredRead;
}
size_t OmniMetProvider::_CurlWriteCallback(void* data, size_t size, size_t nmemb, void* userp)
{
std::string* result = reinterpret_cast<std::string*>(userp);
result->append(reinterpret_cast<const char* const>(data), nmemb);
return nmemb;
}
PXR_NAMESPACE_CLOSE_SCOPE
| 27,507 | C++ | 41.780715 | 159 | 0.662704 |
NVIDIA-Omniverse/usd-plugin-samples/src/usd-plugins/dynamicPayload/omniMetProvider/omniMetProvider.h | // Copyright 2023 NVIDIA CORPORATION
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef OMNI_OMNIMETPROVIDER_OMNIMETPROVIDER_H_
#define OMNI_OMNIMETPROVIDER_OMNIMETPROVIDER_H_
#include <string>
#include <vector>
#include <utility>
#include <pxr/pxr.h>
#include <pxr/base/tf/token.h>
#include <pxr/usd/sdf/layer.h>
#include <pxr/usd/sdf/schema.h>
#include <iEdfDataProvider.h>
PXR_NAMESPACE_OPEN_SCOPE
TF_DECLARE_PUBLIC_TOKENS(
OmniMetProviderProviderArgKeys,
(dataLodLevel)
(deferredRead)
(lod1Count)
);
/// \class OmniMetProvider
///
/// Defines a specific EDF back-end data provider for reading information
/// from the Metropolitan Museum of Art REST APIs and converting that
/// into prim and attribute data that can be processed by USD.
///
class OmniMetProvider : public IEdfDataProvider
{
public:
OmniMetProvider(const EdfDataParameters& parameters);
virtual ~OmniMetProvider();
virtual bool Read(std::shared_ptr<IEdfSourceData> sourceData) override;
virtual bool ReadChildren(const std::string& parentPath, std::shared_ptr<IEdfSourceData> sourceData) override;
virtual bool IsDataCached() const override;
private:
int GetDataLodLevel() const;
size_t GetLod1Count() const;
bool IsDeferredRead() const;
void _LoadData(bool includeObjects, size_t objectCount, std::shared_ptr<IEdfSourceData> sourceData);
std::string _LoadDepartments();
std::vector<std::string> _LoadObjects(const std::string& departmentId, size_t objectCount);
std::vector<std::pair<std::string, int>> _ParseDepartments(const std::string& departmentJson,
std::shared_ptr<IEdfSourceData> sourceData);
void _ParseObject(const std::string& objectData, const std::string& parentPath, std::shared_ptr<IEdfSourceData> sourceData);
// NOTE: these methods are not technically const, since they do change internal state
// in the edfData object's layer data. This is ok, because that object is a cache
// https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#es50-dont-cast-away-const
// the mutuable cache state is allowed to change internally and still keep the semantics
// of the object not changing from the outside
void _LoadDepartments(bool includeObjects) const;
void _LoadObjects(const std::string& departmentId, const std::string& parentPath) const;
bool _IsDepartmentDataCached() const;
bool _IsObjectDataCached(const std::string& parentPath) const;
void _ParseDepartments(const std::string& response) const;
std::vector<int> _ParseObjectIds(const std::string& response) const;
void _ParseObject(const std::string& parentPath, const std::string& response) const;
static size_t _CurlWriteCallback(void* data, size_t size, size_t nmemb, void* userp);
};
PXR_NAMESPACE_CLOSE_SCOPE
#endif | 3,321 | C | 37.627907 | 128 | 0.747666 |
NVIDIA-Omniverse/kit-osc/README.md | # OSC Omniverse Kit Extension [omni.osc]
Omniverse Kit extension for sending and receiving OSC (Open Sound Control) messages.
*The OSC control surface app running on the iPad is [TouchOSC](https://hexler.net/touchosc).*
# Getting Started
Open the Community tab under Extensions window (`Window > Extensions`), search for `OSC`, and install and enable the `omni.osc` extension.
## Running the server
After installing and enabling the extension, you should see the following window.
Enter the private IP address of the computer running your Kit application and the desired port, then click `Start`. If you are prompted to configure your Windows Firewall, ensure that the Kit application is allowed to communicate with other devices on the private network.
You can find the private IP address of your computer by running `ipconfig` in the Windows terminal.
If you run the server on `localhost`, that means the server can only receive messages from OSC clients running on the same machine. If you want to receive messages from OSC clients running on other devices on the same network, you must run the server on an IP address that is visible to those devices.
Once the server is running, confirm that it can successfully receive messages by inspecting the verbose console logs. It might be helpful to filter only the logs that originate from `omni.osc`.
## Receiving messages with Python
Below is a python snippet that demonstrates how to handle OSC messages received by the server. It assumes that the OSC server configured above is running. You can paste and run the below snippet directly into the Omniverse Script Editor for testing.
```python
import carb
import carb.events
import omni.osc
def on_event(event: carb.events.IEvent) -> None:
addr, args = omni.osc.osc_message_from_carb_event(event)
carb.log_info(f"Received OSC message: [{addr}, {args}]")
sub = omni.osc.subscribe_to_osc_event_stream(on_event)
```
## Receiving messages with ActionGraph
Search for `OSC` in the Action Graph nodes list and add the `On OSC Message` node to your graph. The node takes a single input,
the OSC address path that this node will handle. This input can be a valid regular expression. Note that this input field does *not* support
OSC pattern matching expressions. The node outputs an OmniGraph bundle with two attributes named `address` and `arguments` which you
can access by using the `Extract Attribute` node.
You can find example USD stages that demonstrate how to configure an ActionGraph using this extension at [exts/omni.osc/data/examples](/exts/omni.osc/data/examples).
## Sending messages from Python
Since `omni.osc` depends on [python-osc](https://pypi.org/project/python-osc/), you can import this module directly in
your own Python code to send OSC messages. Please see the [documentation](https://python-osc.readthedocs.io/en/latest/) for additional
information and support.
```python
import random
import time
from pythonosc import udp_client
client = udp_client.SimpleUDPClient("127.0.0.1", 3334)
client.send_message("/scale", [random.random(), random.random(), random.random()])
```
You can paste and run the above snippet directly into the Omniverse Script Editor for testing.
## Sending messages from ActionGraph
This is not currently implemented.
## Limitations & Known Issues
- OSC Bundles are currently not supported.
- The OmniGraph `On OSC Message` node can only handle OSC messages containing lists of floating-point arguments.
# Help
The below sections should help you diagnose any potential issues you may encounter while working with `omni.osc` extension.
## Unable to receive messages
1. First, enable verbose logs in the console (filter by the `omni.osc` extension). The server will log any messages received.
2. Confirm that the computer running the Kit application and the device sending the OSC messages are on the same network.
3. Confirm that kit.exe is allowed to communicate with the private network through the Windows Defender Firewall. Note that
you may have multiple instances of kit.exe on this list. When in doubt, ensure that all of them have the appropriate permission.
4. Confirm that the Windows Defender Firewall allows incoming UDP traffic to the port in use.
5. Confirm that the device sending the OSC messages is sending the messages via UDP to the correct IP address and port.
6. Use a tool such as [wireshark](https://www.wireshark.org/) to confirm that the computer running the Kit application is receiving UDP traffic from the device.
## Unable to send messages
1. Confirm that the computer running the Kit application and the device receiving the OSC messages are on the same network.
2. Confirm that kit.exe is allowed to communicate with the private network through the Windows Defender Firewall.
3. Confirm that the device receiving the OSC messages is able to receive incoming UDP traffic at the port in use.
# Contributing
The source code for this repository is provided as-is and we are not accepting outside contributions.
# License
- The code in this repository is licensed under the Apache License 2.0. See [LICENSE](/LICENSE).
- python-osc is licensed under the Unlicense. See [exts/omni.osc/vendor/LICENSE-python-osc](/exts/omni.osc/vendor/LICENSE-python-osc).
# Resources
- [https://opensoundcontrol.stanford.edu/spec-1_0.html](https://opensoundcontrol.stanford.edu/spec-1_0.html)
- [https://en.wikipedia.org/wiki/Open_Sound_Control](https://en.wikipedia.org/wiki/Open_Sound_Control)
- [https://python-osc.readthedocs.io/en/latest/](https://python-osc.readthedocs.io/en/latest/)
| 5,998 | Markdown | 46.992 | 301 | 0.779593 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/config/extension.toml | [package]
# Semantic Versionning is used: https://semver.org/
version = "0.3.1"
# The title and description fields are primarily for displaying extension info in UI
title = "OSC (Open Sound Control)"
description="Send and receive OSC (Open Sound Control) messages"
authors = ["NVIDIA"]
repository = "https://github.com/NVIDIA-Omniverse/kit-osc"
readme = "docs/README.md"
changelog = "docs/CHANGELOG.md"
icon = "data/icon.png"
preview_image = "data/preview.png"
# One of categories for UI.
category = "Other"
# Keywords for the extension
keywords = ["kit", "osc"]
[dependencies]
"omni.kit.uiapp" = {}
"omni.kit.pipapi" = {}
"omni.graph" = {}
"omni.graph.bundle.action" = {}
# Main python module this extension provides, it will be publicly available as "import omni.osc.core".
[[python.module]]
name = "omni.osc"
[python.pipapi]
archiveDirs = ["vendor"]
[settings.exts."omni.osc"]
address = "localhost"
port = 3334
[[test]]
dependencies = ["omni.graph", "omni.kit.test"]
| 983 | TOML | 22.999999 | 102 | 0.703967 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/omni/osc/extension.py | # Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
from typing import Any, List
import carb
import carb.events
import carb.profiler
import omni.ext
import omni.kit.app
from pythonosc.dispatcher import Dispatcher
from .core import carb_event_payload_from_osc_message, push_to_osc_event_stream
from .menu import OscMenu
from .server import DaemonOSCUDPServer
from .window import OscWindow
class OmniOscExt(omni.ext.IExt):
def on_startup(self, ext_id):
def on_start(host: str, port: int) -> bool:
return self.server.start(host, port)
def on_stop() -> bool:
return self.server.stop()
def toggle_window_visible(_arg0, _arg1) -> None:
"""
Toggle the window visibility from the editor menu item
"""
self.window.visible = not self.window.visible
self.server = OmniOscExt.create_server()
# The main UI window
default_addr = carb.settings.get_settings().get("exts/omni.osc/address")
default_port = carb.settings.get_settings().get("exts/omni.osc/port")
self.window = OscWindow(
on_start=on_start, on_stop=on_stop, default_addr=default_addr, default_port=default_port
)
# The editor menu entry that toggles the window visibility
self.menu = OscMenu(on_click=toggle_window_visible)
# Toggle the editor menu entry when the user closes the window
self.window.set_visibility_changed_fn(lambda visible: self.menu.set_item_value(visible))
def on_shutdown(self):
self.window = None
self.menu = None
if self.server is not None:
self.server.stop()
self.server = None
def create_server() -> DaemonOSCUDPServer:
"""
Create a server that routes all OSC messages to a carbonite event stream
"""
@carb.profiler.profile
def on_osc_msg(addr: str, *args: List[Any]) -> None:
"""
OSC message handler
"""
carb.log_verbose(f"OSC message: [{addr}, {args}]")
payload = carb_event_payload_from_osc_message(addr, args)
push_to_osc_event_stream(payload)
# Server
dispatcher = Dispatcher()
dispatcher.set_default_handler(on_osc_msg)
return DaemonOSCUDPServer(dispatcher)
| 2,714 | Python | 34.723684 | 100 | 0.658438 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/omni/osc/__init__.py | # Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
import omni.kit.pipapi
# python-osc:
# - SWIPAT request: http://nvbugs/3684871
# - A copy of the source is forked to https://github.com/NVIDIA-Omniverse/python-osc
# - The dependency vendored and installed from exts/omni.osc/vendor/python_osc-1.8.0-py3-none-any.whl
omni.kit.pipapi.install(
package="python-osc", module="pythonosc", use_online_index=False, ignore_cache=True, ignore_import_check=False
)
from pythonosc import * # noqa: F401
from .core import * # noqa: F401,F403
from .extension import * # noqa: F401,F403
from .server import * # noqa: F401,F403
# NOTE(jshrake): omni.graph is an optional dependency so handle the case
# that the below import fails
try:
from .ogn import *
except Exception as e:
print(f"omni.osc failed to import OGN due to {e}")
pass
| 1,219 | Python | 37.124999 | 114 | 0.754717 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/omni/osc/core.py | ## Copyright © 2022 NVIDIA CORPORATION & AFFILIATES. ALL RIGHTS RESERVED.
##
## This software product is a proprietary product of Nvidia Corporation and its affiliates
## (the "Company") and all right, title, and interest in and to the software
## product, including all associated intellectual property rights, are and
## shall remain exclusively with the Company.
##
## This software product is governed by the End User License Agreement
## provided with the software product.
from typing import Callable, Tuple
import carb
import carb.events
import omni.ext
import omni.kit.app
OSC_EVENT_TYPE_NAME: str = "omni.osc"
OSC_EVENT_TYPE: int = carb.events.type_from_string(OSC_EVENT_TYPE_NAME)
OSC_MESSAGE_ADDRESS_STR = "address"
OSC_MESSAGE_ARGUMENTS_STR = "arguments"
def get_osc_event_stream() -> carb.events._events.IEventStream:
"""
Returns the OSC event stream
"""
return omni.kit.app.get_app().get_message_bus_event_stream()
def push_to_osc_event_stream(payload: dict) -> None:
"""
Push a payload to the OSC event stream
"""
get_osc_event_stream().push(OSC_EVENT_TYPE, sender=0, payload=payload)
def subscribe_to_osc_event_stream(
cb: Callable[[carb.events._events.IEvent], None]
) -> carb.events._events.ISubscription:
"""
Returns a Carbonite event subscription to the OSC event stream
"""
return get_osc_event_stream().create_subscription_to_pop_by_type(OSC_EVENT_TYPE, cb)
def carb_event_payload_from_osc_message(address: str, args: list) -> dict:
"""
Return a carbonite event payload suitable for pushing to the OSC event stream
"""
return {OSC_MESSAGE_ADDRESS_STR: address, OSC_MESSAGE_ARGUMENTS_STR: args}
def osc_message_from_carb_event(e: carb.events.IEvent) -> Tuple[str, list]:
"""
Return the OSC message address and arguments extracted from a carbonite event payload
"""
return (e.payload[OSC_MESSAGE_ADDRESS_STR], e.payload[OSC_MESSAGE_ARGUMENTS_STR])
| 1,961 | Python | 34.672727 | 90 | 0.7231 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/omni/osc/server.py | # Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
import threading
import carb
import carb.events
from pythonosc import osc_server
from pythonosc.dispatcher import Dispatcher
class DaemonOSCUDPServer:
"""
Run a python-osc BlockingOSCUDPServer in a separate thread.
Usage::
import omni.osc.core as osc
dispatcher = osc.Dispatcher()
dispatcher.set_default_handler(lambda(path, args): print(f"{path}: {args}"))
server = osc.DaemonOSCUDPServer(dispatcher)
server.start("192.168.0.1", 3434)
# ...
server.stop()
"""
def __init__(self, dispatcher: Dispatcher):
self.dispatcher: Dispatcher = dispatcher
self.server: osc_server.BlockingOSCUDPServer = None
self.thread: threading.Thread = None
def running(self) -> bool:
"""
Returns true if the server is running
"""
return self.thread is not None and self.thread.is_alive()
def start(self, addr: str, port: int) -> bool:
"""
Start the OSC server on the specified address and port.
Does nothing if the server is already running.
"""
if not self.running():
carb.log_info(f"Starting OSC server on {addr}:{port}")
try:
self.server = osc_server.BlockingOSCUDPServer((addr, port), dispatcher=self.dispatcher)
self.thread = threading.Thread(target=lambda: self.server.serve_forever())
# NOTE(jshrake): Running the thread in daemon mode ensures that the thread and server
# are properly disposed of in the event that the main thread exits unexpectedly.
self.thread.daemon = True
self.thread.start()
except Exception as e:
carb.log_error(f"Error starting OSC server: {e}")
else:
carb.log_info("OSC server already running")
return self.running()
def stop(self) -> bool:
"""
Stops the OSC server.
"""
if self.running():
carb.log_info("Stopping OSC server")
try:
self.server.shutdown()
self.thread.join()
except Exception as e:
carb.log_error(f"Error stopping OSC server: {e}")
finally:
self.server = None
self.thread = None
else:
carb.log_info("OSC server not running")
return self.running()
| 2,857 | Python | 34.28395 | 103 | 0.615681 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/omni/osc/menu.py | # Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
import omni.kit.ui
MENU_PATH = "Window/OSC"
class OscMenu:
def __init__(self, on_click):
editor_menu = omni.kit.ui.get_editor_menu()
if not editor_menu:
return
editor_menu.add_item(menu_path=MENU_PATH, on_click=on_click, toggle=True, value=True)
def set_item_value(self, val: bool) -> None:
editor_menu = omni.kit.ui.get_editor_menu()
if not editor_menu:
return
editor_menu.set_value(MENU_PATH, val)
def __del__(self):
editor_menu = omni.kit.ui.get_editor_menu()
if not editor_menu:
return
if editor_menu.has_item(MENU_PATH):
editor_menu.remove_item(MENU_PATH)
| 1,125 | Python | 33.121211 | 93 | 0.672889 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/omni/osc/window.py | # Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
from typing import Callable
import omni.ui as ui
OnStartCallback = Callable[[str, int], bool]
OnStopCallback = Callable[[], bool]
class OscWindow(ui.Window):
def __init__(
self, default_addr: str, default_port: int, on_start: OnStartCallback, on_stop: OnStopCallback
) -> None:
super().__init__("OSC UDP Server", width=300, height=300)
def start() -> None:
"""
Callback when the user presses the start button
"""
is_running = on_start(addr.as_string, port.as_int)
running.set_value(is_running)
def stop() -> None:
"""
Callback when the user presses the stop button
"""
is_running = on_stop()
running.set_value(is_running)
def update_running_label(label: ui.Label, running: bool) -> None:
"""
Keep the UI label up to date with the state of the server
"""
if running:
label.text = f"Running UDP server @ {addr.as_string}:{port.as_int}"
label.set_style({"color": "green"})
else:
label.text = "Stopped"
label.set_style({"color": "red"})
def toggle_enabled(field: ui.AbstractField, running: bool) -> None:
"""
Enable or disable the input field based on the state of the server
"""
field.enabled = not running
color = "gray" if running else "white"
field.set_style({"color": color})
# Settings
addr = ui.SimpleStringModel(default_addr)
port = ui.SimpleIntModel(default_port)
running = ui.SimpleBoolModel(False)
with self.frame:
with ui.VStack():
label = ui.Label("", height=20)
update_running_label(label, running.get_value_as_bool())
running.add_value_changed_fn(lambda m: update_running_label(label, m.get_value_as_bool()))
with ui.VStack(height=20):
with ui.HStack():
ui.Label("Address:")
addr_field = ui.StringField(addr)
toggle_enabled(addr_field, running.get_value_as_bool())
running.add_value_changed_fn(lambda m: toggle_enabled(addr_field, m.get_value_as_bool()))
ui.Spacer(height=2)
with ui.HStack():
ui.Label("Port:")
port_field = ui.IntField(port)
toggle_enabled(port_field, running.get_value_as_bool())
running.add_value_changed_fn(lambda m: toggle_enabled(port_field, m.get_value_as_bool()))
with ui.VStack():
ui.Button("Start", clicked_fn=start)
ui.Button("Stop", clicked_fn=stop)
| 3,323 | Python | 39.536585 | 113 | 0.560036 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/omni/osc/ogn/__init__.py | # Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
"""
Dynamically import every file in a directory tree that looks like a Python Ogn Node.
This includes linked directories, which is the mechanism by which nodes can be hot-reloaded from the source tree.
"""
# Required to register nodes in Kit 104
try:
import omni.graph.core as og
og.register_ogn_nodes(__file__, "omni.osc")
except Exception:
# Swallow any exceptions
pass
| 817 | Python | 37.952379 | 113 | 0.774786 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/omni/osc/ogn/nodes/OgnOnOscEvent.py | # Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
"""
This is the implementation of the OGN node defined in OgnOnOscEvent.ogn
This implementation is inspired by the OgnOnCustomEvent node
See https://gitlab-master.nvidia.com/omniverse/kit/-/blob/master/kit/source/extensions/omni.graph.action/nodes/OgnOnCustomEvent.py # noqa E501
"""
import re
from typing import Any, List, Union
import carb
import carb.events
import carb.profiler
import omni.graph.core as og
import omni.osc
from omni.osc.core import OSC_MESSAGE_ADDRESS_STR, OSC_MESSAGE_ARGUMENTS_STR
from .. import OgnOnOscEventDatabase
class OgnOnOscEventInternalState:
"""Convenience class for maintaining per-node state information"""
def __init__(self):
"""Instantiate the per-node state information."""
# This subscription object controls the lifetime of our callback, it will be
# cleaned up automatically when our node is destroyed
self.sub = None
# Set when the callback has triggered
self.is_set = False
# The last event received
self.event: Union[None, carb.events.IEvent] = None
# The node instance handle
self.node = None
# The regex used to match the OSC address path
self.osc_path_regex = ""
# The compiled regex pattern
self.osc_path_regex_pattern = None
@carb.profiler.profile
def on_event(self, event: carb.events.IEvent):
"""The event callback"""
if event is None:
return
# Only handle messages with a path that matches the OSC address path regex
osc_addr, _ = omni.osc.osc_message_from_carb_event(event)
if self.osc_path_regex_pattern is None or not self.osc_path_regex_pattern.match(osc_addr):
return
self.is_set = True
self.event = event
# Tell the evaluator we need to be computed
if self.node.is_valid():
self.node.request_compute()
@carb.profiler.profile
def first_time_subscribe(self, node: og.Node, osc_path_regex: str) -> bool:
"""Checked call to set up carb subscription
Args:
node: The node instance
event_name: The name of the carb event
Returns:
True if we subscribed, False if we are already subscribed
"""
if self.osc_path_regex != osc_path_regex:
# osc path regex changed since we last subscribed, re-compile
try:
self.osc_path_regex_pattern = re.compile(osc_path_regex)
self.osc_path_regex = osc_path_regex
except Exception as e:
carb.log_error(f"Error compiling OSC Address Path Regex '{osc_path_regex}': {e}")
if self.sub is None:
self.sub = omni.osc.subscribe_to_osc_event_stream(self.on_event)
self.node = node
return True
return False
def try_pop_event(self) -> Union[None, carb.events.IEvent]:
"""Pop the last event received, or None if there is no event to pop"""
if self.is_set:
self.is_set = False
event = self.event
self.event = None
return event
return None
# ======================================================================
class OgnOnOscEvent:
"""
This node triggers when an OSC event is received that matches the OSC address path regex.
"""
@staticmethod
def internal_state():
"""Returns an object that will contain per-node state information"""
return OgnOnOscEventInternalState()
@staticmethod
def release(node):
state = OgnOnOscEventDatabase.OgnOnOscEventDatabase.per_node_internal_state(node)
if state.sub:
state.sub.unsubscribe()
state.sub = None
@staticmethod
def check_all_args_are_floats(args: List[Any]) -> bool:
"""
Returns true if the OSC message arguments has the shape of List[float]
"""
all_args_are_float = all(isinstance(arg, float) for arg in args)
return all_args_are_float
@staticmethod
@carb.profiler.profile
def compute(db: og.Database) -> bool:
state: OgnOnOscEventInternalState = db.internal_state
osc_path_regex = db.inputs.path
state.first_time_subscribe(db.node, osc_path_regex)
event = state.try_pop_event()
if event is None:
return False
try:
addr, args = omni.osc.osc_message_from_carb_event(event)
# Populate the output bundle
bundle: og._impl.bundles.BundleContents = db.outputs.message
bundle.clear()
# Update the address attribute
addr_attribute = bundle.insert((og.Type(og.BaseDataType.TOKEN), OSC_MESSAGE_ADDRESS_STR))
addr_attribute.value = addr
# Update the arguments attribute
all_args_are_floats = OgnOnOscEvent.check_all_args_are_floats(args)
# NOTE(jshrake): This node currently only supports OSC arguments shaped like a List[Float]
if all_args_are_floats:
if len(args) == 1:
# Argument list contains a single element, write it as a double
args_attribute = bundle.insert((og.Type(og.BaseDataType.DOUBLE), OSC_MESSAGE_ARGUMENTS_STR))
args_attribute.value = args[0]
elif len(args) > 1:
# Argument list contains multiple element, write it as a list
args_attribute = bundle.insert((og.Type(og.BaseDataType.DOUBLE, tuple_count=len(args), array_depth=0), OSC_MESSAGE_ARGUMENTS_STR))
args_attribute.value = args
else:
carb.log_warn(f"OnOscMessage node expected OSC message arguments to be of type List[Float], instead got {args}")
return False
db.outputs.execOut = og.ExecutionAttributeState.ENABLED
except Exception as e:
carb.log_error(f"Error in OgnOnOscEvent::compute: {e}")
return False
return True
| 6,464 | Python | 37.254438 | 150 | 0.629332 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/omni/osc/tests/tests.py | # Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# NVIDIA CORPORATION and its licensors retain all intellectual property
# and proprietary rights in and to this software, related documentation
# and any modifications thereto. Any use, reproduction, disclosure or
# distribution of this software and related documentation without an express
# license agreement from NVIDIA CORPORATION is strictly prohibited.
import asyncio
import omni.kit.test
import omni.osc
class Test(omni.kit.test.AsyncTestCase):
# Before running each test
async def setUp(self):
pass
# After running each test
async def tearDown(self):
pass
async def test_can_start_and_stop_server(self):
server = omni.osc.DaemonOSCUDPServer(None)
is_running = server.start("localhost", 12345)
self.assertTrue(is_running)
await asyncio.sleep(0.1)
is_running = server.running()
self.assertTrue(is_running)
is_running = server.stop()
self.assertFalse(is_running)
async def test_server_can_receive_messages(self):
server = omni.osc.OmniOscExt.create_server()
is_running = server.start("localhost", 3337)
self.assertTrue(is_running)
self.count = 0
def on_event(e) -> None:
addr, _ = omni.osc.osc_message_from_carb_event(e)
self.assertEqual(e.type, omni.osc.core.OSC_EVENT_TYPE)
self.assertEqual(addr, "/filter")
self.count += 1
sub = omni.osc.subscribe_to_osc_event_stream(on_event)
total_msg_count = 10
def send_messages():
import random
from pythonosc import udp_client
client = udp_client.SimpleUDPClient(address="127.0.0.1", port=3337)
self.assertTrue(client is not None)
for _ in range(total_msg_count):
client.send_message("/filter", random.random())
send_messages()
# Wait a few seconds for the server to receive the messages
await asyncio.sleep(3)
# Manually pump the stream so our subscription callback executes
omni.osc.get_osc_event_stream().pump()
self.assertEqual(self.count, total_msg_count)
| 2,226 | Python | 34.919354 | 79 | 0.655436 |
NVIDIA-Omniverse/kit-osc/exts/omni.osc/docs/CHANGELOG.md | # Changelog
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [0.3.1] - 2023-09-28
### Changed
- Update CHANGELOG
## [0.3.0] - 2023-09-26
### Changed
- Fix OGN node registration for Kit 105.1
## [0.2.0] - 2022-09-12
### Changed
- The `On OSC Message` OmniGraph node now outputs a Bundle typed value rather than an Unknown typed value.
- Users can extract the "address" and the "arguments" of the OSC message with the `Extract Attribute` node.
## [0.1.1] - 2022-09-12
### Changed
- Updated documentation.
## [0.1.0] - 2022-09-02
### Added
- Initial release.
| 600 | Markdown | 22.115384 | 107 | 0.671667 |
AccelerationAgency/omniverse-extensions/exts/taa.google.spreadsheet.api/taa/google/spreadsheet/api/extension.py | import omni.ext
import omni.ui as ui
import omni.kit.commands
from typing import List
from pxr import Gf
omni.kit.pipapi.install('google-api-python-client')
omni.kit.pipapi.install('google-auth-httplib2')
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
SPACING = 4
LABEL_WIDTH = 120
class MyExtension(omni.ext.IExt):
data = {'translate_x': 0, 'translate_y': 0, 'translate_z': 0, 'rotate_x': 0, 'rotate_y': 0, 'rotate_z': 0, 'scale_x': 0, 'scale_y': 0, 'scale_z': 0}
subscription = None
stage = None
google_sheet = None
label_width = 50
_source_prim_model = ui.SimpleStringModel()
# lifecycle
def on_startup(self, ext_id):
print("[taa.google.spreadsheet.api] Extension starting up")
self.stage = omni.usd.get_context().get_stage()
self._window = ui.Window("TAA Google Spreadsheet API", width=400, height=270)
with self._window.frame:
with ui.VStack(height=0, spacing=SPACING):
with ui.CollapsableFrame("Source", name="group"):
with ui.VStack(height=0, spacing=SPACING):
with ui.HStack():
ui.Label("Prim", name="attribute_name", width=LABEL_WIDTH)
ui.StringField(model=self._source_prim_model)
ui.Button(" S ", width=0, height=0, style={"margin": 0}, clicked_fn=self._on_get_selection, tooltip="Get From Selection")
ui.Spacer(height= 12)
with ui.CollapsableFrame("Settings", name="group"):
with ui.VStack(height=0, spacing=SPACING):
ui.Label('Spreadsheet ID', height=20)
self.spreadsheet_id_field = ui.StringField(height=20)
ui.Label('Range', height=20)
self.range_field = ui.StringField(height=20)
ui.Label('API Key', height=20)
self.api_key_field = ui.StringField(height=20)
ui.Spacer(height= 12)
self.startButton = ui.Button("Start", height=54, clicked_fn=lambda: self.start(), style={"background_color": "green"})
self.stopButton = ui.Button("Stop", height=54, clicked_fn=lambda: self.stop(), style={"color": "red"})
ui.Spacer(height= 12)
self.statusLabel = ui.Label('Click start to begin', height=14, style={"font_size": 12})
self.stopButton.visible = False
print("[taa.google.spreadsheet.api] Extension start up complete")
def on_shutdown(self):
print("Extension shutting down")
self.stop()
print("Extension shutdown complete")
# custom methods
def _on_get_selection(self):
print('_on_get_selection', self.get_selection())
self._source_prim_model.as_string = ", ".join(self.get_selection())
def get_selection(self) -> List[str]:
return omni.usd.get_context().get_selection().get_selected_prim_paths()
def apply_changes(self, frame):
try:
# load the data from Google Spreadsheet ever few seconds; this API is rate limited
frameNumber = int(frame.payload["SWHFrameNumber"])
if(frameNumber % 180 != 0): return
print('applying changes')
self.read_data()
# act on all selected prims
paths = self.list_paths_of_selected_prims()
for path in paths:
# get reference to the prim on stage, making sure that it's valid
prim = self.stage.GetPrimAtPath(path)
if prim.IsValid() == False: continue
# transform the prim based on the settings in the Google Spreadsheet
self.move_prim(prim)
self.rotate_prim(prim)
self.scale_prim(prim)
print('changes applied successfully')
except Exception as err:
print(err)
def read_config(self):
try:
spreadsheetId = self.spreadsheet_id_field.model.get_value_as_string()
range = self.range_field.model.get_value_as_string()
api_key = self.api_key_field.model.get_value_as_string()
return (spreadsheetId, range, api_key)
except Exception as err:
print(err)
def read_data(self):
try:
spreadsheetId, range, api_key = self.read_config()
if self.google_sheet == None:
service = build('sheets', 'v4', developerKey=api_key)
self.google_sheet = service.spreadsheets()
result = self.google_sheet.values().get(spreadsheetId=spreadsheetId, range=range).execute()
values = result.get('values', [])
data = toJSON(values)
# normalize and clean data
self.data["shape"] = data.setdefault('shape', 'Cube')
self.data["size"] = float(data.setdefault('size', 100))
self.data["radius"] = float(data.setdefault('radius', 100))
self.data["translate_x"] = float(data.setdefault('translate_x', 0))
self.data["translate_y"] = float(data.setdefault('translate_y', 0))
self.data["translate_z"] = float(data.setdefault('translate_z', 0))
self.data["rotate_x"] = float(data.setdefault('rotate_x', 0))
self.data["rotate_y"] = float(data.setdefault('rotate_y', 0))
self.data["rotate_z"] = float(data.setdefault('rotate_z', 0))
self.data["scale_x"] = float(data.setdefault('scale_x', 1))
self.data["scale_y"] = float(data.setdefault('scale_y', 1))
self.data["scale_z"] = float(data.setdefault('scale_z', 1))
except HttpError as err:
print(err)
def move_prim(self, prim):
try:
x = self.data.get('translate_x')
y = self.data.get('translate_y')
z = self.data.get('translate_z')
omni.kit.commands.execute('TransformPrimSRT',
path=prim.GetPath(),
new_translation=Gf.Vec3d(x, y, z),
)
except Exception as err:
print("Failed to move prim", err)
def rotate_prim(self, prim):
try:
x = self.data.get('rotate_x')
y = self.data.get('rotate_y')
z = self.data.get('rotate_z')
omni.kit.commands.execute('TransformPrimSRT',
path=prim.GetPath(),
new_rotation_euler=Gf.Vec3d(x, y, z),
)
except Exception as err:
print("Failed to rotate prime", err)
def scale_prim(self, prim):
try:
x = self.data.get('scale_x')
y = self.data.get('scale_y')
z = self.data.get('scale_z')
omni.kit.commands.execute('TransformPrimSRT',
path=prim.GetPath(),
new_scale=Gf.Vec3d(x, y, z),
)
except Exception as err:
print("Failed to scale prim", err)
def list_paths_of_selected_prims(self):
try:
paths = [i.strip() for i in self._source_prim_model.as_string.split(",")]
if not paths:
paths = self.get_selection()
if not paths:
pass
return paths
except Exception as err:
print(err)
def start(self):
self.read_data()
def on_update_apply(frame): self.apply_changes(frame)
self.subscription = omni.kit.app.get_app().get_update_event_stream().create_subscription_to_pop(on_update_apply)
self.startButton.visible = False
self.stopButton.visible = True
self.statusLabel.text = "Status: started"
def stop(self):
if self.subscription: del self.subscription
self.startButton.visible = True
self.stopButton.visible = False
self.statusLabel.text = "Status: stopped"
"""
Utility functions
"""
def toJSON(values):
json = {}
if not values:
return json
for row in values:
key = row[0]
value = row[1]
if not key or not value:
continue
json[row[0]] = row[1]
return json
| 8,802 | Python | 27.124601 | 152 | 0.527153 |
AccelerationAgency/omniverse-extensions/exts/taa.google.spreadsheet.api/config/extension.toml | [package]
version = "1.0.0"
title = "TAA - Google Spreadsheet API"
description="An exploration into using Google Spreadsheet data to objects on the stage"
readme = "docs/README.md"
repository = ""
category = "Other"
keywords = ["taa", "google", "spreadsheet", "api", "example"]
icon = "data/taa-logo.png"
[dependencies]
"omni.kit.uiapp" = {}
[[python.module]]
name = "taa.google.spreadsheet.api" | 399 | TOML | 23.999999 | 87 | 0.696742 |
AccelerationAgency/omniverse-extensions/exts/taa.omniverse.cameracreator/taa/omniverse/cameracreator/extension.py | import omni.ext
import omni.ui as ui
import omni.kit.commands as commands
class MyExtension(omni.ext.IExt):
# Lifecycle
def on_startup(self, ext_id):
print("[taa.omniverse.viewport] Extension starting up")
self._window = ui.Window("TAA Quick Camera", width=200, height = 200)
with self._window.frame:
with ui.VStack(height = 0, spacing = 4):
self.perspectiveButton = ui.Button("Perspective", height=40, clicked_fn=lambda: self.create_perspective_camera(), style={"background_color":"black"})
self.topButton = ui.Button("Top", height=40, clicked_fn=lambda: self.create_top_camera(), style={"background_color":"black"})
self.frontButton = ui.Button("Front", height=40, clicked_fn=lambda: self.create_front_camera(), style={"background_color":"black"})
self.rightButton = ui.Button("Right", height=40, clicked_fn=lambda: self.create_right_camera(), style={"background_color":"black"})
print("[taa.omniverse.viewport] Extension start up complete")
def on_shutdown(self):
print("[taa.omniverse.viewport] Extension shutting down")
self.stop()
print("[taa.omniverse.viewport] Extension shutdown complete")
# Custom methods
def set_camera(self, path):
omni.kit.viewport_legacy.get_viewport_interface().get_viewport_window().set_active_camera(path)
def rename_camera(self, name):
cameraPath = omni.kit.viewport_legacy.get_viewport_interface().get_viewport_window().get_active_camera()
omni.kit.commands.execute('MovePrims', paths_to_move={cameraPath: f'/World/Camera_{name}'})
def create_perspective_camera(self):
print("[taa.omniverse.viewport] Creating new perspective camera")
self.set_camera("/OmniverseKit_Persp")
commands.execute('DuplicateFromActiveViewportCameraCommand', viewport_name='Viewport')
self.rename_camera("Perspective")
def create_top_camera(self):
print("[taa.omniverse.viewport] Creating new top-down camera")
self.set_camera("/OmniverseKit_Top")
commands.execute('DuplicateFromActiveViewportCameraCommand', viewport_name='Viewport')
self.rename_camera("Top")
def create_front_camera(self):
print("[taa.omniverse.viewport] Creating new front view camera")
self.set_camera("/OmniverseKit_Front")
commands.execute('DuplicateFromActiveViewportCameraCommand', viewport_name='Viewport')
self.rename_camera("Front")
def create_right_camera(self):
print("[taa.omniverse.viewport] Creating new right view camera")
self.set_camera("/OmniverseKit_Right")
commands.execute('DuplicateFromActiveViewportCameraCommand', viewport_name='Viewport')
self.rename_camera("Right")
def start(self):
print("[taa.omniverse.viewport] Starting...")
def stop(self):
print("[taa.omniverse.viewport] Stopping...")
| 2,974 | Python | 44.76923 | 165 | 0.675521 |
AccelerationAgency/omniverse-extensions/exts/taa.omniverse.cameracreator/config/extension.toml | [package]
version = "1.0.0"
title = "TAA - Omniverse Camera Creator"
description = "An simple extension that lets you quickly create cameras with a single click."
readme = "docs/README.md"
repository = ""
category = "Other"
keywords = ["taa", "viewport", "create", "camera", "view"]
icon = "data/taa-logo.png"
[dependencies]
"omni.kit.uiapp" = {}
[[python.module]]
name = "taa.omniverse.cameracreator" | 405 | TOML | 24.374998 | 93 | 0.693827 |
ilanhuang/audio2face-streamgpt-public/README.md | # Stream-GPT
Stream-GPT is an Omniverse Extension that uses OpenAI's GPT-3 model to create a virtual assistant. It allows users to interact with the assistant through both text and voice, and the assistant responds in kind. The extension uses OpenAI's Whisper ASR system to transcribe audio input and Eleven Labs' API to convert the assistant's text responses into audio.
## Getting Started
### Prerequisites
- Python 3.6 or higher
- Omniverse Kit
- Omniverse Audio2Face
- OpenAI API key
- Eleven Labs API key
### Installation
1. Clone the repository:
```bash
git clone https://github.com/ilanhuang/audio2face-stream-chatgpt.git
```
2. Install the required Python packages:
```bash
pip install -r requirements.txt
```
3. Update the `sys.path.append` in `extension.py` with the correct path to the `streaming_server` directory in your local clone of the repository.
```python
sys.path.append("C:\\Users\\YourUsername\\path\\to\\stream-gpt\\pkg\\audio2face-2022.2.1\\exts\\omni.audio2face.player\omni\\audio2face\\player\\scripts\\streaming_server")
```
4. Add the custom extension to Omniverse:
- Go to the "Windows" tab on the top of the screen.
- Scroll down to "Extensions".
- Click on the gear icon to open the Extensions settings.
- Click on the "+" button to add a new path to the custom extension.
- A window will pop up when you turn on the extension.
5. Set your OpenAI and Eleven Labs API keys, as well as the voice_id, model_id, and the Audio2Face's audioplayer's prim path (instance_name) in the extension's settings:
- Open the extension and click on the "Settings" button.
- Enter your OpenAI API key, Eleven Labs API key, voice_id, model_id and instance name in the corresponding fields. (A text file in the repository lists the available voice ids.)
## Usage
Once the application is running, you can interact with the virtual assistant through the UI. You can type your prompts into the text field and click on the "Send" button or use the "Record Audio" button to speak your prompts. The assistant will respond in the chat log and through your speakers.
You can also add a system to the GPT virtual assistant by typing it in the "System" field in the UI.
All interactions made with the extension are saved in a folder named "chat_logs" for future reference. | 2,294 | Markdown | 40.727272 | 358 | 0.762424 |
ilanhuang/audio2face-streamgpt-public/exts/stream.gptchat/stream/gptchat/recording_transcription.py | #Stream-GPT
#GNU - GLP Licence
#Copyright (C) <year> <Huang I Lan & Erks - Virtual Studio>
#This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
#This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
import os
import pyaudio
import wave
import keyboard
import time
from time import sleep
import openai
import datetime
def open_file(filepath):
with open(filepath, 'r', encoding='utf-8') as infile:
return infile.read()
def save_file(filepath, content):
with open(filepath, 'w', encoding='utf-8') as outfile:
outfile.write(content)
def timestamp_to_datetime(unix_time):
return datetime.datetime.fromtimestamp(unix_time).strftime("%A, %B %d, %Y at %I:%M%p %Z")
def record_client_voice(output_filename, recording_status):
CHUNK = 1024
FORMAT = pyaudio.paInt16
CHANNELS = 1
RATE = 16000
frames = []
p = pyaudio.PyAudio()
stream = None
try:
stream = p.open(format=FORMAT,
channels=CHANNELS,
rate=RATE,
input=True,
frames_per_buffer=CHUNK)
start_time = time.time()
min_duration = 0.1
while recording_status() or time.time() - start_time < min_duration:
data = stream.read(CHUNK)
frames.append(data)
except Exception as e:
print(f"Error while recording audio: {e}")
finally:
if stream is not None:
stream.stop_stream()
stream.close()
p.terminate()
wf = wave.open(output_filename, 'wb')
wf.setnchannels(CHANNELS)
wf.setsampwidth(p.get_sample_size(FORMAT))
wf.setframerate(RATE)
wf.writeframes(b''.join(frames))
wf.close()
return output_filename
def transcribe_audio_to_text(file_path):
with open(file_path, 'rb') as audio_file:
transcript_response = openai.Audio.transcribe("whisper-1", audio_file)
return transcript_response["text"] | 2,508 | Python | 32.013157 | 240 | 0.64673 |
Subsets and Splits