instancingAwareCollectionExpressionEvaluator.h

//
// Copyright 2026 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HD_INSTANCING_AWARE_COLLECTION_EXPRESSION_EVALUATOR_H
#define PXR_IMAGING_HD_INSTANCING_AWARE_COLLECTION_EXPRESSION_EVALUATOR_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hd/api.h"
 
#include "pxr/imaging/hd/collectionExpressionEvaluator.h"
 
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/weakPtr.h"
#include "pxr/usd/sdf/path.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdInstanceProxyViewSceneIndex;
class SdfPathExpression;
 
TF_DECLARE_REF_PTRS(HdInstanceProxyViewSceneIndex);
 
class HdInstancingAwareCollectionExpressionEvaluator
{
public:
    struct MatchResult {
        SdfPathSet nonInstanceMatches;
 
        SdfPathSet fullyMatchedInstances;
 
        SdfPathSet partiallyMatchedInstances;
 
        SdfPathSet matchedInstanceProxyPaths;
    };
 
    HdInstancingAwareCollectionExpressionEvaluator() = default;
 
    HD_API
    HdInstancingAwareCollectionExpressionEvaluator(
        const HdInstanceProxyViewSceneIndexRefPtr &proxyViewSceneIndex,
        const SdfPathExpression &expr,
        const HdCollectionPredicateLibrary &predicateLib);
 
    bool IsEmpty() const { return _inputEval.IsEmpty(); }
 
    HD_API
    SdfPredicateFunctionResult Match(const SdfPath &path) const;
 
    HD_API
    MatchResult GetAllMatches(
        const SdfPath &rootPath,
        HdCollectionExpressionEvaluator::MatchKind matchKind,
        bool includeInstanceProxyMatches = false) const;
 
    HD_API
    void AppendAllMatches(
        const SdfPath &rootPath,
        HdCollectionExpressionEvaluator::MatchKind matchKind,
        bool includeInstanceProxyMatches,
        MatchResult * const result) const;
 
private:
    void _CollectProxyMatches(
        const SdfPath &path,
        bool includeProxyPaths,
        bool *allMatch,
        bool *anyMatch,
        SdfPathSet *matchedProxyPaths) const;
 
    void _TraverseProxyDescendants(
        const SdfPath &path,
        SdfPathSet *proxyPaths) const;
 
private:
    // Data.
 
    // Evaluator backed by the proxy view's input scene.
    HdCollectionExpressionEvaluator _inputEval;
    // Evaluator backed by the proxy view scene.
    HdCollectionExpressionEvaluator _proxyViewEval;
 
    // Non-owning handle; lifetime is managed by the owning scene index.
    TfWeakPtr<HdInstanceProxyViewSceneIndex> _proxyViewSi;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_INSTANCING_AWARE_COLLECTION_EXPRESSION_EVALUATOR_H