forked from GafferHQ/gaffer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Changes
8853 lines (6660 loc) · 368 KB
/
Changes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
0.53.0.0 (relative to 0.52.x)
========
Improvements
------------
- Loop : Added plug context menu item for connecting previous to next (#2887).
- ArnoldOptions : Added adaptive sampling settings (#2919).
- ArnoldRender (#2919) :
- Added support for a "camera" parameter in outputs, allowing renders from
multiple cameras to be performed in a single process.
- Added support for Arnold's `uv_camera`.
- SceneInspector : Added curve basis to Object section (#2892).
Documentation
-------------
- Improved the "Getting Started" scripting tutorial, renaming it to "Node Graph
Editing in Python".
API
---
- ContextProcessor : Added `setup()`, `inPlug()` and `outPlug()` methods (#2880).
- Loop : Added `setup()`, `inPlug()` and `outPlug()` methods (#2887).
Build
-----
- Replaced DEBUG option with BUILD_TYPE, with values of DEBUG, RELEASE or RELWITHDEBINFO (#2593).
Breaking Changes
----------------
- ContextProcessors : Removed SceneContextVariables, DeleteSceneContextVariables,
SceneTimeWarp, ImageContextVariables, DeleteImageContextVariables and ImageTimeWarp nodes.
Use the generic equivalents instead. Compatibility with old scripts is provided by
converting them automatically on loading (#2880).
- Loops : Removed SceneLoop and ImageLoop nodes. Use the generic Loop node instead.
Compatibility with old scripts is provided by converting them automatically on
loading (#2887).
- ScriptEditor (#2876) :
- Renamed to `PythonEditor`. Compatibility with old scripts and layouts is preserved
by a config file.
- Removed `script` variable. Use the new `root` variable instead.
- Removed `parent` variable. Paste serialised scripts using the GraphEditor
instead.
- Screengrab app : Renamed `-scriptEditor` argument to `pythonEditor` (#2876).
0.52.3.3 (relative to 0.52.3.2)
========
Fixes
-----
- Arnold renderer : Fixed light linking bug (#2947).
- ViewportGadget : Fixed bug in orthographic camera projection. This prevented the
CropWindowTool from working (#2946).
0.52.3.2 (relative to 0.52.3.1)
========
Fixes
-----
- gui : Fixed crash when starting Gaffer with unicode in the clipboard (#2933).
- TransformTool : Fixed crash caused by selection deduplication (#2940).
- ImageTransform : Fixed bug when rotating an empty data window (#2932).
- ImageView : Fixed TypeId bug (#2937).
- Arnold : Fixed crash when using shadowGroups (#2934).
0.52.3.1 (relative to 0.52.3.0)
========
Fixes
-----
- ArnoldMeshLight : Fixed light linking bug. ArnoldMeshLights are now included in the
`defaultLights` set by default. A new `defaultLight` plug controls this behaviour,
matching the `defaultLight` plug on other Light nodes (#2926).
0.52.3.0 (relative to 0.52.2.0)
========
Features
--------
- BleedFill : Added new image node to fill areas with zero alpha by bleeding in colours
from adjacent image regions (#2909).
- Rectangle : Added new image node to annotate rectangular regions of an image (#2912).
Improvements
------------
- Light linking (#2875) :
- Added a "defaultLights" set for use in light linking set expressions.
- Added a "defaultLight" plug to all Light nodes, to control membership in
the "defaultLights" set.
- Significantly optimised the processing of light links in Gaffer and in
the Arnold renderer backend.
- Viewer : "userDefault" metadata can now be used to configure the default settings
for Views (#2893).
- PythonCommand/SystemCommand : Empty commands are now ignored (#2896).
- SceneWriter : Added support for subclassing in Python (#2901).
- Checkerboard : Improved performance (#2912).
Fixes
-----
- SceneInspector : Fixed bug which caused sections to be disabled (#2903).
- Layout Menu : Fixed clashes between custom layout names and standard menu items. For instance,
previously you could save a layout called "Delete" and it would mean that the standard "Delete"
submenu was no longer available (#2899).
- Grade : Fixed bug that caused clamping to be ignored if the other settings were at default
values (#2908).
- CompoundDataPlug/ValuePlug : Fixed GIL management bugs which could cause Gaffer to hang (#2907).
0.52.2.0 (relative to 0.52.1.0)
========
Improvements
------------
- Bookmarks (#2873) :
- Added Ctrl+B shortcut to quickly navigate to a bookmark in any editor.
- Added bookmarks to pinning icon context menu.
- TransformTool (#2850) :
- Added status widget with information about what is being edited (#2753).
- Added support for transforming an ancestor location if the selected location
is not movable. This is particularly convenient for transforming the output of
a SceneReader node.
- Wrapper : Added GAFFER_EXTENSION_PATHS environment variable for easy configuration of 3rd
party extensions (#2868).
- StandardOptions : Added a depthOfField enable toggle (default off) (#2890).
- Camera/CameraTweaks : Added a depthOfField render override (#2890).
Fixes
-----
- GUI Config : Fixed layout registration bug that caused the standard layouts to be
copied into the user preferences. This caused problems running older Gaffer versions
and broke the saving of custom layouts (#2891).
- Cameras : Fixed on-by-default depth of field rendering for cameras with an fStop
specified. In particular this affected cameras imported to Gaffer via Alembic. The
`depthOfField` plug on the StandardOptions node must now be used to turn depth of field
on explicitly (#2890).
- Arnold metadata : Added missing metadata for Arnold 5.2 shader parameters (#2883).
- TransformTool (#2850) :
- Fixed attempts to edit read-only plugs inside References.
- Fixed `Selection::scene` so that it doesn't refer to internal plugs of
the tool.
- Menus : Fixed search widget focus styling on Mac (#2873).
- Clipboard : Fixed bug that meant Gaffer's clipboard was not synchronised with
the system clipboard on startup (#2878).
- Instancer : Fixed division by zero bug (#2886).
- Switch : Fixed overzealous dirty propagation. These could cause unnecessary
viewer and/or interactive render updates (#2859).
API
---
- Tool : Made `view()` method public (#2850).
- GraphComponent : Added default value for `commonAncestor()` type (#2850).
- Menu : Fixed position of search widget when menu has title (#2873).
- Editor : Editors now grab keyboard focus on enter. This makes it easier to add
custom shortcuts from extension code (#2873).
- CompoundEditor : Added `nodeSetMenuSignal()`, used for customising the context
menu for the pinning icon (#2873).
Build
-----
- Added VDB_LIB_SUFFIX option (#2889).
0.52.1.0 (relative to 0.52.0.0)
========
Features
--------
- PrimitiveInspector : Added new editor panel for inspecting the values of all
primitive variables associated with the object at the selected location (#2863).
Fixes
-----
- Fixed FilterSwitch compatibility within boxes (#2866).
- SceneWriter : Fixed unnecessary messages about unsupported features from
the Alembic writer (#2865).
- USD : Fixed python errors due to clashing symbols (#2837).
API
---
- VectorDataWidget (#2863) :
- Added `horizontal/verticalScrollMode` constructor arguments.
- Added `set/getHeader()` accessors.
- Fixed various issues with the header and tooltips.
- Restricted column tooltips to the header.
- Added alternating column background colours.
- Added support for many new data types (eg vectors, matrices, boxes, quats,
char, short).
- GafferUI : Moved ScrollMode enum from ScrolledContainer to Enums (backwards
compatibility is provided) (#2863).
0.52.0.0
========
This release brings a major overhaul to Gaffer's camera definition, bringing more
flexibility and improved compatibility with USD and Alembic. Note that if you were
previously using a Parameters node to add a "screenWindow" parameter, you should
now manipulate the standard aperture and film fit settings instead.
Features
--------
- Camera : Adopted new camera definition (#2816)
- Added perspectiveMode, with "Field of View" and "Aperture and Focal Length"
modes.
- Added aperture settings.
- Added depth of field settings.
- Added optional render overrides that override the StandardOptions settings on
a per-camera basis.
- Improved compatibility with USD and Alembic.
- CameraTweaks : Added new node to apply downstream edits to camera parameters (#2816).
- StandardOptions : Added filmFit render option (#2816).
Fixes
-----
- Restored FilterSwitch/UnionFilter compatibility for files from version 0.27.0.0 (#2854).
- SceneGadget : Fixed depth sorting for `objectAt()` when used with some legacy
graphics drivers (#2816).
- Fixed overzealous dirty propagation in several nodes. These could cause unnecessary
viewer and/or interactive render updates.
- SceneElementProcessor (#2855)
- ImageNode (#2855)
- Switch (#2859)
- OpenGLRenderer : Fixed GL resource management threading bug. This was the cause of
rare crashes when collapsing locations in the viewer (#2851).
- Documentation : Fixed broken link (#2857).
API
---
- PlugAlgo : Added `createPlugFromData()` and `extractDataFromPlug()` methods (#2816).
- ViewportGadget : Added `set/getPlanarMovement()` methods (#2816).
- Packaged IECorePreview and IECoreScenePreview headers. Note that these are subject to
change without notice (#2862).
Breaking Changes
----------------
- CompoundDataPlug : Removed `createPlugFromData()` and `extractDataFromPlug()` methods (#2816).
Use PlugAlgo instead (#2816).
- RendererAlgo : Added `scene` argument to `applyCameraGlobals()` (#2816).
- ViewportGadget : Removed `set/getOrthographic3D()` methods. Use `set/getPlanarMovement()`
instead (#2816).
- SceneAlgo : Added `scene` argument to `shutter()` method (#2816).
- Camera : Adopted new camera definition (#2816). In particular, if you were using a "screenWindow"
parameter, you will now need to use aperture and/or filmFit instead.
0.51.0.0
========
This release provides support for the latest versions of Arnold and 3Delight (5.2 and 1.1.7
respectively), along with the usual mix of improvements and bug fixes.
> Caution : The specialised switch nodes such as SceneSwitch and ImageSwitch have been replaced
> with a single all-purpose Switch node. Compatibility for old files is provided by converting
> nodes during loading, but files saved from Gaffer 0.51 will not be useable in prior versions.
> This can be worked around with a config file in the previous version which does
> `Gaffer.Switch = Gaffer.SwitchComputeNode`.
Features
--------
- Arnold : Added support for Arnold 5.2. Please note that Arnold 5.2 is not compatible with
earlier Arnold versions, so if you wish to use Gaffer 0.51 with an earlier version, you
will need to compile Gaffer yourself.
- 3Delight : Updated to support version 1.1.7. Please note that earlier versions are no
longer supported.
Improvements
------------
- Viewer :
- Improved interactivity when using transform tools or scrubbing animation
(#2818).
- Added "Escape" hotkey to pause processing (#2838, #2843).
- SceneInspector :
- Added inspection of light and shader parameters (#2797).
- Added annotation for indexed primitive variables (#2824).
- ScriptNode : Added "frameRange:start" and "frameRange:end" context variables (#2811).
- Documentation : Added "Anatomy of an Image" article (#2832).
- Switch (#2123, #2812) : Replaced specialised nodes with a single all-purpose Switch node.
Fixes
-----
- SceneInspector :
- The order in which diffs are displayed now matches the order
in which objects are selected in the Viewer (#2814).
- Fixed formatting of Color4f values (#2797).
- GraphEditor : Fixed problems with `nodeDoubleClickSignal()` (#2821)
- The signal didn't respect slot return values, so a slot couldn't return True
to signify that it had handled the event, and block other slots.
- The default slot wasn't returning True.
- Catalogue : Fixed delay when adding image with downsteam network (#2827).
- AnimationEditor : Fixed numerical imprecision when snapping keys to whole frames
(#2820).
- RenderController :
- Fixed bug where objects failed to render after being removed from
the lights set (#2825).
- Fixed GIL management bugs (#2830).
- SceneView : Fixed bugs that could lead to a hang in the viewer
when expanding or collapsing the current selection (#2830).
- SceneGadget : Fixed GIL management bugs (#2830).
- Houdini : Fixed compilation with default build flags for Houdini 17 (#2829).
- TransformTools : Fixed bug which prevented the editing of promoted transform
plugs (#2831).
- ImageGadget : Fixed bug which prevented non-default dataWindow maximum coordinates
from being annotated in the Viewer (#2840).
- TaskNode : Fixed bugs preventing implementation via internal network (#2846).
- OpenGLRender (#2799) :
- Fixed crash when trying to use `gaffer execute` with OpenGLRender nodes.
- Fixed bug whereby the visualisation of the main render camera was visible.
- Arnold : Fixed tests for API changes in Arnold 5.2 (#2841).
API
---
- BackgroundTask : Added `waitFor()` method (#2818).
- Added MAKE_GAFFER_COMPATIBILITY_VERSION macro (#2819).
- ContextAlgo : Added GlobalScope utility class (#2812).
- Switch :
- Added `inPlugs()` and `outPlug()` methods (#2812).
- FilterPlug : Add `sceneAffectsMatch()` method (#2812).
- TransformTool : Add `selectionChangedSignal()` (#2848).
Breaking Changes
----------------
- Removed compatibility for loading files from Gaffer 0.15.0.0 and earlier.
Resave the file in a more recent version before loading in the current
version. Note that this can also expose bugs in custom scripts : if a script
incorrectly attempts to connect to an ArrayPlug instead of a child element,
this will now fail instead of being silently corrected (#2805, #2812).
- Switch (#2812) :
- Removed SwitchDependencyNode, SwitchComputeNode, SceneSwitch, ShaderSwitch, FilterSwitch,
and ImageSwitch nodes. Use Switch node instead. Backwards compatibility for old files is
provided by converting to Switches during loading.
- 3Delight : Removed compatibility for older versions. At the time of writing
3Delight 1.1.7 is the latest tested version (#2836).
- SceneGadget : Removed private member variable. Source compatibility is retained
(#2818).
- Filter : Made `sceneAffectsMatch()` protected. Use the new `FilterPlug::sceneAffectsMatch()`
method instead (#2812).
- UnionFilter : Removed compatibility for nodes created prior to version 0.28.0.0 (#2812).
- TransformTool : Added private member data (#2848).
0.50.0.0
========
Improvements
------------
- TransformTools : Added support for multiple selection (#2665, #2803).
Fixes
-----
- CameraTool/TransformTool (#2807, #2808) : Mitigated against crashes during Catalogue
image saving.
API
---
- GafferSceneUI::ContextAlgo : Added `set/getLastSelectedPath()` functions, used for
specifying the last location to have been selected (#2803).
Breaking Changes
----------------
- TransformTool (#2803) :
- Moved `orientedTransform()` method to `Selection` class.
- Changed `selection()` return type.
0.49.1.0
========
Improvements
------------
- SceneReader : Added transform plug, allowing caches to be positioned without needing a
separate Transform node (#2792).
Fixes
-----
- SubGraph : Fixed crash bug in `correspondingInput()`. This typically manifested itself
as a crash when trying to delete or cut a box (#2796).
- FileMenu : Added confirmation dialogue for "Revert to Saved", and added proper error
reporting for loading errors (#2735, #2794).
- SetUI/FilteredSceneProcessorUI : Fixed bugs dealing with ArrayPlug inputs. These were
most visible as errors when working with the CopyAttributes node (#2785).
- File Browser : Fixed crash when pointed at files with strange permissions. (#2800).
- GraphEditor : Fixed hangs when framing backdrops (#2801).
Documentation
-------------
- Added "Anatomy of a Scene" article (#2787).
API
---
- ParallelAlgo : Refactored `callOnUIThread()` internals (#2786).
0.49.0.1
========
Fixes
-----
Python bindings : Fixed several bugs which could cause Gaffer to hang (#2789).
0.49.0.0
========
Improvements
------------
- ArnoldAttributes : Added `shadowGroup` attribute for performing shadow linking
(#2754).
- ScaleTool : Added handles for scaling in the XY, XZ and YZ planes (#2760, #2664).
- RotateTool : Added support for free rotation by dragging on a virtual
sphere (#2760, #2664).
- TranslateTool : Made XY, YX and YZ handles more visible (#2760, #2664).
- Translate/Rotate/Scale tools :
- Added support for animation (#2721).
- Added control over the size of the handle via the `+` and `-` keys (#2671, #2769).
- Catalogue (#2702) :
- Multiple images may now be selected.
- The selected images can now be deleted via the `Delete` and `Backspace`
keys.
- Images can now be reordered using drag and drop.
- OSLObject/OSLImage : Added support for more vector type conversions. Among other
things, this allows Color4fData primitive variables to be read as `color` values
in OSLObject, by discarding the alpha channel (#2759).
- GraphEditor : Added icons for Box and Reference nodes (#2762).
- Improved error message when a dependency cycle is detected. The error now
includes the names of the plugs involved (#2745).
- AnimationEditor :
- Keyframes are now pre-highlighted during drag-select (#2768).
- The current frame can be set by clicking/dragging on the time axis (#2724).
- When dragging keyframes in a single axis only, the viewport auto-scroll
is now constrained to that axis (#2724).
- SceneReader/SceneWriter (Cortex 10.0.0-a29) :
- Added support for scalar attributes in Alembic files.
- Added support for quaternion primitive variables in Alembic files.
- MeshTangents : Added support for non-triangular faces (Cortex 10.0.0-a30).
- VDB : Added support for float and double metadata (Cortex 10.0.0-a31).
Fixes
-----
- TypedObjectPlug : Fixed GIL management bug that could result in the
application hanging during operations such as choosing AOVs in the
image viewer (#2765).
- ScriptNode : Fixed GIL management bug that could result in the
application hanging during operations such as cut & paste (#2780).
- GraphEditor :
- Fixed connection visibility context menu items so that they
respect the read-only status of nodes (#2757).
- Omitted connection visibility context menu items from the menu
for auxiliary nodes, since such nodes do not have hideable connections
(#2752, #2757).
- Fixed bookmark drawing update bug (#2763).
- Fixed plug label visibility bug (#2761).
- AnimationEditor (#2768) :
- Fixed bugs with framerates other than 24fps.
- Fixed selection management bug.
- Improved numerical precision of keyframe dragging.
- Backdrop : Made resizing undoable (#2734).
- FileMenu : Closing a backup confirmation dialogue now aborts loading
completely (#2749).
- Isolate : Fixed filter matching bug in set computation (#2748).
- Translate/Rotate/Scale tools : Fixed context management bug (#2760).
- CollectScenes : Replaced bogus ArrayPlug input with ScenePlug (#2726).
- Catalogue :
- Fixed bug that caused CatalogueSelect nodes to be parented
at the wrong level, if a nested Catalogue was promoted to the next level
(#2702).
- Fixed bug whereby image order changed if image deletion was undone (#2767).
- Offset : Fixed hangs caused by empty data windows (#2770).
- VDB : Fixed crashes caused by thread-safety bug. This manifested most
commonly when instancing VDB objects (Cortex 10.0.0-a30).
- Seeds : Fixed cancellation bug (Cortex 10.0.0-a31).
- SceneReader : Fixed crashes caused by thread-safety bug in AlembicScene
(Cortex 10.0.0-a32).
API
---
- Dispatcher : Fixed crashes caused by passing `None` to `frameRange()` method
in Python (#2716).
- Added AttributeVisualiser.h to installation (#2744).
- ConfirmationDialogue : `waitForConfirmation()` now returns `None` if the user
closes the dialogue (#2749).
- StandardStyle (#2760) :
- Added support for XY,XZ and YZ axes in `renderScaleHandle()`.
- Added support for XYZ rotation handle in `renderRotateHandle()`.
- Handle : Added `rasterScaleFactor()` protected method (#2760).
- MetadataAlgo : Added `bookmarkedAffectedByChange()` method (#2763).
- GraphComponent (#2767) :
- Added python binding for `del graphComponent[childIndex]`.
- The original child order is now restored when undoing
calls to `removeChild()`.
- DependencyNode : Fixed crashes caused by Python derived classes returning
`None` from `affects()` overrides (#2771).
- ViewportGadget : Added support for enabling/disabling drag tracking separately
in each axis (#2724).
Documentation
-------------
- Added guidelines for contributing (#2713).
- Added code of conduct (#2713).
- Reworked the "Managing Complexity" section (#2623).
- Improved installation and configuration sections (#2624).
- Improved "Getting Started" tutorial (#2629).
Breaking Changes
----------------
- ScaleHandle : `scaling()` method now returns a `V3f` (#2760).
- RotateHandle (#2760) :
- Changed signature of `rotation()` method.
- Added private member data.
- RotateTool (#2760) :
- Added private member data.
- Changed signature of `rotate()` method.
- Style : Added `highlightVector` argument to `renderRotateHandle()` method (#2760).
- TransformTool : Added argument to `updateHandles()` method (#2671, #2769).
- ViewportGadget (#2724) :
- Changed function signatures for `setDragTracking()` and `getDragTracking()` methods.
- Changed private member variables.
0.48.1.0
========
Features
--------
- CollectTransforms : Added a node for collecting transforms from different
contexts and storing them as attributes (#2708).
- CollectPrimitiveVariables Added a node for collecting primitive variables
from different contexts (#2708).
- PrimitiveVariableExists : Added utility node for querying the existence
of a primitive variable (#2708).
Improvements
------------
- ArnoldLight : Improved performance (#2718).
- SceneInspector : Added tooltips with the unabbreviated name of the item
being inspected (#2722).
Fixes
-----
- Expression : Fixed threading bug in UI error handling (#2652, #2723).
- ColorProcessor/Shuffle : Fixed bugs caused by attempted computation of non-existent
upstream channels (#2701, #2731).
- Light : Fixed bounds computation (#2725).
- AnimationGadget : Fixes crash caused by dragging keys on adjacent frames (#2720).
0.48.0.0
========
Features
--------
- Viewer : The 3D viewer now updates asynchronously, keeping the UI responsive while the scene
is computed in the background (#2649).
- AnimationEditor : Added a new editor to allow the graphical editing of animation
curves. This can be found on the tab next to the GraphEditor in the standard layouts (#2632).
- DeleteObject node (#2694).
- CopyAttributes node (#2710).
Improvements
------------
- TranslateTool : Added handles for movement in the XY,XZ,YZ and camera planes (#2709).
- Layouts menu (#51, #2698) :
- Added "Default/..." menu items to allow the default startup layout to be chosen.
- Added new "Save As/..." menu items to allow previously saved layouts to be replaced.
- SceneInspector (#2607) :
- Added filter to sets sections.
- Moved set computations to background process, so they don't block the UI.
- Shader : Improved performance (#2644).
- ArnoldLightUI : Added support for "userDefault" parameter metadata. This matches
the format already in use for ArnoldShaderUI (#2646).
- Viewer :
- Added selection mask, to choose which types of objects can be selected (#2696).
- Added more Arnold diagnostic shading modes (#2645)
- Matte
- Opaque
- Receive shadows
- Self shadows
- ArnoldAttributes :
- Added `volumeStepScale`, `shapeStepSize` and `shapeStepScale` attributes (#2634).
- Clarified intended usage of subdividePolygons attribute (#2680).
- FormatPlug : Made "Custom" mode persistent, so it is remembered across save and reload (#2660).
- InteractiveRender : Removed unnecessary deletion and recreation of objects when `childNames`
changes (#2690, #2649).
Fixes
-----
- GraphEditor :
- Fixed arrowheads on axis-aligned auxiliary connections (#2647, #2648).
- Fixed potential auto-scroll bug when dragging a node (#2705).
- LocalDispatcher/TractorDispatcher : Fixed problems using `imath` context variables (#2653, #2654).
- OSLObject : Fixed crashes caused by indexed primitive variables (#2655).
- Viewer : Fixed visibility of children of look-through camera (#2694).
- ObjectSource : Fixed transform.* -> out.bound dirty propagation (#2649).
API
---
- SceneGadget :
- Added `setPaused()/getPaused()` and `state()` methods (#2649).
- Replaced `baseState()` with `set/getOpenGLOptions() methods (#2649).
- Added `waitForCompletion()` method (#2649).
- Added `set/getBlockingPaths()` methods (#2649).
- Added `set/getSelectionMask()` methods (#2696).
- RenderController : Added new utility class for controlling interactive renders (#2649).
- AnimationGadget : Added new Gadget for editing animation curves (#2632).
- Animation (#2632) :
- Keys are now reference counted, so ownership can be shared between CurvePlugs and the
AnimationEditor.
- Keys may be edited in place with `key->setTime()` etc, and the CurvePlug automatically updates.
- `CurvePlug::keys()` has been replaced with `CurvePlug::begin()` and `CurvePlug::end()`.
This hides the internal choice of container while still providing iteration.
- Added optional `threshold` argument to `closestKey()`.
- IECoreScenePreview::Renderer (#2649) :
- Added `command()` virtual method.
- Added `name()` virtual method.
- IECoreGLPreview::OpenGLRenderer (#2649) :
- Made it possible to call `render()` concurrently with edits.
- Added support for highlighting selected objects.
- Added "gl:queryBound" command.
- Added "gl:querySelection" command.
- Added support for custom object and attribute visualisers.
- Added options for controlling base attributes.
- PresetsPlugValueWidget : Added support for an optional "Custom" menu item, which allows the
user to enter an arbitary value. This is controlled by "presetsPlugValueWidget:allowCustom"
plug metadata (#2660).
- BusyWidget : Added `busy` constructor argument (#2607).
- LightTweaks (#2660) :
- Moved TweakPlug to the GafferScene namespace, so it can be reused by other
nodes.
- Added "Remove" mode.
- Layouts (#2698) :
- Added `persistent` argument to `add()` method, mirroring the `Bookmarks.add()` API.
This automatically takes care of saving persistent layouts into the startup location.
- Added `setDefault()/getDefault()` and `createDefault()` methods to allow the management
of a default layout.
- Handle (#2709) :
- Added `set/getVisibleOnHover()` methods.
- Added `PlanarDrag` axis accessors.
- TranslateHandle (#2709) :
- Added `axisMask()` method.
- FilteredSceneProcessor : Added constructor to allow array `inPlug()`.
- Style :
- Added methods for rendering animation curves (#2632).
- Added `width` and `userColor` arguments to `renderLine()` (#2632).
- Added `userColor` argument to `renderText()` (#2632).
- Added XY/XZ/YZ Axes enum values (#2709).
- ViewportGadget : Added `set/getVariableAspectZoom()` method (#2632).
Build
-----
- ViewportGadget : Fixed compilation on Windows (#2705).
- OpenImageIOReader : Fixed compilation with XCode 9.4 (#2712).
- Updated Cortex to version 10.0.0-a28
- Updated FreeType version 2.9.1
- Updated Python to version 2.7.15
- Updated Alembic to version 1.7.8
Breaking Changes
----------------
- GafferSceneUI : Moved visualiser base classes to IECoreGLPreview (#2649).
- ArnoldAttributes : Changed volume step attributes (#2634).
- GafferImage : Removed FormatPlug compatibility for files saved in Gaffer 0.16 or older.
To migrate, resave the file in Gaffer 0.47 (#2682).
- GafferOSL::ShadingEngine : Removed `scope` parameter from `needsAttribute()` (#2655).
- Layouts (#2698) :
- Removed `save()` method. Use the `persistent` argument to `add()` and `setDefault()` instead.
- Added `applicationRoot` argument to constructor. You should use `acquire()` instead anyway.
- LayoutMenu : Removed `delete()` method (#2698).
- GUI config : Renamed standard layout from "Default" to "Standard" (#2698).
- TranslateHandle : translation()` method now returns a V3f rather than a float (#2709).
- TransformTool : Made `orientedTransform()` method const (#2709).
- Style : Changed method signatures, enum values, and added virtual functions (#2632).
- Animation : Refactored API. See API section for more details (#2632).
- IECoreScenePreview::Renderer : Added virtual methods (#2649).
- InteractiveRender : Added and removed private member data (ABI break) (#2649).
- SceneGadget (#2649) :
- Added/removed private members (ABI break).
- Remove `baseState()`.
- SceneView : Reorganised/simplified drawingMode plugs (#2649).
0.47.0.0
========
Features
---------
- ImageView : Introduced asynchronous processing, so that the UI remains responsive while
the viewer updates progressively (#2578).
- Apps : Added a new `dispatch` application. This dispatches task nodes such as ImageWriters,
SystemCommands and Render nodes, either from within an existing .gfr file or by
creating nodes on the fly. This differs from the execute app in that it performs a
full dispatch via a dispatcher, rather than executing a single task node (#2588).
- Revamped OSL shaders (#2539).
- Added MultiplyVector, DotProduct, CrossProduct, RemapFloat, RemapColor, RemapVector,
FloatToColor, ColorToFloat, FloatToVector, VectorToFloat, ColorToVector,
Luminance, MixColor, MixVector, MixFloat, AddColor, AddFloat, AddVector,
DivideColor, DivideFloat, DivideVector, MultiplyColor, MultiplyFloat, MultiplyVector,
SubtractColor, SubtractFloat, SubtractVector, InvertMatrix, Length, Normalize,
PowFloat, RoundFloat, SinFloat, MatrixTransform, CompareColor, CompareFloat,
CompareVector, SwitchColor, SwitchFloat, SwitchVector, CoordinateSystemTransform,
CoordinateSystemMatrix.
- Removed some old shaders, keeping compatibility by converting them to new shaders
during loading.
- Appleseed : Updated to [version 1.9](https://github.com/appleseedhq/appleseed/releases/tag/1.9.0-beta)
(#2570).
Improvements
------------
- Instancer : Replaced original proof-of-concept Instancer with a new version intended
to be suitable for production use (#2642) :
- Added support for orientation and scale primitive variables.
- Added support for index and id primitive variables.
- Added support for creating per-instance attributes.
- Added support for sets.
- Improved performance by removing `${instancer:id}` context variable.
- Documentation : Improved structure and presentation (#2612, #2613, #2616, #2619, #2625, #2628, #2631).
- Appleseed (#2570) :
- Added support for pixel_time AOV.
- Added denoiser options to AppleseedOptions node.
- OSLImage/OSLObject (#2586) :
- Added support for `time` global variable.
- Added support for reading context variables.
- OSLImage : Improved performance by only reading the upstream channels needed by the
shader (#2586).
- Arnold renderer : Improved shader conversion performance (#2594).
- ArnoldOptions : Changed default value for `parallel_node_init` to on. This matches the default
in Arnold 5.1 (#2594).
- OSLImage/OSLObject/RankFilter/Resample : Added cancellation support. This improves
responsiveness in the new asynchronous ImageView (#2586, #2590).
- Isolate/Prune : Improved set processing performance (#2587).
- BranchCreator : Improved set processing performance (#2594).
- Application : Moved startup file execution before argument evaluation. This makes it
possible for a startup file to manipulate application arguments if necessary (#2588).
- Stats app : Added `-canceller` argument (#2586).
- UI : Renamed Scene Hierarchy to Hierarchy View and Node Graph to Graph Editor.
- AttributeVisualiser : Added support for visualising Color3f attributes #2641).
Fixes
-----
- Viewer :
- Fixed display of nested lights in look-through menu (#2615).
- Fixed selection after expanding the selected locations (#2617).
- Metadata :
- Fixed GIL management bug (#2582).
- Fixed crash if `None` is passed to `registerValue()` (#2582).
- Fixed bindings for change signals (#2610).
- UI : Fixed initial size and position of Preferences, Settings and Node Editor
windows (#2643).
- ContextAlgo : Fixed GIL management (#2618).
- SubGraph : Fixed crash in `correspondingInput()`. This manifested itself as crashes in
the NodeGraph when dragging a Box with an unconnected BoxOut node over a connection (#2583).
- TractorDispatcher : Fixed bug handling nodes like TaskList and FrameMask nodes, that don't
have any work of their own to do (#2584).
- ImageAlgo : Fixed GIL management bug (#2585).
- Arnold/OSL : Fixed problems caused by Arnold trying to recompile Gaffer's OSL shaders
unnecessarily. We no longer install the shader source files (#2539).
- ScriptNode : Fixed GIL management bug (#2578).
- BackgroundTask : Fixed interactions with ScriptNode lifetime (#2578).
- Threading : Fixed bugs caused by TBB cancellation propagation (#2589).
- LocalDispatcher : Fixed exception handling during foreground dispatch. Exceptions from
Tasks are now propagated back to the caller instead of being suppressed (#2588).
- Appleseed : Disabled SPPM for interactive renders (#2570).
- Catalogue : Fixed bug where orphaned Catalogue tried to save an image (#2621).
- ViewportGadget : Fixed `setCameraTransform()` to trigger a rerender (#2639).
- Arnold : Worked around clashes between Mesa drivers and libai.so (#2638).
API
---
- DispatchUI : Added `DispatchDialogue` class (#2588).
- Dispatcher :
- Added `dispatchSignal()` (#2574).
- Improved signal exception handling (#2574).
- Added `deregisterDispatcher()` static method (#2588).
- Removed "frame" variable from TaskBatch contexts. This means it is no longer
available to PythonCommand code in sequence mode (#2608).
- Outputs : Added `deregisterOutput()` method (#2581).
- GafferUI : Added new BackgroundMethod decorator to assist in performing processing in
background threads (#2578).
- ShadingEngine : Added `hash()` method (#2586).
- PlugLayout :
- Added `embedded` constructor argument (#2599).
- Added "<layoutName>:width" metadata support (#2604).
- Editor : Added `instanceCreatedSignal()` method. This can be used to customise the
standard editors immediately after they've been created (#2605).
- BusyWidget : Added `setBusy()` and `getBusy()` methods (#2604).
- ImageGadget : Added `setPaused()/getPaused()` and `state()` methods (#2604).
- ScriptEditor : Added `outputWidget()` accessor (#2622).
Build
-----
- Updated Appleseed version to 1.9.
- Updated OpenImageIO version to 1.8.12.
- Updated OpenShadingLanguage version to 1.9.9.
- Updated GLEW version to 2.1.0.
- Updated Cortex version to 10.0.0-a25.
- Improved documentation build process (#2622).
Breaking Changes
----------------
- Instancer : Added and removed plugs, changed behaviour and structure of output scene (#2642).
- Metadata : Changed function signatures for `GafferBindings::metadataModuleDependencies`
and `GafferBindings::metadataModuleDependencies`. Source compatibility is retained (#2579).
- Action (#2578) :
- Added new arguments to constructor and `enact()`.
- Added new data member.
- Source compatibility is retained.
- EditorWidget : Renamed to Editor (#2605).
- BackgroundTask : Replaced `done()` method with `status()`.
- SceneHierarchy : Renamed to HierarchyView (#2640).
- NodeGraph : Renamed to GraphEditor (#2640).
0.46.1.0
========
Features
--------
- ReverseWinding : Added new node that reverses the winding order of meshes (#2568).
- MeshDistortion : Added new node that calculates the distortion of a mesh from a
reference shape (#2568).
Improvements
------------
- Stats app : Added `-sets` command line argument, to allow scene sets to be computed (#2572).
- OSLObject : Added support for reading and writing UVs via new InUV and OutUV shaders (#2569).
- SceneViewUI : Defer camera and light set computation until required (#2567).
Fixes
-----
- Arnold : Fixed NodeEditor layout of new standard_surface shader parameters (#2573).
- Catalogue : Fixed crash caused by non-writable directory (#2571).
- Stats app : Fixed bugs in `-preCache` argument. It was using the wrong context and
not respecting the `-frames` flag (#2572).
- WidgetAlgo : Fixed bug when `grab()` with the event loop running (#2575).
- MapOffset : Fixed bug when offsetting an indexed uv set (#2576).
0.46.0.0
========
Features
--------
- FrameMask : Added new node to mask out upstream tasks on particular frames (#2558).
Improvements
------------
- Layouts (#2522) :
- Simplified space-bar panel expansion, and removed the annoying auto-expand
behaviour for collapsed panels.
- Removed tabs from the Scene layout's Timeline panel.
- DeleteFaces/DeletePoints/DeleteCurves : Added invert plug (#2546).
- Spline widgets (#2551) :
- Added axis lines at y=0 and y=1.
- Improved framing behaviour.
- Made float splines display as curves by default.
- Dispatcher : Reduced overhead of job directory creation (#2557).
- OSLObject : Added support for double primitive variables (#2547).
Fixes
-----
- Layouts : Fixed circular references created by layout menus. These could cause crashes
during shutdown (#2522).
- BoolPlugValueWidget : Fixed displayMode metadata handling. This restores the little
switches on the Attributes nodes (#2553).
API
---
- Metadata : Improved wildcard matching (#2536) :
- Stopped '*' matching '.' in a plug path. This mimics how '*' doesn't match '/' in a
glob match or in the PathMatcher.
- Added '...' wildcard that matches any number of plug path elements, in the same way a
PathMatcher does.
- ImageAlgo (#2561) :
- Added support for lambdas in `parallelGatherTiles()`.
- Added a `tileOrder` parameter to `parallelProcessTiles()`.
- Added python bindings for `parallelGatherTiles()`.
- Context : Added optional `IECore::Canceller` that can be used to cancel long
running background processes (#2559).
- BackgroundTask : Added new class to assist in the running of processes on background
threads (#2559).
- ParallelAlgo (#2559) :
- Added `callOnUIThread()` method.
- Added `callOnBackgroundThread()` method.
Breaking Changes
----------------
- SplitContainer (#2522) :
- Removed `animationDuration` argument from `setSizes()` method.
- Removed `targetSizes()` method.
- Metadata : `*` no longer matches `.` in a plug path (#2536).
- PlugValueWidget : Removed `registerCreator()` method. Use metadata instead (#2536).
- ImageAlgo : Changed signatures for `parallelProcessTiles()` and `parallelGatherTiles()`
(#2561).
- StringAlgo : Removed. Use `IECore::StringAlgo` instead (#2534).
- Display : Removed `executeOnUIThread()` method. Use ParallelAlgo instead (#2559).
- Gadget : Removed `executeOnUIThread()` method. Use ParallelAlgo instead (#2559).
Build
-----
- Requires Cortex 10.0.0-a20.
- Improved experimental CMake build setup (#2560).
0.45.3.0
========
Features
--------
- GafferSceneUI : Added CameraTool to the Viewer (#2531).
- This enables the movement of the camera in the viewport to be pushed back upstream
into the node for the camera or light that is currently being looked through. Note
that once activated, the CameraTool will remain active even after another tool has
been chosen.
Improvements
------------
- ShaderUI : Added support for userDefault metadata for shader parameters (#2544).
Fixes
-----
- SceneGadget : Fixed dirty propogation (#2541).
- Metadata (#2544) :
- Added `deregisterValue()` overload for string targets.
- Fixed overwriting of values for string targets.
- FormatPlug::acquireDefaultFormatPlug() : Fixed crashes if None is passed via
python bindings (#2549).
Build
-----
- Added experimental CMake build in contrib (#2543).
API
---
- ViewportGadget (#2531) :
- Added accessors for center of interest.
- Added `orthographic3D` camera mode.
- BoolPlugValueWidget (#2531) :
- Added support for `BoolWidget.DisplayMode.Tool`
- Added `boolWidget()` accessor, matching `StringPlugValueWidget.textWidget()`.
- GafferUI : Add ToolUI (#2531) :
- This sets up the "active" plug to use a BoolPlugValueWidget in tool mode,
with an appropriate icon.
- Viewer : Added support for "tool:exclusive" metadata (#2531) :
- This allows certain tools to be marked as non-exclusive, allowing them to
remain active even when another tool has been chosen.
- TransformTool : Exposed constructor for Selection class (#2531).