Implement custom data provider picking and selection highlighting. (#150

)

lib/flowViewport/API/interfacesImp/fvpDataProducerSceneIndexInterfaceImp.cpp

@@ -250,7 +250,7 @@ void DataProducerSceneIndexInterfaceImp::_AddDataProducerSceneIndexToThisViewpor
     //Add it to the merging scene index if the render inex proxy is present, it may happen that it will be set later
     auto renderIndexProxy = viewportInformationAndSceneIndicesPerViewportData->GetRenderIndexProxy();
     if (renderIndexProxy && dataProducerSceneIndexData && dataProducerSceneIndexData->GetDataProducerLastSceneIndexChain()){
-        renderIndexProxy->InsertSceneIndex(dataProducerSceneIndexData->GetDataProducerLastSceneIndexChain(), SdfPath::AbsoluteRootPath());
+        renderIndexProxy->InsertSceneIndex(dataProducerSceneIndexData->GetDataProducerLastSceneIndexChain(), dataProducerSceneIndexData->GetPrefix());
     }
 }
 

lib/flowViewport/API/interfacesImp/fvpFilteringSceneIndexInterfaceImp.cpp

@@ -97,7 +97,8 @@ bool FilteringSceneIndexInterfaceImp::_CreateSceneFilteringSceneIndicesData(cons
 
         auto findResult = std::find_if(sceneFilteringSceneIndicesData().cbegin(), sceneFilteringSceneIndicesData().cend(),
                     [&client](const PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr& filteringSIData) { return filteringSIData->GetClient() == client;});
-        if (findResult != sceneFilteringSceneIndicesData().cend()){
+        if (!TF_VERIFY(findResult == sceneFilteringSceneIndicesData().cend(),
+                       "Filtering scene index client already found in FilteringSceneIndexInterfaceImp::_CreateSceneFilteringSceneIndicesData()")){
             return false;
         }
 

lib/flowViewport/API/samples/fvpDataProducerSceneIndexExample.h

@@ -24,10 +24,14 @@
 #include <pxr/base/tf/refPtr.h>
 #include <pxr/base/gf/matrix4d.h>
 #include <pxr/base/vt/array.h>
+#include <pxr/usd/sdf/path.h>
 #include <pxr/imaging/hd/retainedSceneIndex.h>
 #include <pxr/imaging/hd/dataSource.h>
 #include <pxr/imaging/hd/retainedDataSource.h>
 
+#include <set>
+#include <map>
+
 namespace FVP_NS_DEF {
 
 /** This class is an example on how to add Hydra primitives into a Hydra viewport. 
@@ -67,17 +71,7 @@ class FVP_API DataProducerSceneIndexExample
     struct CubeGridCreationParams
     {
         /// Constructor
-        CubeGridCreationParams(){
-            _numLevelsX = 10;//Default values
-            _numLevelsY = 10;
-            _numLevelsZ = 1;
-            _halfSize   = 2.0;
-            _color      = {0.f, 1.0f, 0.0f};
-            _opacity    = 0.8;
-            _deltaTrans = {5.0f, 5.0f, 5.0f};
-            _initalTransform.SetIdentity();
-            _useInstancing = false;
-        }
+        CubeGridCreationParams() = default;
 
         //Comparison operator
         bool operator == (const CubeGridCreationParams& other)const{
@@ -87,9 +81,11 @@ class FVP_API DataProducerSceneIndexExample
                     (_halfSize          == other._halfSize) && 
                     (_color             == other._color) &&
                     (_opacity           == other._opacity) &&
-                    (_initalTransform   == other._initalTransform)&&
+                    (_initialTransform  == other._initialTransform)&&
                     (_deltaTrans        == other._deltaTrans) &&
-                    (_useInstancing     == other._useInstancing);
+                    (_useInstancing     == other._useInstancing) &&
+                    (_hidden            == other._hidden) &&
+                    (_transformed       == other._transformed);
         }
 
         /// Number of X levels for the 3D grid of cube primitives
@@ -105,21 +101,28 @@ class FVP_API DataProducerSceneIndexExample
         /// Opacity of each cube in the 3D grid.
         double              _opacity{0.8};
         /// Initial transform of each cube in the 3D grid.
-        PXR_NS::GfMatrix4d  _initalTransform;
+        PXR_NS::GfMatrix4d  _initialTransform{1.0};
         /** _deltaTrans.x is the space between 2 cubes on the X axis of the 3D grid.
         *   _deltaTrans.y is the space between 2 cubes on the Y axis of the 3D grid.
         *   _deltaTrans.z is the space between 2 cubes on the Z axis of the 3D grid.
         * */
         PXR_NS::GfVec3f     _deltaTrans{5.0f, 5.0f, 5.0f};
         /// if _useInstancing is true, then we are using Hydra instancing to create the cube primitives, if it is false then we are not using Hydra instancing.
         bool                _useInstancing{false};
+
+        // Hidden cubes, indexed by name, when not using instancing.
+        std::set<std::string> _hidden{};
+
+        // Transformed cubes, indexed by name, when not using instancing.
+        // At time of writing (31-May-2024) only translation is supported.
+        std::map<std::string, PXR_NS::GfVec3d> _transformed{};
     };
 
     ///Set the CubeGridCreationParams
     void setCubeGridParams(const CubeGridCreationParams& params);
 
     ///Call FlowViewport::DataProducerSceneIndexInterface::_AddDataProducerSceneIndex to add our data producer scene index to create the 3D grid of cubes
-    void addDataProducerSceneIndex();
+    void addDataProducerSceneIndex(const PXR_NS::SdfPath& prefix = PXR_NS::SdfPath::AbsoluteRootPath());
 
     ///Call the FlowViewport::DataProducerSceneIndexInterface::RemoveViewportDataProducerSceneIndex to remove our data producer scene index from the Hydra viewport
     void removeDataProducerSceneIndex();
@@ -190,4 +193,4 @@ class FVP_API DataProducerSceneIndexExample
 
 } //end of namespace FVP_NS_DEF {
 
-#endif //FLOW_VIEWPORT_EXAMPLES_DATA_PRODUCER_SCENE_INDEX_EXAMPLE_H
+#endif //FLOW_VIEWPORT_EXAMPLES_DATA_PRODUCER_SCENE_INDEX_EXAMPLE_H

lib/flowViewport/fvpUtils.cpp

@@ -15,6 +15,8 @@
 
 #include "fvpUtils.h"
 
+#include <pxr/imaging/hd/selectionSchema.h>
+
 namespace FVP_NS_DEF {
 
 #ifdef CODE_COVERAGE_WORKAROUND
@@ -30,4 +32,11 @@ void leakSceneIndex(const PXR_NS::HdSceneIndexBaseRefPtr& si) {
 }
 #endif
 
+PXR_NS::HdDataSourceBaseHandle createFullySelectedDataSource()
+{
+    PXR_NS::HdSelectionSchema::Builder selectionBuilder;
+    selectionBuilder.SetFullySelected(PXR_NS::HdRetainedTypedSampledDataSource<bool>::New(true));
+    return PXR_NS::HdDataSourceBase::Cast(selectionBuilder.Build());
+}
+
 } // namespace FVP_NS_DEF

lib/flowViewport/fvpUtils.h

@@ -89,6 +89,8 @@ class PrimvarDataSource final : public PXR_NS::HdContainerDataSource
     PXR_NS::TfToken _role;
 };
 
+PXR_NS::HdDataSourceBaseHandle FVP_API createFullySelectedDataSource();
+
 } // namespace FVP_NS_DEF
 
 #endif // FVP_UTILS_H

lib/flowViewport/sceneIndex/fvpSelectionSceneIndex.cpp

@@ -39,6 +39,8 @@
 #include "flowViewport/sceneIndex/fvpSelectionSceneIndex.h"
 #include "flowViewport/sceneIndex/fvpPathInterface.h"
 #include "flowViewport/selection/fvpSelection.h"
+#include <flowViewport/selection/fvpPathMapper.h>
+#include <flowViewport/selection/fvpPathMapperRegistry.h>
 
 #include "flowViewport/debugCodes.h"
 
@@ -265,7 +267,23 @@ PrimSelections SelectionSceneIndex::UfePathToPrimSelections(const Ufe::Path& app
     auto primSelections = _inputSceneIndexPathInterface->UfePathToPrimSelections(appPath);
 
     if (primSelections.empty()) {
-        TF_WARN("SelectionSceneIndex::UfePathToPrimSelections(%s) returned no path, Hydra selection will be incorrect", Ufe::PathString::string(appPath).c_str());
+        // Path interface of input scene index didn't provide information.
+        // Try path mapper registry.
+        auto mapper = Fvp::PathMapperRegistry::Instance().GetMapper(appPath);
+
+        auto warnEmptyPath = [](const Ufe::Path& appPath) {
+            TF_WARN("SelectionSceneIndex::UfePathToPrimSelections(%s) returned no path, Hydra selection will be incorrect", Ufe::PathString::string(appPath).c_str());
+        };
+
+        if (!mapper) {
+            warnEmptyPath(appPath);
+        }
+        else {
+            primSelections = mapper->UfePathToPrimSelections(appPath);
+            if (primSelections.empty()) {
+                warnEmptyPath(appPath);
+            }
+        }
     }
 
     return primSelections;

lib/flowViewport/selection/CMakeLists.txt

@@ -7,13 +7,21 @@ target_sources(${TARGET_NAME}
     fvpSelectionFwd.cpp
     fvpSelectionTask.cpp
     fvpSelectionTracker.cpp
+    fvpPathMapper.cpp
+    fvpPathMapperFwd.cpp
+    fvpPathMapperRegistry.cpp
+    fvpPrefixPathMapper.cpp
 )
 
 set(HEADERS
     fvpSelection.h
     fvpSelectionFwd.h
     fvpSelectionTask.h
     fvpSelectionTracker.h
+    fvpPathMapper.h
+    fvpPathMapperFwd.h
+    fvpPathMapperRegistry.h
+    fvpPrefixPathMapper.h
 )
 
 # -----------------------------------------------------------------------------

lib/flowViewport/selection/fvpPathMapper.cpp

@@ -0,0 +1,17 @@
+//
+// Copyright 2024 Autodesk
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#include <flowViewport/selection/fvpPathMapper.h>

lib/flowViewport/selection/fvpPathMapper.h

@@ -0,0 +1,51 @@
+//
+// Copyright 2024 Autodesk
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+#ifndef FVP_PATH_MAPPER_H
+#define FVP_PATH_MAPPER_H
+
+#include <flowViewport/api.h>
+#include <flowViewport/selection/fvpPathMapperFwd.h>
+#include <flowViewport/sceneIndex/fvpPathInterface.h>
+
+#include <pxr/usd/sdf/path.h>
+
+#include <ufe/ufe.h>
+
+UFE_NS_DEF {
+class Path;
+}
+
+namespace FVP_NS_DEF {
+
+/// \class PathMapper
+///
+/// The path handler performs application path to scene index path mapping.
+///
+/// This is useful for selection highlighting, where an application selection
+/// path is converted to a path to a Hydra scene index prim that must be
+/// highlighted.
+
+class PathMapper : public PathInterface
+{
+protected:
+
+    FVP_API
+    PathMapper() = default;
+};
+
+}
+
+#endif

lib/flowViewport/selection/fvpPathMapperFwd.cpp

@@ -0,0 +1,17 @@
+//
+// Copyright 2024 Autodesk
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#include <flowViewport/selection/fvpPathMapperFwd.h>

lib/flowViewport/selection/fvpPathMapperFwd.h

@@ -0,0 +1,32 @@
+//
+// Copyright 2024 Autodesk
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+#ifndef FVP_SELECTION_PATH_MAPPER_FWD_H
+#define FVP_SELECTION_PATH_MAPPER_FWD_H
+
+#include <flowViewport/api.h>
+
+#include <memory>
+
+namespace FVP_NS_DEF {
+
+class PathMapper;
+
+using PathMapperPtr      = std::shared_ptr<PathMapper>;
+using PathMapperConstPtr = std::shared_ptr<const PathMapper>;
+
+}
+
+#endif