EMSUSD-872 - Adds the ability to System-lock a layer #3619

AramAzhari-adsk · 2024-02-15T13:54:43Z

The system lock is a severity of locking a layer where it cannot be undone using UI. It is meant to be controlled through script or programmatically to prevent a user from editing or saving a layer.

The locking can be performed using the mayaUsdLayerEditor command with the lockLayer parameter:

lockLayer 0 is unlocked
lockLayer 1 is locked: Sets the PermissionToEdit to false
lockLayer 2 is system locked: Sets both the PermissionToEdit and PermissionToSave to false

Example of System Locking:

In the above example:

(1) asdf.usda is system locked, No Save, No Edit
As a result of the system lock, the anonymous layers (2), (3) cannot be saved since saving them will cause a change in asdf.usda. The anonymous layers can still be edited.
qwerty.usda changes can be saved since it doesn't affect the system locked parent.

Any Layer Editor operations that affect the locked parent are disabled on sublayers. This includes context menu operations.

AramAzhari-adsk · 2024-02-15T13:57:03Z

lib/mayaUsd/utils/layerLocking.h

+#define MAYAUSD_LAYERLOCKING_H
+
+#include <mayaUsd/base/api.h>
+#include <mayaUsd/nodes/proxyShapeBase.h>


The proxy shape will be updated on future iterations to add new functionality to layer locking.

AramAzhari-adsk · 2024-02-15T13:57:54Z

lib/mayaUsd/utils/layerLocking.cpp

+}
+} // namespace
+
+void addSystemLockedLayer(const PXR_NS::SdfLayerRefPtr& layer)


There are similar functions in layer muting. They will be extended to in the future iterations.

AramAzhari-adsk · 2024-02-15T13:59:20Z

lib/usd/ui/layerEditor/layerTreeItem.cpp

-{
-    return (_isSharedLayer || (_layer && !_layer->PermissionToEdit()));
-}
+bool LayerTreeItem::isReadOnly() const { return (_isSharedLayer); }


Note: By design some of the functionalities should still be available if a layer has no permission to edit.

AramAzhari-adsk · 2024-02-15T14:00:39Z

lib/usd/ui/layerEditor/layerTreeItem.cpp

@@ -282,15 +281,21 @@ bool LayerTreeItem::isLocked() const { return _layer && _layer->PermissionToEdit

 bool LayerTreeItem::appearsLocked() const


Named similar to appearsMuted(). It has to do with the parent / children's state of lock.
By design, some of the sublayer's actions cannot be performed if the parent is locked.

AramAzhari-adsk · 2024-02-15T14:01:05Z

lib/usd/ui/layerEditor/layerTreeItem.cpp

+
+bool LayerTreeItem::isSystemLocked() const { return MayaUsd::isLayerSystemLocked(_layer); }
+
+bool LayerTreeItem::appearsSystemLocked() const


Named similar to appearsLocked(). It has to do with the parent / children's state of system lock.
By design, some of the sublayer's actions cannot be performed if the parent is locked.

Oh, so you want to be able to distinguish between something being locked and something being locked by its parent? So that is why appearsLocked does not check itself? OK, but the function name is a bit misleading. You can keep them like that, just a trap for the unwary :)

This is similarly named to appearsMuted. The notion is that something "appears" locked but it's not really locked itself. Hence the word appear.

AramAzhari-adsk · 2024-02-15T14:02:38Z

lib/usd/ui/layerEditor/layerTreeItemDelegate.cpp

@@ -283,7 +289,11 @@ void LayerTreeItemDelegate::paint_ActionIcon(

    QString tooltip;
    if (_lastHitAction == action._name) {
-        tooltip = action._tooltip;
+        if (item->isSystemLocked()) {


When a layer is system locked, a different message is shown to the user to indicate that a layer cannot be unlocked or edited.

AramAzhari-adsk · 2024-02-15T14:03:56Z

lib/usd/ui/layerEditor/layerTreeModel.cpp

@@ -151,7 +151,7 @@ bool LayerTreeModel::canDropMimeData(
    }

    auto parentItem = layerItemFromIndex(parentIndex);
-    if (!parentItem || parentItem->isReadOnly()) {
+    if (!parentItem || parentItem->isReadOnly() || parentItem->isLocked()) {


By design, immediate children of a locked parent layer cannot be reorganised (also covers the system lock layers by the shared constraint of PermissionToEdit = false).

AramAzhari-adsk · 2024-02-15T14:04:34Z

lib/usd/ui/layerEditor/layerTreeModel.cpp

@@ -235,7 +235,8 @@ bool LayerTreeModel::dropMimeData(

 void LayerTreeModel::setEditTarget(LayerTreeItem* item)
 {
-    if (!item->appearsMuted() && !item->isReadOnly()) {
+    if (!item->appearsMuted() && !item->isReadOnly() && !item->isLocked()


A locked or system locked layer cannot be targeted.

AramAzhari-adsk · 2024-02-15T14:05:04Z

lib/usd/ui/layerEditor/layerTreeModel.cpp

@@ -481,8 +482,11 @@ void LayerTreeModel::saveStage(QWidget* in_parent)
    auto saveAllLayers = [this]() {
        const auto layers = getAllNeedsSavingLayers();
        for (auto layer : layers) {
-            if (!layer->isAnonymous())
-                layer->saveEditsNoPrompt();
+            if (!layer->isSystemLocked()) {


A System-locked layer cannot be saved by the extension that PermissionToSave = False. This also means that anonymous layers cannot be renamed until the layer is unlocked.

AramAzhari-adsk · 2024-02-15T14:06:18Z

lib/usd/ui/layerEditor/layerTreeModel.cpp

@@ -570,15 +574,15 @@ void LayerTreeModel::toggleMuteLayer(LayerTreeItem* item, bool* forcedState)

 void LayerTreeModel::toggleLockLayer(LayerTreeItem* item, bool* forcedState /*= nullptr*/)
 {
-    if (item->isInvalidLayer() || item->isSessionLayer())
+    if (item->isInvalidLayer() || item->isSessionLayer() || item->isSystemLocked())


No system locking is allowed through toggling.

AramAzhari-adsk · 2024-02-15T14:07:47Z

lib/usd/ui/layerEditor/saveLayersDialog.cpp

    for (const auto& dirtyLayer : StageLayersToSave._dirtyFileBackedLayers) {
        _stageLayerMap.emplace(std::make_pair(dirtyLayer, stageName));
    }

+    // We do not allow saving layers in any of the following conditions:


SaveLayerDialog will no longer list anonymous or file backed layers that are system locked. Same goes for anonymous layers whose parent layer is system locked.

AramAzhari-adsk · 2024-02-15T14:24:05Z

lib/mayaUsd/commands/layerEditorCommand.cpp

@@ -805,11 +818,15 @@ class LockLayer : public BaseCmd
        auto stage = getStage();
        if (!stage)
            return false;
-        if (_lockIt) {
+        if (_systemLock) {


Note: For the time being, the undo state of a system lock goes into fully unlock. In a future design iterations a system-lock may get changed to never be undoable to prevent accidental unlocks.

Ideally, it should return to the previous lock state (for example: locked -> system locked -> undo -> locked).

pierrebai-adsk · 2024-02-15T15:02:54Z

lib/mayaUsd/commands/layerEditorCommand.cpp

-            bool lockIt = true;
-            argParser.getFlagArgument(kLockLayerFlag, 0, lockIt);
+            int lockValue = 0;
+            // 0 = Unlocked


I wished there was an enum so that we would not have these magic values in the code.

pierrebai-adsk · 2024-02-15T15:03:50Z

lib/mayaUsd/utils/CMakeLists.txt

@@ -12,6 +12,7 @@ target_sources(${PROJECT_NAME}
        dynamicAttribute.cpp
        editability.cpp
        json.cpp
+		layerLocking.cpp


Not very important: indentation. If you make other adjustements in other files, you might as well fix it, otherwise it is really not critical.

pierrebai-adsk · 2024-02-15T15:12:17Z

lib/mayaUsd/utils/layerLocking.cpp

+
+    LockedLayers& layers = getLockedLayers();
+    auto          iter = layers.find(layer);
+    if (iter != layers.end()) {


Given that it is a set, I'm not sure why you bother checking if it is already in the set. Adding again would not do any harm.

pierrebai-adsk · 2024-02-15T15:15:23Z

lib/usd/ui/layerEditor/abstractCommandHook.h

@@ -80,7 +80,7 @@ class AbstractCommandHook
    virtual void muteSubLayer(UsdLayer usdLayer, bool muteIt) = 0;

    // lock or unlock the given layer
-    virtual void lockSubLayer(UsdLayer usdLayer, bool lockIt) = 0;
+    virtual void lockSubLayer(UsdLayer usdLayer, bool lockIt, bool systemLock) = 0;


Could pass 0, 1, 2 like the MEL command and even reuse the suggested enum to be used instead of 0, 1, 2.

pierrebai-adsk · 2024-02-15T15:22:40Z

lib/usd/ui/layerEditor/layerTreeItem.h

@@ -138,6 +138,10 @@ class LayerTreeItem : public QStandardItem
    bool isLocked() const;
    // check if this layer is locked
    bool appearsLocked() const;
+    // is the layer system locked?
+    bool isSystemLocked() const;
+    // check if this layer is system locked


I'd change the comment to reflect that this check if parents are locked and not itself. I'd even add a similar comment in the cpp to help future readers understand that not checking itself is volontary and not an oversight.

pierrebai-adsk

LGTM, only minor possible improvements.

pierrebai-adsk

LGTM

EMSUSD-872 - Adds the ability to System-lock a layer

00346db

AramAzhari-adsk self-assigned this Feb 15, 2024

AramAzhari-adsk commented Feb 15, 2024

View reviewed changes

Fixes the linting errors.

62a9a4c

AramAzhari-adsk assigned AramAzhari-adsk and unassigned AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk requested a review from pierrebai-adsk February 15, 2024 14:11

AramAzhari-adsk commented Feb 15, 2024

View reviewed changes

pierrebai-adsk reviewed Feb 15, 2024

View reviewed changes

pierrebai-adsk previously approved these changes Feb 15, 2024

View reviewed changes

Updated according to the review feedback.

13619e9

AramAzhari-adsk dismissed pierrebai-adsk’s stale review via 13619e9 February 15, 2024 17:35

AramAzhari-adsk assigned AramAzhari-adsk and unassigned AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk requested a review from pierrebai-adsk February 15, 2024 17:36

pierrebai-adsk approved these changes Feb 15, 2024

View reviewed changes

AramAzhari-adsk added the ready-for-merge Development process is finished, PR is ready for merge label Feb 15, 2024

samuelliu-adsk added the workflows Related to in-context workflows label Feb 15, 2024

samuelliu-adsk merged commit cfee033 into dev Feb 15, 2024
11 checks passed

seando-adsk deleted the azharia/EMSUSD-872/Adds-System-Lock-Funcitonality-To-Layers branch February 20, 2024 14:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EMSUSD-872 - Adds the ability to System-lock a layer #3619

EMSUSD-872 - Adds the ability to System-lock a layer #3619

AramAzhari-adsk commented Feb 15, 2024 •

edited

Loading

AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024

pierrebai-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024 •

edited

Loading

AramAzhari-adsk Feb 15, 2024

AramAzhari-adsk Feb 15, 2024 •

edited

Loading

AramAzhari-adsk Feb 15, 2024

pierrebai-adsk Feb 15, 2024

pierrebai-adsk Feb 15, 2024

pierrebai-adsk Feb 15, 2024

pierrebai-adsk Feb 15, 2024

pierrebai-adsk Feb 15, 2024

pierrebai-adsk Feb 15, 2024

pierrebai-adsk left a comment

pierrebai-adsk left a comment

		@@ -282,15 +281,21 @@ bool LayerTreeItem::isLocked() const { return _layer && _layer->PermissionToEdit

		bool LayerTreeItem::appearsLocked() const


		bool LayerTreeItem::isSystemLocked() const { return MayaUsd::isLayerSystemLocked(_layer); }

		bool LayerTreeItem::appearsSystemLocked() const

EMSUSD-872 - Adds the ability to System-lock a layer #3619

EMSUSD-872 - Adds the ability to System-lock a layer #3619

Conversation

AramAzhari-adsk commented Feb 15, 2024 • edited Loading

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 Feb 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AramAzhari-adsk Feb 15, 2024 • edited Loading

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

pierrebai-adsk left a comment

Choose a reason for hiding this comment

pierrebai-adsk left a comment

Choose a reason for hiding this comment

AramAzhari-adsk commented Feb 15, 2024 •

edited

Loading

AramAzhari-adsk Feb 15, 2024 •

edited

Loading

AramAzhari-adsk Feb 15, 2024 •

edited

Loading