Inputs for the prim indexing procedure. More...
Public Types | |
using | PayloadSet = std::unordered_set< SdfPath, SdfPath::Hash > |
Set of paths to prims that should have their payloads included during composition. More... | |
Public Member Functions | |
bool | IsEquivalentTo (const PcpPrimIndexInputs ¶ms) const |
Returns true if prim index computations using this parameters object would be equivalent to computations using params . More... | |
PcpPrimIndexInputs & | Cache (PcpCache *cache_) |
If supplied, the given PcpCache will be used where possible to compute needed intermediate results. More... | |
PcpPrimIndexInputs & | VariantFallbacks (const PcpVariantFallbackMap *map) |
Ordered list of variant names to use for the "standin" variant set if there is no authored opinion in scene description. More... | |
PcpPrimIndexInputs & | IncludedPayloads (const PayloadSet *payloadSet) |
PcpPrimIndexInputs & | IncludedPayloadsMutex (tbb::spin_rw_mutex *mutex) |
Optional mutex for accessing includedPayloads. More... | |
PcpPrimIndexInputs & | IncludePayloadPredicate (std::function< bool(const SdfPath &)> predicate) |
Optional predicate evaluated when a not-yet-included payload is discovered while indexing. More... | |
PcpPrimIndexInputs & | Cull (bool doCulling=true) |
Whether subtrees that contribute no opinions should be culled from the index. More... | |
PcpPrimIndexInputs & | USD (bool doUSD=true) |
Whether the prim stack should be computed, and whether relocates, inherits, permissions, symmetry, or payloads should be considered during prim index computation,. More... | |
PcpPrimIndexInputs & | FileFormatTarget (const std::string &target) |
The file format target for scene description layers encountered during prim index computation. More... | |
Public Attributes | |
PcpCache * | cache |
const PcpVariantFallbackMap * | variantFallbacks |
const PayloadSet * | includedPayloads |
tbb::spin_rw_mutex * | includedPayloadsMutex |
std::function< bool(const SdfPath &)> | includePayloadPredicate |
const PcpPrimIndex * | parentIndex |
std::string | fileFormatTarget |
bool | cull |
bool | usd |
Inputs for the prim indexing procedure.
Definition at line 330 of file primIndex.h.
using PayloadSet = std::unordered_set<SdfPath, SdfPath::Hash> |
Set of paths to prims that should have their payloads included during composition.
Definition at line 358 of file primIndex.h.
|
inline |
If supplied, the given PcpCache will be used where possible to compute needed intermediate results.
Definition at line 348 of file primIndex.h.
|
inline |
Whether subtrees that contribute no opinions should be culled from the index.
Definition at line 376 of file primIndex.h.
|
inline |
The file format target for scene description layers encountered during prim index computation.
Definition at line 387 of file primIndex.h.
|
inline |
Optional mutex for accessing includedPayloads.
Definition at line 363 of file primIndex.h.
|
inline |
Optional predicate evaluated when a not-yet-included payload is discovered while indexing.
If the predicate returns true, indexing includes the payload and sets the includedDiscoveredPayload bit in the outputs.
Definition at line 370 of file primIndex.h.
bool IsEquivalentTo | ( | const PcpPrimIndexInputs & | params | ) | const |
Returns true if prim index computations using this parameters object would be equivalent to computations using params
.
|
inline |
Whether the prim stack should be computed, and whether relocates, inherits, permissions, symmetry, or payloads should be considered during prim index computation,.
Definition at line 382 of file primIndex.h.
|
inline |
Ordered list of variant names to use for the "standin" variant set if there is no authored opinion in scene description.
Definition at line 353 of file primIndex.h.