EMSUSD-1149 prevent unlocking system-locked layer when unlocking parents #3706

pierrebai-adsk · 2024-04-09T20:20:50Z

When unlocking recursively, do not unlock sub-layers that are system-locked.
Correctly check that the request was for system lock when undoing a lock command.
Add more lock tests to cover more cases, like having sub-layers and system-locked layers.

- When unlocking recursively, do not unlock sub-layers that are system-locked. - Correctly check that the *request* was for system lock when undoing a lock command. - Add more lock tests to cover more cases, like having sub-layers and system-locked layers.

AramAzhari-adsk

The design for the locklayer command is to allow locking / systemlocking / unlocking any layer and its sublayers through script, but not through UI.

I believe this will prevent the scenario of going through the script.

pierrebai-adsk · 2024-04-11T14:03:38Z

Well, if we all recursive unlocking of system-locked layers in the command, then the recursive option will not be useful because we will need to do the recursion in the UI code and skip the system-locked layer. The UI will not be able to use the recursive flag.

AramAzhari-adsk · 2024-04-11T14:10:50Z

Well, if we all recursive unlocking of system-locked layers in the command, then the recursive option will not be useful because we will need to do the recursion in the UI code and skip the system-locked layer. The UI will not be able to use the recursive flag.

We may either have to add a new parameter to mark the command to be run as a super user or a way to pass the information through UI to know it's being run through there. Any other suggestions are also welcome!

pierrebai-adsk · 2024-04-11T14:14:41Z

No, that starts to be byzantine. The Maya command hook will do the layer recursion. Maaaybe there could be a flag to skip system-locked layers? That seems reasonable.

AramAzhari-adsk · 2024-04-11T14:30:16Z

No, that starts to be byzantine. The Maya command hook will do the layer recursion. Maaaybe there could be a flag to skip system-locked layers? That seems reasonable.

Either that or a generic way to indicate that overrides are allowed, but that creates the concept of user roles.
Even something as simple as a force parameter.

…system-locked layers - Add a flag to control the lock command affecting sub-layers that are system-locked. - Use teh flag from the UI, in the Maya command hook. - Update the unit test.

pierrebai-adsk · 2024-04-11T14:43:42Z

Added -skipSystemLocked flag. Seems explicit enough to make its behavior clear.

AramAzhari-adsk · 2024-04-11T14:54:51Z

lib/mayaUsd/commands/layerEditorCommand.cpp

@@ -868,7 +883,7 @@ class LockLayer : public BaseCmd
        // Execute lock commands
        for (size_t layerIndex = 0; layerIndex < _layers.size(); layerIndex++) {
            // Note: the undo of system-locked is unlocked by design.
-            if (_previousStates[layerIndex] == MayaUsd::LayerLockType::LayerLock_SystemLocked) {
+            if (_lockType == MayaUsd::LayerLockType::LayerLock_SystemLocked) {


I believe this should also be conditioned?

I don't understand what you mean

The previous state will always have the correct value when undoing, so there is no need to protect, at worst it will set the same state it already was.

As long as any consecutive number of system-locks results in Unlock, then it's all good.

AramAzhari-adsk · 2024-04-11T14:55:25Z

lib/usd/ui/layerEditor/mayaCommandHook.cpp

@@ -208,8 +208,13 @@ void MayaCommandHook::lockLayer(
    MayaUsd::LayerLockType lockState,
    bool                   includeSubLayers)
 {
+    // Per design, we refuse to change the lock state of system-locked
+    // layers through the UI.
+    if (MayaUsd::isLayerSystemLocked(usdLayer))


This also needs to be conditioned whether we skip system locked files or not.

Again, I don't understand what you mean. We never want to affect system-locked layer from thr UI.

Is it guaranteed that the mayaCommandHook is only called from the UI?

If so, then it's all good.

What I would suggest though, is to add the skipSystemLocked. Because unlike Muting, sub-layers of a system-locked layer can be unlocked.

Ah, so we should et it do its work if include sub-layers is true? OK.

Actually the code behind the lock layer and sublayer menu is

maya-usd/plugin/adsk/scripts/mayaUsdMenu.mel

Lines 945 to 953 in 7466596

if (!$isSessionLayer && $hasSublayers) {

if ($isLocked)

$label = getMayaUsdString("kMenuUnlockLayerAndSublayers");

else

$label = getMayaUsdString("kMenuLockLayerAndSublayers");

$cmd = makeCommand($panelName, "lockLayerAndSubLayers");

$enabled = !$isSystemLocked;

menuItem -label $label -enable $enabled -c $cmd;

}

which seems to be enabled only if the right-clicked layer isn't system locked.

AramAzhari-adsk

MayaCommandHook::lockLayer should allow unlocking sub-layers of a system-locked layer since the system-lock is not inheritance-based such as Muting layers.

AramAzhari-adsk

Actually, if the menu item is disabled, then there's no need to apply to sub-layers.
The sub-layers can be unlocked through the selection of those layers.

All good.

pierrebai-adsk self-assigned this Apr 9, 2024

pierrebai-adsk added bug Something isn't working adsk Related to Autodesk plugin labels Apr 9, 2024

pierrebai-adsk requested a review from AramAzhari-adsk April 10, 2024 13:04

AramAzhari-adsk requested changes Apr 11, 2024

View reviewed changes

EMSUSD-1149 add explicit flag to control if recursive locking affect …

bd921fe

…system-locked layers - Add a flag to control the lock command affecting sub-layers that are system-locked. - Use teh flag from the UI, in the Maya command hook. - Update the unit test.

pierrebai-adsk assigned pierrebai-adsk and unassigned pierrebai-adsk Apr 11, 2024

pierrebai-adsk requested a review from AramAzhari-adsk April 11, 2024 14:42

AramAzhari-adsk reviewed Apr 11, 2024

View reviewed changes

EMSUSD-1149 Code format

3fce3e9

pierrebai-adsk assigned pierrebai-adsk and unassigned pierrebai-adsk Apr 11, 2024

pierrebai-adsk requested a review from AramAzhari-adsk April 11, 2024 15:01

AramAzhari-adsk requested changes Apr 11, 2024

View reviewed changes

AramAzhari-adsk approved these changes Apr 11, 2024

View reviewed changes

pierrebai-adsk added the ready-for-merge Development process is finished, PR is ready for merge label Apr 11, 2024

seando-adsk added workflows Related to in-context workflows and removed bug Something isn't working adsk Related to Autodesk plugin labels Apr 11, 2024

seando-adsk merged commit 7f34c62 into dev Apr 11, 2024
11 checks passed

seando-adsk deleted the bailp/EMSUSD-1149/system-lock-vs-unlock branch April 11, 2024 20:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EMSUSD-1149 prevent unlocking system-locked layer when unlocking parents #3706

EMSUSD-1149 prevent unlocking system-locked layer when unlocking parents #3706

pierrebai-adsk commented Apr 9, 2024

AramAzhari-adsk left a comment

pierrebai-adsk commented Apr 11, 2024

AramAzhari-adsk commented Apr 11, 2024

pierrebai-adsk commented Apr 11, 2024 •

edited

Loading

AramAzhari-adsk commented Apr 11, 2024

pierrebai-adsk commented Apr 11, 2024

AramAzhari-adsk Apr 11, 2024

pierrebai-adsk Apr 11, 2024

pierrebai-adsk Apr 11, 2024

AramAzhari-adsk Apr 11, 2024

AramAzhari-adsk Apr 11, 2024

pierrebai-adsk Apr 11, 2024

AramAzhari-adsk Apr 11, 2024

AramAzhari-adsk Apr 11, 2024

pierrebai-adsk Apr 11, 2024

AramAzhari-adsk Apr 11, 2024

AramAzhari-adsk left a comment

AramAzhari-adsk left a comment

	if (!$isSessionLayer && $hasSublayers) {
	if ($isLocked)
	$label = getMayaUsdString("kMenuUnlockLayerAndSublayers");
	else
	$label = getMayaUsdString("kMenuLockLayerAndSublayers");
	$cmd = makeCommand($panelName, "lockLayerAndSubLayers");
	$enabled = !$isSystemLocked;
	menuItem -label $label -enable $enabled -c $cmd;
	}

EMSUSD-1149 prevent unlocking system-locked layer when unlocking parents #3706

EMSUSD-1149 prevent unlocking system-locked layer when unlocking parents #3706

Conversation

pierrebai-adsk commented Apr 9, 2024

AramAzhari-adsk left a comment

Choose a reason for hiding this comment

pierrebai-adsk commented Apr 11, 2024

AramAzhari-adsk commented Apr 11, 2024

pierrebai-adsk commented Apr 11, 2024 • edited Loading

AramAzhari-adsk commented Apr 11, 2024

pierrebai-adsk commented Apr 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AramAzhari-adsk left a comment

Choose a reason for hiding this comment

AramAzhari-adsk left a comment

Choose a reason for hiding this comment

pierrebai-adsk commented Apr 11, 2024 •

edited

Loading