targetIndex.h
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 #ifndef PXR_USD_PCP_TARGET_INDEX_H
8 #define PXR_USD_PCP_TARGET_INDEX_H
9 
10 #include "pxr/pxr.h"
11 #include "pxr/usd/pcp/api.h"
12 #include "pxr/usd/pcp/errors.h"
14 #include "pxr/usd/sdf/path.h"
15 
16 PXR_NAMESPACE_OPEN_SCOPE
17 
18 SDF_DECLARE_HANDLES(SdfSpec);
19 class PcpCache;
20 class PcpPropertyIndex;
21 
30  SdfPathVector paths;
31  PcpErrorVector localErrors;
32  bool hasTargetOpinions = false;
33 };
34 
46 PCP_API
47 void
48 PcpBuildTargetIndex(
49  const PcpSite& propSite,
50  const PcpPropertyIndex& propIndex,
51  const SdfSpecType relOrAttrType,
52  PcpTargetIndex *targetIndex,
53  PcpErrorVector *allErrors);
54 
75 PCP_API
76 void
77 PcpBuildFilteredTargetIndex(
78  const PcpSite& propSite,
79  const PcpPropertyIndex& propIndex,
80  const SdfSpecType relOrAttrType,
81  const bool localOnly,
82  const SdfSpecHandle &stopProperty,
83  const bool includeStopProperty,
84  PcpCache *cacheForValidation,
85  PcpTargetIndex *targetIndex,
86  SdfPathVector *deletedPaths,
87  PcpErrorVector *allErrors);
88 
89 PXR_NAMESPACE_CLOSE_SCOPE
90 
91 #endif // PXR_USD_PCP_TARGET_INDEX_H
PcpCache is the context required to make requests of the Pcp composition algorithm and cache the resu...
Definition: cache.h:76
Base class for all Sdf spec classes.
Definition: spec.h:32
A site specifies a path in a layer stack of scene description.
Definition: site.h:28
SdfSpecType
An enum that specifies the type of an object.
Definition: types.h:73
PcpPropertyIndex is an index of all sites in scene description that contribute opinions to a specific...
Definition: propertyIndex.h:48
A PcpTargetIndex represents the results of indexing the target paths of a relationship or attribute.
Definition: targetIndex.h:29