HYDRA-712 : Handle hierarchical transform & visibility changes for plugin nodes

lib/flowViewport/API/interfacesImp/fvpFilteringSceneIndexInterfaceImp.cpp

@@ -96,7 +96,7 @@ bool FilteringSceneIndexInterfaceImp::_CreateSceneFilteringSceneIndicesData(cons
         std::lock_guard<std::mutex> lock(sceneFilteringClient_mutex);
 
         auto findResult = std::find_if(sceneFilteringSceneIndicesData().cbegin(), sceneFilteringSceneIndicesData().cend(),
-                    [&client](const PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr& filteringSIData) { return filteringSIData->getClient() == client;});
+                    [&client](const PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr& filteringSIData) { return filteringSIData->GetClient() == client;});
         if (findResult != sceneFilteringSceneIndicesData().cend()){
             return false;
         }
@@ -123,7 +123,7 @@ bool FilteringSceneIndexInterfaceImp::_CreateSelectionHighlightFilteringSceneInd
         std::lock_guard<std::mutex> lock(selectionHighlightFilteringClient_mutex);
 
         auto findResult = std::find_if(selectionHighlightFilteringSceneIndicesData.cbegin(), selectionHighlightFilteringSceneIndicesData.cend(),
-                    [&client](const PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr& filteringSIData) { return filteringSIData->getClient() == client;});
+                    [&client](const PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr& filteringSIData) { return filteringSIData->GetClient() == client;});
         if (findResult != selectionHighlightFilteringSceneIndicesData.cend()){
             return false;
         }
@@ -149,11 +149,11 @@ void FilteringSceneIndexInterfaceImp::_DestroySceneFilteringSceneIndicesData(con
         std::lock_guard<std::mutex> lock(sceneFilteringClient_mutex);
 
         auto findResult = std::find_if(sceneFilteringSceneIndicesData().cbegin(), sceneFilteringSceneIndicesData().cend(),
-                    [&client](const PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr& filteringSIData) { return filteringSIData->getClient() == client;});
+                    [&client](const PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr& filteringSIData) { return filteringSIData->GetClient() == client;});
         if (findResult != sceneFilteringSceneIndicesData().cend()){
             const auto& filteringSIData = (*findResult);
             rendererNames = (filteringSIData)
-                ? filteringSIData->getClient()->getRendererNames()
+                ? filteringSIData->GetClient()->getRendererNames()
                 : FvpViewportAPITokens->allRenderers;
 
             sceneFilteringSceneIndicesData().erase(findResult);//This also decreases ref count
@@ -175,7 +175,7 @@ void FilteringSceneIndexInterfaceImp::_DestroySelectionHighlightFilteringSceneIn
         std::lock_guard<std::mutex> lock(selectionHighlightFilteringClient_mutex);
 
         auto findResult = std::find_if(selectionHighlightFilteringSceneIndicesData.cbegin(), selectionHighlightFilteringSceneIndicesData.cend(),
-                    [&client](const PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr& filteringSIData) { return filteringSIData->getClient() == client;});
+                    [&client](const PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr& filteringSIData) { return filteringSIData->GetClient() == client;});
         if (findResult != selectionHighlightFilteringSceneIndicesData.cend()){
             selectionHighlightFilteringSceneIndicesData.erase(findResult);//Also decreases ref count
         }

lib/flowViewport/API/interfacesImp/fvpFilteringSceneIndexInterfaceImp.h

@@ -46,8 +46,10 @@ class FilteringSceneIndexInterfaceImp :  public FilteringSceneIndexInterface
     FVP_API
     void setSceneIndexDataFactory(FilteringSceneIndexDataAbstractFactory& factory);
 
-    //Called by Flow viewport
+    //Called by Flow viewport and the DCC
+    FVP_API
     const std::set<PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr>&           getSceneFilteringSceneIndicesData() const;
+    FVP_API
     const std::set<PXR_NS::FVP_NS_DEF::FilteringSceneIndexDataBaseRefPtr>&           getSelectionHighlightFilteringSceneIndicesData() const;
 
 private :

lib/flowViewport/API/perViewportSceneIndicesData/fvpDataProducerSceneIndexDataBase.cpp

@@ -44,7 +44,6 @@ namespace FVP_NS_DEF {
 */
 DataProducerSceneIndexDataBase::DataProducerSceneIndexDataBase(const CreationParameters& params)
 {
-    _parentMatrix.SetIdentity();
     _dataProducerSceneIndex     = params._customDataProducerSceneIndex;
     _prefix                     = params._prefix;
     _lastSceneIndexChain        = params._customDataProducerSceneIndex;
@@ -55,7 +54,6 @@ DataProducerSceneIndexDataBase::DataProducerSceneIndexDataBase(const CreationPar
 //For Usd stages
 DataProducerSceneIndexDataBase::DataProducerSceneIndexDataBase(const CreationParametersForUsdStage& params)
 {
-    _parentMatrix.SetIdentity();
     _dataProducerSceneIndex     = nullptr;//Will be set later
     _prefix                     = params._prefix;
     _lastSceneIndexChain        = nullptr;//Will be set later
@@ -70,24 +68,6 @@ DataProducerSceneIndexDataBase::~DataProducerSceneIndexDataBase()
 #endif
 }
 
-void DataProducerSceneIndexDataBase::UpdateHydraTransformFromParentPath() 
-{ 
-    if (! _rootOverridesSceneIndex){
-        return;
-    }
-
-    _rootOverridesSceneIndex->SetRootTransform(_parentMatrix);
-}
-
-void DataProducerSceneIndexDataBase::UpdateVisibilityFromDCCNode(bool isVisible) 
-{ 
-    if (! _rootOverridesSceneIndex){
-        return;
-    }
-
-    _rootOverridesSceneIndex->SetRootVisibility(isVisible);
-}
-
 void DataProducerSceneIndexDataBase::_CreateSceneIndexChainForDataProducerSceneIndex()
 {
     if (_dccNode){
@@ -135,7 +115,6 @@ void DataProducerSceneIndexDataBase::_CreateSceneIndexChainForDataProducerSceneI
 {
     _rootOverridesSceneIndex    = UsdImagingRootOverridesSceneIndex::New(inputSceneIndex);
     _lastSceneIndexChain        = _rootOverridesSceneIndex;
-    UpdateHydraTransformFromParentPath();//Update the transform, this is useful when deleting the node and undoing it
 }
 
 void DataProducerSceneIndexDataBase::_CreateSceneIndexChainForDataProducerSceneIndexWithoutDCCNode(HdSceneIndexBaseRefPtr const & inputSceneIndex)

lib/flowViewport/API/perViewportSceneIndicesData/fvpDataProducerSceneIndexDataBase.h

@@ -85,11 +85,11 @@ TF_DECLARE_WEAK_AND_REF_PTRS(DataProducerSceneIndexDataBase);//Be able to use Re
     const SdfPath&                  GetPrefix()const{return _prefix;}
     const std::string&              GetRendererNames() const {return _rendererNames;}
 
-    /// Provide the node name from the DCC to be overriden in a DCC specific subclass
-    virtual std::string GetDCCNodeName() const {return "";}
+    // Returns true if visibility was changed, false otherwise.
+    virtual bool UpdateVisibility() = 0;
 
-    void UpdateVisibilityFromDCCNode(bool isVisible);
-    void UpdateHydraTransformFromParentPath();
+    // Returns true if transform was changed, false otherwise.
+    virtual bool UpdateTransform() = 0;
 
 protected:
 
@@ -119,9 +119,6 @@ TF_DECLARE_WEAK_AND_REF_PTRS(DataProducerSceneIndexDataBase);//Be able to use Re
     /// Is the last scene index of the scene index chain when a dccNode was passed.
     HdSceneIndexBaseRefPtr              _lastSceneIndexChain = nullptr;
 
-    /// Is the world matrix of the scene index. It is used only when a dccNode was passed to override the transform of the root of the scene index.
-    GfMatrix4d                          _parentMatrix;
-
     /// _rootOverridesSceneIndex is used to set a transform and visibility at the root of the Usd stage/data producer scene index. It is used only when a dccNode was passed.
     /// With this scene index when you select the proxyshape node and move it or hide it, we apply the same operation on the stage, same for a data producer scene index with a hosting node.
     UsdImagingRootOverridesSceneIndexRefPtr _rootOverridesSceneIndex = nullptr;

lib/flowViewport/API/perViewportSceneIndicesData/fvpFilteringSceneIndexDataBase.cpp

@@ -29,13 +29,6 @@ FilteringSceneIndexDataBase::FilteringSceneIndexDataBase(const std::shared_ptr<:
 {
 }
 
-void FilteringSceneIndexDataBase::updateVisibilityFromDCCNode(bool isVisible) 
-{
-    _isVisible = isVisible;
-    const std::string& rendererNames = _client->getRendererNames();
-    ::Fvp::FilteringSceneIndicesChainManager::get().updateFilteringSceneIndicesChain(rendererNames);
-}
-
 }//End of namespace FVP_NS_DEF
 
 PXR_NAMESPACE_CLOSE_SCOPE

lib/flowViewport/API/perViewportSceneIndicesData/fvpFilteringSceneIndexDataBase.h

@@ -41,10 +41,12 @@ TF_DECLARE_WEAK_AND_REF_PTRS(FilteringSceneIndexDataBase);//Be able to use Ref c
 
     ~FilteringSceneIndexDataBase() override = default;
 
-    void updateVisibilityFromDCCNode(bool isVisible);
-    std::shared_ptr<::Fvp::FilteringSceneIndexClient> getClient() {return _client;}
-    bool getVisible() const{return _isVisible;}
-    void setVisible(bool visible) {_isVisible = visible;}
+    std::shared_ptr<::Fvp::FilteringSceneIndexClient> GetClient() {return _client;}
+
+    bool GetVisibility() { return _isVisible; }
+
+    // Returns true if visibility was changed, false otherwise.
+    virtual bool UpdateVisibility() = 0;
 
 protected:
     FilteringSceneIndexDataBase(const std::shared_ptr<::Fvp::FilteringSceneIndexClient>& filteringSIClient);
@@ -53,7 +55,7 @@ TF_DECLARE_WEAK_AND_REF_PTRS(FilteringSceneIndexDataBase);//Be able to use Ref c
     const std::shared_ptr<::Fvp::FilteringSceneIndexClient>  _client;
 
     ///_isVisible is true when the filteringSceneIndices should be visible and false when they are not such as when the hosting node has been hidden/deleted.
-    bool    _isVisible = true;
+    bool    _isVisible = false;
 };
 
 }//End of namespace FVP_NS_DEF {

lib/flowViewport/API/perViewportSceneIndicesData/fvpFilteringSceneIndicesChainManager.cpp

@@ -141,15 +141,15 @@ void FilteringSceneIndicesChainManager::_AppendFilteringSceneIndicesChain(  View
     //Call our Hydra viewport API mechanism for custom filtering scene index clients
     const auto& viewportFilteringSceneIndicesData = FilteringSceneIndexInterfaceImp::get().getSceneFilteringSceneIndicesData();
     for (const auto& filteringSceneIndexData : viewportFilteringSceneIndicesData) {
-        auto client = filteringSceneIndexData->getClient();
+        auto client = filteringSceneIndexData->GetClient();
         const std::string& rendererNames = client->getRendererNames();
         //Filter by render delegate name
         if ( (FvpViewportAPITokens->allRenderers != rendererNames) && rendererNames.find(rendererDisplayName) == std::string::npos){
             //Ignore that client info, it is not targeted for this renderer
             continue;
         }
 
-        const bool isVisible = filteringSceneIndexData->getVisible();
+        const bool isVisible = filteringSceneIndexData->GetVisibility();
         if (! isVisible){
             continue; //We should not append not visible filtering scene indices
         }