leafNodeIndexer.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_EF_LEAF_NODE_INDEXER_H
#define PXR_EXEC_EF_LEAF_NODE_INDEXER_H


#include "pxr/pxr.h"

#include "pxr/exec/vdf/node.h"
#include "pxr/exec/vdf/types.h"

#include <tbb/concurrent_queue.h>
#include <tbb/concurrent_unordered_map.h>
#include <tbb/concurrent_vector.h>

PXR_NAMESPACE_OPEN_SCOPE

class VdfConnection;
class VdfMask;
class VdfOutput;

class Ef_LeafNodeIndexer
{
public:
    using Index = uint32_t;

    static constexpr Index InvalidIndex = Index(-1);

    size_t GetCapacity() const {
        return _nodes.size();
    }

    Index GetIndex(const VdfNode &node) const;

    const VdfNode *GetNode(Index index) const {
        return index < _nodes.size() ? _nodes[index].node : nullptr;
    }

    const VdfOutput *GetSourceOutput(Index index) const {
        return index < _nodes.size() ? _nodes[index].output : nullptr;
    }

    const VdfMask *GetSourceMask(Index index) const {
        return index < _nodes.size() ? _nodes[index].mask : nullptr;
    }

    void Invalidate();

    void DidDisconnect(const VdfConnection &connection);

    void DidConnect(const VdfConnection &connection);

private:
    // The data tracked for each leaf node.
    struct _LeafNode {
        const VdfNode *node;
        const VdfOutput *output;
        const VdfMask *mask;
    };

    // Map from VdfNode index to leaf node index. If a given node does not have
    // an index, InvalidIndex will be stored at the corresponding location.
    tbb::concurrent_unordered_map<VdfIndex, Index> _indices;

    // The tightly packed vector of leaf node data. The vector is indexed with
    // the leaf node index.
    tbb::concurrent_vector<_LeafNode> _nodes;

    // Free list of leaf node data. New indices are assigned by pulling from
    // this list first.
    tbb::concurrent_queue<Index> _freeList;
};

inline
Ef_LeafNodeIndexer::Index
Ef_LeafNodeIndexer::GetIndex(const VdfNode &node) const
{
    const auto it = _indices.find(VdfNode::GetIndexFromId(node.GetId()));
    return it != _indices.end() ? it->second : InvalidIndex;
}

PXR_NAMESPACE_CLOSE_SCOPE

#endif