targetIndex.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_PCP_TARGET_INDEX_H
#define PXR_USD_PCP_TARGET_INDEX_H
 
#include "pxr/pxr.h"
#include "pxr/usd/pcp/api.h"
#include "pxr/usd/pcp/errors.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/sdf/path.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
SDF_DECLARE_HANDLES(SdfSpec);
class PcpCache;
class PcpLayerStackIdentifier;
class PcpPrimIndex;
class PcpPropertyIndex;
 
struct PcpTargetIndex {
    SdfPathVector paths;
    PcpErrorVector localErrors;
    bool hasTargetOpinions = false;
};
 
PCP_API
void
PcpBuildTargetIndex(
    const PcpSite& propSite,
    const PcpPropertyIndex& propIndex,
    const SdfSpecType relOrAttrType,
    PcpTargetIndex *targetIndex,
    PcpErrorVector *allErrors);
 
PCP_API
void
PcpBuildFilteredTargetIndex(
    const PcpSite& propSite,
    const PcpPropertyIndex& propIndex,
    const SdfSpecType relOrAttrType,
    const bool localOnly,
    const SdfSpecHandle &stopProperty,
    const bool includeStopProperty,
    PcpCache *cacheForValidation,
    PcpTargetIndex *targetIndex,
    SdfPathVector *deletedPaths,
    PcpErrorVector *allErrors);
 
PCP_API
void
PcpComposeTargetPaths(
    const PcpLayerStackIdentifier &layerStackId,
    const SdfPath &propPath,
    const PcpPrimIndex &primIndex,
    SdfSpecType relOrAttrType,
    SdfPathVector *paths,
    bool *hasTargetOpinions,
    PcpErrorVector *allErrors);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_PCP_TARGET_INDEX_H