collectionExpressionEvaluator.h

//
// Copyright 2024 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
 
#ifndef PXR_IMAGING_HD_COLLECTION_EXPRESSION_EVALUATOR_H
#define PXR_IMAGING_HD_COLLECTION_EXPRESSION_EVALUATOR_H
 
#include "pxr/pxr.h"
 
#include "pxr/imaging/hd/api.h"
 
#include "pxr/base/tf/declarePtrs.h"
 
#include "pxr/usd/sdf/pathExpressionEval.h"
#include "pxr/usd/sdf/predicateLibrary.h"
 
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class HdSceneIndexBase;
struct HdSceneIndexPrim;
class SdfPathExpression;
 
using SdfPathVector = std::vector<class SdfPath>;
 
TF_DECLARE_WEAK_AND_REF_PTRS(HdSceneIndexBase);
 
using HdCollectionPredicateLibrary =
    SdfPredicateLibrary<const HdSceneIndexPrim &>;
 
class HdCollectionExpressionEvaluator
{
public:
    HdCollectionExpressionEvaluator() = default;
 
    HD_API
    HdCollectionExpressionEvaluator(
        const HdSceneIndexBaseRefPtr &sceneIndex,
        const SdfPathExpression &expr);
 
    HD_API
    HdCollectionExpressionEvaluator(
        const HdSceneIndexBaseRefPtr &sceneIndex,
        const SdfPathExpression &expr,
        const HdCollectionPredicateLibrary &predicateLib);
 
    bool IsEmpty() const {
        return !_sceneIndex || _eval.IsEmpty();
    }
 
    HdSceneIndexBaseRefPtr
    GetSceneIndex() const {
        return _sceneIndex;
    }
 
    HD_API
    SdfPredicateFunctionResult
    Match(const SdfPath &path) const;
 
    HD_API
    void
    PopulateAllMatches(
        const SdfPath &rootPath,
        SdfPathVector * const result) const;
    
    enum MatchKind {
        MatchAll,
        ShallowestMatches,
        ShallowestMatchesAndAllDescendants
    };
 
    HD_API
    void
    PopulateMatches(
        const SdfPath &rootPath,
        MatchKind matchKind,
        SdfPathVector * const result) const;
 
private:
    HdSceneIndexBaseRefPtr _sceneIndex;
 
    using _PrimEvaluator = SdfPathExpressionEval<const HdSceneIndexPrim &>;
    _PrimEvaluator _eval;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_COLLECTION_EXPRESSION_EVALUATOR_H