WIP: MaterialX addon #104594

Bogdan Nagirniak · 2023-05-09T15:35:13+02:00

Bogdan Nagirniak commented

2023-05-09 15:35:13 +02:00

Purpose

This PR continues implementation of https://archive.blender.org/developer/D16044
As part of Hydra Render engine we are providing MaterialX Blender addon.

Features

Adds new MaterialX nodes to the existing Shader editor. MaterialX nodes are generated from MaterialX XML spec.
Users can compose Shader nodegraph combining both: Blender nodes and MaterialX nodes.
Allows import of MaterialX XML files.
Allows export Shader nodegraph to MaterialX XML file. Currently support limited number of most used shading nodes.
Provides python API to export Shader nodegraph to MaterialX document. It is used in Hydra Render engine.

Notes

New addon is in TESTING status.

How it works

When addon starts, it generates python code with MaterialX nodes. Generated *.py files are lay in <user addons dir>/materialx_data/materialx_nodes.

Screenshots

List of new MaterialX nodes in Shader editor

Tools for Import/Export .mtlx file:

Exported .mtlx to Shader editor:

### Purpose This PR continues implementation of https://archive.blender.org/developer/D16044 As part of [Hydra Render engine](https://projects.blender.org/blender/blender/pulls/104712) we are providing MaterialX Blender addon. ### Features - Adds new MaterialX nodes to the existing Shader editor. MaterialX nodes are generated from MaterialX XML spec. - Users can compose Shader nodegraph combining both: Blender nodes and MaterialX nodes. - Allows import of MaterialX XML files. - Allows export Shader nodegraph to MaterialX XML file. Currently support limited number of most used shading nodes. - Provides python API to export Shader nodegraph to MaterialX document. It is used in [Hydra Render engine](https://projects.blender.org/blender/blender/pulls/104712). ### Notes New addon is in TESTING status. ### How it works When addon starts, it generates python code with MaterialX nodes. Generated `*.py` files are lay in `<user addons dir>/materialx_data/materialx_nodes`. ### Screenshots List of new MaterialX nodes in Shader editor ![Screenshot 2023-05-09 162457.png](/attachments/82583a61-ebb0-4613-9613-54f393dc026a) Tools for Import/Export `.mtlx` file: ![Screenshot 2023-05-09 162652.png](/attachments/a076e1d0-70e3-4b90-a9d5-eb6165dcbfb7) Exported `.mtlx` to Shader editor: ![Screenshot 2023-05-09 163158.png](/attachments/5727ffff-be54-4dc9-9d77-7d77ba3fa8b2)

Screenshot 2023-05-09 163158.png

95 KiB

Screenshot 2023-05-09 162457.png

132 KiB

Screenshot 2023-05-09 162652.png

14 KiB

Bogdan Nagirniak added 27 commits 2023-05-09 15:35:15 +02:00

Create basic MaterialX addon: c78738087b

- Created basic structure of MaterialX addon
- Added MxNode related classes, generate_node_classes.py, categories.py.
- Added preferences.py, node_tree.py
- Added basic UI for MX node tree
- Added materialx libraries

BLEN-215: Move node classes generation code to Appdata (#1 ) e50fcd0df3

Added constant variables ADDON_DATA_DIR, NODE_CLASSES_FOLDER, MX_LIBS_DIR.
Added generate_init_code function to create __init__.py for node_classes.
Small fixes.

BLEN-216: Matlib implementation (#2 ) a83e948bb8

Added mathlib module, with ui.py and manager.py.
Added properties module.
Added class MaterialXProperties to be used as a parent for addon PropertyGroups. It sets "materialx" property as parent for addon properties (bpy.context.window_manager.materialx. ...) Added constant variables MATLIB_FOLDER, MATLIB_DIR, currently, it is set to save matlib to addon appdata folder.

Code cleanups (#4 ) d2fc8f497c

Renamed ADDON_PREFIX to ADDON_ALIAS, made it to use in properties. Made code improvements.

BLEN-217: MaterialX panel in material tab (#3 ) 23bc2562fc

Added drawing MaterialX Node Tree inside Material panel.

Co-authored-by: Bogdan Nagirniak <bnagirniak@luxoft.com>

BLEN-218: Add some tools to preferences (#5 ) c677f9dfe7

Implemented AddonPreferences with log_level and dev_tools options.
Changed appdata folder name: materialx -> materiax_data

BLEN-219: Export blender nodes to MX nodes (#6 ) 8c3745c394

* BLEN-219: Export blender nodes to MX nodes.
Added bl_node module.
Added bl_node.nodes module:
- color.py
- converter.py
- input.py
- output.py
- shader.py
- texture.py
- vector.py

Moved manager.URL to utils.MATLIB_URL.
Remove redundant code from material.ui.
Code cleanup.

BLEN-221: Code cleanups, UI improvements (#7 ) cc589bc916

Made UI improvements: removed unused panels, fixed text, etc.
Made code cleanups and improvements, removed unused code.
Refactoring: moved NodeParser node classes to bl_nodes folder.
Fixed some TODOs.

BLEN-222: Make node link invalid if connects different types (#8 ) 3f18d03ae9

* BLEN-222: Mike node link invalid if connects different types.
Registered timer for update_links.

Co-authored-by: Bogdan Nagirniak <bnagirniak@luxoft.com>

BLEN-226: Finalizing MaterialX addon. (#9 ) 2b3e80a3a2

More fixes and cleanups.
Implemented showing MxNodeTree node editor when mx_node_tree is changed.
Fixed loading materialx from matlib.

BLEN-229: Adjust code to integrated MaterialX library (#10 ) c4e887d5a6

Removed default libraries files.
Fixed export Material editor and MaterialX editor to file.

BLEN-235: Use MaterialX addon instead mx related code. (#11 ) eaac854bd1

Added get_materialx_data method.

added clear_temp_dir on Blender exit (#13 ) abcd6a82d1

BLEN-245: Fix assign materials: blender shader, materiax (#12 ) c5b73128df

Merge branch 'master' into materialx-addon 996764f666

BLEN-264: Basic integration MaterialX nodes into Blender shader nodetree (#14 ) e9826b3008

All MaterialX nodes moved to Blender shader node tree.
MaterialX nodes and Blender nodes now work between each other.
It is possible to have MaterialX surfacematerial node or Blender Material Output node for material (both works).
Moved functions import, export, print to console to Blender shader node tree.
Removed: online MatX library, unused code, MatX properties
Moved materialx/ui.py -> ui.py. deleted folder "material". small improvements

Co-authored-by: markyandex@gmail.com <markyandex@gmail.com>

BLEN-233: Support MaterialX 1.38.5 (#15 ) dfa1db9e31

Added caching of MaterialX Document
Changes:
    getOutput -> getActiveOutput
    getOutputs-> getActiveOutputs
    getInput -> getActiveInput
    getInputs-> getActiveInputs

Co-authored-by: markyandex@gmail.com <markyandex@gmail.com>

Refactoring (#16 ) 7913e6fbae

Changed description of addon and moved preference's register/unregister functions to preferences.py

Co-authored-by: markyandex@gmail.com <markyandex@gmail.com>

BLEN-294: Assign MaterialX materials (#17 ) 641fdcd5d4

BLEN-321: Fix export to mtlx with dependencies
Fixed code in utils.export_to_file() (renamed from export_mx_to_file()).
Made code cleanups/improvements.

Fixed to use materialx folder in blender (#18 ) ba72037bb5

Merge branch 'master' into materialx-addon 7e65e8a969

Merge branch 'main' into materialx-addon 166cd20e89

BLEN-350: Fix error with Add shader node 61dd62cb6d

* Fixed generation of MaterialX nodes
* Fixed nodes `add` and `mix`
* Adjust code for other nodes to fit new requirements

**NOTE FOR REVIEWERS**
You need to regenerate MaterialX nodes for this PR

Pull Request #3

BLEN-358: Error in console after closing Blender bcc93b0452

**TECHNICAL STEPS**
Added check for input types and warnings if input has inappropriate type. This check added for `Mix` and `Add` nodes for now.

Pull Request BogdanNagirniak/blender-addons#4

Adjust generating node classes and searching of mtlx files c218b6543d

### Purpose
Folder `materialx` with mtlx files moved to blender.shared in Windows.

### Technical steps
Make FILE_PATH in generated node classes to be local for MX_LIBS_DIR and MX_ADDON_LIBS_DIR.
Added blender.shared to BL_DATA_DIR for Windows.

Pull Request BogdanNagirniak/blender-addons#7

Merge branch 'main' into materialx-addon 1423d21450

Extend list of supported formats due to enable OIIO for USD. 1bfb4ef94f

### Purpose
Extend list of supported formats due to enable OIIO for USD.

### Techical steps
Extend SUPPORTED_FORMATS with `".exr", ".open_exr", ".tif", ".tiff", ".zfile", ".tx"`

Pull Request BogdanNagirniak/blender-addons#8

Bogdan Nagirniak requested review from Brecht Van Lommel 2023-05-09 15:36:05 +02:00

Bogdan Nagirniak requested review from Brian Savery (AMD) 2023-05-09 15:36:05 +02:00

Brecht Van Lommel commented

2023-05-09 15:58:20 +02:00

The design of this is different than we agreed on, so I'm confused about what the plan is here? Is this really meant as the implementation we ship with Blender?

For reference: in conversation at the Blender Conference we agreed that the nodes should be implemented natively in C/C++ as shader nodes, and that we should add new native socket types where needed, rather than having a completely separate node system for MaterialX.
blender/blender#100894 (comment)

The design of this is different than we agreed on, so I'm confused about what the plan is here? Is this really meant as the implementation we ship with Blender? > For reference: in conversation at the Blender Conference we agreed that the nodes should be implemented natively **in C/C++** as shader nodes, and that we should add **new native socket types** where needed, rather than having a completely separate node system for MaterialX. https://projects.blender.org/blender/blender/issues/100894#issuecomment-106110

Brian Savery (AMD) reviewed 2023-05-10 00:48:43 +02:00

Brian Savery (AMD) left a comment

I guess my main comment is on the mechanism of generating the .py files for materialx nodes. Why are they generated on the user side and not something done once.

materialx/libraries/alglib/alglib_defs.mtlx Outdated

						
				@ -0,0 +1,93 @@

				<?xml version="1.0"?>

Brian Savery (AMD) commented

2023-05-10 00:46:32 +02:00

Why are these node defs being included?

Bogdan Nagirniak added 1 commit 2023-05-10 18:14:18 +02:00

Removed alglib .mtlx as not needed 3f7a4984e3

### Purpose
`alglib` .mtlx files are not needed, it can be removed.

### Technical steps
- Removed `libraries` folder
- Removed `alglib_defs.mtlx` from node code generation.

Pull Request BogdanNagirniak/blender-addons#9

Bogdan Nagirniak referenced this pull request from blender/blender

2023-05-26 18:37:16 +02:00

Hydra render engine #104712

Bogdan Nagirniak added 1 commit 2023-06-13 18:51:43 +02:00

Caching generated image leads to infinite loop in preview render 5103b7f446

### Purpose
Fix infinite loop in preview render when generated image cached.

### Technical steps
Caching images moved from python to C++ part so caching no more triggers Depsgraph updates;

Co-authored-by: Bogdan Nagirniak <bodyan@gmail.com>
Pull Request BogdanNagirniak/blender-addons#15

Bogdan Nagirniak added 1 commit 2023-08-28 14:58:54 +02:00

Merge branch 'main' into materialx-addon 7bb38d8687

Bogdan Nagirniak added 1 commit 2023-09-13 12:52:54 +02:00

Merge branch 'main' into materialx-addon 98f3666ca6

Ashley commented

2023-09-24 13:28:06 +02:00

First-time contributor

I've been attempting to try out this addon but have been running into errors registering the nodes: ValueError: register_class(...): already registered as a subclass 'MxNode_STD_convert'. Perhaps there's a mismatch between the materialx version I'm using and what this addon supports? What version are you testing it with?

I've been attempting to try out this addon but have been running into errors registering the nodes: `ValueError: register_class(...): already registered as a subclass 'MxNode_STD_convert'`. Perhaps there's a mismatch between the materialx version I'm using and what this addon supports? What version are you testing it with?

Bogdan Nagirniak commented

2023-09-24 20:04:45 +02:00

Sorry, this PR has to be closed. MaterialX is going to be supported natively by Blender. Here is PR blender/blender#111765 which converts Blender material nodes to MaterialX, which is going to be merged.

Sorry, this PR has to be closed. MaterialX is going to be supported natively by Blender. Here is PR https://projects.blender.org/blender/blender/pulls/111765 which converts Blender material nodes to MaterialX, which is going to be merged.

Bogdan Nagirniak closed this pull request

2023-09-24 20:04:45 +02:00