documents/notebook.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Example API Usage\n",
    "\n",
    "The following notebook shows some basic usage of the API."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### MaterialX to glTF Conversion Example\n",
    "\n",
    "The following example loads a test data MaterialX file and writes the results to glTF JSON output."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO:glTFMtlx:> Convert shader to glTF: Gltf_pbr. Category: gltf_pbr\n"
     ]
    },
    {
     "data": {
      "text/markdown": [
       "#### Converted glTF\n",
       "```json\n",
       "{\n",
       "  \"images\": [\n",
       "    {\n",
       "      \"uri\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADElEQVQI12P4z/AfAAQAAf/zKSWvAAAAAElFTkSuQmCC\",\n",
       "      \"name\": \"KHR_texture_procedural_fallback\"\n",
       "    }\n",
       "  ],\n",
       "  \"textures\": [\n",
       "    {\n",
       "      \"source\": 0\n",
       "    }\n",
       "  ],\n",
       "  \"extensions\": {\n",
       "    \"KHR_texture_procedurals\": {\n",
       "      \"procedurals\": [\n",
       "        {\n",
       "          \"name\": \"NG_main\",\n",
       "          \"nodetype\": \"nodegraph\",\n",
       "          \"type\": \"color3\",\n",
       "          \"inputs\": [\n",
       "            {\n",
       "              \"name\": \"uvtiling\",\n",
       "              \"nodetype\": \"input\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"value\": [\n",
       "                8.0,\n",
       "                8.0\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"name\": \"color1\",\n",
       "              \"nodetype\": \"input\",\n",
       "              \"type\": \"color3\",\n",
       "              \"value\": [\n",
       "                1.0,\n",
       "                0.094118,\n",
       "                0.031373\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"name\": \"color2\",\n",
       "              \"nodetype\": \"input\",\n",
       "              \"type\": \"color3\",\n",
       "              \"value\": [\n",
       "                0.035294,\n",
       "                0.090196,\n",
       "                0.878431\n",
       "              ]\n",
       "            }\n",
       "          ],\n",
       "          \"outputs\": [\n",
       "            {\n",
       "              \"name\": \"output_N_mtlxmix_out\",\n",
       "              \"nodetype\": \"output\",\n",
       "              \"type\": \"color3\",\n",
       "              \"node\": 0\n",
       "            }\n",
       "          ],\n",
       "          \"nodes\": [\n",
       "            {\n",
       "              \"name\": \"N_mtlxmix\",\n",
       "              \"nodetype\": \"mix\",\n",
       "              \"type\": \"color3\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"fg\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"color3\",\n",
       "                  \"input\": 1\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"bg\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"color3\",\n",
       "                  \"input\": 2\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"mix\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"float\",\n",
       "                  \"node\": 5\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"color3\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"name\": \"N_mtlxdotproduct\",\n",
       "              \"nodetype\": \"dotproduct\",\n",
       "              \"type\": \"float\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in1\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"node\": 4\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"in2\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"value\": [\n",
       "                    1.0,\n",
       "                    1.0\n",
       "                  ]\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"float\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"name\": \"N_mtlxmult\",\n",
       "              \"nodetype\": \"multiply\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in1\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"node\": 6\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"in2\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"input\": 0\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"vector2\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"name\": \"N_mtlxsubtract\",\n",
       "              \"nodetype\": \"subtract\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in1\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"node\": 2\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"in2\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"value\": [\n",
       "                    0.0,\n",
       "                    0.0\n",
       "                  ]\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"vector2\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"name\": \"N_mtlxfloor\",\n",
       "              \"nodetype\": \"floor\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"node\": 3\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"vector2\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"name\": \"N_modulo\",\n",
       "              \"nodetype\": \"modulo\",\n",
       "              \"type\": \"float\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in1\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"float\",\n",
       "                  \"node\": 1\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"in2\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"float\",\n",
       "                  \"value\": 2.0\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"float\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"name\": \"Texcoord\",\n",
       "              \"nodetype\": \"texcoord\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"index\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"integer\",\n",
       "                  \"value\": 0\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"vector2\"\n",
       "                }\n",
       "              ]\n",
       "            }\n",
       "          ],\n",
       "          \"xpos\": \"-1.2309688043141684\",\n",
       "          \"ypos\": \"3.189328265723073\"\n",
       "        }\n",
       "      ]\n",
       "    }\n",
       "  },\n",
       "  \"materials\": [\n",
       "    {\n",
       "      \"name\": \"Gltf_pbr\",\n",
       "      \"pbrMetallicRoughness\": {\n",
       "        \"baseColorTexture\": {\n",
       "          \"index\": 0,\n",
       "          \"extensions\": {\n",
       "            \"KHR_texture_procedurals\": {\n",
       "              \"index\": 0,\n",
       "              \"output\": 0\n",
       "            }\n",
       "          }\n",
       "        }\n",
       "      }\n",
       "    }\n",
       "  ],\n",
       "  \"asset\": {\n",
       "    \"version\": \"2.0\",\n",
       "    \"generator\": \"MaterialX 1.39 / glTF 2.0 Texture Procedural Converter\"\n",
       "  },\n",
       "  \"extensionsUsed\": [\n",
       "    \"KHR_texture_procedurals\",\n",
       "    \"EXT_texture_procedurals_mx_1_39\"\n",
       "  ]\n",
       "}\n",
       "```"
      ],
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "data": {
      "text/markdown": [
       "#### Original MaterialX\n",
       "```xml\n",
       "<?xml version=\"1.0\"?>\n",
       "<materialx version=\"1.39\" colorspace=\"lin_rec709\">\n",
       "  <nodegraph name=\"NG_main\" xpos=\"-1.2309688043141684\" ypos=\"3.189328265723073\">\n",
       "    <input name=\"uvtiling\" type=\"vector2\" value=\"8,8\" />\n",
       "    <input name=\"color1\" type=\"color3\" value=\"1,0.094118,0.031373\" />\n",
       "    <input name=\"color2\" type=\"color3\" value=\"0.035294,0.090196,0.878431\" />\n",
       "    <output name=\"output_N_mtlxmix_out\" type=\"color3\" nodename=\"N_mtlxmix\" />\n",
       "    <mix name=\"N_mtlxmix\" type=\"color3\">\n",
       "      <input name=\"fg\" type=\"color3\" interfacename=\"color1\" />\n",
       "      <input name=\"bg\" type=\"color3\" interfacename=\"color2\" />\n",
       "      <input name=\"mix\" type=\"float\" nodename=\"N_modulo\" />\n",
       "    </mix>\n",
       "    <dotproduct name=\"N_mtlxdotproduct\" type=\"float\">\n",
       "      <input name=\"in1\" type=\"vector2\" nodename=\"N_mtlxfloor\" />\n",
       "      <input name=\"in2\" type=\"vector2\" value=\"1,1\" />\n",
       "    </dotproduct>\n",
       "    <multiply name=\"N_mtlxmult\" type=\"vector2\">\n",
       "      <input name=\"in1\" type=\"vector2\" nodename=\"Texcoord\" />\n",
       "      <input name=\"in2\" type=\"vector2\" interfacename=\"uvtiling\" />\n",
       "    </multiply>\n",
       "    <subtract name=\"N_mtlxsubtract\" type=\"vector2\">\n",
       "      <input name=\"in1\" type=\"vector2\" nodename=\"N_mtlxmult\" />\n",
       "      <input name=\"in2\" type=\"vector2\" value=\"0,0\" />\n",
       "    </subtract>\n",
       "    <floor name=\"N_mtlxfloor\" type=\"vector2\">\n",
       "      <input name=\"in\" type=\"vector2\" nodename=\"N_mtlxsubtract\" />\n",
       "    </floor>\n",
       "    <modulo name=\"N_modulo\" type=\"float\">\n",
       "      <input name=\"in1\" type=\"float\" nodename=\"N_mtlxdotproduct\" />\n",
       "      <input name=\"in2\" type=\"float\" value=\"2\" />\n",
       "    </modulo>\n",
       "    <texcoord name=\"Texcoord\" type=\"vector2\">\n",
       "      <input name=\"index\" type=\"integer\" value=\"0\" />\n",
       "    </texcoord>\n",
       "  </nodegraph>\n",
       "  <gltf_pbr name=\"Gltf_pbr\" type=\"surfaceshader\">\n",
       "    <input name=\"base_color\" type=\"color3\" nodegraph=\"NG_main\" />\n",
       "  </gltf_pbr>\n",
       "  <surfacematerial name=\"MAT_Gltf_pbr\" type=\"material\">\n",
       "    <input name=\"surfaceshader\" type=\"surfaceshader\" nodename=\"Gltf_pbr\" />\n",
       "  </surfacematerial>\n",
       "</materialx>\n",
       "\n",
       "```"
      ],
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "# Import support modules\n",
    "import MaterialX as mx\n",
    "import json\n",
    "from IPython.display import display, Markdown\n",
    "\n",
    "# Import conversion module utilities\n",
    "from gltf_materialx_converter import converter as MxGLTFPT\n",
    "from gltf_materialx_converter import utilities as MxGLTFPTUtil\n",
    "\n",
    "input_file = \"../tests/data/checkerboard_graph.mtlx\" # Replace with desired file name\n",
    "\n",
    "# Set up definitions and read in a sample file\n",
    "stdlib, libFiles = MxGLTFPTUtil.load_standard_libraries()\n",
    "mxdoc = MxGLTFPTUtil.create_working_document([stdlib])\n",
    "mx.readFromXmlFile(mxdoc, input_file)\n",
    "\n",
    "# Set up string to display just the contents of the file w/o the libraries\n",
    "mxdoc2 = MxGLTFPTUtil.create_working_document([])\n",
    "mx.readFromXmlFile(mxdoc2, input_file)\n",
    "mtlx_string = mx.writeToXmlString(mxdoc2)\n",
    "\n",
    "# Convert\n",
    "converter = MxGLTFPT.glTFMaterialXConverter()\n",
    "json_string, status = converter.materialX_to_glTF(mxdoc)\n",
    "\n",
    "display(Markdown(f\"#### Converted glTF\\n```json\\n{json_string}\\n```\"))\n",
    "display(Markdown(f\"#### Original MaterialX\\n```xml\\n{mtlx_string}\\n```\"))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## glTF to MaterialX Convertion Example\n",
    "\n",
    "The same test data example is used by taking the glTF result from the previous example and re-converting this back into MaterialX."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO:glTFMtlx:> Importing 1 procedural graphs\n",
      "INFO:glTFMtlx:> Create new nodegraph: NG_main\n",
      "INFO:glTFMtlx:> Scan 1 procedural outputs\n",
      "INFO:glTFMtlx:> Import material: MATERIAL_Gltf_pbr. Shader: Gltf_pbr\n"
     ]
    },
    {
     "data": {
      "text/markdown": [
       "#### Converted MaterialX\n",
       "```xml\n",
       "<?xml version=\"1.0\"?>\n",
       "<materialx version=\"1.39\" colorspace=\"lin_rec709\" doc=\"glTF version: 2.0. glTF generator: MaterialX 1.39 / glTF 2.0 Texture Procedural Converter. \">\n",
       "  <nodegraph name=\"NG_main\" xpos=\"-1.2309688043141684\" ypos=\"3.189328265723073\">\n",
       "    <input name=\"uvtiling\" type=\"vector2\" value=\"8, 8\" />\n",
       "    <input name=\"color1\" type=\"color3\" value=\"1, 0.094118, 0.031373\" />\n",
       "    <input name=\"color2\" type=\"color3\" value=\"0.035294, 0.090196, 0.878431\" />\n",
       "    <mix name=\"N_mtlxmix\" type=\"color3\">\n",
       "      <input name=\"fg\" type=\"color3\" interfacename=\"color1\" />\n",
       "      <input name=\"bg\" type=\"color3\" interfacename=\"color2\" />\n",
       "      <input name=\"mix\" type=\"float\" nodename=\"N_modulo\" />\n",
       "    </mix>\n",
       "    <dotproduct name=\"N_mtlxdotproduct\" type=\"float\">\n",
       "      <input name=\"in1\" type=\"vector2\" nodename=\"N_mtlxfloor\" />\n",
       "      <input name=\"in2\" type=\"vector2\" value=\"1, 1\" />\n",
       "    </dotproduct>\n",
       "    <multiply name=\"N_mtlxmult\" type=\"vector2\">\n",
       "      <input name=\"in1\" type=\"vector2\" nodename=\"Texcoord\" />\n",
       "      <input name=\"in2\" type=\"vector2\" interfacename=\"uvtiling\" />\n",
       "    </multiply>\n",
       "    <subtract name=\"N_mtlxsubtract\" type=\"vector2\">\n",
       "      <input name=\"in1\" type=\"vector2\" nodename=\"N_mtlxmult\" />\n",
       "      <input name=\"in2\" type=\"vector2\" value=\"0, 0\" />\n",
       "    </subtract>\n",
       "    <floor name=\"N_mtlxfloor\" type=\"vector2\">\n",
       "      <input name=\"in\" type=\"vector2\" nodename=\"N_mtlxsubtract\" />\n",
       "    </floor>\n",
       "    <modulo name=\"N_modulo\" type=\"float\">\n",
       "      <input name=\"in1\" type=\"float\" nodename=\"N_mtlxdotproduct\" />\n",
       "      <input name=\"in2\" type=\"float\" value=\"2\" />\n",
       "    </modulo>\n",
       "    <texcoord name=\"Texcoord\" type=\"vector2\">\n",
       "      <input name=\"index\" type=\"integer\" value=\"0\" />\n",
       "    </texcoord>\n",
       "    <output name=\"output_N_mtlxmix_out\" type=\"color3\" nodename=\"N_mtlxmix\" />\n",
       "  </nodegraph>\n",
       "  <gltf_pbr name=\"Gltf_pbr\" type=\"surfaceshader\">\n",
       "    <input name=\"base_color\" type=\"color3\" nodegraph=\"NG_main\" />\n",
       "  </gltf_pbr>\n",
       "  <surfacematerial name=\"MATERIAL_Gltf_pbr\" type=\"material\">\n",
       "    <input name=\"surfaceshader\" type=\"surfaceshader\" nodename=\"Gltf_pbr\" />\n",
       "  </surfacematerial>\n",
       "</materialx>\n",
       "\n",
       "```"
      ],
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "converter.set_add_asset_info(True)\n",
    "mxdoc3 = converter.gltf_string_to_materialX(json_string, stdlib)   \n",
    "mtlx_string3 = mx.writeToXmlString(mxdoc3)\n",
    "display(Markdown(f\"#### Converted MaterialX\\n```xml\\n{mtlx_string3}\\n```\"))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Equivalency Check\n",
    "As of MaterialX version 1.39.2 a \"functional\" equivalency test is available. We perform this test to check that the re-converted MaterialX file is functionally equivalent to the original document.\n",
    "\n",
    "We explicitly set the options to perform value comparisons via the `performValueComparisons` option (as opposed to straight string comparisons) to perform the desired check. Note that this option is set by default."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "MaterialX version is 1.39.2 or higher. Perform equivalence check:\n",
      "- Documents are functionally equivalent.\n"
     ]
    }
   ],
   "source": [
    "have_required_version = MxGLTFPTUtil.have_version(1, 39, 2)\n",
    "\n",
    "if have_required_version:\n",
    "    print(f'MaterialX version is 1.39.2 or higher. Perform equivalence check:')\n",
    "\n",
    "    # Set up options\n",
    "    equivalence_opts = mx.ElementEquivalenceOptions()\n",
    "    # Always use value comparisons vs string comparisons\n",
    "    equivalence_opts.performValueComparisons = True\n",
    "    # Always skip documentation attributes\n",
    "    equivalence_opts.attributeExclusionList = { 'doc' }\n",
    "\n",
    "    # Remove shaders and materials from the documents\n",
    "    for mnode in mxdoc2.getMaterialNodes():\n",
    "        mxdoc2.removeNode(mnode.getName())\n",
    "    for mnode in mxdoc3.getMaterialNodes():\n",
    "        mxdoc3.removeNode(mnode.getName())\n",
    "\n",
    "    # Check for equivalence\n",
    "    equivalent, message = mxdoc3.isEquivalent(mxdoc2, equivalence_opts)\n",
    "    if equivalent:\n",
    "        print(f\"- Documents are functionally equivalent.\")\n",
    "    else:\n",
    "        print(f\"- Documents are not functionally equivalent: '{message}'.\")\n",
    "else:\n",
    "    print(f\"- Cannot compare documents because MaterialX version is less than 1.39.2\")    \n"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Conversion With Unnamed glTF Element\n",
    "\n",
    "glTF does not require any string name identifiers to identify specific elements. As such name-generation is required when converting  from such content to name-based data models such as MaterialX or OpenUSD.\n",
    "\n",
    "In the example below, we remove all the names from the JSON content and then perform the conversion back to MaterialX again. The `glTF_graph_clear_names` method is used to clear the names."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/markdown": [
       "#### Source glTF Without Names\n",
       "```json\n",
       "{\n",
       "  \"images\": [\n",
       "    {\n",
       "      \"uri\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADElEQVQI12P4z/AfAAQAAf/zKSWvAAAAAElFTkSuQmCC\",\n",
       "      \"name\": \"KHR_texture_procedural_fallback\"\n",
       "    }\n",
       "  ],\n",
       "  \"textures\": [\n",
       "    {\n",
       "      \"source\": 0\n",
       "    }\n",
       "  ],\n",
       "  \"extensions\": {\n",
       "    \"KHR_texture_procedurals\": {\n",
       "      \"procedurals\": [\n",
       "        {\n",
       "          \"nodetype\": \"nodegraph\",\n",
       "          \"type\": \"color3\",\n",
       "          \"inputs\": [\n",
       "            {\n",
       "              \"nodetype\": \"input\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"value\": [\n",
       "                8.0,\n",
       "                8.0\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"nodetype\": \"input\",\n",
       "              \"type\": \"color3\",\n",
       "              \"value\": [\n",
       "                1.0,\n",
       "                0.094118,\n",
       "                0.031373\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"nodetype\": \"input\",\n",
       "              \"type\": \"color3\",\n",
       "              \"value\": [\n",
       "                0.035294,\n",
       "                0.090196,\n",
       "                0.878431\n",
       "              ]\n",
       "            }\n",
       "          ],\n",
       "          \"outputs\": [\n",
       "            {\n",
       "              \"nodetype\": \"output\",\n",
       "              \"type\": \"color3\",\n",
       "              \"node\": 0\n",
       "            }\n",
       "          ],\n",
       "          \"nodes\": [\n",
       "            {\n",
       "              \"nodetype\": \"mix\",\n",
       "              \"type\": \"color3\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"fg\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"color3\",\n",
       "                  \"input\": 1\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"bg\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"color3\",\n",
       "                  \"input\": 2\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"mix\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"float\",\n",
       "                  \"node\": 5\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"color3\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"nodetype\": \"dotproduct\",\n",
       "              \"type\": \"float\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in1\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"node\": 4\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"in2\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"value\": [\n",
       "                    1.0,\n",
       "                    1.0\n",
       "                  ]\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"float\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"nodetype\": \"multiply\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in1\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"node\": 6\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"in2\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"input\": 0\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"vector2\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"nodetype\": \"subtract\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in1\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"node\": 2\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"in2\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"value\": [\n",
       "                    0.0,\n",
       "                    0.0\n",
       "                  ]\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"vector2\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"nodetype\": \"floor\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"vector2\",\n",
       "                  \"node\": 3\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"vector2\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"nodetype\": \"modulo\",\n",
       "              \"type\": \"float\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"in1\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"float\",\n",
       "                  \"node\": 1\n",
       "                },\n",
       "                {\n",
       "                  \"name\": \"in2\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"float\",\n",
       "                  \"value\": 2.0\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"float\"\n",
       "                }\n",
       "              ]\n",
       "            },\n",
       "            {\n",
       "              \"nodetype\": \"texcoord\",\n",
       "              \"type\": \"vector2\",\n",
       "              \"inputs\": [\n",
       "                {\n",
       "                  \"name\": \"index\",\n",
       "                  \"nodetype\": \"input\",\n",
       "                  \"type\": \"integer\",\n",
       "                  \"value\": 0\n",
       "                }\n",
       "              ],\n",
       "              \"outputs\": [\n",
       "                {\n",
       "                  \"nodetype\": \"output\",\n",
       "                  \"name\": \"out\",\n",
       "                  \"type\": \"vector2\"\n",
       "                }\n",
       "              ]\n",
       "            }\n",
       "          ],\n",
       "          \"xpos\": \"-1.2309688043141684\",\n",
       "          \"ypos\": \"3.189328265723073\"\n",
       "        }\n",
       "      ]\n",
       "    }\n",
       "  },\n",
       "  \"materials\": [\n",
       "    {\n",
       "      \"pbrMetallicRoughness\": {\n",
       "        \"baseColorTexture\": {\n",
       "          \"index\": 0,\n",
       "          \"extensions\": {\n",
       "            \"KHR_texture_procedurals\": {\n",
       "              \"index\": 0,\n",
       "              \"output\": 0\n",
       "            }\n",
       "          }\n",
       "        }\n",
       "      }\n",
       "    }\n",
       "  ],\n",
       "  \"asset\": {\n",
       "    \"version\": \"2.0\",\n",
       "    \"generator\": \"MaterialX 1.39 / glTF 2.0 Texture Procedural Converter\"\n",
       "  },\n",
       "  \"extensionsUsed\": [\n",
       "    \"KHR_texture_procedurals\",\n",
       "    \"EXT_texture_procedurals_mx_1_39\"\n",
       "  ]\n",
       "}\n",
       "```"
      ],
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "# Remove names from JSON\n",
    "json_object = json.loads(json_string)\n",
    "converter.glTF_graph_clear_names(json_object)\n",
    "json_string_cleared = json.dumps(json_object, indent=2)\n",
    "\n",
    "display(Markdown(f\"#### Source glTF Without Names\\n```json\\n{json_string_cleared}\\n```\"))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "When converting to MaterialX, names are auto-matically generated for unnamed elements. \n",
    "\n",
    "To provide more user-friendly names the category of the element is used as a prefix. e.g. the string `INPUT_<number>` is used for unnamed procedural graph inputs where `<number>` starts at 0 and subsequent names are generated through the MaterialX API. Note that pre-generation is required so that connection references are set to the correct name identifiers."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "INFO:glTFMtlx:> Importing 1 procedural graphs\n",
      "INFO:glTFMtlx:> Create new nodegraph: GRAPH_0\n",
      "INFO:glTFMtlx:> Scan 1 procedural outputs\n",
      "INFO:glTFMtlx:> Import material: MATERIAL_SHADER_0. Shader: SHADER_0\n"
     ]
    },
    {
     "data": {
      "text/markdown": [
       "#### MaterialX With Generated Names\n",
       "```xml\n",
       "<?xml version=\"1.0\"?>\n",
       "<materialx version=\"1.39\" colorspace=\"lin_rec709\" doc=\"glTF version: 2.0. glTF generator: MaterialX 1.39 / glTF 2.0 Texture Procedural Converter. \">\n",
       "  <nodegraph name=\"GRAPH_0\" xpos=\"-1.2309688043141684\" ypos=\"3.189328265723073\">\n",
       "    <input name=\"INPUT_0\" type=\"vector2\" value=\"8, 8\" />\n",
       "    <input name=\"INPUT_1\" type=\"color3\" value=\"1, 0.094118, 0.031373\" />\n",
       "    <input name=\"INPUT_2\" type=\"color3\" value=\"0.035294, 0.090196, 0.878431\" />\n",
       "    <mix name=\"NODE_0\" type=\"color3\">\n",
       "      <input name=\"fg\" type=\"color3\" interfacename=\"INPUT_1\" />\n",
       "      <input name=\"bg\" type=\"color3\" interfacename=\"INPUT_2\" />\n",
       "      <input name=\"mix\" type=\"float\" nodename=\"NODE_5\" />\n",
       "    </mix>\n",
       "    <dotproduct name=\"NODE_1\" type=\"float\">\n",
       "      <input name=\"in1\" type=\"vector2\" nodename=\"NODE_4\" />\n",
       "      <input name=\"in2\" type=\"vector2\" value=\"1, 1\" />\n",
       "    </dotproduct>\n",
       "    <multiply name=\"NODE_2\" type=\"vector2\">\n",
       "      <input name=\"in1\" type=\"vector2\" nodename=\"NODE_6\" />\n",
       "      <input name=\"in2\" type=\"vector2\" interfacename=\"INPUT_0\" />\n",
       "    </multiply>\n",
       "    <subtract name=\"NODE_3\" type=\"vector2\">\n",
       "      <input name=\"in1\" type=\"vector2\" nodename=\"NODE_2\" />\n",
       "      <input name=\"in2\" type=\"vector2\" value=\"0, 0\" />\n",
       "    </subtract>\n",
       "    <floor name=\"NODE_4\" type=\"vector2\">\n",
       "      <input name=\"in\" type=\"vector2\" nodename=\"NODE_3\" />\n",
       "    </floor>\n",
       "    <modulo name=\"NODE_5\" type=\"float\">\n",
       "      <input name=\"in1\" type=\"float\" nodename=\"NODE_1\" />\n",
       "      <input name=\"in2\" type=\"float\" value=\"2\" />\n",
       "    </modulo>\n",
       "    <texcoord name=\"NODE_6\" type=\"vector2\">\n",
       "      <input name=\"index\" type=\"integer\" value=\"0\" />\n",
       "    </texcoord>\n",
       "    <output name=\"OUTPUT_0\" type=\"color3\" nodename=\"NODE_0\" />\n",
       "  </nodegraph>\n",
       "  <gltf_pbr name=\"SHADER_0\" type=\"surfaceshader\">\n",
       "    <input name=\"base_color\" type=\"color3\" nodegraph=\"GRAPH_0\" />\n",
       "  </gltf_pbr>\n",
       "  <surfacematerial name=\"MATERIAL_SHADER_0\" type=\"material\">\n",
       "    <input name=\"surfaceshader\" type=\"surfaceshader\" nodename=\"SHADER_0\" />\n",
       "  </surfacematerial>\n",
       "</materialx>\n",
       "\n",
       "```"
      ],
      "text/plain": [
       "<IPython.core.display.Markdown object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "mxdoc_cleared = converter.gltf_string_to_materialX(json_string_cleared, stdlib)   \n",
    "mxdoc_cleared_string = mx.writeToXmlString(mxdoc_cleared)\n",
    "display(Markdown(f\"#### MaterialX With Generated Names\\n```xml\\n{mxdoc_cleared_string}\\n```\"))"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.0"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}