utils.h

//
// Copyright 2024 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_HDSI_UTILS_H
#define PXR_IMAGING_HDSI_UTILS_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hd/collectionPredicateLibrary.h"
#include "pxr/imaging/hdsi/api.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/token.h"
#include <optional>
 
PXR_NAMESPACE_OPEN_SCOPE
 
TF_DECLARE_WEAK_AND_REF_PTRS(HdSceneIndexBase);
 
class HdCollectionExpressionEvaluator;
class HdCollectionsSchema;
class SdfPathExpression;
 
struct HdSceneIndexPrim;
 
 
HDSI_API
void
HdsiUtilsCompileCollection(
    const HdCollectionsSchema &collections,
    const TfToken &collectionName,
    const HdSceneIndexBaseRefPtr &sceneIndex,
    const HdCollectionPredicateLibrary &predicateLibrary,
    SdfPathExpression *expr,
    std::optional<HdCollectionExpressionEvaluator> *eval);
 
HDSI_API
void
HdsiUtilsCompileCollection(
    const HdCollectionsSchema &collections,
    const TfToken &collectionName,
    const HdSceneIndexBaseRefPtr &sceneIndex,
    SdfPathExpression *expr,
    std::optional<HdCollectionExpressionEvaluator> *eval);
 
 
HDSI_API
bool 
HdsiUtilsIsPruned(
    const SdfPath &primPath,
    const HdCollectionExpressionEvaluator &eval);
 
HDSI_API
void
HdsiUtilsRemovePrunedChildren(
    const SdfPath &parentPath,
    const HdCollectionExpressionEvaluator &eval,
    SdfPathVector *children);
 
 
HDSI_API
SdfPath 
HdsiUtilsGetBoundMaterial(
    const HdSceneIndexPrim& prim);
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif //PXR_IMAGING_HDSI_UTILS_H