Skip to content

Commit 52faf46

Browse files
authored
Bump package version to match USD: 0.25.05. (#28)
- Update workflow name and add tag to readme - Update readme with build info. - Rebuild docs.
1 parent 61d065e commit 52faf46

33 files changed

Lines changed: 605 additions & 331 deletions

.github/workflows/static.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# Simple workflow for deploying static content to GitHub Pages
2-
name: Deploy static content to Pages
1+
name: Build and Deploy
32

43
on:
54
# Runs on pushes targeting the default branch

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
## MaterialX USD Utilities
22

3-
This is a Github <a href="https://github.com/kwokcb/materialxusd">repository</a> of utilities related to MaterialX and USD.
3+
<a href="https://github.com/kwokcb/materialxusd/actions">
4+
<img src="https://github.com/kwokcb/materialxusd/actions/workflows/static.yml/badge.svg" alt="GitHub Actions Status">
5+
</a>
6+
7+
This is a Github <a href="https://github.com/kwokcb/materialxusd">repository</a> of utilities related to MaterialX and USD. The corresponding web site is <a href="https://kwokcb.github.io/materialxusd/">here</a>
8+
9+
The utilities and results use the `25.05` version of OpenUSD which is sync'ed to MaterialX version `1.39.3`.
410

511
This can be hooked into the larger interoperability picture with glTF / MaterialX and USD as shown in the example below:
612

documents/Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ PROJECT_NAME = MaterialXUSD
4848
# could be handy for archiving the generated documentation or if some version
4949
# control system is used.
5050

51-
PROJECT_NUMBER = 0.0.1
51+
PROJECT_NUMBER = 0.25.05
5252

5353
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5454
# for a project that appears at the top of each page and should give viewer a

documents/html/classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities-members.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,11 @@
123123
<tr class="odd"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#abf336b04d1bcf9b6c77cd2c3d520471c">encapsulate_top_level_nodes</a>(self, mx.Document doc, str nodegraph_name=&quot;top_level_nodes&quot;, bool remove_original=True)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
124124
<tr class="even"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#aadb11d04e3718ca4874707af77c66703">encapsulate_top_level_nodes_file</a>(self, str input_path, str new_input_path, str nodegraph_name='top_level_nodes', bool remove_original_nodes=True)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
125125
<tr class="odd"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#aadfbb34633aacafb0c2a9b05116165cc">get_standard_libraries</a>(self)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
126-
<tr class="even"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#aecffc179fd921ca0a420a53b7d675cf9">load_standard_libraries</a>(self)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
127-
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>logger</b> (defined in <a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a>)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
128-
<tr class="even"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#a523bca6eb5bb2f1da5f334f3844e0572">resolve_image_file_paths</a>(self, mx.Document doc, mx.FileSearchPath search_paths)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
129-
<tr class="odd"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#aa3206ef4975e308bfcf1538cfb8a92bf">write_document</a>(self, mx.Document doc, str path)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
126+
<tr class="even"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#a06c40ebea4a29f193468100d95441d67">has_time_frame_nodes</a>(self, mx.Document doc)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
127+
<tr class="odd"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#aecffc179fd921ca0a420a53b7d675cf9">load_standard_libraries</a>(self)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
128+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>logger</b> (defined in <a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a>)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
129+
<tr class="odd"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#a523bca6eb5bb2f1da5f334f3844e0572">resolve_image_file_paths</a>(self, mx.Document doc, mx.FileSearchPath search_paths)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
130+
<tr class="even"><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#aa3206ef4975e308bfcf1538cfb8a92bf">write_document</a>(self, mx.Document doc, str path)</td><td class="entry"><a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></td><td class="entry"></td></tr>
130131
</table></div><!-- contents -->
131132
</div><!-- doc-content -->
132133
<!-- HTML footer for doxygen 1.12.0-->

documents/html/classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,9 @@
158158
<tr class="memitem:aadb11d04e3718ca4874707af77c66703" id="r_aadb11d04e3718ca4874707af77c66703"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aadb11d04e3718ca4874707af77c66703">encapsulate_top_level_nodes_file</a> (self, str input_path, str new_input_path, str nodegraph_name='top_level_nodes', bool remove_original_nodes=True)</td></tr>
159159
<tr class="memdesc:aadb11d04e3718ca4874707af77c66703"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encapsulate top level nodes in a nodegraph. <br /></td></tr>
160160
<tr class="separator:aadb11d04e3718ca4874707af77c66703"><td class="memSeparator" colspan="2">&#160;</td></tr>
161+
<tr class="memitem:a06c40ebea4a29f193468100d95441d67" id="r_a06c40ebea4a29f193468100d95441d67"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a06c40ebea4a29f193468100d95441d67">has_time_frame_nodes</a> (self, mx.Document doc)</td></tr>
162+
<tr class="memdesc:a06c40ebea4a29f193468100d95441d67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the MaterialX document has any time or frame nodes. <br /></td></tr>
163+
<tr class="separator:a06c40ebea4a29f193468100d95441d67"><td class="memSeparator" colspan="2">&#160;</td></tr>
161164
</table><table class="memberdecls">
162165
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
163166
Public Attributes</h2></td></tr>
@@ -987,8 +990,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#aadb11d04e3718ca4874707af
987990
<div class="line"><span class="lineno"> 548</span> <span class="keywordflow">return</span> doc </div>
988991
<div class="line"><span class="lineno"> 549</span> <span class="keywordflow">return</span> <span class="keywordtype">None</span></div>
989992
<div class="line"><span class="lineno"> 550</span> </div>
990-
<div class="line"><span class="lineno"> 551</span> </div>
991-
<div class="line"><span class="lineno"> 552</span> </div>
992993
</div><!-- fragment -->
993994
</div>
994995
</div>
@@ -1021,6 +1022,50 @@ <h2 class="memtitle"><span class="permalink"><a href="#aadfbb34633aacafb0c2a9b05
10211022
</div><!-- fragment -->
10221023
</div>
10231024
</div>
1025+
<a id="a06c40ebea4a29f193468100d95441d67" name="a06c40ebea4a29f193468100d95441d67"></a>
1026+
<h2 class="memtitle"><span class="permalink"><a href="#a06c40ebea4a29f193468100d95441d67">&#9670;&#160;</a></span>has_time_frame_nodes()</h2>
1027+
1028+
<div class="memitem">
1029+
<div class="memproto">
1030+
<table class="memname">
1031+
<tr>
1032+
<td class="memname">materialxusd.materialxusd_utils.MaterialXUsdUtilities.has_time_frame_nodes </td>
1033+
<td>(</td>
1034+
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>self</em></span>, </td>
1035+
</tr>
1036+
<tr>
1037+
<td class="paramkey"></td>
1038+
<td></td>
1039+
<td class="paramtype">mx.Document</td> <td class="paramname"><span class="paramname"><em>doc</em></span>&#160;)</td>
1040+
</tr>
1041+
</table>
1042+
</div><div class="memdoc">
1043+
1044+
<p>Check if the MaterialX document has any time or frame nodes. </p>
1045+
<dl class="params"><dt>Parameters</dt><dd>
1046+
<table class="params">
1047+
<tr><td class="paramname">doc</td><td>The MaterialX document. </td></tr>
1048+
</table>
1049+
</dd>
1050+
</dl>
1051+
<dl class="section return"><dt>Returns</dt><dd>True if time or frame nodes are found, False otherwise. </dd></dl>
1052+
1053+
<p class="definition">Definition at line <a class="el" href="materialxusd__utils_8py_source.html#l00551">551</a> of file <a class="el" href="materialxusd__utils_8py_source.html">materialxusd_utils.py</a>.</p>
1054+
<div class="fragment"><div class="line"><span class="lineno"> 551</span> <span class="keyword">def </span>has_time_frame_nodes(self, doc : mx.Document):</div>
1055+
<div class="line"><span class="lineno"> 552</span> <span class="stringliteral">&#39;&#39;&#39;</span></div>
1056+
<div class="line"><span class="lineno"> 553</span><span class="stringliteral"> @brief Check if the MaterialX document has any time or frame nodes.</span></div>
1057+
<div class="line"><span class="lineno"> 554</span><span class="stringliteral"> @param doc The MaterialX document.</span></div>
1058+
<div class="line"><span class="lineno"> 555</span><span class="stringliteral"> @return True if time or frame nodes are found, False otherwise.</span></div>
1059+
<div class="line"><span class="lineno"> 556</span><span class="stringliteral"> &#39;&#39;&#39;</span></div>
1060+
<div class="line"><span class="lineno"> 557</span> <span class="keywordflow">for</span> elem <span class="keywordflow">in</span> doc.traverseTree():</div>
1061+
<div class="line"><span class="lineno"> 558</span> <span class="keywordflow">if</span> elem.isA(mx.Node):</div>
1062+
<div class="line"><span class="lineno"> 559</span> <span class="keywordflow">if</span> elem.getCategory() <span class="keywordflow">in</span> [<span class="stringliteral">&#39;time&#39;</span>, <span class="stringliteral">&#39;frame&#39;</span>]:</div>
1063+
<div class="line"><span class="lineno"> 560</span> <span class="keywordflow">return</span> <span class="keyword">True</span> </div>
1064+
<div class="line"><span class="lineno"> 561</span> <span class="keywordflow">return</span> <span class="keyword">False</span> </div>
1065+
<div class="line"><span class="lineno"> 562</span> </div>
1066+
</div><!-- fragment -->
1067+
</div>
1068+
</div>
10241069
<a id="aecffc179fd921ca0a420a53b7d675cf9" name="aecffc179fd921ca0a420a53b7d675cf9"></a>
10251070
<h2 class="memtitle"><span class="permalink"><a href="#aecffc179fd921ca0a420a53b7d675cf9">&#9670;&#160;</a></span>load_standard_libraries()</h2>
10261071

documents/html/classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

documents/html/doxygen_crawl.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
<a href="mtlx2usd_8py_source.html"/>
1717
<a href="preprocess__mtlx_8py_source.html"/>
1818
<a href="usd__mtlx__ref_8py_source.html"/>
19+
<a href="md__d_1_2_work_2materialx_2materialxusd_2x.html"/>
1920
<a href="classmaterialxusd_1_1materialxusd_1_1_materialx_u_s_d_converter.html"/>
2021
<a href="classmaterialxusd_1_1materialxusd_1_1_materialx_u_s_d_converter-members.html"/>
2122
<a href="namespacematerialxusd_1_1materialxusd__custom.html"/>
@@ -27,6 +28,7 @@
2728
<a href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html"/>
2829
<a href="index.html"/>
2930
<a href="doxygen_crawl.html"/>
31+
<a href="pages.html"/>
3032
<a href="namespaces.html"/>
3133
<a href="annotated.html"/>
3234
<a href="classes.html"/>
@@ -42,6 +44,8 @@
4244
<a href="functions.html"/>
4345
<a href="functions.html"/>
4446
<a href="functions.html"/>
47+
<a href="functions.html"/>
48+
<a href="functions_func.html"/>
4549
<a href="functions_func.html"/>
4650
<a href="functions_func.html"/>
4751
<a href="functions_func.html"/>
@@ -89,6 +93,7 @@
8993
<a href="classmaterialxusd_1_1materialxusd__custom_1_1_mtlx_to_usd.html#ad804a7ee0c14d3d42da84f34798e21ea"/>
9094
<a href="classmaterialxusd_1_1materialxusd__custom_1_1_mtlx_to_usd.html#afdc4e8d9b675e070b2e9ed049b7d65fc"/>
9195
<a href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html"/>
96+
<a href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#a06c40ebea4a29f193468100d95441d67"/>
9297
<a href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#a2194295013b7d6301fd78142ec4f6486"/>
9398
<a href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#a523bca6eb5bb2f1da5f334f3844e0572"/>
9499
<a href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#a60a262ead97a38a9fe02cc5cf31cdeb6"/>
@@ -124,6 +129,7 @@
124129
<a href="materialxusd_8py_source.html"/>
125130
<a href="materialxusd__custom_8py_source.html"/>
126131
<a href="materialxusd__utils_8py_source.html"/>
132+
<a href="md__d_1_2_work_2materialx_2materialxusd_2x.html"/>
127133
<a href="mtlx2usd_8py_source.html"/>
128134
<a href="namespacematerialxusd_1_1materialxusd__custom.html"/>
129135
<a href="namespaces.html"/>

documents/html/functions.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,11 @@ <h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
157157
</ul>
158158

159159

160+
<h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
161+
<li>has_time_frame_nodes()&#160;:&#160;<a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#a06c40ebea4a29f193468100d95441d67">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></li>
162+
</ul>
163+
164+
160165
<h3><a id="index_l" name="index_l"></a>- l -</h3><ul>
161166
<li>load_standard_libraries()&#160;:&#160;<a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#aecffc179fd921ca0a420a53b7d675cf9">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></li>
162167
<li>log()&#160;:&#160;<a class="el" href="classmaterialxusd_1_1materialxusd__custom_1_1_mtlx_to_usd.html#a44db5220b8b8f74f27aee1fdbc6944eb">materialxusd.materialxusd_custom.MtlxToUsd</a></li>

documents/html/functions_func.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,11 @@ <h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
157157
</ul>
158158

159159

160+
<h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
161+
<li>has_time_frame_nodes()&#160;:&#160;<a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#a06c40ebea4a29f193468100d95441d67">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></li>
162+
</ul>
163+
164+
160165
<h3><a id="index_l" name="index_l"></a>- l -</h3><ul>
161166
<li>load_standard_libraries()&#160;:&#160;<a class="el" href="classmaterialxusd_1_1materialxusd__utils_1_1_material_x_usd_utilities.html#aecffc179fd921ca0a420a53b7d675cf9">materialxusd.materialxusd_utils.MaterialXUsdUtilities</a></li>
162167
<li>log()&#160;:&#160;<a class="el" href="classmaterialxusd_1_1materialxusd__custom_1_1_mtlx_to_usd.html#a44db5220b8b8f74f27aee1fdbc6944eb">materialxusd.materialxusd_custom.MtlxToUsd</a></li>

documents/html/glsl_vs_glslfx.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1236,7 +1236,7 @@ <h2 class="text-center">MaterialX RTS Comparison</h2>
12361236
<tr class='row'>
12371237
<td class='col-sm'>LamaLayerBSDFTest_glsl.png</td>
12381238
<td class='col-sm'>LamaLayerBSDFTest_glslfx.png</td>
1239-
<td class='col-sm'><p>GLSL vs. GLSLFXRMS: (RMS 0.01390)</p>
1239+
<td class='col-sm'><p>GLSL vs. GLSLFXRMS: (RMS 0.01311)</p>
12401240
</td><td class='col-sm'>Histogram: GLSL vs. GLSLFX</p>
12411241
</td>
12421242
</tr>
@@ -1593,7 +1593,7 @@ <h2 class="text-center">MaterialX RTS Comparison</h2>
15931593
<tr class='row'>
15941594
<td class='col-sm'>N_material_glsl.png</td>
15951595
<td class='col-sm'>N_material_glslfx.png</td>
1596-
<td class='col-sm'><p>GLSL vs. GLSLFXRMS: (RMS 0.01322)</p>
1596+
<td class='col-sm'><p>GLSL vs. GLSLFXRMS: (RMS 0.01366)</p>
15971597
</td><td class='col-sm'>Histogram: GLSL vs. GLSLFX</p>
15981598
</td>
15991599
</tr>

0 commit comments

Comments
 (0)