Added USD pick mode fixes for VP2

plugin/al/lib/AL_USDMaya/AL/usdmaya/nodes/ProxyDrawOverride.cpp

@@ -58,10 +58,42 @@
 #include <pxr/base/arch/env.h>
 #endif
 
+#include <pxr/usd/usd/modelAPI.h>
+
 namespace AL {
 namespace usdmaya {
 namespace nodes {
 namespace {
+//----------------------------------------------------------------------------------------------------------------------
+/// \brief Retarget a prim based on the AL_USDMaya's pick mode settings. This will either return new
+/// prim to select,
+///        or the original prim if no re-targetting occurred.
+/// \param prim Attempt to retarget this prim.
+/// \return The retargetted prim, or the original.
+UsdPrim retargetSelectPrim(const UsdPrim& prim)
+{
+    switch (ProxyShape::PickMode(MGlobal::optionVarIntValue("AL_usdmaya_pickMode"))) {
+
+    // Read up prim hierarchy and return first Model kind ancestor as the target prim
+    case ProxyShape::PickMode::kModels: {
+        UsdPrim tmpPrim = prim;
+        while (tmpPrim.IsValid()) {
+            if (UsdModelAPI(tmpPrim).IsModel()) {
+                return tmpPrim;
+            }
+            tmpPrim = tmpPrim.GetParent();
+        }
+    }
+
+    case ProxyShape::PickMode::kPrims:
+    case ProxyShape::PickMode::kInstances:
+    default: {
+        break;
+    }
+    }
+    return prim;
+}
+
 //----------------------------------------------------------------------------------------------------------------------
 /// \brief  user data struct - holds the info needed to render the scene
 //----------------------------------------------------------------------------------------------------------------------
@@ -578,8 +610,13 @@ bool ProxyDrawOverride::userSelect(
         MGlobal::executeCommand(command, nodes, false, true);
 
         for (const auto& it : hitBatch) {
-            auto path = it.first;
-            auto obj = proxyShape->findRequiredPath(path);
+            // Retarget hit path based on pick mode policy. The retargeted prim must
+            // align with the path used in the 'AL_usdmaya_ProxyShapeSelect' command.
+            const SdfPath hitPath = it.first;
+            const UsdPrim retargetedHitPrim
+                = retargetSelectPrim(proxyShape->getUsdStage()->GetPrimAtPath(hitPath));
+            const MObject obj = proxyShape->findRequiredPath(retargetedHitPrim.GetPath());
+
             if (obj != MObject::kNullObj) {
                 MFnDagNode dagNode(obj);
                 MDagPath   dg;
@@ -702,6 +739,17 @@ bool ProxyDrawOverride::userSelect(
             }
         } else {
 #endif
+
+            // Massage hit paths to align with pick mode policy
+            for (std::size_t i = 0; i < paths.size(); ++i) {
+                const SdfPath& path = paths[i];
+                const UsdPrim  retargetedPrim
+                    = retargetSelectPrim(proxyShape->getUsdStage()->GetPrimAtPath(path));
+                if (retargetedPrim.GetPath() != path) {
+                    paths[i] = retargetedPrim.GetPath();
+                }
+            }
+
             switch (listAdjustment) {
             case MGlobal::kReplaceList: {
                 MString command;