Skip to content

Commit

Permalink
Changes.md : Note that ShufflePlug changes affect multiple nodes
Browse files Browse the repository at this point in the history
And update outdated comment in ShufflePlug.inl.
  • Loading branch information
johnhaddon committed Jul 10, 2024
1 parent 6a074fc commit 42605e7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
3 changes: 2 additions & 1 deletion Changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Fixes
- UVInspector : Fixed `Unable to find ScriptNode for UVView` warnings.
- Scene Editors : Fixed update when ScenePlugs are added to or removed from the node being viewed.
- PrimitiveInspector : Fixed failure to update when the location being viewed ceases to exist, or is recreated.
- Shuffle : Fixed some special cases where shuffling a channel to itself would fail to have the expected effect.
- Shuffle, ShuffleAttributes, ShufflePrimitiveVariables : Fixed some special cases where shuffling a source to itself would fail to have the expected effect.

API
---
Expand All @@ -41,6 +41,7 @@ Breaking Changes
- TweakPlugValueWidget : Removed support for `tweakPlugValueWidget:allowCreate` and `tweakPlugValueWidget:allowRemove` metadata.
- Editor : Removed arguments from `Settings` constructor.
- Unpremultiply : Removed `image:channelName` from the context used to evaluate the `alphaChannel` plug.
- Shuffle, ShuffleAttributes, ShufflePrimitiveVariables : Changed behaviour when shuffling a source to itself.

1.4.x.x (relative to 1.4.8.0)
=======
Expand Down
10 changes: 5 additions & 5 deletions include/Gaffer/ShufflePlug.inl
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,11 @@ T ShufflesPlug::shuffleInternal( const T &sourceContainer, const T *extraSources
// multiple source names and write to multiple destination names, therefore each
// shuffle specifies a set of data "moves". As each shuffle's set of moves is
// unordered, moves with the same destination name eg. {a->c, b->c} are invalid.
// Identity moves eg. {a->a, b->b} are ignored. Cyclic moves eg. {a->b, b->a} and
// chained moves eg. {a->b, b->c} are valid as data is always copied from the source
// container. If the delete source flag is specified for a shuffle the source names
// are deleted after all shuffles have completed. If the replace destination flag is
// false for a shuffle each move will not replace data with the same name as its destination.
// Cyclic moves eg. {a->b, b->a} and chained moves eg. {a->b, b->c} are valid as
// data is always copied from the source container. If the delete source flag is
// specified for a shuffle the source names are deleted after all shuffles have
// completed. If the replace destination flag is false for a shuffle each move will
// not replace data with the same name as its destination.

T destinationContainer( sourceContainer ); // NOTE : initial copy of all source data to destination.

Expand Down

0 comments on commit 42605e7

Please sign in to comment.