threejs-materials 0.2.0__tar.gz

threejs_materials-0.2.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 materialx-lib contributors
+
+   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.

threejs_materials-0.2.0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: threejs-materials
+Version: 0.2.0
+Summary: Download PBR materials on demand and convert to Three.js MeshPhysicalMaterial JSON
+License-Expression: Apache-2.0
+Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Dist: materialx>=1.39.4
+Requires-Dist: requests>=2.31.0
+Requires-Dist: openexr>=3.3
+Requires-Dist: pillow>=10.0
+Provides-Extra: usd
+Requires-Dist: usd-core>=24.11; extra == "usd"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file

threejs_materials-0.2.0/README.md

@@ -0,0 +1,385 @@
+# threejs-materials
+
+A Python library that converts PBR materials into [Three.js `MeshPhysicalMaterial`](https://threejs.org/docs/#api/en/materials/MeshPhysicalMaterial)-compatible JSON with base64-encoded textures.
+
+The primary input format is [MaterialX](https://materialx.org/) — the library can download materials on demand from four open sources and bake procedural graphs into flat textures. For Blender / USD users, `Material.from_usd()` reads `UsdPreviewSurface` materials directly without baking.
+
+<table>
+<tr>
+<td align="center"><strong>Studio mode</strong> (full PBR)</td>
+<td align="center"><strong>CAD mode</strong> (<code>interpolate_color()</code>)</td>
+</tr>
+<tr>
+<td><img src="screenshots/Studio mode.png" width="400"></td>
+<td><img src="screenshots/CAD mode.png" width="400"></td>
+</tr>
+</table>
+
+## Installation
+
+```bash
+cd threejs-materials
+uv sync        # or: pip install -e .
+```
+
+### Dependencies
+
+- `materialx >= 1.39.4` — MaterialX SDK with TextureBaker
+- `requests >= 2.31.0` — HTTP downloads
+- `openexr >= 3.3` — EXR to PNG conversion
+
+### Optional: USD support
+
+```bash
+pip install threejs-materials[usd]
+```
+
+This installs `usd-core` for `Material.from_usd()`. Note that `usd-core` may not support the latest Python version.
+
+## Output format
+
+Both MaterialX and USD pipelines produce the same output format. Each property carries a `value`, a base64-encoded `texture`, or both:
+
+```json
+{
+    "id": "Car Paint",
+    "name": "Car Paint",
+    "source": "gpuopen",
+    "properties": {
+        "color": {
+            "value": [0.944, 0.776, 0.373],
+            "texture": "data:image/png;base64,..."
+        },
+        "metalness": { "value": 1.0 },
+        "roughness": { "value": 0.5, "texture": "data:image/png;base64,..." },
+        "normal": { "texture": "data:image/png;base64,..." },
+        "ior": { "value": 1.5 }
+    }
+}
+```
+
+Parametric materials (PhysicallyBased) have values only:
+
+```json
+{
+    "id": "Gold",
+    "name": "Gold",
+    "source": "physicallybased",
+    "properties": {
+        "color": { "value": [1.059, 0.773, 0.307] },
+        "metalness": { "value": 1.0 },
+        "roughness": { "value": 0.0 },
+        "ior": { "value": 1.5 }
+    }
+}
+```
+
+### Property name mapping
+
+Each output property maps to Three.js `MeshPhysicalMaterial` fields:
+
+| Output property             | `value` →                   | `texture` →                                                |
+| --------------------------- | --------------------------- | ---------------------------------------------------------- |
+| `color`                     | `color`                     | `map`                                                      |
+| `metalness`                 | `metalness`                 | `metalnessMap`                                             |
+| `roughness`                 | `roughness`                 | `roughnessMap`                                             |
+| `normal`                    | —                           | `normalMap`                                                |
+| `normalScale`               | `normalScale`               | —                                                          |
+| `ao`                        | —                           | `aoMap`                                                    |
+| `emissive`                  | `emissive`                  | `emissiveMap`                                              |
+| `emissiveIntensity`         | `emissiveIntensity`         | —                                                          |
+| `ior`                       | `ior`                       | —                                                          |
+| `transmission`              | `transmission`              | `transmissionMap`                                          |
+| `thickness`                 | `thickness`                 | `thicknessMap`                                             |
+| `attenuationColor`          | `attenuationColor`          | —                                                          |
+| `attenuationDistance`       | `attenuationDistance`       | —                                                          |
+| `clearcoat`                 | `clearcoat`                 | `clearcoatMap`                                             |
+| `clearcoatRoughness`        | `clearcoatRoughness`        | —                                                          |
+| `clearcoatNormal`           | —                           | `clearcoatNormalMap`                                       |
+| `sheen`                     | `sheen`                     | —                                                          |
+| `sheenColor`                | `sheenColor`                | `sheenColorMap`                                            |
+| `sheenRoughness`            | `sheenRoughness`            | —                                                          |
+| `iridescence`               | `iridescence`               | `iridescenceMap`                                           |
+| `iridescenceIOR`            | `iridescenceIOR`            | —                                                          |
+| `iridescenceThicknessRange` | `iridescenceThicknessRange` | —                                                          |
+| `anisotropy`                | `anisotropy`                | —                                                          |
+| `anisotropyRotation`        | `anisotropyRotation`        | —                                                          |
+| `specularIntensity`         | `specularIntensity`         | `specularIntensityMap`                                     |
+| `specularColor`             | `specularColor`             | `specularColorMap`                                         |
+| `opacity`                   | `opacity`                   | `alphaMap`                                                 |
+| `transparent`               | `transparent`               | —                                                          |
+| `alphaTest`                 | `alphaTest`                 | —                                                          |
+| `dispersion`                | `dispersion`                | —                                                          |
+| `displacement`              | —                           | `displacementMap`                                          |
+| `displacementScale`         | `displacementScale`         | —                                                          |
+| `side`                      | `side`                      | —                                                          |
+| `metallicRoughness`         | —                           | `metalnessMap` + `roughnessMap` (G=roughness, B=metalness) |
+
+## Common API
+
+### `material.override(**props, repeat=None) -> Material`
+
+Return a new `Material` with property and/or texture repeat overrides. The original material is not modified.
+
+```python
+mat = Material.gpuopen.load("Car Paint")
+
+red_paint = mat.override(color=(0.8, 0.1, 0.1))
+rough_red = mat.override(color=(0.8, 0.1, 0.1), roughness=0.9)
+tiled     = mat.override(repeat=(3, 3))
+```
+
+Overrides set the `value` of the named property, creating it if absent. Existing textures are preserved. Calls can be chained: `mat.override(color=(1,0,0)).override(repeat=(2,2))`.
+
+### `encode_texture_base64(file_path) -> str`
+
+Encode an image file as a base64 data URI. Automatically converts EXR to PNG.
+
+```python
+from threejs_materials import encode_texture_base64
+
+data_uri = encode_texture_base64("textures/normal.png")
+# -> 'data:image/png;base64,iVBORw0KGgo...'
+```
+
+### `material.interpolate_color() -> (r, g, b, a)`
+
+Estimate a single representative sRGB color from a material — useful for CAD viewers that need a flat color per object while keeping a material dictionary for full PBR rendering.
+
+```python
+from threejs_materials import Material
+
+wood = Material.gpuopen.load("Ivory Walnut Solid Wood")
+
+materials = {"wood": wood}      # keep for full PBR rendering
+object.material = "wood"
+object.color = wood.interpolate_color()   # (0.53, 0.31, 0.18, 1.0)
+```
+
+When the material has a color texture, the texture is decoded and averaged (requires `Pillow`). Scalar colors (linear RGB) are converted to sRGB. Transmission and opacity are mapped to the alpha channel so glass-like materials appear semi-transparent.
+
+### Three.js usage
+
+```javascript
+const data = JSON.parse(jsonStr);
+const material = new THREE.MeshPhysicalMaterial();
+
+for (const [key, prop] of Object.entries(data.properties)) {
+    if (prop.texture) {
+        material[key] = new THREE.TextureLoader().load(prop.texture);
+    }
+    if (prop.value !== undefined) {
+        if (Array.isArray(prop.value) && prop.value.length === 3) {
+            material[key] = new THREE.Color(...prop.value);
+        } else {
+            material[key] = prop.value;
+        }
+    }
+}
+```
+
+### Consumer notes
+
+- **Color space**: Textures include a `colorSpace` field when available. Three.js expects color textures (baseColor, emissive, sheenColor, specularColor) in **sRGB** and data textures (roughness, metalness, normal, AO, displacement) in **linear**. Set `texture.colorSpace` accordingly.
+- **Normal maps**: Baked using the OpenGL convention (Y-up), matching Three.js and glTF expectations.
+- **Scalar x texture**: When both `value` and `texture` are present, Three.js multiplies them. The library sets scalars to `1.0` (neutral) when a texture is present so the texture controls fully.
+- **glTF packed metallicRoughness**: When present, the `metallicRoughness` property carries a single packed texture (G=roughness, B=metalness). The consumer must assign it to both `metalnessMap` and `roughnessMap`.
+
+---
+
+## MaterialX
+
+### Sources
+
+| Source                                                   | Type                     | Shader model       |
+| -------------------------------------------------------- | ------------------------ | ------------------ |
+| [ambientCG](https://ambientcg.com/)                      | Texture-based            | `open_pbr_surface` |
+| [GPUOpen MaterialX Library](https://matlib.gpuopen.com/) | Procedural (baked)       | `standard_surface` |
+| [PolyHaven](https://polyhaven.com/)                      | Texture-based            | `standard_surface` |
+| [PhysicallyBased](https://physicallybased.info/)         | Parametric (no textures) | `open_pbr_surface` |
+
+Browse materials on the source websites, then load them by name.
+
+### `Material.{source}.load(name, resolution="1K") -> Material`
+
+Download, convert, and cache a material.
+
+```python
+from threejs_materials import Material
+
+mat = Material.gpuopen.load("Car Paint", resolution="1K")
+mat = Material.ambientcg.load("Onyx015", resolution="1K")
+mat = Material.polyhaven.load("plank_flooring_04", resolution="1K")
+mat = Material.physicallybased.load("Titanium")
+```
+
+The first call downloads and converts the material (takes a few seconds). Subsequent calls return the cached JSON instantly from `~/.materialx-cache/`.
+
+#### Resolution
+
+Pass a normalized resolution (`1K`, `2K`, `4K`, `8K` — case-insensitive). Each source maps it to its native format:
+
+| Input | GPUOpen | ambientCG | PolyHaven | PhysicallyBased |
+| ----- | ------- | --------- | --------- | --------------- |
+| 1K    | 1k 8b   | 1K-PNG    | 1k        | n/a             |
+| 2K    | 2k 8b   | 2K-PNG    | 2k        | n/a             |
+| 4K    | 4k 8b   | 4K-PNG    | 4k        | n/a             |
+| 8K    | —       | 8K-PNG    | 8k        | n/a             |
+
+PhysicallyBased materials are parametric — no resolution needed (and not accepted).
+
+### `Material.list_sources()`
+
+Print available sources with clickable URLs.
+
+```python
+from threejs_materials import Material
+
+Material.list_sources()
+# Material sources:
+#   Material.ambientCG        https://ambientcg.com/list?type=material
+#   Material.GPUOpen          https://matlib.gpuopen.com/main/materials/all
+#   Material.PolyHaven        https://polyhaven.com/textures
+#   Material.PhysicallyBased  https://physicallybased.info/
+```
+
+### `Material.from_mtlx(mtlx_file) -> Material`
+
+Convert a local `.mtlx` file without downloading anything.
+
+```python
+from threejs_materials import Material
+
+mat = Material.from_mtlx("examples/gpuo-car-paint.mtlx")
+```
+
+Texture paths in the `.mtlx` are resolved relative to the file's location.
+
+### Conversion pipeline
+
+When a material is loaded:
+
+1. **Download** — source-specific: fetch ZIP (ambientCG, GPUOpen), individual files (PolyHaven), or generate from parameters (PhysicallyBased)
+2. **Bake** — run MaterialX `TextureBaker` (GLSL preferred, MSL fallback on macOS) to flatten procedural graphs into texture images
+3. **Fallback merge** — if the baker can't handle certain textures, merge from the original document
+4. **EXR to PNG** — convert any EXR textures to 8-bit PNG
+5. **Extract** — map shader inputs to `MeshPhysicalMaterial` properties with base64-encoded textures
+6. **Cache** — write JSON to `~/.materialx-cache/`
+
+### Cache
+
+Converted materials are cached as flat JSON files in `~/.materialx-cache/`:
+
+```
+~/.materialx-cache/
+    gpuopen_car_paint_1k_8b.json
+    ambientcg_onyx015_1k-png.json
+    polyhaven_plank_flooring_04_1k.json
+    physicallybased_titanium.json
+```
+
+To force re-conversion, delete the cached file and call `.load()` again.
+
+### Shader model coverage
+
+Supported models: `standard_surface`, `gltf_pbr`, `open_pbr_surface`. Other models produce empty output with a logged warning.
+
+| Feature          | standard_surface                        | gltf_pbr                 | open_pbr_surface         |
+| ---------------- | --------------------------------------- | ------------------------ | ------------------------ |
+| Base color       | Yes                                     | Yes                      | Yes                      |
+| Metalness        | Yes                                     | Yes                      | Yes                      |
+| Roughness        | Yes                                     | Yes                      | Yes                      |
+| Normal map       | Yes                                     | Yes                      | Yes                      |
+| Specular         | Yes (weight, color, IOR)                | Yes (weight, color, IOR) | Yes (weight, color, IOR) |
+| Transmission     | Yes                                     | Yes (+ attenuation)      | Yes (+ attenuation)      |
+| Emission         | Yes                                     | Yes                      | Yes                      |
+| Clearcoat        | Yes                                     | Yes                      | Yes                      |
+| Clearcoat normal | Yes                                     | Yes                      | Yes                      |
+| Sheen            | Yes                                     | Yes                      | Yes (fuzz)               |
+| Iridescence      | Yes                                     | Yes                      | Yes                      |
+| Anisotropy       | Yes (scalar — no Three.js strength map) | Yes                      | Yes                      |
+| Opacity          | Yes                                     | Yes (alpha/alpha_mode)   | Yes (geometry_opacity)   |
+| Displacement     | Yes (model-independent)                 | Yes                      | Yes                      |
+| Dispersion       | No                                      | Yes                      | Yes                      |
+| Normal scale     | No (baked into texture)                 | Yes                      | No (baked into texture)  |
+| Thin-walled      | No                                      | No                       | Yes (→ DoubleSide)       |
+| Subsurface       | No                                      | No                       | No                       |
+
+Subsurface scattering is not mapped — Three.js `MeshPhysicalMaterial` has no SSS support.
+
+### MaterialX limitations
+
+#### Materials
+
+- **Single material per document** — only the first material is used when a `.mtlx` file contains multiple materials. A warning is logged.
+- **First shader node** — if a material has multiple shader nodes (e.g. surface + volume), only the first surface shader is extracted.
+
+#### Baking
+
+- **8-bit textures** — the TextureBaker uses `UINT8` output. HDR information (emissive, HDR environment lighting baked into textures) is clamped to [0,1]. This is acceptable for web preview but lossy for physically accurate emissive maps.
+- **Global bake lock** — baking operations are serialized via a `threading.Lock` because the MaterialX baker requires `os.chdir`. This is thread-safe but becomes a bottleneck under concurrent load. The lock is per-process only (`threading.Lock`, not `multiprocessing.Lock`).
+- **Geometry-dependent nodes** — procedurals driven by `<position>`, `<normal>`, or `<tangent>` cannot be baked (the baker renders on a flat UV quad with no 3D geometry).
+
+#### Image tracing
+
+- **Single upstream image** — `find_upstream_image` returns the first image node found when walking upstream. Complex graphs with multiple images (layered blends, channel packing before baking) will only capture one image. After baking, this is fine since the baker flattens everything to single `<image>` nodes.
+- **No channel extraction tracking** — when an image passes through `extract` or `swizzle` nodes, the specific channel being used is not recorded. The consumer must know glTF metallicRoughness packing conventions (G=roughness, B=metalness).
+
+#### EXR conversion
+
+- **LDR clamp** — EXR textures are clamped to [0,1] and converted to 8-bit PNG. Dynamic range beyond 1.0 is lost.
+- **Channel naming** — EXR files with non-standard channel names (not R/G/B/A) fall back to source-order channel selection, which may produce incorrect color mappings for unusual EXR layouts.
+
+#### Network
+
+- **No retry logic** — a single network failure raises an exception. The caller is responsible for retries.
+- **GPUOpen pagination** — the material search assumes all results fit in one API page. Materials not in the first page may not be found.
+- **GPUOpen sequential package lookup** — each package UUID is queried individually; materials with many packages may be slow to resolve.
+
+#### Caching
+
+- **No cache invalidation** — cached materials are never automatically refreshed. Delete the cache file manually to force re-conversion.
+
+---
+
+## USD
+
+For Blender users and other USD workflows: `Material.from_usd()` reads `UsdPreviewSurface` materials directly from USD files. No MaterialX baking is needed since UsdPreviewSurface is already a flat PBR shader.
+
+### `Material.from_usd(usd_file) -> Material`
+
+Load a USD file (`.usda`, `.usdc`, `.usdz`) with `UsdPreviewSurface` materials.
+
+```python
+from threejs_materials import Material
+
+mat = Material.from_usd("model.usda")
+```
+
+Textures are resolved relative to the file location. USDZ archives with embedded textures are supported. Both metallic and specular workflows are handled (`useSpecularWorkflow` input).
+
+### UsdPreviewSurface input mapping
+
+| UsdPreviewSurface input | Output property      | Notes                              |
+| ----------------------- | -------------------- | ---------------------------------- |
+| `diffuseColor`          | `color`              | value + texture                    |
+| `metallic`              | `metalness`          | value + texture                    |
+| `roughness`             | `roughness`          | value + texture                    |
+| `normal`                | `normal`             | texture only                       |
+| `emissiveColor`         | `emissive`           | value + texture                    |
+| `clearcoat`             | `clearcoat`          | value only                         |
+| `clearcoatRoughness`    | `clearcoatRoughness` | value only                         |
+| `ior`                   | `ior`                | value only                         |
+| `occlusion`             | `ao`                 | texture only                       |
+| `displacement`          | `displacement`       | texture only                       |
+| `opacity`               | `opacity`            | + `transparent: true` if < 1       |
+| `opacityThreshold`      | `alphaTest`          | mask/cutout mode                   |
+| `specularColor`         | `specularColor`      | only if `useSpecularWorkflow == 1` |
+
+Inputs at their UsdPreviewSurface default value are omitted from the output.
+
+### USD limitations
+
+- **Single material per file** — only the first `UsdPreviewSurface` material is used when a file contains multiple materials. A warning is logged.
+- **No UV transform support** — `UsdTransform2d` nodes are not read; texture coordinates are assumed to be used as-is.
+- **Emission intensity** — UsdPreviewSurface has no emission intensity input; `emissiveColor` maps directly to `emissive`.

threejs_materials-0.2.0/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "threejs-materials"
+version = "0.2.0"
+# version also managed by [tool.bumpversion] below
+description = "Download PBR materials on demand and convert to Three.js MeshPhysicalMaterial JSON"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+dependencies = [
+    "materialx>=1.39.4",
+    "requests>=2.31.0",
+    "openexr>=3.3",
+    "pillow>=10.0",
+]
+
+[project.optional-dependencies]
+usd = ["usd-core>=24.11"]
+test = ["pytest"]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# bump-my-version settings
+
+[tool.bumpversion]
+current_version = "0.2.0"
+commit = false
+tag = false
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+serialize = ["{major}.{minor}.{patch}"]
+allow_dirty = true
+message = "Bump version: {current_version} → {new_version}"
+search = "{current_version}"
+replace = "{new_version}"
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

threejs_materials-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

threejs_materials-0.2.0/src/threejs_materials/__init__.py

@@ -0,0 +1,4 @@
+from threejs_materials.library import Material
+from threejs_materials.convert import encode_texture_base64
+
+__all__ = ["Material", "encode_texture_base64"]