Merge branch '1.4_maintenance'

Changes.md

@@ -6,6 +6,11 @@
 1.4.x.x (relative to 1.4.1.0)
 =======
 
+Features
+--------
+
+- LightPositionTool : Added `Diffuse` mode for placing lights along the normal of the target position.
+
 Improvements
 ------------
 
@@ -14,6 +19,10 @@ Improvements
   - Changed default value for `principled_bsdf.specular_ior_level` to `0.5`, matching Blender.
   - Added support for `uv.tangent` and `uv.tangent_sign` primitive variables to assist in rendering with normal maps (#5269).
 - AttributeQuery, PrimitiveVariableQuery, ContextQuery, OptionQuery, ShaderQuery : Added support for querying arrays of length 1 as their equivalent scalar types.
+- CodeWidget : Added <kbd>Ctrl</kbd>+<kbd>L</kbd> shortcut for selecting all text on the current line.
+- AttributeTweaks, CameraTweaks, ShaderTweaks, OptionTweaks, PrimitiveVariableTweaks :
+  - Added support for a `{source}` token which is substituted with the original value when tweaking a string in `Replace` mode.
+  - Added tooltips documenting the tweak modes.
 
 Fixes
 -----
@@ -26,6 +35,13 @@ API
 
 - PlugAlgo : `setValueFromData()` and `canSetValueFromData()` now support conversion of arrays of length 1 to their equivalent scalar types.
 - BoxPlug : Added Python bindings for `ValueType`, `PointType` and `ChildType` type aliases.
+- RenderPassEditor : Added `deregisterColumn()` method.
+- DocumentationAlgo : Added table and strikethrough support to `markdownToHTML()`.
+
+Build
+-----
+
+- MacOS : Fixed issue where `Python.framework` may not be found when building with a prebuilt dependencies package.
 
 1.4.1.0 (relative to 1.4.0.0)
 =======

SConstruct

@@ -751,11 +751,14 @@ commandEnv["ENV"]["PATH"] = commandEnv.subst( "$BUILD_DIR/bin" + os.path.pathsep
 if env["PLATFORM"] == "win32" :
 	commandEnv["ENV"]["PATH"] = commandEnv.subst( "$BUILD_DIR/lib" + os.path.pathsep ) + commandEnv["ENV"]["PATH"]
 
-if commandEnv["PLATFORM"]=="darwin" :
+if commandEnv["PLATFORM"] == "darwin" :
 	commandEnv["ENV"]["DYLD_LIBRARY_PATH"] = commandEnv.subst( ":".join(
 		[ "/System/Library/Frameworks/ImageIO.framework/Resources", "$BUILD_DIR/lib" ] +
 		split( commandEnv["LOCATE_DEPENDENCY_LIBPATH"] )
 	) )
+	commandEnv["ENV"]["DYLD_FRAMEWORK_PATH"] = commandEnv.subst( ":".join(
+		[ "$BUILD_DIR/lib" ] + split( commandEnv["LOCATE_DEPENDENCY_LIBPATH"] )
+	) )
 elif commandEnv["PLATFORM"] == "win32" :
 	commandEnv["ENV"]["PATH"] = commandEnv.subst( ";".join( [ "$BUILD_DIR/lib" ] + split( commandEnv[ "LOCATE_DEPENDENCY_LIBPATH" ] ) + [ commandEnv["ENV"]["PATH"] ] ) )
 else:

doc/source/Interface/ControlsAndShortcuts/index.md

@@ -347,6 +347,7 @@ Drop scene location path(s) into Python Editor   | {{leftClick}} and drag select
 Indent selection                                 | {kbd}`Ctrl` + {kbd}`]`
 Unindent selection                               | {kbd}`Ctrl` + {kbd}`[`
 Comment/uncomment selection                      | {kbd}`Ctrl` + {kbd}`/`
+Select current line                              | {kbd}`Ctrl` + {kbd}`L`
 
 
 ### Execution ###

include/Gaffer/TweakPlug.h

@@ -148,6 +148,8 @@ class GAFFER_API TweakPlug : public Gaffer::ValuePlug
 			const std::string &tweakName
 		) const;
 
+		void applyReplaceTweak( const IECore::Data *sourceData, IECore::Data *tweakData ) const;
+
 		static const char *modeToString( Gaffer::TweakPlug::Mode mode );
 
 };

include/Gaffer/TweakPlug.inl

@@ -149,6 +149,10 @@ bool TweakPlug::applyTweak(
 	{
 		applyListTweak( currentValue, newData.get(), newData.get(), mode, name );
 	}
+	else if( mode == TweakPlug::Replace )
+	{
+		applyReplaceTweak( currentValue, newData.get() );
+	}
 
 	if( mode != Gaffer::TweakPlug::CreateIfMissing )
 	{

include/GafferSceneUI/LightPositionTool.h

@@ -79,13 +79,17 @@ class GAFFERSCENEUI_API LightPositionTool : public GafferSceneUI::TransformTool
 			const float targetDistance
 		);
 
+		// Positions the current selection to be `distance` away from `target`, along `normal`.
+		void positionAlongNormal( const Imath::V3f &target, const Imath::V3f &normal, const float targetDistance );
+
 		enum class Mode
 		{
 			Shadow,
 			Highlight,
+			Diffuse,
 
 			First = Shadow,
-			Last = Highlight
+			Last = Diffuse
 		};
 
 	protected :

python/GafferSceneUI/AttributeTweaksUI.py

@@ -99,6 +99,7 @@
 
 			"tweakPlugValueWidget:allowCreate", True,
 			"tweakPlugValueWidget:allowRemove", True,
+			"tweakPlugValueWidget:propertyType", "attribute",
 
 		],
 

python/GafferSceneUI/CameraTweaksUI.py

@@ -91,6 +91,7 @@
 
 			"tweakPlugValueWidget:allowRemove", True,
 			"tweakPlugValueWidget:allowCreate", True,
+			"tweakPlugValueWidget:propertyType", "parameter",
 
 		],
 

python/GafferSceneUI/LightPositionToolUI.py

@@ -48,8 +48,10 @@ def __toolTip( tool ) :
 	result = None
 	if mode == GafferSceneUI.LightPositionTool.Mode.Shadow :
 		result = "Hold 'Shift' + 'V' to place shadow pivot\nHold 'V' to place shadow target"
-	else :
+	elif mode == GafferSceneUI.LightPositionTool.Mode.Highlight :
 		result = "Hold 'V' to place highlight target"
+	else :
+		result = "Hold 'V' to place diffuse target"
 
 	return result
 
@@ -89,6 +91,7 @@ def __toolTip( tool ) :
 
 			"preset:Shadow", GafferSceneUI.LightPositionTool.Mode.Shadow,
 			"preset:Highlight", GafferSceneUI.LightPositionTool.Mode.Highlight,
+			"preset:Diffuse", GafferSceneUI.LightPositionTool.Mode.Diffuse,
 
 			"viewer:cyclePresetShortcut", "O",
 

python/GafferSceneUI/OptionTweaksUI.py

@@ -85,6 +85,7 @@
 		"tweaks.*" : [
 
 			"tweakPlugValueWidget:allowCreate", True,
+			"tweakPlugValueWidget:propertyType", "option",
 
 		],
 

python/GafferSceneUI/RenderPassEditor.py

@@ -199,6 +199,13 @@ def registerColumn( cls, groupKey, columnKey, inspectorFunction, section = "Main
 
 		section[columnKey] = inspectorFunction
 
+	@classmethod
+	def deregisterColumn( cls, groupKey, columnKey, section = "Main" ) :
+
+		sections = cls.__columnRegistry.get( groupKey )
+		if sections is not None and section in sections.keys() and columnKey in sections[section].keys() :
+			del sections[section][columnKey]
+
 	__addRenderPassButtonMenuSignal = None
 	## This signal is emitted whenever the add render pass button is clicked.
 	# If the resulting menu definition has been populated with items,

python/GafferSceneUI/ShaderTweaksUI.py

@@ -128,6 +128,7 @@
 			"noduleLayout:visible", False, # Can be shown individually using PlugAdder above
 			"tweakPlugValueWidget:allowCreate", True,
 			"tweakPlugValueWidget:allowRemove", True,
+			"tweakPlugValueWidget:propertyType", "parameter",
 
 		],
 

python/GafferSceneUITest/LightPositionToolTest.py

@@ -273,6 +273,61 @@ def testPositionHighlight( self ) :
 						places = 3
 					)
 
+	def __diffuseSource( self, lightP, diffuseP, normal ) :
+		d = ( lightP - diffuseP ).length()
+		return diffuseP + normal * d
+
+	def testPositionDiffuse( self ) :
+
+		random.seed( 42 )
+
+		script = Gaffer.ScriptNode()
+		script["light"] = GafferSceneTest.TestLight()
+
+		view = GafferSceneUI.SceneView()
+		view["in"].setInput( script["light"]["out"] )
+		GafferSceneUI.ContextAlgo.setSelectedPaths( view.getContext(), IECore.PathMatcher( [ "/light"] ) )
+
+		tool = GafferSceneUI.LightPositionTool( view )
+		tool["active"].setValue( True )
+
+		for i in range( 0, 5 ) :
+			lightP = imath.V3f( random.random() * 10 - 5, random.random() * 10 - 5, random.random() * 10 - 5 )
+			diffuseP = imath.V3f( random.random() * 10 - 5, random.random() * 10 - 5, random.random() * 10 - 5 )
+			normal = imath.V3f( random.random() * 2 - 1, random.random() * 2 - 1, random.random() * 2 - 1 ).normalized()
+
+			script["light"]["transform"]["translate"].setValue( lightP )
+
+			d0 = ( lightP - diffuseP ).length()
+			upDir = script["light"]["transform"].matrix().multDirMatrix( imath.V3f( 0, 1, 0 ) )
+
+			with Gaffer.Context() :
+				tool.positionAlongNormal( diffuseP, normal, d0 )
+
+			p = script["light"]["transform"]["translate"].getValue()
+
+			d1 = ( p - diffuseP ).length()
+			self.assertAlmostEqual( d0, d1, places = 4 )
+
+			desiredP = self.__diffuseSource( lightP, diffuseP, normal )
+
+			for j in range( 0, 3 ) :
+				self.assertAlmostEqual( p[j], desiredP[j], places = 4 )
+
+			desiredO = imath.M44f()
+			imath.M44f.rotationMatrixWithUpDir( desiredO, imath.V3f( 0, 0, -1 ), diffuseP - p, upDir )
+			rotationO = imath.V3f()
+			desiredO.extractEulerXYZ( rotationO )
+
+			o = script["light"]["transform"]["rotate"].getValue()
+
+			with self.subTest( f"Iteration {i}" ) :
+				self.assertAnglesAlmostEqual(
+					o,
+					IECore.radiansToDegrees( imath.V3f( rotationO ) ),
+					places = 3
+				)
+
 	def testEmptySelectionModeChange( self ) :
 
 		script = Gaffer.ScriptNode()

python/GafferTest/TweakPlugTest.py

@@ -451,5 +451,35 @@ def testStringListOperations( self ) :
 			self.assertTrue( plug.applyTweak( data ) )
 			self.assertEqual( data["v"], IECore.StringData( result ) )
 
+	def testStringSubstitutions( self ) :
+
+		for source, tweakMode, tweakValue, result in [
+			# Create modes don't support substitutions.
+			( None, Gaffer.TweakPlug.Mode.Create, "{source}", "{source}" ),
+			( None, Gaffer.TweakPlug.Mode.CreateIfMissing, "{source}", "{source}" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Create, "{source}", "{source}" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.CreateIfMissing, "{source}", "a" ),
+			# Neither do list modes.
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.ListAppend, "{source}", "a {source}" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.ListPrepend, "{source}", "{source} a" ),
+			# Replace mode does support substitutions.
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source}", "a" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "prefix{source}", "prefixa" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source}suffix", "asuffix" ),
+			( IECore.StringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source} {source}", "a a" ),
+			# And works with InternedStringData too.
+			( IECore.InternedStringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source}", "a" ),
+			( IECore.InternedStringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "prefix{source}", "prefixa" ),
+			( IECore.InternedStringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source}suffix", "asuffix" ),
+			( IECore.InternedStringData( "a" ), Gaffer.TweakPlug.Mode.Replace, "{source} {source}", "a a" ),
+		] :
+			with self.subTest( source = source, tweakMode = tweakMode, tweakValue = tweakValue ) :
+				plug = Gaffer.TweakPlug( "v", tweakValue, tweakMode )
+				data = IECore.CompoundData( { "v" : source } )
+				self.assertTrue( plug.applyTweak( data ) )
+				if source is not None :
+					self.assertIs( type( data["v"] ), type( source ) )
+				self.assertEqual( data["v"].value, result )
+
 if __name__ == "__main__":
 	unittest.main()

python/GafferUI/CodeWidget.py

@@ -111,6 +111,8 @@ def __keyPress( self, widget, event ) :
 			return self.__commentPress()
 		elif event.key == "Return" and event.modifiers == event.Modifiers.None_ :
 			return self.__returnPress()
+		elif event.modifiers == event.Modifiers.Control and event.key == "L" :
+			return self.__extendSelectionPress()
 
 		return False
 
@@ -241,6 +243,33 @@ def __returnPress( self ) :
 
 		return True
 
+	def __extendSelectionPress( self ) :
+
+		cursor = self._qtWidget().textCursor()
+
+		if cursor.hasSelection() :
+			# Extend an existing selection to contain the beginning of the
+			# first selected line through to the end of the last selected line.
+			selectionEnd = cursor.selectionEnd()
+			cursor.setPosition( cursor.selectionStart(), cursor.MoveAnchor )
+			cursor.movePosition( cursor.StartOfLine, cursor.MoveAnchor )
+			cursor.setPosition( selectionEnd, cursor.KeepAnchor )
+			cursor.movePosition( cursor.EndOfLine, cursor.KeepAnchor )
+		else :
+			# Select the entire line where the cursor is currently positioned.
+			cursor.movePosition( cursor.StartOfLine, cursor.MoveAnchor )
+			cursor.movePosition( cursor.EndOfLine, cursor.KeepAnchor )
+
+		if not cursor.atEnd() :
+			# Move the cursor to the start of the next line to allow
+			# repeated presses to extend the selection to subsequent lines.
+			cursor.movePosition( cursor.Down, cursor.KeepAnchor )
+			cursor.movePosition( cursor.StartOfLine, cursor.KeepAnchor )
+
+		self._qtWidget().setTextCursor( cursor )
+
+		return True
+
 	def __textChanged( self, widget ) :
 
 		if self.__completionMenu is not None :

python/GafferUI/ContextVariableTweaksUI.py

@@ -85,6 +85,7 @@
 		"tweaks.*" : [
 
 			"tweakPlugValueWidget:allowCreate", True,
+			"tweakPlugValueWidget:propertyType", "context variable",
 
 		]