Gaffer 1.4.0.0b5

Improvements

• LightPositionTool : The tool is now only visible for members of the __lights set, instead of all objects.
• Catalogue : Added imageNames output plug, containing the names of all images in the Catalogue. Among other things this can be used to drive a Wedge or ContactSheet node and a CatalogueSelect.
• Render, InteractiveRender : Added resolvedRenderer plug, which outputs the name of the renderer that will be used, taking into account the influence of the render:defaultRenderer option ¹.

Fixes

• PlugAlgo : Updated canSetValueFromData(), setValueFromData() and getValueAsData() with support for missing types.
• LightPositionTool : Fixed lingering shadow pivot point after placing a shadow pivot, switching to highlight mode and switching back to shadow mode ¹.
• Catalogue :
  • Fixed undo for image reordering via drag & drop.
  • Fixed bugs caused by reordering images using GraphComponent::reorderChildren().
• InteractiveRender : Fixed context used to evaluate scene globals when renderer is set to "Default" ¹.
• Instancer : Fixed handling of unindexed primvars in RootPerVertex mode ¹.
• ImageGadget :
  • Fixed loading of 2 channel images ¹.
  • Fixed error message to include filename ¹.
• Expression : setExpression() now respects configs that provide backwards compatibility for old plug names.
• Shuffle : Fixed default name for plugs constructed via the legacy ChannelPlug( out, in ) constructor ¹.
• ImageReader :
  • Fixed loading of OpenEXR images with 32 bit float data and DWA compression ¹.
  • Fixed loading of secondary layers in OpenEXR images with DWA compression ¹.
• GUI : Fixed potential crashes during shutdown ¹.
• ScriptNode : Fixed execution of multi-line if : statements in .gfr files ¹.
• ArnoldShader : Fixed startup errors caused by unknown values in widget metadata ¹.

API

• TypedObjectPlug : Added Python bindings for the default values of the defaultValue constructor argument.
• Box2fVectorDataPlug : Added new plug type for storing arrays of Box2f.
• Catalogue : Deprecated image:index metadata.

Breaking Changes

• StandardLightVisualiser : Added attributeName argument to surfaceTexture() virtual method.

Build

• OpenEXR : Applied patches from the following pull requests :
  • AcademySoftwareFoundation/openexr#1591
  • AcademySoftwareFoundation/openexr#1684

1. To be omitted from final release notes for 1.4.0.0. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶ ↩⁷ ↩⁸ ↩⁹ ↩¹⁰ ↩¹¹ ↩¹²

Gaffer 1.3.15.0

Improvements

• Render, InteractiveRender : Added resolvedRenderer plug, which outputs the name of the renderer that will be used, taking into account the influence of the render:defaultRenderer option.

Fixes

• InteractiveRender : Fixed context used to evaluate scene globals when renderer is set to "Default".
• Instancer : Fixed handling of unindexed primvars in RootPerVertex mode.
• ArnoldShader : Fixed startup errors caused by unknown values in widget metadata.

Gaffer 1.4.0.0b4

Features

• Render, InteractiveRender : Added new nodes capable of rendering to any supported renderer, and using the render:defaultRenderer option to determine which to use by default.
• StandardOptions : Added render:defaultRenderer option, allowing the scene globals to specify which renderer is used by the Render and InteractiveRender nodes.
• RenderPassEditor : Added a column for the render:defaultRenderer option, allowing each pass to be rendered in a different renderer.

Improvements

• GraphEditor : Removed all renderer-specific Render and InteractiveRender nodes from the node menu. These nodes still exist for backwards compatibility with old scenes, but the generic Render and InteractiveRender nodes should now be used instead.

Fixes

• Windows : Removed "Error(s) running Gaffer" shutdown message. It was misleading when errors originated in the renderer rather than Gaffer itself.

Documentation

• Updated with generic Render and InteractiveRender nodes in place of deprecated renderer-specific nodes.

Breaking Changes

• CyclesOptions : Removed cycles:integrator:sampling_pattern option. This is intended only for debugging, but is still available via a CustomOptions node.
• CyclesAttributes : Removed the cycles:dupliGenerated and cycles:dupliUV attributes.

Gaffer 1.3.14.0

Features

• Render, InteractiveRender : Added new nodes capable of rendering to any supported renderer, and using the render:defaultRenderer option to determine which to use by default.
• StandardOptions : Added render:defaultRenderer option, allowing the scene globals to specify which renderer is used by the Render and InteractiveRender nodes.
• RenderPassEditor : Added a column for the render:defaultRenderer option, allowing each pass to be rendered in a different renderer.

Gaffer 1.4.0.0b3

Fixes

• Tractor : Fixed failure to import Tractor API [^1].
• Cycles :
  • Fixed hangs and crashes when using non-default session modes such as SVM shading.
  • Fixed failure to render background light in batch renders (#5234).
  • Fixed failure to update when reverting a background shader to previous values.
• GafferUI :
  • Fixed Color space 'sRGB' could not be found errors when running with certain custom OCIO configs (#5695).
  • Fixed icon colours when running with an ACES OCIO config.
• DocumentationAlgo : Fixed generation of duplicate entries for aliased nodes in exportNodeReference() [^1].

Documentation

• Node Reference : Removed duplicate entries for nodes that have been aliased by compatibility configs [^1].

Breaking Changes

• CyclesOptions : Changed hairShape default value to "ribbon", to match Cycles' and Blender's own defaults.
• Pointer :
  • Removed Pointer( const ImagePrimitive * ) constructor.
  • Removed image() method.

API

• ImageGadget : Removed textureLoader() method.
• Pointer : Added fileName() method.

Gaffer 1.3.13.1

Fixes

• DocumentationAlgo : Fixed generation of duplicate entries for aliased nodes in exportNodeReference().

Documentation

• Node Reference : Removed duplicate entries for nodes that have been aliased by compatibility configs.

Gaffer 1.4.0.0b2

Features

• GraphEditor : Added X shortcut for removing connections between nodules. Hold X then left click to remove all connections under the cursor. Hold X then left drag to draw a line, all connections that intersect with the line will be removed once the drag is ended (#788).
• LightPosition Tool : Added a variation on the shadow placement tool to place highlights. Lights are positioned such that they will create a specular highlight at the target point.

Improvements

• ImageReader : Added fileValid = False metadata to images from missing frames, when missingFrameMode is Black or Hold.
• Viewer : Added Ctrl+PgUp shortcut for displaying the RGBA image layer (or the first available layer if RGBA doesn't exist) [^1].
• RenderPassEditor [^1] :
  • Added "Inclusions", "Exclusions" and "Additional Lights" columns, to provide control over the locations included in the render for each render pass.
  • Added the ability to display render passes grouped in a hierarchy generated from the render pass name. The default grouping uses the first token delimited by "_" from the render pass name, such that render passes named "char_gafferBot" and "char_cow" would be displayed under a "/char" group, while "prop_ball" and "prop_box" would be displayed under a "/prop" group.
  • Render pass grouping can be configured in a startup file by using GafferSceneUI.RenderPassEditor.registerPathGroupingFunction( f ), where f is a function that receives a render pass name and returns the path that the render pass should be grouped under.
  • Grouped display can be enabled by default in a startup file by using Gaffer.Metadata.registerValue( GafferSceneUI.RenderPassEditor.Settings, "displayGrouped", "userDefault", IECore.BoolData( True ) ).
  • Dragging cells selected from the "Name" column now provides a list of the selected render pass names, rather than their paths.
  • Disabled render pass names are now dimmed to more clearly indicate their state.
• RenderPassEditor, LightEditor, PathListingWidget : Boolean values are now displayed as checkboxes rather than 0 or 1 [^1].
• Collect : Added the ability to collect StringVectorData inputs.
• StandardOptions : Added inclusions, exclusions and additionalLights plugs, to control which locations are included in a render based on set expressions entered on these plugs. These, plus the existing includedPurposes plug are now grouped under the "Render Set" section of the UI [^1].
• GafferScene : Registered the "RenderSetAdaptor" adapting the render:inclusions, render:exclusions and render:additionalLights options to prune scene locations before rendering [^1].

Fixes

• 3Delight : Fixed startup errors on Windows when the DELIGHT environment variable wasn't defined [^1].
• FlatImageProcessor : Fixed bug that could cause an input to be evaluated with an invalid image:viewName.
• Collect : Fixed display of results collected from TypedObjectPlug inputs.

API

• ScenePath : Added automatic conversion of a list of Python strings to a ScenePath [^1].
• RenderPassEditor : Added registerPathGroupingFunction() and pathGroupingFunction() methods [^1].
• ExtensionAlgo : Added exportNode() and exportNodeUI() functions.
• Widget : Added a 0.5 pixel offset to ButtonEvent.line objects passed to mouse event signals such as buttonPressSignal() and dragMoveSignal()

Breaking Changes

• CyclesOptions :
  • Removed useFrameAsSeed plug. The frame is now automatically used as the seed if seed is not set.
  • Removed all texture cache options. These had never been exposed in the UI because this never became an offical Cycles feature.
  • Removed cryptomatteAccurate. This feature is no longer present in Cycles.

[^1] : To be omitted from final release notes for 1.4.0.0.

Gaffer 1.3.13.0

Improvements

• Viewer : Added Ctrl+PgUp shortcut for displaying the RGBA image layer (or the first available layer if RGBA doesn't exist).
• RenderPassEditor :
  • Added "Inclusions", "Exclusions" and "Additional Lights" columns, to provide control over the locations included in the render for each render pass.
  • Added the ability to display render passes grouped in a hierarchy generated from the render pass name. The default grouping uses the first token delimited by "_" from the render pass name, such that render passes named "char_gafferBot" and "char_cow" would be displayed under a "/char" group, while "prop_ball" and "prop_box" would be displayed under a "/prop" group.
  • Render pass grouping can be configured in a startup file by using GafferSceneUI.RenderPassEditor.registerPathGroupingFunction( f ), where f is a function that receives a render pass name and returns the path that the render pass should be grouped under.
  • Grouped display can be enabled by default in a startup file by using Gaffer.Metadata.registerValue( GafferSceneUI.RenderPassEditor.Settings, "displayGrouped", "userDefault", IECore.BoolData( True ) ).
  • Dragging cells selected from the "Name" column now provides a list of the selected render pass names, rather than their paths.
  • Disabled render pass names are now dimmed to more clearly indicate their state.
• RenderPassEditor, LightEditor, PathListingWidget : Boolean values are now displayed as checkboxes rather than 0 or 1.
• StandardOptions : Added inclusions, exclusions and additionalLights plugs, to control which locations are included in a render based on set expressions entered on these plugs. These, plus the existing includedPurposes plug are now grouped under the "Render Set" section of the UI.
• GafferScene : Registered the "RenderSetAdaptor" adapting the render:inclusions, render:exclusions and render:additionalLights options to prune scene locations before rendering.

API

• ScenePath : Added automatic conversion of a list of Python strings to a ScenePath.
• RenderPassEditor : Added registerPathGroupingFunction() and pathGroupingFunction() methods.

Gaffer 1.4.0.0b1

Note : This release introduces linux-gcc11 builds which are only compatible with Linux distributions using glibc 2.28 or higher.
These specific linux-gcc11 builds are intended for testing purposes while we upgrade our toolchain and dependencies to better align
with VFX Platform 2023, and should be considered "beta" in advance of a stable release in Gaffer 1.5.

Known bugs : Gaffer may crash when stopping an InteractiveCyclesRender with the CPU device and SVM shading mode. A fix is in progress.

Features

• Cycles :
  • Updated to version 4.0.2.
  • Added support for CUDA and Optix devices (GCC 11 builds only).
• Dispatcher : Dispatchers are now TaskNodes, allowing them to be nested in a task graph. Possibilities include :
  • Using a LocalDispatcher and a Wedge to launch multiple TractorDispatcher jobs.
  • Using a nested LocalDispatcher to perform a group of tasks on a single blade within a TractorDispatcher job.
• DeepSlice : Added a new node for clipping out part of an image based on depth.
• ImageInspector : Added a new panel for inspecting image format, metadata and channel statistics.

Improvements

• Arnold : Gaffer's native OpenColorIO config is now automatically translated to Arnold. Use an ArnoldColorManager node to override this behaviour.
• Toolbars : Changed hotkey behavior to toogle any tool on and off. Exclusive tools such as the Translate and Crop Window tools activate the first tool (currently Selection Tool) when they are toggled off.
• CropWindowTool : Added Alt + C for toggling both the crop window tool and the relevant crop window enabled plug.
• TaskList, FrameMask : Reimplemented in C++ for improved performance.
• LocalDispatcher :
  • Added a new dockable LocalJobs editor, to replace the floating window previously accessible via the "Execute/Local Jobs" menu item.
  • Task output is now shown in the UI.
  • Jobs are no longer removed from the UI as soon as they complete.
  • Incomplete jobs are now killed automatically when the application is closed, after prompting to confirm that shutdown should go ahead.
• Cache : Increased default computation cache size to 8Gb. Call Gaffer.ValuePlug.setCacheMemoryLimit() from a startup file to override this.
• Dispatcher : Reduced internal overhead of dispatch() call, with one benchmark showing around a 3x speedup.
• ScriptWindow : Added "Save" option to dialogue shown when closing a window containing unsaved changes.
• Resize :
  • Added support for deep images.
  • Added "Nearest" filter.
• Shuffle :
  • Reimplemented to match ShuffleAttributes and ShufflePrimitiveVariables.
    • Any number of shuffles can be added using the UI.
    • Wildcards can be used to match multiple source channels, and expressions can be used to map them to destination channels.
    • Source channels can optionally be deleted after shuffling.
    • Overwriting of destination channels can optionally be avoided.
  • Added missingSourceMode plug to determine behaviour when a source channel doesn't exist.
• NodeEditor : Improved image channel selectors :
  • Added "Custom" option, to allow strings to be entered manually.
  • Added right-click context menu.
• Switch : Added connectedInputs output plug.
• Backdrop : Improved drawing order for nested backdrops :
  • Larger backdrops are automatically drawn behind smaller ones, so that nested backdrops will always appear on top.
  • Added a depth plug to assign a manual drawing depth for the rare cases where the automatic depth is unwanted.
• ImageStats : Added areaSource plug, allowing area to be driven by the input display window or data window.
• 3Delight :
  • Added camera overscan support.
  • NSI scene description export format is now based on file extension - .nsi for binary and .nsia for ASCII.
  • Added support for reading dl: and user: attributes from shaders.
  • Added importanceSampleFilter plug to DelightOptions, providing denoiser-compatible output.
  • Matched DelightOptions default values for oversampling and shadingSamples to 3Delight's own default values.
  • Added support for external procedurals.
• GraphEditor : Improved logic used to connect a newly created node to the selected nodes.
• ScenePlug, ImagePlug : Child plugs are now serialisable. Among other things, this enables them to be driven by expressions (#3986).
• Premultiply : Added useDeepVisibility plug, which weights samples according to their visibility based on the opacity of samples in front.
• CyclesOptions : Improved device selection UI.
• ImageReader : Improved multithreading of EXR reads. This can result in a performance improvement of around 4X for large images.
• Added OIIO config that disables OIIO threading by default. This simplifies our threading model, and has no impact on performance for our main use cases. If read performance of Gaffer compositing using non-EXR formats, such as Tiff, is important to you, you may want to add your own config to turn OIIO threading back on.

Fixes

• BackgroundTask : Fixed potential deadlock caused by destroying a BackgroundTask from Python while it was still running.
• Dispatcher : The job directory is no longer created when dispatch is cancelled by a slot connected to preDispatchSignal().
• LocalDispatcher :
  • Fixed delays and zombie processes caused by shutting down Gaffer while background jobs were running. Background jobs are now killed before Gaffer exits instead.
  • Stopped failed jobs jumping to the end of the Local Jobs UI.
  • Fixed message log update.
  • Fixed Job.statistics() errors on Windows, ensuring that a pid is always returned when available.
• ImageStats :
  • Fixed output of infinite values, which were previously being clamped.
  • Results for min/max now correctly reflect zero values outside the data window.
• NodeMenu, NodeEditor : userDefault metadata is now evaluated in the script context, so it can depend on script variables.
• 3Delight : Fixed loading of surface shaders such as dlStandard so that they can be connected to the inputs of shaders such as dlLayeredMaterial.
• DeepState : Fixed handling of NaN values and samples where ZBack is less than Z.
• Premultiply : Fixed handling of non-existent alpha channel.
• PlugAlgo : Fixed promotion of CompoundDataPlugs with non-dynamic children, such as the Camera.renderSettingOverrides plug.
• ColorToVector : Fixed parameter types.

API

• PathColumn :
  • Added CellData::sortValue member, to provide additional control over sorting in the PathListingWidget.
  • Added missing Python binding for headerData() method.
• StandardPathColumn :
  • Added constructor which allows the full header CellData to be specified.
  • Added missing Python binding for property() method.
• IconPathColumn :
  • Added constructor which allows the full header CellData to be specified.
  • Added prefix() and property() accessors.
• Window : Added preCloseSignal(), which allows connected slots to prevent a window from being closed.
• LocalDispatcher :
  • Added Job.status() and Job.statusChangedSignal() methods.
  • Added Job.messages() and Job.messagesChangedSignal() methods.
  • Added Job.frameRange(), Job.environmentCommand() and Job.startTime() methods.
  • Added Job.cpuUsage() and Job.memoryUsage() methods.
  • Added JobPool.addJob() and JobPool.removeJob() methods.
• GafferTractor : Added tractorAPI() method used for accessing the tractor.api.author module.
• GafferTractorTest : Added tractorAPI() method which returns a mock API if Tractor is not available. This allows the GafferTractor module to be tested without Tractor being installed.
• ParallelAlgo : Added canCallOnUIThread() function.
• Label : Added textSelectable constructor argument.
• ShufflesPlug :
  • Added ignoreMissingSource argument to shuffle().
  • Added shuffleWithExtraSources() method.
• ShufflePlugValueWidget : Widgets for the source and destination plugs can now be customised using standard plugValueWidget:type metadata.
• ImageTestCase : in assertImageEqual function, maxDifference may now be a tuple, to specify an asymmetric range.
• Editor : Added Settings class, which should be used to store settings for subclasses. See LightEditor and ImageInspector for examples.
• DeepPixelAccessor : Added utility class for accessing deep samples while abstracting away the underlying tile storage.
• Color3fPlug : Added setValue( V3f() ) overload.

Breaking Changes

• Arnold : Removed support for Arnold 7.1.
• Cycles : Updated to version 4.0.2.
• Render : Changed render:includedPurposes default to "default", "render".
• Backdrop : Changed default drawing order. Use the new depth plug to override the order if necessary.
• ValuePlug : Removed deprecated getObjectValue() overload.
• Preferences : Removed cache plug.
• TaskNode :
  • The Task constructor no longer takes a copy of the context, so the context must not be modified after being passed.
  • Removed Task( taskNode, context ) constructor. Use Task( taskNode["task"], context ) instead.
• Dispatcher :
  • Removed createMatching() method.
  • Removed non-const TaskBatch accessors frames() and preTasks().
  • Made TaskBatch constructors private.
  • The job directory is no longer available in slots connected to preDispatchSignal().
  • Removed nodes arguments from dispatch signals. Use the dispatcher["tasks"] plug instead.
  • Removed script and context arguments from frameRange() method. The current frame and full frame range are now queried from the current context.
• DispatcherUI :
  • Removed appendMenuDefinitions(), appendNodeContextMenuDefinitions(), executeSelected() and repeatPrevious() functions.
  • Removed DispatcherWindow class.
• LocalDispatcher :
  • Removed `...

Gaffer 1.3.12.0

Improvements

• SceneReader : Added basic loding of UsdGeomNurbsCurves, converting them to CurvesPrimitives (basis curves).
• Console output : Every line is now prefixed with the message level.
• RenderPasses : Added validation of render pass names entered in the names plug.
• RenderPassEditor :
  • Added support for adding a new render pass to an EditScope by clicking the plus button at the bottom of the editor.
  • Added support for deleting selected render passes by clicking the minus button at the bottom of the editor, or by right-clicking one of the names and selecting 'Delete Selected Render Passes'.

Fixes

• Viewer : Fixed context handling bug in the shader view (#5654).
• PythonCommand : Fixed misleading results for repr( variables ) and str( variables ), which would suggest the dictionary was empty when it was not.
• CompoundObject : Fixed crashes in Python bindings caused by passing None as a key.
• Windows : Fixed "{path} was unexpected at this time." startup error when environment variables such as PATH contain " characters.
• PathListingWidget : Fixed bug which caused the pointer to be stuck displaying the "values" icon after dragging cells with no value.
• SceneAlgo : Fixed computation of history through Expression nodes.
• LightTool : Fixed crash when deleting the node being viewed.
• USD : Fixed loading of Arnold lights previously exported from Gaffer to USD.
• Catalogue : Fixed connection delays on Windows.
• Context : Fixed potential crash when setting a variable with ownership.

Documentation

• Added Render Pass Editor shortcuts to the "Controls and Shortcuts" section.
• Added Render Pass Editor (Arnold) example demonstrating use of the Render Pass Editor, as well as the RenderPasses and RenderPassWedge nodes.

API

• EditScopeAlgo : Added support for creating render passes.
• RenderPasses : Added registerRenderPassNameWidget() and createRenderPassNameWidget() methods for registration and creation of the widget used for editing render pass names.
• RenderPassEditor : Added addRenderPassButtonMenuSignal() to allow customisation of the add render pass button behaviour.
• ConfirmationDialogue : The cancel button may now be omitted by passing cancelLabel = None to the constructor.

Build

• Cortex : Updated to version 10.5.6.2.