MAYA-106188 - As a user, I would like to activate and deactivate prims #773

seando-adsk · 2020-09-11T17:38:49Z

MAYA-106188 - As a user, I would like to activate and deactivate prims

Implemented new UFE interface UIInfoHandler.
Added support for child filtering with new Ufe::Hierarchy method "filteredChildren" and Ufe::HierarchyHandler method "childFilter". In USD we support a single child filter for "Inactive Prims".
Added context menu for "{Active/Deactivate} Prim".
Added test cases for new interface, new methods and new menu.

* Implemented new UFE interface UIInfoHandler. * Added support for child filtering with new Ufe::Hierarchy method "filteredChildren" and Ufe::HierarchyHandler method "childFilter". In USD we support a single child filter for "Inactive Prims". * Added context menu for "{Active/Deactivate} Prim". * Added test cases for new interface, new methods and new menu.

lib/mayaUsd/ufe/Global.cpp

seando-adsk · 2020-09-11T17:41:10Z

lib/mayaUsd/ufe/ProxyShapeHierarchyHandler.cpp

+#if UFE_PREVIEW_VERSION_NUM >= 2022
+Ufe::Hierarchy::ChildFilter ProxyShapeHierarchyHandler::childFilter() const
+{
+	return Ufe::Hierarchy::ChildFilter();


Return empty list - we don't (yet) support any child filters for the proxy shape.

Doesn't this mean that inactive children of the USD pseudo-root (which the proxy shape represents) can't be shown?

Oops I forgot about that case. I'll fix it.

See commit e19fa54

seando-adsk · 2020-09-11T17:41:39Z

lib/mayaUsd/ufe/UsdContextOps.cpp

+static constexpr char kUSDToggleActiveStateItem[] = "Toggle Active State";
+static constexpr char kUSDActivatePrimLabel[] = "Activate Prim";
+static constexpr char kUSDDeactivatePrimLabel[] = "Deactivate Prim";


New context menu item to activate/deactivate a prim

lib/mayaUsd/ufe/UsdContextOps.cpp

seando-adsk · 2020-09-11T17:44:11Z

lib/mayaUsd/ufe/UsdHierarchy.cpp

@@ -41,19 +42,16 @@
 #endif

 namespace {
-	UsdPrimSiblingRange filteredChildren( const UsdPrim& prim )
+	UsdPrimSiblingRange getUSDFilteredChildren(const UsdPrim& prim, const Usd_PrimFlagsPredicate pred = UsdPrimDefaultPredicate)


Added the predicate as input (with default) so that it can be used by new filtered children method.

seando-adsk · 2020-09-11T17:50:59Z

lib/mayaUsd/ufe/UsdUIInfoHandler.cpp

+			if (MGlobal::executeCommand("displayRGBColor -q \"outlinerInvisibleColor\"", outlinerInvisibleColor) &&
+				(outlinerInvisibleColor.length() == 3))
+			{
+				double rgb[3];
+				outlinerInvisibleColor.get(rgb);
+				info.textFgColor.set(static_cast<float>(rgb[0]), static_cast<float>(rgb[1]), static_cast<float>(rgb[2]));
+			}
+			else
+			{
+				info.textFgColor.set(0.403922f, 0.403922f, 0.403922f);
+			}


Get the current Maya Outliner invisible color and set that for inactive prim. If we cannot get color just use a hard-coded gray. This happens when we run the tests. The displayRGBColor command will fail.

seando-adsk · 2020-09-11T17:52:13Z

lib/mayaUsd/ufe/UsdUIInfoHandler.cpp

+
+std::string UsdUIInfoHandler::getLongRunTimeLabel() const
+{
+	return "Universal Scene Description";


Used by the menu divider (for a label).

test/lib/ufe/testChildFilter.py

seando-adsk · 2020-09-11T17:55:02Z

test/lib/ufe/testContextOps.py

+        # Active / Deactivate Prim
+        cmd = self.contextOps.doOpCmd(['Toggle Active State'])
+        self.assertIsNotNone(cmd)
+
+        # Initially, Ball_35 should be active.
+        self.assertTrue(self.ball35Prim.IsActive())
+
+        ufeCmd.execute(cmd)
+        self.assertFalse(self.ball35Prim.IsActive())
+
+        cmds.undo()
+        self.assertTrue(self.ball35Prim.IsActive())
+
+        cmds.redo()
+        self.assertFalse(self.ball35Prim.IsActive())


Test the toggle active state (with undo/redo).

seando-adsk · 2020-09-11T17:56:25Z

test/lib/ufe/testUIInfoHandler.py

+        # Clear selection to start off
+        cmds.select(clear=True)
+
+    def testUIInfo(self):


Basically this tests the new UIInfoHandler interface. Make sure we have a long runtime label. And that the treeViewCellInfo will do something for an inactive prim.

ppt-adsk · 2020-09-11T19:18:34Z

lib/mayaUsd/ufe/UsdContextOps.cpp

+    }
+
+private:
+    UsdPrim _prim;


On working with Hamed on parenting bugs I've become increasingly weary about storing prims (or scene items, same thing) as command data members, because they can go stale. Imagine the following sequence of commands:

Inactivate prim (prim stored in this command)

Reparent prim (prim removed using UsdStage::removePrim())

Undo reparent

Undo inactivate --- boom.
You should be able to demonstrate this fairly easily. Solution is the same everywhere, and I know you've implemented it in the past: use a path. In this case it can be the SdfPath and the UsdStage of the prim (that would get my vote), or you can use the Ufe::Path and call Hierarchy::createItem(), then downcast to the UsdSceneItem and get the prim.

Ah yes good thinking.

See commit e19fa54

ppt-adsk · 2020-09-11T19:28:30Z

lib/mayaUsd/ufe/ProxyShapeHierarchyHandler.cpp

+#if UFE_PREVIEW_VERSION_NUM >= 2022
+Ufe::Hierarchy::ChildFilter ProxyShapeHierarchyHandler::childFilter() const
+{
+	return Ufe::Hierarchy::ChildFilter();


Doesn't this mean that inactive children of the USD pseudo-root (which the proxy shape represents) can't be shown?

test/lib/ufe/testChildFilter.py

lib/mayaUsd/ufe/UsdHierarchy.cpp

HamedSabri-adsk · 2020-09-14T12:49:51Z

lib/mayaUsd/ufe/UsdHierarchyHandler.cpp

+    Ufe::ChildFilterFlag inactivePrims("InactivePrims", "Inactive Prims", true);
+    Ufe::Hierarchy::ChildFilter childFilters;
+    childFilters.emplace_back(inactivePrims);
+    return childFilters;


construct ChildFilterFlag object in place, creating inactivePrims is not necessary:

Ufe::Hierarchy::ChildFilter childFilters; childFilters.emplace_back("InactivePrims", "Inactive Prims", true);

Another good catch - thanks.

See commit e19fa54

* Code review comments: ** Need child filter for ProxyShapeHierarchy. ** Store Stage/SdfPath instead of UsdPrim.

HamedSabri-adsk

LGTM! Thank you.

ppt-adsk · 2020-09-14T17:30:01Z

lib/mayaUsd/ufe/UsdContextOps.cpp

    {
-        _active = _prim.IsActive();
+        _stage = prim.GetStage();


Nit-pick: could have put everything in the constructor initializer list, rather than having the default constructor called, then doing the assignment:
ToggleActiveStateCommand(const UsdPrim& prim) : _stage(prim.GetStage()), _primPath(prim.GetPath()), _active(prim.IsActive) {}

seando-adsk · 2020-09-15T13:40:25Z

Ready to merge. My preflight failed on the 2020_python2_osx because of machine connection problem. All the other builds passed.

seando-adsk commented Sep 11, 2020

View reviewed changes

seando-adsk requested a review from ppt-adsk September 11, 2020 17:56

seando-adsk added requires maya This issue requires changes in Maya ufe-usd Related to UFE-USD plugin in Maya-Usd labels Sep 11, 2020

ppt-adsk requested changes Sep 11, 2020

View reviewed changes

HamedSabri-adsk suggested changes Sep 14, 2020

View reviewed changes

lib/mayaUsd/ufe/UsdHierarchy.cpp Outdated Show resolved Hide resolved

HamedSabri-adsk reviewed Sep 14, 2020

View reviewed changes

MAYA-106188 - As a user, I would like to activate and deactivate prims

e19fa54

* Code review comments: ** Need child filter for ProxyShapeHierarchy. ** Store Stage/SdfPath instead of UsdPrim.

HamedSabri-adsk approved these changes Sep 14, 2020

View reviewed changes

ppt-adsk approved these changes Sep 14, 2020

View reviewed changes

seando-adsk assigned ecp-maya-devops-adsk and unassigned ecp-maya-devops-adsk Sep 14, 2020

seando-adsk added the ready-for-merge Development process is finished, PR is ready for merge label Sep 15, 2020

kxl-adsk merged commit 81ae65c into dev Sep 15, 2020

kxl-adsk deleted the donnels/MAYA-106188/show_inactive_prims branch September 15, 2020 14:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MAYA-106188 - As a user, I would like to activate and deactivate prims #773

MAYA-106188 - As a user, I would like to activate and deactivate prims #773

seando-adsk commented Sep 11, 2020

seando-adsk Sep 11, 2020

ppt-adsk Sep 11, 2020

seando-adsk Sep 14, 2020

seando-adsk Sep 14, 2020

seando-adsk Sep 11, 2020

seando-adsk Sep 11, 2020

seando-adsk Sep 11, 2020

seando-adsk Sep 11, 2020

seando-adsk Sep 11, 2020

seando-adsk Sep 11, 2020

ppt-adsk Sep 11, 2020

seando-adsk Sep 14, 2020

seando-adsk Sep 14, 2020

ppt-adsk Sep 11, 2020

HamedSabri-adsk Sep 14, 2020

seando-adsk Sep 14, 2020

seando-adsk Sep 14, 2020

HamedSabri-adsk left a comment

ppt-adsk Sep 14, 2020

seando-adsk commented Sep 15, 2020

MAYA-106188 - As a user, I would like to activate and deactivate prims #773

MAYA-106188 - As a user, I would like to activate and deactivate prims #773

Conversation

seando-adsk commented Sep 11, 2020

MAYA-106188 - As a user, I would like to activate and deactivate prims

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

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

HamedSabri-adsk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seando-adsk commented Sep 15, 2020