ShaderTweaks : Support localising global shaders

Author: murraystevenson

Changes.md

@@ -10,7 +10,7 @@ Improvements
   - Nodes can be pinned for comparison by dropping them onto the green "B" side of the "Scene" comparison header [^1].
   - The current expansion is now preserved when enabling or disabling comparison mode [^1].
 - LocaliseAttributes : Added support for localising global attributes, controlled by the new `includeGlobalAttributes` plug.
-- AttributeTweaks : Added support for localising global attributes when `localise` is enabled.
+- AttributeTweaks, ShaderTweaks : Global attributes are now localised when `localise` is enabled and no matching attribute is found at the target location or any of its ancestors.
 - AttributeQuery, ShaderQuery : Global attributes are now queried when `inherit` is enabled and no matching attribute is found at the target location or any of its ancestors.
 
 Fixes

python/GafferSceneTest/ShaderTweaksTest.py

@@ -393,15 +393,26 @@ def testLocalise( self ) :
 		group = GafferScene.Group()
 		group["in"][0].setInput( plane["out"] )
 
+		globalSurface = GafferSceneTest.TestShader( "surface" )
+		globalSurface["type"].setValue( "surface" )
+		globalSurface["parameters"]["c"].setValue( imath.Color3f( 4, 5, 6 ) )
+		globalSurface["parameters"]["i"].setValue( 3 )
+
+		globalAttributes = GafferScene.CustomAttributes()
+		globalAttributes["in"].setInput( group["out"] )
+		globalAttributes["global"].setValue( True )
+		globalAttributes["extraAttributes"].setValue( IECore.CompoundObject( { "surface" : globalSurface.attributes()["surface"] } ) )
+
 		shader = GafferSceneTest.TestShader( "surface" )
 		shader["type"].setValue( "surface" )
 		shader["parameters"]["c"].setValue( imath.Color3f( 1, 2, 3 ) )
+		shader["parameters"]["i"].setValue( 2 )
 
 		groupFilter = GafferScene.PathFilter()
 		groupFilter["paths"].setValue( IECore.StringVectorData( [ "/group" ] ) )
 
 		assignment = GafferScene.ShaderAssignment()
-		assignment["in"].setInput( group["out"] )
+		assignment["in"].setInput( globalAttributes["out"] )
 		assignment["filter"].setInput( groupFilter["out"] )
 		assignment["shader"].setInput( shader["out"] )
 
@@ -438,10 +449,21 @@ def testLocalise( self ) :
 
 		planeAttr = tweaks["out"].attributes( "/group/plane" )
 		self.assertTrue( "surface" in planeAttr )
-		self.assertEqual(
-			planeAttr["surface"].getShader( "surface" ).parameters["c"].value,
-			imath.Color3f( 3, 2, 1 )
-		)
+		shaderParameters = planeAttr["surface"].getShader( "surface" ).parameters
+		self.assertEqual( shaderParameters["c"].value, imath.Color3f( 3, 2, 1 ) )
+		self.assertEqual( shaderParameters["i"].value, 2 )
+
+		# Disable the shader assignment on "/group", our tweak should now localise
+		# the global shader.
+		assignment["enabled"].setValue( False )
+
+		self.assertFalse( "surface" in tweaks["out"].attributes( "/group" ) )
+
+		planeAttr = tweaks["out"].attributes( "/group/plane" )
+		self.assertTrue( "surface" in planeAttr )
+		shaderParameters = planeAttr["surface"].getShader( "surface" ).parameters
+		self.assertEqual( shaderParameters["c"].value, imath.Color3f( 3, 2, 1 ) )
+		self.assertEqual( shaderParameters["i"].value, 3 )
 
 		# Test disabling tweak results in no localisation
 

python/GafferSceneUI/ShaderTweakProxyUI.py

@@ -199,7 +199,7 @@ def _shaderAttributes( context, nodes, paths, affectedOnly ) :
 				if not node["in"].exists( path ):
 					continue
 
-				attributes = node["in"].fullAttributes( path ) if useFullAttr else node["in"].attributes( path )
+				attributes = node["in"].fullAttributes( path, withGlobalAttributes = True ) if useFullAttr else node["in"].attributes( path )
 				for name, attribute in attributes.items() :
 					if not IECore.StringAlgo.matchMultiple( name, attributeNamePatterns ) :
 						continue

python/GafferSceneUI/ShaderTweaksUI.py

@@ -191,7 +191,7 @@ def _shaderAttributes( plugValueWidget, paths, affectedOnly ) :
 		useFullAttr = node["localise"].getValue()
 		attributeNamePatterns = node["shader"].getValue() if affectedOnly else "*"
 		for path in paths :
-			attributes = node["in"].fullAttributes( path ) if useFullAttr else node["in"].attributes( path )
+			attributes = node["in"].fullAttributes( path, withGlobalAttributes = True ) if useFullAttr else node["in"].attributes( path )
 			for name, attribute in attributes.items() :
 				if not IECore.StringAlgo.matchMultiple( name, attributeNamePatterns ) :
 					continue

src/GafferScene/ShaderTweaks.cpp

@@ -422,7 +422,8 @@ bool ShaderTweaks::affectsProcessedAttributes( const Gaffer::Plug *input ) const
 		tweaksPlug()->isAncestorOf( input ) ||
 		input == shaderPlug() ||
 		input == ignoreMissingPlug() ||
-		input == localisePlug()
+		input == localisePlug() ||
+		( input == inPlug()->globalsPlug() && !localisePlug()->isSetToDefault() )
 	;
 }
 
@@ -451,7 +452,7 @@ void ShaderTweaks::hashProcessedAttributes( const ScenePath &path, const Gaffer:
 
 		if( localisePlug()->getValue() )
 		{
-			h.append( inPlug()->fullAttributesHash( path ) );
+			h.append( inPlug()->fullAttributesHash( path, /* withGlobalAttributes = */ true ) );
 		}
 	}
 }
@@ -485,7 +486,7 @@ IECore::ConstCompoundObjectPtr ShaderTweaks::computeProcessedAttributes( const S
 	ConstCompoundObjectPtr fullAttributes;
 	if( localisePlug()->getValue() )
 	{
-		fullAttributes = inPlug()->fullAttributes( path );
+		fullAttributes = inPlug()->fullAttributes( path, /* withGlobalAttributes = */ true );
 		source = &fullAttributes->members();
 	}