targetIndex.h
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_USD_PCP_TARGET_INDEX_H
25 #define PXR_USD_PCP_TARGET_INDEX_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/pcp/api.h"
29 #include "pxr/usd/pcp/errors.h"
31 #include "pxr/usd/sdf/path.h"
32 
33 PXR_NAMESPACE_OPEN_SCOPE
34 
35 SDF_DECLARE_HANDLES(SdfSpec);
36 class PcpCache;
37 class PcpPropertyIndex;
38 
47  SdfPathVector paths;
48  PcpErrorVector localErrors;
49  bool hasTargetOpinions = false;
50 };
51 
63 PCP_API
64 void
65 PcpBuildTargetIndex(
66  const PcpSite& propSite,
67  const PcpPropertyIndex& propIndex,
68  const SdfSpecType relOrAttrType,
69  PcpTargetIndex *targetIndex,
70  PcpErrorVector *allErrors);
71 
92 PCP_API
93 void
94 PcpBuildFilteredTargetIndex(
95  const PcpSite& propSite,
96  const PcpPropertyIndex& propIndex,
97  const SdfSpecType relOrAttrType,
98  const bool localOnly,
99  const SdfSpecHandle &stopProperty,
100  const bool includeStopProperty,
101  PcpCache *cacheForValidation,
102  PcpTargetIndex *targetIndex,
103  SdfPathVector *deletedPaths,
104  PcpErrorVector *allErrors);
105 
106 PXR_NAMESPACE_CLOSE_SCOPE
107 
108 #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:93
Base class for all Sdf spec classes.
Definition: spec.h:51
A site specifies a path in a layer stack of scene description.
Definition: site.h:46
SdfSpecType
An enum that specifies the type of an object.
Definition: types.h:90
PcpPropertyIndex is an index of all sites in scene description that contribute opinions to a specific...
Definition: propertyIndex.h:65
A PcpTargetIndex represents the results of indexing the target paths of a relationship or attribute.
Definition: targetIndex.h:46