Add Element helper for content document membership (AcademySoftwareFoundation#2936)

- add Element::belongsToContentDocument() for filtering elements imported from libraries
- expose the helper through Python and JavaScript bindings
- update existing C++ and JavaScript source-URI checks to use the new helper
- add C++ and Python test coverage

Author: popsiclelmlm

javascript/MaterialXView/source/viewer.js

@@ -1113,7 +1113,7 @@ export class Material
                     }
 
                     // Skip elements from the referenced data library
-                    if (currentElem.getActiveSourceUri() !== elem.getDocument().getSourceUri())
+                    if (!currentElem.belongsToContentDocument())
                     {
                         continue;
                     }

python/MaterialXTest/main.py

@@ -199,6 +199,36 @@ def test_Matrices(self):
         self.assertTrue((rotY * rotZ).isEquivalent(
             mx.Matrix44.createScale(mx.Vector3(1, -1, -1)), _epsilon))
 
+    def test_ElementContentDocument(self):
+        # Create a document.
+        doc = mx.createDocument()
+
+        # Test content document membership.
+        doc.setSourceUri('content.mtlx')
+        contentElem = doc.addChildOfCategory('generic', 'contentElem')
+        self.assertTrue(contentElem.belongsToContentDocument())
+        lib = mx.createDocument()
+        lib.setSourceUri('library.mtlx')
+        lib.addChildOfCategory('generic', 'libElem')
+        doc.importLibrary(lib)
+        libElem = doc.getChild('libElem')
+        self.assertTrue(libElem)
+        self.assertFalse(libElem.belongsToContentDocument())
+
+        stdlib = mx.createDocument()
+        mx.loadLibraries(mx.getDefaultDataLibraryFolders(), mx.getDefaultDataSearchPath(), stdlib)
+
+        docWithDataLibrary = mx.createDocument()
+        docWithDataLibrary.setDataLibrary(stdlib)
+        referencedNodeDef = docWithDataLibrary.getChild('ND_image_color3')
+        self.assertTrue(referencedNodeDef)
+        self.assertFalse(referencedNodeDef.belongsToContentDocument())
+
+        docWithImportedLibrary = mx.createDocument()
+        docWithImportedLibrary.importLibrary(stdlib)
+        importedNodeDef = docWithImportedLibrary.getChild('ND_image_color3')
+        self.assertTrue(importedNodeDef)
+        self.assertFalse(importedNodeDef.belongsToContentDocument())
 
     def test_BuildDocument(self):
         # Create a document.

source/JsMaterialX/JsMaterialXCore/JsElement.cpp

@@ -169,6 +169,7 @@ EMSCRIPTEN_BINDINGS(element)
         .function("hasSourceUri", &mx::Element::hasSourceUri)
         .function("getSourceUri", &mx::Element::getSourceUri)
         .function("getActiveSourceUri", &mx::Element::getActiveSourceUri)
+        .function("belongsToContentDocument", &mx::Element::belongsToContentDocument)
         .function("validate", ems::optional_override([](mx::Element &self) {
             return self.validate();
         }))

source/MaterialXCore/Element.cpp

@@ -359,6 +359,11 @@ ConstDocumentPtr Element::getDocument() const
     return getRoot()->asA<Document>();
 }
 
+bool Element::belongsToContentDocument() const
+{
+    return getActiveSourceUri() == getDocument()->getSourceUri();
+}
+
 bool Element::hasInheritedBase(ConstElementPtr base) const
 {
     for (ConstElementPtr elem : traverseInheritance())

source/MaterialXCore/Element.h

@@ -749,6 +749,11 @@ class MX_CORE_API Element : public std::enable_shared_from_this<Element>
         return EMPTY_STRING;
     }
 
+    /// Return true if this element belongs to its content document, and not
+    /// to an imported library with a distinct source URI.
+    /// @return True if the active source URI matches the content document URI.
+    bool belongsToContentDocument() const;
+
     /// @}
     /// @name Validation
     /// @{

source/MaterialXGenShader/Util.cpp

@@ -412,17 +412,18 @@ vector<TypedElementPtr> findRenderableElements(ConstDocumentPtr doc)
         vector<OutputPtr> graphOutputs;
         for (NodeGraphPtr graph : doc->getNodeGraphs())
         {
+            if (!graph->belongsToContentDocument())
+            {
+                continue;
+            }
             for (OutputPtr output : graph->getOutputs())
             {
-                if (output->getActiveSourceUri() == doc->getActiveSourceUri())
-                {
-                    graphOutputs.push_back(output);
-                }
+                graphOutputs.push_back(output);
             }
         }
         for (OutputPtr output : doc->getOutputs())
         {
-            if (output->getActiveSourceUri() == doc->getActiveSourceUri())
+            if (output->belongsToContentDocument())
             {
                 graphOutputs.push_back(output);
             }

source/MaterialXGraphEditor/Graph.cpp

@@ -1912,7 +1912,7 @@ void Graph::buildGroupNode(UiNodePtr node)
 bool Graph::readOnly()
 {
     // If the sources are not the same then the current graph cannot be modified
-    return _state.graphElem->getActiveSourceUri() != _graphDoc->getActiveSourceUri();
+    return !_state.graphElem->belongsToContentDocument();
 }
 
 void Graph::drawOutputPins(UiNodePtr node, const std::string& longestInputLabel)

source/MaterialXRender/ImageHandler.cpp

@@ -179,7 +179,7 @@ ImageVec ImageHandler::getReferencedImages(ConstDocumentPtr doc)
     ImageVec imageVec;
     for (ElementPtr elem : doc->traverseTree())
     {
-        if (elem->getActiveSourceUri() != doc->getSourceUri())
+        if (!elem->belongsToContentDocument())
         {
             continue;
         }

source/MaterialXTest/MaterialXCore/Element.cpp

@@ -6,6 +6,7 @@
 #include <MaterialXTest/External/Catch/catch.hpp>
 
 #include <MaterialXCore/Document.h>
+#include <MaterialXFormat/Util.h>
 
 namespace mx = MaterialX;
 
@@ -60,6 +61,37 @@ TEST_CASE("Element", "[element]")
     REQUIRE_THROWS_AS(doc2->setChildIndex("elem1", 100), mx::Exception);
     REQUIRE(*doc2 == *doc);
 
+    // Check content document membership.
+    mx::DocumentPtr contentDoc = mx::createDocument();
+    contentDoc->setSourceUri("content.mtlx");
+    mx::ElementPtr contentElem = contentDoc->addChildOfCategory("generic", "contentElem");
+    REQUIRE(contentElem->belongsToContentDocument());
+    mx::DocumentPtr lib = mx::createDocument();
+    lib->setSourceUri("library.mtlx");
+    lib->addChildOfCategory("generic", "libElem");
+    contentDoc->importLibrary(lib);
+    mx::ElementPtr libElem = contentDoc->getChild("libElem");
+    REQUIRE(libElem);
+    REQUIRE(!libElem->belongsToContentDocument());
+
+    // Check content document membership for referenced standard library
+    // elements, which remain outside the content document.
+    mx::FileSearchPath searchPath = mx::getDefaultDataSearchPath();
+    mx::DocumentPtr stdlib = mx::createDocument();
+    mx::loadLibraries({ "libraries" }, searchPath, stdlib);
+
+    mx::DocumentPtr docWithDataLibrary = mx::createDocument();
+    docWithDataLibrary->setDataLibrary(stdlib);
+    mx::ElementPtr referencedNodeDef = docWithDataLibrary->getChild("ND_image_color3");
+    REQUIRE(referencedNodeDef);
+    REQUIRE(!referencedNodeDef->belongsToContentDocument());
+
+    mx::DocumentPtr docWithImportedLibrary = mx::createDocument();
+    docWithImportedLibrary->importLibrary(stdlib);
+    mx::ElementPtr importedNodeDef = docWithImportedLibrary->getChild("ND_image_color3");
+    REQUIRE(importedNodeDef);
+    REQUIRE(!importedNodeDef->belongsToContentDocument());
+
     // Create and test an orphaned element.
     mx::ElementPtr orphan;
     {

source/MaterialXTest/MaterialXFormat/XmlIo.cpp

@@ -72,7 +72,7 @@ TEST_CASE("Load content", "[xmlio]")
         doc->flattenSubgraphs();
         for (mx::NodeGraphPtr graph : doc->getNodeGraphs())
         {
-            if (graph->getActiveSourceUri() == doc->getSourceUri())
+            if (graph->belongsToContentDocument())
             {
                 graph->flattenSubgraphs();
             }
@@ -83,7 +83,7 @@ TEST_CASE("Load content", "[xmlio]")
         bool referencesValid = true;
         for (mx::ElementPtr elem : doc->traverseTree())
         {
-            if (elem->getActiveSourceUri() != doc->getSourceUri())
+            if (!elem->belongsToContentDocument())
             {
                 continue;
             }