https://github.com/prismpipeline/quiltix
QuiltiX is a graphical node editor to edit, and author MaterialX based materials of 3D assets
https://github.com/prismpipeline/quiltix
3d 3d-graphics materialx nodegraph openusd pyside python qt real-time-rendering rendering rendering-3d-graphics universal-scene-description usd vfx
Last synced: 29 days ago
JSON representation
QuiltiX is a graphical node editor to edit, and author MaterialX based materials of 3D assets
- Host: GitHub
- URL: https://github.com/prismpipeline/quiltix
- Owner: PrismPipeline
- License: apache-2.0
- Created: 2023-07-30T10:51:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-20T17:04:26.000Z (about 1 year ago)
- Last Synced: 2024-05-21T00:55:04.281Z (12 months ago)
- Topics: 3d, 3d-graphics, materialx, nodegraph, openusd, pyside, python, qt, real-time-rendering, rendering, rendering-3d-graphics, universal-scene-description, usd, vfx
- Language: Python
- Homepage: https://pypi.org/project/QuiltiX
- Size: 33 MB
- Stars: 235
- Watchers: 9
- Forks: 25
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
----
[](https://github.com/PrismPipeline/QuiltiX/LICENSE)
[](https://github.com/PrismPipeline/QuiltiX/releases/latest)
QuiltiX is a graphical node editor to edit, and author [MaterialX](https://materialx.org/) based materials of 3D assets. It includes a viewport based on [OpenUSD](https://www.openusd.org/release/index.html)'s [Hydra](https://openusd.org/release/glossary.html#hydra), which enables viewing your assets in any renderer supporting both Hydra & MaterialX.
## Table of Contents
- [Requirements](#requirements)
- [Installation](#installation)
- [From PyPi](#from-pypi)
- [From Zip](#from-zip)
- [From Source](#from-source)
- [Running QuiltiX](#running-quiltix)
- [Running QuiltiX using hython](#running-quiltix-using-hython)
- [QuiltiX Plugins](#quiltix-plugins)
- [Creating a QuiltiX plugin](#creating-a-quiltix-plugin)
- [QuiltiX Plugin hooks](#quiltix-plugin-hooks)
- [Integrating with your environment](#integrating-with-your-environment)
- [Using your own compiled OpenUSD](#using-your-own-compiled-openusd)
- [Adding Hydra delegates](#adding-hydra-delegates)
- [Arnold](#arnold)
- [Karma](#karma)
- [Adding custom MaterialX Node definitions](#adding-custom-materialx-node-definitions)
- [Platform support](#platform-support)
- [Contributing](#contributing)
- [License](#license)
## Requirements
QuiltiX requires Python 3.11+ as well as compiled versions of USD and MaterialX.
## Installation
### From PyPi
```shell
pip install QuiltiX
```
If you additionally require pre-built binaries for MaterialX & USD we currently provide these for Windows.
On Linux/Mac you need to provide your own binaries for now. Here are linked instructions for [MaterialX](https://github.com/AcademySoftwareFoundation/MaterialX/tree/main#quick-start-for-developers) & [OpenUSD](https://github.com/PixarAnimationStudios/OpenUSD/blob/release/BUILDING.md)
```shell
pip install QuiltiX
pip install git+https://github.com/PrismPipeline/[email protected]
```
### From Zip
For Windows a zip containing QuiltiX and all required dependencies can be downloaded from [here](https://prism-pipeline.com/quiltix/).
Just extract and execute the `QuiltiX.bat`
### From Source
1) Clone the repository
```
git clone https://github.com/PrismPipeline/QuiltiX.git
cd QuiltiX
```
2) Install the dependencies
This will install the base python dependencies, excluding any development dependencies, MaterialX & USD
```
pip install .
```
Additional install options
If you want want to contribute it is recommended to install QuiltiX in [development/editable mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html).
It is also recommended to also install QuiltiX's dev dependencies.
```
pip install -e .[dev]
```
For more information see [pyproject.toml](pyproject.toml)
## Running QuiltiX
```
python -m QuiltiX
```
Or if you installed QuiltiX via zip you can execute the `QuiltiX.bat` after extracting.
### Running QuiltiX using hython
QuiltiX can be run from `hython`, which is Houdini's python executable. This way you can use Houdini's built USD and MaterialX and don't have to worry about providing your own.
You will also be able to use Render delegates for Houdini like Karma. Read more in the [Karma](#karma) section.
Hython instructions
You will still need some additional libraries required by QuiltiX, so it is still necessary to install the dependencies mentioned in [Installation](#installation).
You can then execute QuiltiX while making sure that both QuiltiX and its python dependencies are in the `PYTHONPATH` environmenv variable:
```shell
cd QuiltiX_root
set PYTHONPATH=%PYTHONPATH%;./src;/path/to/python/dependencies
/path/to/hython.exe -c "from QuiltiX import quiltix;quiltix.launch()"
```
Or if you have a virtual environment
```shell
cd QuiltiX_root
/path/to/venv/Scripts/activate
set PYTHONPATH=%PYTHONPATH%;%VIRTUAL_ENV%/Lib/site-packages;./src
/path/to/hython.exe -c "from QuiltiX import quiltix;quiltix.launch()"
```
> Note that currently both the Storm as well as HoudiniGL render delegates do not seem to work in QuiltiX when being launched from hython.
## QuiltiX Plugins
QuiltiX supports adding Plugins via the environment variable `QUILTIX_PLUGIN_PATHS`. We are using [pluggy](https://pluggy.readthedocs.io/en/stable/) in the backend to load them.
### Creating a QuiltiX plugin
To create a QuiltiX plugin you need to create a `plugin.py` file. In this file you need implement one or multiple `hooks` that QuiltiX provides. Example:
```python
@qx_plugin.hookimpl
def after_ui_init(editor: "quiltix.QuiltiXWindow"):
# I am printing the QuiltiXWindow
print(editor)
```
You also need to implement a `plugin_name` function returning the name of your plugin. Example:
```python
def plugin_name() -> str:
return "QuiltiXWindow printer"
```
If your plugin has the possibility to not be valid (due to missing dependencies or similar) you can implement a `is_valid` function returning `False` to avoid it loading entirely. Example:
```python
def is_valid() -> bool:
if 1==1:
return False
else:
return True
```
For further reference please take a look at the `sample_plugins` dir and the tests in `tests/test_plugins.py`
### QuiltiX Plugin hooks
These are the hooks that are currently supported, but there is no harm in adding more. If you would like to add hooks in other parts of QuiltiX to support your features, please open an Issue/PR.
The hook specifications live in `src/QuiltiX/qx_plugin.py`
| hook | Purpose |
|-|-|
| before_ui_init | Building UI funcionality on top of the QuiltiX UI |
| after_ui_init | Adjusting parts of the internals before the QuiltiX UI startup |
| before_mx_import | Adjusting things like environment variables before MaterialX gets initialized |
| after_mx_import | Adjusting MaterialX specific functionality right after it gets imported |
| before_pxr_import | Adjusting things like environment variables before pxr (OpenUSD) gets initialized |
| after_pxr_import | Adjusting pxr (OpenUSD) specific functionality right after it gets imported |
## Integrating with your environment
QuiltiX tries to rely as much as possible on pre-existing environment variables from MaterialX/USD to extend its systems.
Overview over the most important Environment Variables:
| Environment Variable | Purpose | Variable Type | Example |
|-|-|-|-|
| PXR_PLUGINPATH_NAME | Paths to Hydra delegate plugins | Paths | |
| PXR_MTLX_STDLIB_SEARCH_PATHS | Paths to standard MaterialX node definition locations | Paths | |
| PXR_MTLX_PLUGIN_SEARCH_PATHS | Paths to custom MaterialX node definition locations | Paths | |
| HD_DEFAULT_RENDERER | Name of the default Hydra delegate for the viewport | String | GL |
### Using your own compiled OpenUSD
To be able to use your own version of OpenUSD for QuiltiX instead of relying on our [provided version](https://github.com/PrismPipeline/OpenUSD_build), you will need to provide some environment variables. Make sure that you append to them!
Essentially you need to add all `.dll`s to `PATH` and the `pxr` python library to `PYTHONPATH`.
| Environment Variable | Path relative to compiled ${USD_ROOT} |
|-|-|
| PATH | ${USD_ROOT}/bin |
| PATH | ${USD_ROOT}/lib |
| PYTHONPATH | ${USD_ROOT}/lib/python |
### Adding [Hydra delegates](https://openusd.org/release/glossary.html#hydra)
> **_NOTE_**
> The Hydra renderer needs to support MaterialX for it to work in QuiltiX.
**_What is a Hdyra Delegate?_**
"Hydra Render Delegates are bridges between the Hydra viewport and a renderer. [...] The Hydra Render Delegate system allows the ability to switch out the backend renderer for the viewport data in Hydra. [...]"[[src]](https://learn.foundry.com/katana/dev-guide/Plugins/HydraRenderDelegates/Introduction.html#what-is-a-hydra-render-delegate)
The [Storm Hydra Delegate](https://openusd.org/dev/api/hd_storm_page_front.html) by Pixar is both shipped with USD and enabled per default in QuiltiX.
> Adding additional Hydra delegates can, depending on the renderer, be a non-trivial task due to the need of matching USD (and potentially MaterialX) versions for the compiled binaries. Some renderers also need additional configuration for additional features like renderer specific procedurals or shaders.
To register a Hydra renderer plugin the Hydra plugin directory of the renderer needs to be added to the `PXR_PLUGINPATH_NAME` environment variable. Generally renderers also need their binaries added to the `PATH` environment variable, but there might be additional variables for licensing or additional features.
Below is a non-exhaustive list of install instructions for Hydra renderers.
#### Arnold
To use Arnold in QuiltiX you need the following:
* Arnold SDK
* A compiled version of [arnold-usd](https://github.com/Autodesk/arnold-usd)
Full Arnold install instructions
Arnold SDK download instructions can be found [here](https://help.autodesk.com/view/ARNOL/ENU/?guid=arnold_user_guide_ac_download_arnold_html#download-arnold-sdk).
To install arnold-usd one can build from source [here](https://github.com/Autodesk/arnold-usd).
For Windows you can find a compiled version of `hdArnold` and the Arnold SDK [here](https://github.com/PrismPipeline/arnold-usd/releases/tag/v7.2.5.2) with [install instructions](https://github.com/PrismPipeline/arnold-usd/blob/0d97fa0af15600217036e32985ee0b7fe7a34051/README.md).
> This plugin can be used in USD applications, like QuiltiX, to add the Arnold Hydra delegate.
>
> Download and extract the archive and then add the following paths to the environment:
> `Arnold/hdArnold/plugin` to `PXR_PLUGINPATH_NAME`
> `Arnold/Arnold-7.2.5.2-windows/bin` to `PATH`
#### Karma
To run Karma you need to execute QuiltiX from hython. See [here](#running-quiltix-using-hython) for more information.
It is possible to use additional Hydra delegates, which are available in the Houdini environment.
#### Changing the active Hydra delegate
The default Hydra delegate can be changed by setting the `HD_DEFAULT_RENDERER` environment variable to the preferred renderer.
```shell
set HD_DEFAULT_RENDERER="GL"
```
After opening QuiltiX the active Hydra delegate can be changed in the "View" -> "Set Renderer" menu.
### Adding custom MaterialX Node definitions
To add custom MaterialX node defintions they can be added by adding the location of the node definition files to the `PXR_MTLX_PLUGIN_SEARCH_PATHS` environment variable.
## Platform support
QuiltiX has been developed with all platforms in mind, but has been developed on Windows. If you see any issues on another platform please open up an issue.
## Contributing
We welcome contributions to the QuiltiX! If you'd like to contribute, please follow these steps:
1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Submit a pull request.
## License
QuiltiX is licensed under the Apache License. See [LICENSE](LICENSE) for more information.