Editor, NodeToolbar, PlugLayout, PlugValueWidget : Remove setContext()
#5952
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We have never used the flexibility this method was intended to provide, but it has been the source of unnecessary complexity and synchronisation bugs. Also rename `getContext()` to `context()`, and add compatibility shim to forward legacy `getContext()` calls to it.
When accessing the context for Editor, NodeToolbar, PlugLayout and PlugValueWidget. This means we are not relying on the compatibility shim, which is now solely for external code. Note : Here I'm treating GafferCortexUI as "external" and hence haven't touched it - I'm hoping that it is now time for Image Engine to pick up the maintenance for this module.
This is an example of a failure to synchronise changes from `setContext()` in a higher-level component (the Viewer) to a lower-level component (the toolbar). The context we were passing was literally used for nothing, and would never have been updated if we called `Viewer.setContext()`. Better that this is all gone now.
Now `Editor.setContext()` has been removed, we can just acquire the Playback object in the constructor.
murraystevenson
approved these changes
Jul 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We have never used the flexibility this method was intended to provide, but it has been the source of unnecessary complexity and synchronisation bugs. Removing them now smooths the way for some "context aware" behaviours we're in the process of adding, whereby we want all the UI components to share the same context tracking utility, which necessitates sharing the same context.