AttributeQuery : Support inheriting global attributes

Author: murraystevenson

Changes.md

@@ -29,6 +29,7 @@ Improvements
 - PathListingWidget : Improved formatting of Box and Matrix values.
 - LocaliseAttributes : Added support for localising global attributes, controlled by the new `includeGlobalAttributes` plug.
 - AttributeTweaks : Added support for localising global attributes when `localise` is enabled.
+- AttributeQuery : Added support for querying global attributes when `inherit` is enabled.
 
 Fixes
 -----
@@ -93,6 +94,7 @@ Breaking Changes
 - ContextAlgo : Removed deprecated API. Use ScriptNodeAlgo instead, which has been available from Gaffer 1.4.13.0 onwards.
 - ScriptNodeAlgo : Reimplemented using Metadata rather than Context variables for storage. Use the ScriptNodeAlgo API instead of attempting direct access to `ui:*` context variables.
 - AttributeTweaks : Tweaks with `localise` enabled and a mode of `CreateIfMissing` will now not create an attribute if it is missing from the scene hierarchy, but exists in the globals.
+- AttributeQuery : Queries with `inherit` enabled will now return a result when querying an attribute that does not exist in the scene hierarchy, but does exist in the globals.
 
 Build
 -----

python/GafferSceneTest/AttributeQueryTest.py

@@ -40,6 +40,7 @@
 
 import IECore
 import Gaffer
+import GafferTest
 import GafferScene
 import GafferSceneTest
 
@@ -1337,5 +1338,92 @@ def testQueryDoubleData( self ) :
 		self.assertTrue( query["exists"].getValue() )
 		self.assertEqual( query["value"].getValue(), 2.5 )
 
+	def testInheritedGlobalAttribute( self ) :
+
+		sphere = GafferScene.Sphere()
+
+		globalAttributes = GafferScene.CustomAttributes()
+		globalAttributes["in"].setInput( sphere["out"] )
+		globalAttributes["global"].setValue( True )
+		globalAttributes["extraAttributes"].setValue( IECore.CompoundObject( { "test" : IECore.DoubleData( 5.0 ) } ) )
+
+		attributes = GafferScene.CustomAttributes()
+		attributes["in"].setInput( globalAttributes["out"] )
+		attributes["extraAttributes"].setValue( IECore.CompoundObject( { "test" : IECore.DoubleData( 2.5 ) } ) )
+		attributes["enabled"].setValue( False )
+
+		query = GafferScene.AttributeQuery()
+		query.setup( Gaffer.FloatPlug() )
+		query["scene"].setInput( attributes["out"] )
+		query["location"].setValue( "/sphere" )
+		query["attribute"].setValue( "test" )
+
+		self.assertFalse( query["exists"].getValue() )
+		self.assertEqual( query["value"].getValue(), 0.0 )
+
+		query["inherit"].setValue( True )
+
+		self.assertTrue( query["exists"].getValue() )
+		self.assertEqual( query["value"].getValue(), 5.0 )
+
+		globalAttributes["extraAttributes"].setValue( IECore.CompoundObject( { "test" : IECore.DoubleData( 10.0 ) } ) )
+
+		self.assertTrue( query["exists"].getValue() )
+		self.assertEqual( query["value"].getValue(), 10.0 )
+
+		attributes["enabled"].setValue( True )
+
+		self.assertTrue( query["exists"].getValue() )
+		self.assertEqual( query["value"].getValue(), 2.5 )
+
+		query["inherit"].setValue( False )
+
+		self.assertTrue( query["exists"].getValue() )
+		self.assertEqual( query["value"].getValue(), 2.5 )
+
+	def testDirtyPropagation( self ) :
+
+		sphere = GafferScene.Sphere()
+
+		globalAttributes = GafferScene.StandardAttributes()
+		globalAttributes["in"].setInput( sphere["out"] )
+		globalAttributes["global"].setValue( True )
+
+		standardAttributes = GafferScene.StandardAttributes()
+		standardAttributes["in"].setInput( globalAttributes["out"] )
+
+		query = GafferScene.AttributeQuery()
+		query.setup( Gaffer.BoolPlug() )
+		query["scene"].setInput( standardAttributes["out"] )
+		query["location"].setValue( "/sphere" )
+
+		cs = GafferTest.CapturingSlot( query.plugDirtiedSignal() )
+
+		standardAttributes["attributes"]["scene:visible"]["enabled"].setValue( True )
+		self.assertIn( query["value"], { x[0] for x in cs } )
+
+		standardAttributes["attributes"]["scene:visible"]["enabled"].setValue( False )
+		del cs[:]
+		query["default"].setValue( True )
+		self.assertIn( query["value"], { x[0] for x in cs } )
+
+		# modifying the globals with the `inherit` plug disabled
+		# should not dirty query["value"]
+		del cs[:]
+		globalAttributes["attributes"]["scene:visible"]["enabled"].setValue( True )
+		self.assertNotIn( query["value"], { x[0] for x in cs } )
+
+		query["inherit"].setValue( True )
+		self.assertIn( query["value"], { x[0] for x in cs } )
+
+		globalAttributes["attributes"]["scene:visible"]["enabled"].setValue( False )
+		del cs[:]
+		globalAttributes["attributes"]["scene:visible"]["enabled"].setValue( True )
+		self.assertIn( query["value"], { x[0] for x in cs } )
+
+		del cs[:]
+		standardAttributes["attributes"]["scene:visible"]["enabled"].setValue( True )
+		self.assertIn( query["value"], { x[0] for x in cs } )
+
 if __name__ == "__main__":
 	unittest.main()

python/GafferSceneUI/AttributeQueryUI.py

@@ -132,7 +132,8 @@ def __updateVisibility( self, *args, **kwargs ) :
 
 			"description",
 			"""
-			Should inherited attributes or be considered or not.
+			Should inherited attributes or be considered or not. Attributes are
+			inherited from ancestors or from the scene globals.
 			""",
 
 			"nodule:type", ""

src/GafferScene/AttributeQuery.cpp

@@ -259,7 +259,8 @@ void AttributeQuery::affects( const Gaffer::Plug* const input, AffectedPlugsCont
 		( input == locationPlug() ) ||
 		( input == attributePlug() ) ||
 		( input == scenePlug()->existsPlug() ) ||
-		( input == scenePlug()->attributesPlug() ) )
+		( input == scenePlug()->attributesPlug() ) ||
+		( input == scenePlug()->globalsPlug() && !inheritPlug()->isSetToDefault() ) )
 	{
 		outputs.push_back( internalObjectPlug() );
 	}
@@ -300,7 +301,7 @@ void AttributeQuery::hash( const Gaffer::ValuePlug* const output, const Gaffer::
 			if( splug->exists( path ) )
 			{
 				h.append( ( inheritPlug()->getValue() )
-					? splug->fullAttributesHash( path )
+					? splug->fullAttributesHash( path, /* withGlobalAttributes = */ true )
 					: splug->attributesHash( path ) );
 				attributePlug()->hash( h );
 			}
@@ -347,7 +348,7 @@ void AttributeQuery::compute( Gaffer::ValuePlug* const output, const Gaffer::Con
 				if( ! name.empty() )
 				{
 					const IECore::ConstCompoundObjectPtr cobj = ( inheritPlug()->getValue() )
-						? boost::static_pointer_cast< const IECore::CompoundObject >( splug->fullAttributes( path ) )
+						? boost::static_pointer_cast< const IECore::CompoundObject >( splug->fullAttributes( path, /* withGlobalAttributes = */ true ) )
 						: ( splug->attributes( path ) );
 					assert( cobj );