All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
instanceKey.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 USD_INSTANCE_KEY_H
25 #define USD_INSTANCE_KEY_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/usd/clip.h"
29 #include "pxr/usd/usd/primData.h"
30 #include "pxr/usd/usd/stageLoadRules.h"
31 #include "pxr/usd/usd/stagePopulationMask.h"
32 
33 #include "pxr/usd/pcp/instanceKey.h"
34 
35 #include <string>
36 #include <vector>
37 #include <iosfwd>
38 
39 PXR_NAMESPACE_OPEN_SCOPE
40 
41 class PcpPrimIndex;
42 
49 class Usd_InstanceKey
50 {
51 public:
52  Usd_InstanceKey();
53 
55  explicit Usd_InstanceKey(const PcpPrimIndex& instance,
56  const UsdStagePopulationMask *popMask,
57  const UsdStageLoadRules &loadRules);
58 
60  bool operator==(const Usd_InstanceKey& rhs) const;
61  inline bool operator!=(const Usd_InstanceKey& rhs) const {
62  return !(*this == rhs);
63  }
64 
65 private:
66  friend size_t hash_value(const Usd_InstanceKey& key);
67 
68  friend std::ostream &
69  operator<<(std::ostream &os, const Usd_InstanceKey &key);
70 
71  size_t _ComputeHash() const;
72 
73  PcpInstanceKey _pcpInstanceKey;
74  std::vector<Usd_ResolvedClipInfo> _clipInfo;
76  UsdStageLoadRules _loadRules;
77  size_t _hash;
78 };
79 
81 inline size_t
82 hash_value(const Usd_InstanceKey &key) {
83  return key._hash;
84 }
85 
86 PXR_NAMESPACE_CLOSE_SCOPE
87 
88 #endif // USD_INSTANCE_KEY_H
A PcpInstanceKey identifies instanceable prim indexes that share the same set of opinions.
Definition: instanceKey.h:54
PcpPrimIndex is an index of the all sites of scene description that contribute opinions to a specific...
Definition: primIndex.h:77
This class represents rules that govern payload inclusion on UsdStages.
GF_API std::ostream & operator<<(std::ostream &, const GfBBox3d &)
Output a GfBBox3d using the format [(range) matrix zeroArea].
VT_API bool operator==(VtDictionary const &, VtDictionary const &)
Equality comparison.
This class represents a mask that may be applied to a UsdStage to limit the set of UsdPrim s it popul...