-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
463 lines (391 loc) · 12.8 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
<!DOCTYPE html>
<html>
<head>
<title>README.md</title>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
<style>
/* https://github.com/microsoft/vscode/blob/master/extensions/markdown-language-features/media/markdown.css */
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
body {
font-family: var(--vscode-markdown-font-family, -apple-system, BlinkMacSystemFont, "Segoe WPC", "Segoe UI", "Ubuntu", "Droid Sans", sans-serif);
font-size: var(--vscode-markdown-font-size, 14px);
padding: 0 26px;
line-height: var(--vscode-markdown-line-height, 22px);
word-wrap: break-word;
}
#code-csp-warning {
position: fixed;
top: 0;
right: 0;
color: white;
margin: 16px;
text-align: center;
font-size: 12px;
font-family: sans-serif;
background-color:#444444;
cursor: pointer;
padding: 6px;
box-shadow: 1px 1px 1px rgba(0,0,0,.25);
}
#code-csp-warning:hover {
text-decoration: none;
background-color:#007acc;
box-shadow: 2px 2px 2px rgba(0,0,0,.25);
}
body.scrollBeyondLastLine {
margin-bottom: calc(100vh - 22px);
}
body.showEditorSelection .code-line {
position: relative;
}
body.showEditorSelection .code-active-line:before,
body.showEditorSelection .code-line:hover:before {
content: "";
display: block;
position: absolute;
top: 0;
left: -12px;
height: 100%;
}
body.showEditorSelection li.code-active-line:before,
body.showEditorSelection li.code-line:hover:before {
left: -30px;
}
.vscode-light.showEditorSelection .code-active-line:before {
border-left: 3px solid rgba(0, 0, 0, 0.15);
}
.vscode-light.showEditorSelection .code-line:hover:before {
border-left: 3px solid rgba(0, 0, 0, 0.40);
}
.vscode-light.showEditorSelection .code-line .code-line:hover:before {
border-left: none;
}
.vscode-dark.showEditorSelection .code-active-line:before {
border-left: 3px solid rgba(255, 255, 255, 0.4);
}
.vscode-dark.showEditorSelection .code-line:hover:before {
border-left: 3px solid rgba(255, 255, 255, 0.60);
}
.vscode-dark.showEditorSelection .code-line .code-line:hover:before {
border-left: none;
}
.vscode-high-contrast.showEditorSelection .code-active-line:before {
border-left: 3px solid rgba(255, 160, 0, 0.7);
}
.vscode-high-contrast.showEditorSelection .code-line:hover:before {
border-left: 3px solid rgba(255, 160, 0, 1);
}
.vscode-high-contrast.showEditorSelection .code-line .code-line:hover:before {
border-left: none;
}
img {
max-width: 100%;
max-height: 100%;
}
a {
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
a:focus,
input:focus,
select:focus,
textarea:focus {
outline: 1px solid -webkit-focus-ring-color;
outline-offset: -1px;
}
hr {
border: 0;
height: 2px;
border-bottom: 2px solid;
}
h1 {
padding-bottom: 0.3em;
line-height: 1.2;
border-bottom-width: 1px;
border-bottom-style: solid;
}
h1, h2, h3 {
font-weight: normal;
}
table {
border-collapse: collapse;
}
table > thead > tr > th {
text-align: left;
border-bottom: 1px solid;
}
table > thead > tr > th,
table > thead > tr > td,
table > tbody > tr > th,
table > tbody > tr > td {
padding: 5px 10px;
}
table > tbody > tr + tr > td {
border-top: 1px solid;
}
blockquote {
margin: 0 7px 0 5px;
padding: 0 16px 0 10px;
border-left-width: 5px;
border-left-style: solid;
}
code {
font-family: Menlo, Monaco, Consolas, "Droid Sans Mono", "Courier New", monospace, "Droid Sans Fallback";
font-size: 1em;
line-height: 1.357em;
}
body.wordWrap pre {
white-space: pre-wrap;
}
pre:not(.hljs),
pre.hljs code > div {
padding: 16px;
border-radius: 3px;
overflow: auto;
}
pre code {
color: var(--vscode-editor-foreground);
tab-size: 4;
}
/** Theming */
.vscode-light pre {
background-color: rgba(220, 220, 220, 0.4);
}
.vscode-dark pre {
background-color: rgba(10, 10, 10, 0.4);
}
.vscode-high-contrast pre {
background-color: rgb(0, 0, 0);
}
.vscode-high-contrast h1 {
border-color: rgb(0, 0, 0);
}
.vscode-light table > thead > tr > th {
border-color: rgba(0, 0, 0, 0.69);
}
.vscode-dark table > thead > tr > th {
border-color: rgba(255, 255, 255, 0.69);
}
.vscode-light h1,
.vscode-light hr,
.vscode-light table > tbody > tr + tr > td {
border-color: rgba(0, 0, 0, 0.18);
}
.vscode-dark h1,
.vscode-dark hr,
.vscode-dark table > tbody > tr + tr > td {
border-color: rgba(255, 255, 255, 0.18);
}
</style>
<style>
/* Tomorrow Theme */
/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
/* Tomorrow Comment */
.hljs-comment,
.hljs-quote {
color: #8e908c;
}
/* Tomorrow Red */
.hljs-variable,
.hljs-template-variable,
.hljs-tag,
.hljs-name,
.hljs-selector-id,
.hljs-selector-class,
.hljs-regexp,
.hljs-deletion {
color: #c82829;
}
/* Tomorrow Orange */
.hljs-number,
.hljs-built_in,
.hljs-builtin-name,
.hljs-literal,
.hljs-type,
.hljs-params,
.hljs-meta,
.hljs-link {
color: #f5871f;
}
/* Tomorrow Yellow */
.hljs-attribute {
color: #eab700;
}
/* Tomorrow Green */
.hljs-string,
.hljs-symbol,
.hljs-bullet,
.hljs-addition {
color: #718c00;
}
/* Tomorrow Blue */
.hljs-title,
.hljs-section {
color: #4271ae;
}
/* Tomorrow Purple */
.hljs-keyword,
.hljs-selector-tag {
color: #8959a8;
}
.hljs {
display: block;
overflow-x: auto;
color: #4d4d4c;
padding: 0.5em;
}
.hljs-emphasis {
font-style: italic;
}
.hljs-strong {
font-weight: bold;
}
</style>
<style>
/*
* Markdown PDF CSS
*/
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe WPC", "Segoe UI", "Ubuntu", "Droid Sans", sans-serif, "Meiryo";
padding: 0 12px;
}
pre {
background-color: #f8f8f8;
border: 1px solid #cccccc;
border-radius: 3px;
overflow-x: auto;
white-space: pre-wrap;
overflow-wrap: break-word;
}
pre:not(.hljs) {
padding: 23px;
line-height: 19px;
}
blockquote {
background: rgba(127, 127, 127, 0.1);
border-color: rgba(0, 122, 204, 0.5);
}
.emoji {
height: 1.4em;
}
code {
font-size: 14px;
line-height: 19px;
}
/* for inline code */
:not(pre):not(.hljs) > code {
color: #C9AE75; /* Change the old color so it seems less like an error */
font-size: inherit;
}
/* Page Break : use <div class="page"/> to insert page break
-------------------------------------------------------- */
.page {
page-break-after: always;
}
</style>
<script src="https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.min.js"></script>
</head>
<body>
<script>
mermaid.initialize({
startOnLoad: true,
theme: document.body.classList.contains('vscode-dark') || document.body.classList.contains('vscode-high-contrast')
? 'dark'
: 'default'
});
</script>
<h1 id="materialx-json-io">MaterialX JSON I/O</h1>
<h2 id="contents">Contents</h2>
<ul>
<li><a href="#Introduction">Introduction</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#documentation">Documentation</a></li>
</ul>
<h2 id="introduction">Introduction</h2>
<p>This is a Python package for supporting interoperability of MaterialX documents by adding support conversion to / from a <code>JSON</code> representation.</p>
<p>The <code>JSON</code> representation is lossless and is targeted at integrations which prefer to use <code>JSON</code> as a data exchange format instead of <code>XML</code>.</p>
<h2 id="documentation">Documentation</h2>
<p>Visit the <strong><a href="https://kwokcb.github.io/materialxjson/index.html">home page</a></strong> for For further information about this package, including links to API documentation and a Jupyter notebook with sample code that expands on the basic <em>Usage</em> example.</p>
<h2 id="integrations">Integrations</h2>
<p>A plugin using this package is available as a sample as part of QuilitX as of <strong>this change</strong><br>
[https://github.com/PrismPipeline/QuiltiX/commit/e34ebfec22a334d323803b6797beb8db581ebb18].</p>
<h2 id="installation">Installation</h2>
<p>The Python package is losted on <strong><a href="https://pypi.org/project/materialxjson">PyPi</a></strong> and can be installed<br>
using `pip``:</p>
<pre class="hljs"><code><div>pip install materialxjson
</div></code></pre>
<p>or the <strong><a href="https://github.com/kwokcb/materialxjson">source repository</a></strong> can be cloned and the package built from the command line:</p>
<pre class="hljs"><code><div>python -m build
</div></code></pre>
<p>This will build a distribution folder called <code>dist</code> which contains a zip file which can be installed using:</p>
<pre class="hljs"><code><div>pip --install <name of zip>
</div></code></pre>
<h2 id="usage">Usage</h2>
<p>The following example shows bidirectional conversion:</p>
<ol>
<li>A MaterialX file in <code>XML</code> format is read in and written to a string in <code>JSON</code> format.</li>
<li>A MaterialX file in <code>JSON</code> format is read in and written to a string in <code>XML</code> format.</li>
</ol>
<p>Note that any <code>JSON</code> package can be used to perform <code>JSON</code> I/O. The <code>json</code> package is used by the utilities provided in this package.</p>
<h3 id="package-setup">Package Setup</h3>
<p>The <code>materialjson</code> package can be loaded as follows, along with MaterialX and json packages:</p>
<pre class="hljs"><code><div><span class="hljs-keyword">import</span> json
<span class="hljs-keyword">import</span> MaterialX <span class="hljs-keyword">as</span> mx
<span class="hljs-keyword">from</span> materialxjson <span class="hljs-keyword">import</span> core
</div></code></pre>
<h3 id="xml-to-json-format-conversion">XML to JSON Format Conversion</h3>
<p>A MaterialX document can be read in from an XML file as follows:</p>
<pre class="hljs"><code><div><span class="hljs-keyword">import</span> pkg_resources
<span class="hljs-comment"># Read in MaterialX file</span>
mtlxFileName = pkg_resources.resource_filename(<span class="hljs-string">'materialxjson'</span>, <span class="hljs-string">'data/standard_surface_default.mtlx'</span>)
doc = mx.createDocument()
mx.readFromXmlFile(doc, mtlxFileName)
</div></code></pre>
<p>and then converted to JSON format as follows by creating a <code>MaterialXJson</code> object and calling the <code>documentToJSON</code> method:</p>
<pre class="hljs"><code><div><span class="hljs-comment"># Create I/O handler</span>
mtlxjson = core.MaterialXJson()
<span class="hljs-comment"># Write to JSON format</span>
jsonObject = mtlxjson.documentToJSON(doc)
</div></code></pre>
<p>The contents of the JSON object can be extracted out using the <code>json</code> package as follows. (An indentation level of <code>2</code> is<br>
used to make the output more readable.)</p>
<pre class="hljs"><code><div><span class="hljs-comment"># Convert JSON object to JSON string</span>
jsonString = core.Util.jsonToJSONString(jsonObject)
</div></code></pre>
<h3 id="json-to-xml-format-conversion">JSON to XML Format Conversion</h3>
<p>A JSON file can be read in as follows. In this case we load the sample file included with the package:</p>
<pre class="hljs"><code><div><span class="hljs-comment"># Get file to load</span>
jsonFileName = pkg_resources.resource_filename(<span class="hljs-string">'materialxjson'</span>, <span class="hljs-string">'data/standard_surface_default_mtlx.json'</span>)
<span class="hljs-comment"># Load JSON file</span>
jsonObject = core.Util.readJson(jsonFileName)
</div></code></pre>
<p>The JSON object is then converted to a MaterialX document and written out to an XML string as follows:</p>
<pre class="hljs"><code><div><span class="hljs-comment"># Create I/O handler</span>
mtlxjson = core.MaterialXJson()
<span class="hljs-comment"># Read JSON object into document</span>
doc = mx.createDocument()
mtlxjson.documentFromJSON(jsonObject, doc)
<span class="hljs-comment"># Write to XML String</span>
docstring = core.Util.documentToXMLString(doc)
</div></code></pre>
<h2 id="caveats">Caveats</h2>
<p>The following are some caveats to be aware of when using this package:</p>
<ul>
<li>There is no equivalent support for "include files" for JSON conversion. The JSON representation is intended to be a single file representation.</li>
<li>XML comments are not preserved in the JSON representation.</li>
</ul>
<h2 id="author">Author</h2>
<ul>
<li>LinkedIn: <a href="https://www.linkedin.com/in/bernard-kwok/" target="_blank">Bernard Kwok</a></li>
<li>GitHub: <a href="https://github.com/kwokcb">kwokcb</a></li>
<li>Email: <a href="mailto:[email protected]">[email protected]</a></li>
</ul>
</body>
</html>