Merge pull request #6206 from murraystevenson/sceneViewShadingToggle

SceneViewUI : Shading mode menu improvements

Changes.md

@@ -11,6 +11,9 @@ Improvements
 
 - VisualiserTool : Changed `dataName` input widget for choosing the primitive variable to visualise to a list of available variable names for the current selection.
 - Tweaks nodes : Moved list of tweaks to a collapsible "Tweaks" section in the NodeEditor.
+- Viewer :
+  - The shading mode menu icon now updates to indicate when a non-default shading mode is in use.
+  - Added the ability to toggle between default shading and the last selected shading mode by <kbd>Ctrl</kbd> + clicking the shading mode menu button.
 
 Fixes
 -----

python/GafferSceneUI/SceneViewUI.py

@@ -50,6 +50,7 @@
 import GafferSceneUI
 import GafferImage
 
+from GafferUI.PlugValueWidget import sole
 from ._SceneViewInspector import _SceneViewInspector
 
 def __rendererPlugActivator( plug ) :
@@ -548,18 +549,44 @@ class _ShadingModePlugValueWidget( GafferUI.PlugValueWidget ) :
 
 		def __init__( self, plug, **kw ) :
 
-			menuButton = GafferUI.MenuButton(
+			self.__menuButton = GafferUI.MenuButton(
 				image = "shading.png",
 				menu = GafferUI.Menu( Gaffer.WeakMethod( self.__menuDefinition ), title="Shading" ),
 				hasFrame = False,
 			)
 
-			GafferUI.PlugValueWidget.__init__( self, menuButton, plug, **kw )
+			GafferUI.PlugValueWidget.__init__( self, self.__menuButton, plug, **kw )
+
+			self.__menuButton.buttonPressSignal().connect( Gaffer.WeakMethod( self.__buttonPress ) )
+			self.__menuButton.buttonDoubleClickSignal().connect( Gaffer.WeakMethod( self.__buttonDoubleClick ) )
+
+			self.__shadingModeToggle = Gaffer.Metadata.value( plug, "shadingModePlugValueWidget:defaultShadingModeToggle" )
 
 		def hasLabel( self ) :
 
 			return True
 
+		def getToolTip( self ) :
+
+			result = GafferUI.PlugValueWidget.getToolTip( self )
+
+			if self.__shadingModeToggle is not None :
+				if result :
+					result += "\n"
+				result += "## Actions\n\n"
+				result += "- <kbd>Ctrl</kbd> + click to toggle shading to `{}`\n".format( self.__shadingModeToggle if self.getPlug().isSetToDefault() else "Default" )
+
+			return result
+
+		def _updateFromValues( self, values, exception ) :
+
+			value = sole( values )
+			if value != self.getPlug().defaultValue() :
+				self.__shadingModeToggle = value
+				self.__menuButton.setImage( "shadingOn.png" )
+			else :
+				self.__menuButton.setImage( "shading.png" )
+
 		def __menuDefinition( self ) :
 
 			m = IECore.MenuDefinition()
@@ -583,6 +610,27 @@ def __setValue( self, value, *unused ) :
 
 			self.getPlug().setValue( value )
 
+		def __buttonPress( self, widget, event ) :
+
+			if event.buttons == event.Buttons.Left and event.modifiers == event.Modifiers.Control :
+
+				if not self.getPlug().isSetToDefault() :
+					self.getPlug().setToDefault()
+				elif self.__shadingModeToggle is not None :
+					self.getPlug().setValue( self.__shadingModeToggle )
+
+				return True
+
+			return False
+
+		def __buttonDoubleClick( self, widget, event ) :
+
+			if event.buttons == event.Buttons.Left and event.modifiers == event.Modifiers.Control :
+				# Prevent menu from opening when Control is held.
+				return True
+
+			return False
+
 ##########################################################################
 # _ExpansionPlugValueWidget
 ##########################################################################

resources/graphics.py

@@ -136,7 +136,8 @@
 				'grid', # \todo rename to 'sceneViewGadgets'
 				'selectionMaskOff',
 				'selectionMaskOn',
-				'shading'
+				'shading',
+				'shadingOn',
 			]
 
 		},