Merge pull request #53 from jstone-lucasfilm/master

Add a validation rule for shader references to non-shader nodedefs
AcademySoftwareFoundation · Dec 7, 2017 · 2c093c0 · 2c093c0
2 parents 9923d29 + 3537f7b
commit 2c093c0
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 3 deletions.
diff --git a/source/MaterialXCore/Definition.cpp b/source/MaterialXCore/Definition.cpp
@@ -3,13 +3,16 @@
 // All rights reserved.  See LICENSE.txt for license.
 //
 
-#include <MaterialXCore/Node.h>
+#include <MaterialXCore/Definition.h>
 
 #include <MaterialXCore/Document.h>
 
 namespace MaterialX
 {
 
+const string COLOR_SEMANTIC = "color";
+const string SHADER_SEMANTIC = "shader";
+
 const string NodeDef::NODE_ATTRIBUTE = "node";
 const string TypeDef::SEMANTIC_ATTRIBUTE = "semantic";
 const string TypeDef::CONTEXT_ATTRIBUTE = "context";

diff --git a/source/MaterialXCore/Definition.h b/source/MaterialXCore/Definition.h
@@ -16,6 +16,9 @@
 namespace MaterialX
 {
 
+extern const string COLOR_SEMANTIC;
+extern const string SHADER_SEMANTIC;
+
 /// A shared pointer to a NodeDef
 using NodeDefPtr = shared_ptr<class NodeDef>;
 /// A shared pointer to a const NodeDef

diff --git a/source/MaterialXCore/Material.cpp b/source/MaterialXCore/Material.cpp
@@ -189,7 +189,7 @@ OutputPtr BindInput::getConnectedOutput() const
 // ShaderRef methods
 //
 
-NodeDefPtr ShaderRef::getNodeDef()
+NodeDefPtr ShaderRef::getNodeDef() const
 {
     if (hasNodeDefString())
     {
@@ -203,6 +203,18 @@ NodeDefPtr ShaderRef::getNodeDef()
     return NodeDefPtr();
 }
 
+bool ShaderRef::validate(string * message) const
+{
+    bool res = true;
+    NodeDefPtr nodeDef = getNodeDef();
+    TypeDefPtr typeDef = nodeDef ? getDocument()->getTypeDef(nodeDef->getType()) : TypeDefPtr();
+    if (typeDef)
+    {
+        validateRequire(typeDef->getSemantic() == SHADER_SEMANTIC, res, message, "Shader reference to a non-shader nodedef");
+    }
+    return Element::validate(message) && res;
+}
+
 //
 // Override methods
 //

diff --git a/source/MaterialXCore/Material.h b/source/MaterialXCore/Material.h
@@ -486,7 +486,7 @@ class ShaderRef : public Element
     /// @{
 
     /// Return the NodeDef, if any, that this element references.
-    NodeDefPtr getNodeDef();
+    NodeDefPtr getNodeDef() const;
 
     /// @}
     /// @name Output References
@@ -508,6 +508,14 @@ class ShaderRef : public Element
     }
 
     /// @}
+    /// @name Validation
+    /// @{
+
+    /// Validate that the given element tree, including all descendants, is
+    /// consistent with the MaterialX specification.
+    bool validate(string* message = nullptr) const override;
+
+    /// @}
 
   public:
     static const string CATEGORY;