mirror of
https://github.com/lighttransport/tinyusdz.git
synced 2026-01-18 01:11:17 +01:00
MAJOR UPDATE: Complete MaterialX (.mtlx) file loading support in C++
## Key Changes:
### 1. Built-in MaterialX XML Parser (NEW)
Integrated secure, dependency-free parser from sandbox:
- src/mtlx-xml-tokenizer.{hh,cc} - Low-level XML tokenization
- src/mtlx-simple-parser.{hh,cc} - Lightweight DOM builder
- src/mtlx-dom.{hh,cc} - MaterialX-specific document model
- src/mtlx-usd-adapter.hh - pugixml-compatible adapter
**Benefits:**
- No external dependencies (replaces pugixml)
- Security focused: memory limits, bounds checking, XXE protection
- MaterialX optimized
- pugixml-compatible API for easy migration
**Security Features:**
- Max name length: 256 chars
- Max string: 64KB
- Max text: 1MB
- Max nesting: 1000 levels
- Safe entity handling
- No external file access
### 2. OpenPBR Surface Shader Support (NEW)
Added complete MtlxOpenPBRSurface struct to usdMtlx.hh:
- All 8 parameter groups (Base, Specular, Transmission, Coat, etc.)
- 40+ individual parameters
- Proper USD type mappings
- Type trait registration
### 3. MaterialX Import API (ENHANCED)
Updated src/usdMtlx.cc to use built-in parser:
- Replaced all pugi:: with tinyusdz::mtlx::pugi::
- ReadMaterialXFromString() - Load from XML string
- ReadMaterialXFromFile() - Load from file path
- ToPrimSpec() - Convert MaterialX to USD PrimSpec
- LoadMaterialXFromAsset() - USD asset reference support
### 4. Testing Infrastructure
Added comprehensive test suite:
- tests/feat/mtlx/test_mtlx_import.cc - Import test with examples
- Updated Makefile for both import and export tests
- Test with embedded OpenPBR MaterialX XML
- Command-line file loading support
### 5. Documentation
Created C++_MATERIALX_IMPORT.md with:
- Complete API documentation
- Usage examples for all import methods
- OpenPBR parameter reference
- Security features overview
- Migration guide from pugixml
- Test instructions
Updated MATERIALX-SUPPORT-STATUS.md:
- C++ import status changed from ❌ to ✅
- Built-in parser feature matrix
- Updated "What's Missing" section
- Comparison table updated
## Supported Features:
### Shader Types:
✅ OpenPBR Surface (open_pbr_surface) - FULL
✅ Autodesk Standard Surface (standard_surface) - FULL
✅ USD Preview Surface (UsdPreviewSurface) - FULL
### MaterialX Versions:
✅ 1.36, 1.37, 1.38
### File Formats:
✅ .mtlx XML files
✅ String-based XML
✅ USD asset references
## Files Changed:
- src/mtlx-*.{hh,cc}: 9 new parser files (+3,500 lines)
- src/usdMtlx.{hh,cc}: OpenPBR support, parser integration
- src/value-types.hh: Added TYPE_ID_IMAGING_MTLX_OPENPBRSURFACE
- tests/feat/mtlx/*: New import test and updated Makefile
- C++_MATERIALX_IMPORT.md: 400+ line documentation
- MATERIALX-SUPPORT-STATUS.md: Updated status
## API Example:
```cpp
#include "usdMtlx.hh"
tinyusdz::MtlxModel mtlx;
std::string warn, err;
// Load from file
bool success = tinyusdz::ReadMaterialXFromFile(
resolver, "material.mtlx", &mtlx, &warn, &err);
// Convert to USD
tinyusdz::PrimSpec ps;
tinyusdz::ToPrimSpec(mtlx, ps, &err);
```
## Testing:
```bash
cd tests/feat/mtlx
make
./test_mtlx_import
./test_mtlx_import path/to/your.mtlx
```
## Breaking Changes:
NONE - Backward compatible via pugixml adapter
## Migration:
Automatic - existing usdMtlx.cc code works without changes
TinyUSDZ now has COMPLETE MaterialX support at all layers:
✅ C++ Core (Import & Export)
✅ WASM Binding (Import & Export)
✅ Three.js Demo (Full Interactive)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
68 lines
4.4 KiB
YAML
68 lines
4.4 KiB
YAML
# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
|
|
# * For C, use cpp
|
|
# * For JavaScript, use typescript
|
|
# Special requirements:
|
|
# * csharp: Requires the presence of a .sln file in the project folder.
|
|
language: cpp
|
|
|
|
# whether to use the project's gitignore file to ignore files
|
|
# Added on 2025-04-07
|
|
ignore_all_files_in_gitignore: true
|
|
# list of additional paths to ignore
|
|
# same syntax as gitignore, so you can use * and **
|
|
# Was previously called `ignored_dirs`, please update your config if you are using that.
|
|
# Added (renamed) on 2025-04-07
|
|
ignored_paths: []
|
|
|
|
# whether the project is in read-only mode
|
|
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
|
|
# Added on 2025-04-18
|
|
read_only: false
|
|
|
|
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
|
|
# Below is the complete list of tools for convenience.
|
|
# To make sure you have the latest list of tools, and to view their descriptions,
|
|
# execute `uv run scripts/print_tool_overview.py`.
|
|
#
|
|
# * `activate_project`: Activates a project by name.
|
|
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
|
|
# * `create_text_file`: Creates/overwrites a file in the project directory.
|
|
# * `delete_lines`: Deletes a range of lines within a file.
|
|
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
|
|
# * `execute_shell_command`: Executes a shell command.
|
|
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
|
|
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
|
|
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
|
|
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
|
|
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
|
|
# * `initial_instructions`: Gets the initial instructions for the current project.
|
|
# Should only be used in settings where the system prompt cannot be set,
|
|
# e.g. in clients you have no control over, like Claude Desktop.
|
|
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
|
|
# * `insert_at_line`: Inserts content at a given line in a file.
|
|
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
|
|
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
|
|
# * `list_memories`: Lists memories in Serena's project-specific memory store.
|
|
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
|
|
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
|
|
# * `read_file`: Reads a file within the project directory.
|
|
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
|
|
# * `remove_project`: Removes a project from the Serena configuration.
|
|
# * `replace_lines`: Replaces a range of lines within a file with new content.
|
|
# * `replace_symbol_body`: Replaces the full definition of a symbol.
|
|
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
|
|
# * `search_for_pattern`: Performs a search for a pattern in the project.
|
|
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
|
|
# * `switch_modes`: Activates modes by providing a list of their names
|
|
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
|
|
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
|
|
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
|
|
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
|
|
excluded_tools: []
|
|
|
|
# initial prompt for the project. It will always be given to the LLM upon activating the project
|
|
# (contrary to the memories, which are loaded on demand).
|
|
initial_prompt: ""
|
|
|
|
project_name: "mtlx"
|