ArnoldShaderUI : Add presets menu for image.color_space parameter

Changes.md

@@ -1,3 +1,17 @@
+1.3.x.x (relative to 1.3.10.0)
+=======
+
+Improvements
+------------
+
+- ArnoldShader : Added a colour space presets menu for the `image` shader.
+- CyclesShader : Added a colour space presets menu for the `image_texture` and `environment_texture` shaders (#5618).
+
+API
+---
+
+- ArnoldShaderUI : Added support for `colorSpace` widget type metadata, allowing an OpenColorIO colour space to be chosen.
+
 1.3.10.0 (relative to 1.3.9.0)
 ========
 

arnoldPlugins/gaffer.mtd

@@ -1473,6 +1473,7 @@
 		gaffer.fileSystemPath.extensions STRING "tx"
 	[attr color_space]
 		gaffer.layout.index INT 1
+		widget STRING "colorSpace"
 	[attr uvset]
 		gaffer.layout.index INT 2
 

python/GafferArnoldUI/ArnoldShaderUI.py

@@ -47,6 +47,7 @@
 
 import Gaffer
 import GafferUI
+import GafferImageUI
 import GafferSceneUI
 import GafferArnold
 
@@ -289,13 +290,26 @@ def __translateNodeMetadata( nodeEntry ) :
 				"mapper" : "GafferUI.PresetsPlugValueWidget",
 				"filename" : "GafferUI.FileSystemPathPlugValueWidget",
 				"camera" : "GafferSceneUI.ScenePathPlugValueWidget",
+				"colorSpace" : "GafferUI.PresetsPlugValueWidget",
 				"null" : "",
 			}[widget]
 
 			if widget == "camera" :
 				__metadata[paramPath]["scenePathPlugValueWidget:setNames"] = IECore.StringVectorData( [ "__cameras" ] )
 				__metadata[paramPath]["scenePathPlugValueWidget:setsLabel"] = "Show only cameras"
 
+			if widget == "colorSpace" :
+				# Here we're assuming that Arnold is being used with an OCIO
+				# colour manager configured to match Gaffer.
+				__metadata[paramPath]["presetNames"] = GafferImageUI.OpenColorIOTransformUI.colorSpacePresetNames
+				__metadata[paramPath]["presetValues"] = GafferImageUI.OpenColorIOTransformUI.colorSpacePresetValues
+				__metadata[paramPath]["openColorIO:extraPresetNames"] = IECore.StringVectorData( [ "Auto" ] )
+				__metadata[paramPath]["openColorIO:extraPresetValues"] = IECore.StringVectorData( [ "auto" ] )
+				__metadata[paramPath]["openColorIO:includeRoles"] = True
+				# Allow custom values in case Arnold has been configured to use
+				# some other colour manager instead.
+				__metadata[paramPath]["presetsPlugValueWidget:allowCustom"] = True
+
 		# Layout section from OSL "page".
 
 		page = __aiMetadataGetStr( nodeEntry, paramName, "page" )

python/GafferCyclesUI/CyclesShaderUI.py

@@ -44,6 +44,7 @@
 import GafferUI
 import GafferCycles
 import GafferImage
+import GafferImageUI
 
 ##########################################################################
 # Build a registry of information retrieved from GafferCycles metadata.
@@ -122,6 +123,19 @@ def __translateNodesMetadata( nodeTypes ) :
 	paramPath = nodeTypeName + ".parameters.type"
 	__metadata[paramPath]["noduleLayout:visible"] = False
 
+# Add OCIO colorspace menus where appropriate. There doesn't seem to be anywhere
+# we can query this from the Cycles API, so we just hardcode it to shaders know about.
+
+for parameter in [ "image_texture.parameters.colorspace", "environment_texture.parameters.colorspace" ] :
+	# Here we're assuming that Cycles is being used with an OCIO config that matches Gaffer's.
+	__metadata[parameter]["plugValueWidget:type"] = "GafferUI.PresetsPlugValueWidget"
+	__metadata[parameter]["presetNames"] = GafferImageUI.OpenColorIOTransformUI.colorSpacePresetNames
+	__metadata[parameter]["presetValues"] = GafferImageUI.OpenColorIOTransformUI.colorSpacePresetValues
+	__metadata[parameter]["openColorIO:extraPresetNames"] = IECore.StringVectorData( [ "Auto" ] )
+	__metadata[parameter]["openColorIO:extraPresetValues"] = IECore.StringVectorData( [ "" ] )
+	__metadata[parameter]["openColorIO:includeRoles"] = True
+	# Allow custom values in case Cycles has been configured to use some other OCIO config.
+	__metadata[parameter]["presetsPlugValueWidget:allowCustom"] = True
 
 ##########################################################################
 # Gaffer Metadata queries. These are implemented using the preconstructed
@@ -168,7 +182,11 @@ def __plugMetadata( plug, name ) :
 		# Node type is CyclesLight.
 		key = plug.node()["__shader"]["name"].getValue() + "." + plug.relativeName( node )
 
-	return __metadata[key].get( name )
+	result = __metadata[key].get( name )
+	if callable( result ) :
+		return result( plug )
+	else :
+		return result
 
 for nodeType in ( GafferCycles.CyclesShader, GafferCycles.CyclesLight ) :