PcpPrimIndexInputs Class Reference

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 &params) const
 Returns true if prim index computations using this parameters object would be equivalent to computations using params. More...
 
PcpPrimIndexInputsCache (PcpCache *cache_)
 If supplied, the given PcpCache will be used where possible to compute needed intermediate results. More...
 
PcpPrimIndexInputsVariantFallbacks (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...
 
PcpPrimIndexInputsIncludedPayloads (const PayloadSet *payloadSet)
 
PcpPrimIndexInputsIncludedPayloadsMutex (tbb::spin_rw_mutex *mutex)
 Optional mutex for accessing includedPayloads. More...
 
PcpPrimIndexInputsIncludePayloadPredicate (std::function< bool(const SdfPath &)> predicate)
 Optional predicate evaluated when a not-yet-included payload is discovered while indexing. More...
 
PcpPrimIndexInputsCull (bool doCulling=true)
 Whether subtrees that contribute no opinions should be culled from the index. More...
 
PcpPrimIndexInputsUSD (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...
 
PcpPrimIndexInputsFileFormatTarget (const std::string &target)
 The file format target for scene description layers encountered during prim index computation. More...
 

Public Attributes

PcpCachecache
 
const PcpVariantFallbackMapvariantFallbacks
 
const PayloadSetincludedPayloads
 
tbb::spin_rw_mutex * includedPayloadsMutex
 
std::function< bool(const SdfPath &)> includePayloadPredicate
 
const PcpPrimIndexparentIndex
 
std::string fileFormatTarget
 
bool cull
 
bool usd
 

Detailed Description

Inputs for the prim indexing procedure.

Definition at line 351 of file primIndex.h.

Member Typedef Documentation

◆ PayloadSet

using PayloadSet = std::unordered_set<SdfPath, SdfPath::Hash>

Set of paths to prims that should have their payloads included during composition.

Definition at line 379 of file primIndex.h.

Member Function Documentation

◆ Cache()

PcpPrimIndexInputs& Cache ( PcpCache cache_)
inline

If supplied, the given PcpCache will be used where possible to compute needed intermediate results.

Definition at line 369 of file primIndex.h.

◆ Cull()

PcpPrimIndexInputs& Cull ( bool  doCulling = true)
inline

Whether subtrees that contribute no opinions should be culled from the index.

Definition at line 397 of file primIndex.h.

◆ FileFormatTarget()

PcpPrimIndexInputs& FileFormatTarget ( const std::string &  target)
inline

The file format target for scene description layers encountered during prim index computation.

Definition at line 408 of file primIndex.h.

◆ IncludedPayloadsMutex()

PcpPrimIndexInputs& IncludedPayloadsMutex ( tbb::spin_rw_mutex *  mutex)
inline

Optional mutex for accessing includedPayloads.

Definition at line 384 of file primIndex.h.

◆ IncludePayloadPredicate()

PcpPrimIndexInputs& IncludePayloadPredicate ( std::function< bool(const SdfPath &)>  predicate)
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 391 of file primIndex.h.

◆ IsEquivalentTo()

bool IsEquivalentTo ( const PcpPrimIndexInputs params) const

Returns true if prim index computations using this parameters object would be equivalent to computations using params.

◆ USD()

PcpPrimIndexInputs& USD ( bool  doUSD = true)
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 403 of file primIndex.h.

◆ VariantFallbacks()

PcpPrimIndexInputs& VariantFallbacks ( const PcpVariantFallbackMap map)
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 374 of file primIndex.h.


The documentation for this class was generated from the following file: