isolatedSubnetwork.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_EXEC_VDF_ISOLATED_SUBNETWORK_H
#define PXR_EXEC_VDF_ISOLATED_SUBNETWORK_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/vdf/api.h"
#include "pxr/exec/vdf/types.h"
 
#include "pxr/base/tf/functionRef.h"
#include "pxr/base/tf/pxrTslRobinMap/robin_map.h"
#include "pxr/base/tf/pxrTslRobinMap/robin_set.h"
 
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class VdfNetwork;
class VdfNode;
 
class VdfIsolatedSubnetwork
{
public:
    VdfIsolatedSubnetwork(const VdfIsolatedSubnetwork &) = delete;
    VdfIsolatedSubnetwork &operator=(const VdfIsolatedSubnetwork &) = delete;
 
    VDF_API
    ~VdfIsolatedSubnetwork();
 
    using ConnectionSet = pxr_tsl::robin_set<VdfConnection *, TfHash>;
 
    using EditFilter = TfFunctionRef<bool(const VdfNode *)>;
 
    VDF_API static
    std::unique_ptr<VdfIsolatedSubnetwork> IsolateBranch(
        VdfConnection *connection,
        EditFilter canDelete);
 
    VDF_API static
    std::unique_ptr<VdfIsolatedSubnetwork> IsolateBranch(
        VdfNode *node,
        EditFilter canDelete);
 
    VDF_API static
    std::unique_ptr<VdfIsolatedSubnetwork> New(VdfNetwork *network);
 
    VDF_API
    bool AddIsolatedBranch(
        VdfConnection *connection,
        EditFilter canDelete);
 
    VDF_API
    bool AddIsolatedBranch(
        VdfNode *node,
        EditFilter canDelete);
 
    VDF_API
    void RemoveIsolatedObjectsFromNetwork();
 
    const std::vector<VdfNode *> &GetIsolatedNodes() const {
        return _nodes;
    }
 
    const ConnectionSet &GetIsolatedConnections() const {
        return _connections;
    }
 
private:
    VdfIsolatedSubnetwork(VdfNetwork *network);
 
    // Helper that checks if we can traverse past \p sourceNode.
    bool _CanTraverse(
        const VdfNode &sourceNode,
        EditFilter canDelete);
 
    // Helper that traverses a branch.
    void _TraverseBranch(
        VdfConnection *connection,
        EditFilter canDelete);
 
private:
 
    // The network
    VdfNetwork *_network;
 
    // The set of isolated nodes.
    std::vector<VdfNode *> _nodes;
    
    // The set of isolated connections.
    ConnectionSet _connections;
 
    // Used to keep track of the number of remaining output connections for a
    // given node that have not yet been determined to be part of the isolated
    // subnetwork.
    pxr_tsl::robin_map<VdfIndex, int>
    _unisolatedOutputConnections;
 
    // Flag that indicates whether or not RemoveIsolatedObjectsFromNetwork has
    // been called.
    bool _removedIsolatedObjects = false;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif