Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgthetrain/usd-experiments
Experimenting with C++ libraries capable of parsing USD files
https://github.com/mgthetrain/usd-experiments
cpp universal-scene-description usda usdc usdz
Last synced: 6 days ago
JSON representation
Experimenting with C++ libraries capable of parsing USD files
- Host: GitHub
- URL: https://github.com/mgthetrain/usd-experiments
- Owner: MGTheTrain
- License: mit
- Created: 2024-12-07T20:54:12.000Z (15 days ago)
- Default Branch: main
- Last Pushed: 2024-12-07T21:26:11.000Z (15 days ago)
- Last Synced: 2024-12-07T21:29:34.242Z (15 days ago)
- Topics: cpp, universal-scene-description, usda, usdc, usdz
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# usd-experiments
## Table of Contents
- [Summary](#summary)
- [References](#references)
- [Getting started](#getting-started)
## Summary
Experimenting with C++ libraries capable of parsing USD files
## References
- [USD file format](https://docs.fileformat.com/3d/usd/)
- [OpenUSD Github repository](https://github.com/PixarAnimationStudios/OpenUSD)
- [tinyusdz Github repository](https://github.com/lighttransport/tinyusdz/tree/dev)
- [OpenUSD - Converting Between Layer Formats](https://openusd.org/docs/Converting-Between-Layer-Formats.html#ConvertingBetweenLayerFormats-Convertingbetween.usdaand.usdcFiles)
- [Download Pre-Built OpenUSD Libraries and Tools](https://developer.nvidia.com/usd#section-getting-started)
- [A really small getting-started project for USD based projects](https://github.com/meshula/tinyusd)
- [OpenUSD sample files for download](https://openusd.org/release/dl_downloads.html)
- [vcpkg issue](https://github.com/microsoft/vcpkg/issues/37947)
## Getting started
### Preconditions
- Download and install [CMake from the official website](https://cmake.org/download/) or trough a package manager
- Install a C++ compiler on your operating system. For example, on Ubuntu Linux use `sudo apt install -y build-essential` to install the `gcc` and `g++` compilers; on Windows, the `cl.exe` compiler is included with the [Visual Studio IDE](https://visualstudio.microsoft.com/vs/); and on macOS, `clang` and `clang++` compilers are system binaries
- Add git submodules: `git subdmodule update --init`
### Generating USDA or USDC files from glTF files
To generate USD files from glTF files, you can either [download the pre-built OpenUSD libraries and tools](https://developer.nvidia.com/usd#section-getting-started) to use the `usdcat` CLI tool or build the project from GitHub. On macOS 12.0 (Monterey) and later, the pre-built OpenUSD CLI tools, including `usdcat`, should already be installed. The [data folder](data) can be utilized for storing USDA or USDC files. Example usage os `usdcat`:
```sh
usdcat -o
# e.g. usdcat third-party/glTF-Sample-Models/2.0/BrainStem/glTF/BrainStem.gltf -o data/BrainStem.usda
# e.g. usdcat third-party/glTF-Sample-Models/2.0/BrainStem/glTF/BrainStem.gltf -o data/BrainStem.usdc
```
### Building application binaries
#### Mac OS
Run:
```sh
# INFO: Tested on macOS 15
./third-party/vcpkg/bootstrap-vcpkg.sh
./third-party/vcpkg/vcpkg install --allow-unsupported # Initially building USD can be time-consuming and resource-intensive. Packages persist in the vcpkg git submodule
# Unable to use the `-DCMAKE_TOOLCHAIN_FILE` option because of build errors as the `--allow-unsupported` flag is not available in the subsequent `cmake` command
cmake -B build -DCMAKE_BUILD_TYPE=Release .
cmake --build build --parallel --config Release
./build/apps/openusd-parser/openusd-parser
# e.g. ./build/apps/openusd-parser/openusd-parser data/BrainStem.usdc data/BrainStem.txt
```
#### Windows OS
Run:
```sh
# INFO: Tested on Windows 10
.\third-party\vcpkg\bootstrap-vcpkg.bat
.\third-party\vcpkg\vcpkg install # Initially building USD can be time-consuming and resource-intensive. Packages persist in the vcpkg git submodule
cmake -B build -DCMAKE_BUILD_TYPE=Release .
cmake --build build --parallel --config Release
.\build\apps\openusd-parser\Release\openusd-parser
```
#### Linux Ubuntu OS
Run:
```sh
# INFO: Tested on Linux Ubuntu 20.04
./third-party/vcpkg/bootstrap-vcpkg.sh
./third-party/vcpkg/vcpkg install # Initially building USD can be time-consuming and resource-intensive. Packages persist in the vcpkg git submodule
cmake -B build -DCMAKE_BUILD_TYPE=Release .
cmake --build build --parallel --config Release
./build/apps/openusd-parser/openusd-parser
```