Merge pull request #6531 from murraystevenson/sceneInspectorRevampDrag

SceneInspector Revamp : Small UI Improvements

Author: murraystevenson

Changes.md

@@ -5,6 +5,15 @@ Improvements
 ------------
 
 - RenderMan : Added dedicated viewport visualisers for RenderMan lights.
+- SceneInspector :
+  - Cells dragged from the "Name" column now return their name, rather than their full path [^1].
+  - 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].
+
+Fixes
+-----
+
+- PathListingWidget : Columns set to automatically stretch now equally share available space when a PathListingWidget's columns are updated via `setColumns()`.
 
 Fixes
 -----

python/GafferSceneUI/SceneInspector.py

@@ -131,13 +131,14 @@ def __init__( self, scriptNode, **kw ) :
 
 		self.settings()["compare"]["scene"]["value"].setInput( self.settings()["in"] )
 
+		nameColumn = GafferUI.StandardPathColumn( "Name", "name" )
 		self.__standardColumns = [
-			GafferUI.StandardPathColumn( "Name", "name" ),
+			nameColumn,
 			GafferSceneUI.Private.InspectorColumn( "inspector:inspector", headerData = GafferUI.PathColumn.CellData( value = "Value" ) ),
 		]
 
 		self.__diffColumns = [
-			GafferUI.StandardPathColumn( "Name", "name" ),
+			nameColumn,
 			_GafferSceneUI._SceneInspector.InspectorDiffColumn( _GafferSceneUI._SceneInspector.InspectorDiffColumn.DiffContext.A ),
 			_GafferSceneUI._SceneInspector.InspectorDiffColumn( _GafferSceneUI._SceneInspector.InspectorDiffColumn.DiffContext.B ),
 		]
@@ -176,6 +177,7 @@ def __init__( self, scriptNode, **kw ) :
 						displayMode = GafferUI.PathListingWidget.DisplayMode.Tree,
 						sortable = False,
 					)
+					self.__locationPathListing.dragBeginSignal().connectFront( Gaffer.WeakMethod( self.__dragBegin ) )
 
 				with GafferUI.ListContainer( spacing = 4, borderWidth = 4, parenting = { "label" : "Globals" } ) :
 
@@ -195,6 +197,7 @@ def __init__( self, scriptNode, **kw ) :
 						displayMode = GafferUI.PathListingWidget.DisplayMode.Tree,
 						sortable = False,
 					)
+					self.__globalsPathListing.dragBeginSignal().connectFront( Gaffer.WeakMethod( self.__dragBegin ) )
 
 		GafferSceneUI.ScriptNodeAlgo.selectedPathsChangedSignal( scriptNode ).connect(
 			Gaffer.WeakMethod( self.__selectedPathsChanged )
@@ -285,6 +288,16 @@ def __updateFilter( self, tree, plug ) :
 
 		tree.setFilter( pattern )
 
+	def __dragBegin( self, widget, event ) :
+
+		assert( widget in ( self.__locationPathListing, self.__globalsPathListing ) )
+		# Return leaf names rather than full paths when dragging from the Name column.
+		## \todo Support creation of columns in other editors by dragging attributes/options/etc
+		# from the Scene Inspector.
+		selection = widget.getSelection()[0]
+		if not selection.isEmpty() :
+			return IECore.StringVectorData( [ path.split( "/" )[-1] for path in selection.paths() ] )
+
 GafferUI.Editor.registerType( "SceneInspector", SceneInspector )
 
 # InspectorTree isn't public API. Expose the `registerInspectors()` function on SceneInspector
@@ -555,9 +568,9 @@ def __init__( self, plug, **kw ) :
 				self.__icon._qtWidget().setFixedWidth( 13 )
 				self.__icon.buttonPressSignal().connect( Gaffer.WeakMethod( self.__showFocusMenu ) )
 
-				menuButton = GafferUI.Button( image="menuIndicator.png", hasFrame=False, highlightOnOver=False )
-				menuButton._qtWidget().setObjectName( "menuDownArrow" )
-				menuButton.buttonPressSignal().connect( Gaffer.WeakMethod( self.__showFocusMenu ) )
+				self.__menuButton = GafferUI.Button( image="menuIndicator.png", hasFrame=False, highlightOnOver=False )
+				self.__menuButton._qtWidget().setObjectName( "menuDownArrow" )
+				self.__menuButton.buttonPressSignal().connect( Gaffer.WeakMethod( self.__showFocusMenu ) )
 
 		self.__nodeSetChangedSignal = GafferUI.WidgetSignal()
 
@@ -604,6 +617,11 @@ def nodeSetChangedSignal( self ) :
 
 		return self.__nodeSetChangedSignal
 
+	def setHighlighted( self, highlighted ) :
+
+		self.__icon.setHighlighted( highlighted )
+		self.__menuButton.setHighlighted( highlighted )
+
 	def __updateInput( self, *unused ) :
 
 		input = None
@@ -745,8 +763,50 @@ def __init__( self, plug, **kw ) :
 
 		with row :
 			labelWidget = _InputLabelWidget()
-			focusWidget = _FocusPlugValueWidget( plug )
-			labelWidget.connectToNodeSetWidget( focusWidget )
+			self.__focusWidget = _FocusPlugValueWidget( plug )
+			labelWidget.connectToNodeSetWidget( self.__focusWidget )
+
+		self.dragEnterSignal().connectFront( Gaffer.WeakMethod( self.__dragEnter ) )
+		self.dragLeaveSignal().connectFront( Gaffer.WeakMethod( self.__dragLeave ) )
+		self.dropSignal().connectFront( Gaffer.WeakMethod( self.__drop ) )
+
+	def __dropNode( self,  event ) :
+
+		if isinstance( event.data, Gaffer.Node ) :
+			return event.data
+		elif isinstance( event.data, Gaffer.Set ) :
+			for node in reversed( event.data ):
+				if isinstance( node, Gaffer.Node ) :
+					return node
+		else:
+			return None
+
+	def __dragEnter( self, widget, event ) :
+
+		if self.isAncestorOf( event.sourceWidget ) :
+			return False
+
+		if self.__dropNode( event ) :
+			self.__focusWidget.setHighlighted( True )
+
+		return True
+
+	def __dragLeave( self, widget, event ) :
+
+		self.__focusWidget.setHighlighted( False )
+
+		return True
+
+	def __drop( self, widget, event ) :
+
+		node = self.__dropNode( event )
+
+		if node :
+			self.__focusWidget.setNodeSet( nodeSet = Gaffer.StandardSet( [ node ] ) )
+
+		self.__focusWidget.setHighlighted( False )
+
+		return True
 
 # Simple widget that just displays the `renderPass` variable from
 # the current context.

python/GafferUI/PathListingWidget.py

@@ -1167,7 +1167,7 @@ def updateColumnWidths( self, columnsChanged = False ) :
 		if columnWidthsChanged or columnsChanged :
 			# The space available for stretch columns may have changed, so
 			# adjust them to fit.
-			self.__resizeStretchColumns()
+			self.__resizeStretchColumns( columnsChanged )
 
 		if stretchLastColumn :
 			# finally, resize the last column to make use of any remaining available width
@@ -1332,7 +1332,7 @@ def __resizeLastColumnToAvailableWidth( self, minimumSuggestedWidth = 0 ) :
 		header.resizeSection( lastColumn, adjustedWidth )
 		self.__recalculatingColumnWidths = False
 
-	def __resizeStretchColumns( self ) :
+	def __resizeStretchColumns( self, columnsChanged = False ) :
 
 		header = self.header()
 		availableWidth = self.viewport().width()
@@ -1359,8 +1359,12 @@ def __resizeStretchColumns( self ) :
 
 		weight = 1.0 / len( columnsToStretch )
 		for c in columnsToStretch :
-			if stretchColumnWidth > 0 :
-				# preserve any existing column proportions
+			if stretchColumnWidth > 0 and not columnsChanged :
+				# preserve any existing column proportions when resizing
+				# existing columns if the columns haven't changed. If
+				# the columns have changed then we're better off equally
+				# assigning the available space rather than preserving any
+				# existing header widths.
 				weight = header.sectionSize( c ) / stretchColumnWidth
 
 			## \todo A very small resize with multiple stretch columns can result in the

python/GafferUITest/PathListingWidgetTest.py

@@ -1624,6 +1624,43 @@ def testColumnWidthsWhenRemovingLastColumn( self ) :
 				widget.setColumns( widget.getColumns()[:-1] )
 				self.assertEqual( widget._qtWidget().header().length(), widget._qtWidget().viewport().width() )
 
+	def testStretchColumnWidthsWhenUpdatingColumns( self ) :
+
+		with GafferUI.Window() as window :
+			widget = GafferUI.PathListingWidget(
+				path = Gaffer.DictPath( {}, "/" ),
+				displayMode = GafferUI.PathListingWidget.DisplayMode.List,
+				columns = [
+					GafferUI.PathListingWidget.StandardColumn( "Test", "test" ),
+					GafferUI.PathListingWidget.StandardColumn( "Test", "test", sizeMode = GafferUI.PathColumn.SizeMode.Stretch )
+				]
+			)
+
+		window._qtWidget().resize( 512, 384 )
+		window.setVisible( True )
+
+		self.waitForIdle( 1000 )
+
+		widget.setColumns( [
+			GafferUI.PathListingWidget.StandardColumn( "Test", "test" ),
+			GafferUI.PathListingWidget.StandardColumn( "Test", "test", sizeMode = GafferUI.PathColumn.SizeMode.Stretch ),
+			GafferUI.PathListingWidget.StandardColumn( "Test", "test", sizeMode = GafferUI.PathColumn.SizeMode.Stretch )
+		] )
+
+		self.waitForIdle( 1000 )
+
+		# Our two Stretch columns should equally share the available space
+		self.assertEqual( widget._qtWidget().header().sectionSize( 1 ), widget._qtWidget().header().sectionSize( 2 ) )
+		self.assertAlmostEqual(
+			widget._qtWidget().header().sectionSize( 1 ) + widget._qtWidget().header().sectionSize( 2 ),
+			widget._qtWidget().viewport().width() - widget._qtWidget().header().sectionSize( 0 ),
+			## \todo If the available space is an odd number of pixels, we require this delta as `_TreeView.__resizeStretchColumns`
+			# will resize both stretch columns to the same width and leave the remaining pixel. We should update `_TreeView.__resizeStretchColumns`
+			# to use _all_ available space, though this will require moving this delta to the previous assertion as the resulting column
+			# widths could then differ by 1...
+			delta = 1
+		)
+
 	def testColumnSizeSurvivesStylesheetUpdate( self ) :
 
 		for visible in ( False, True ) :