Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
PcpPrimIndexInputs Class Reference

Inputs for the prim indexing procedure. More...

#include <primIndex.h>

Public Types

using PayloadSet = std::unordered_set< SdfPath, SdfPath::Hash >
 Set of paths to prims that should have their payloads included during composition.
 

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.
 
PcpPrimIndexInputs & Cache (PcpCache *cache_)
 If supplied, the given PcpCache will be used where possible to compute needed intermediate results.
 
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.
 
PcpPrimIndexInputs & IncludedPayloads (const PayloadSet *payloadSet)
 
PcpPrimIndexInputs & IncludedPayloadsMutex (tbb::spin_rw_mutex *mutex)
 Optional mutex for accessing includedPayloads.
 
PcpPrimIndexInputs & IncludePayloadPredicate (std::function< bool(const SdfPath &)> predicate)
 Optional predicate evaluated when a not-yet-included payload is discovered while indexing.
 
PcpPrimIndexInputs & Cull (bool doCulling=true)
 Whether subtrees that contribute no opinions should be culled from the index.
 
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,.
 
PcpPrimIndexInputs & FileFormatTarget (const std::string &target)
 The file format target for scene description layers encountered during prim index computation.
 

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
 

Detailed Description

Inputs for the prim indexing procedure.

Definition at line 356 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 384 of file primIndex.h.

Constructor & Destructor Documentation

◆ PcpPrimIndexInputs()

PcpPrimIndexInputs ( )
inline

Definition at line 358 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 374 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 402 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 413 of file primIndex.h.

◆ IncludedPayloads()

PcpPrimIndexInputs & IncludedPayloads ( const PayloadSet *  payloadSet)
inline

Definition at line 385 of file primIndex.h.

◆ IncludedPayloadsMutex()

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

Optional mutex for accessing includedPayloads.

Definition at line 389 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 396 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 408 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 379 of file primIndex.h.

Member Data Documentation

◆ cache

PcpCache* cache

Definition at line 417 of file primIndex.h.

◆ cull

bool cull

Definition at line 424 of file primIndex.h.

◆ fileFormatTarget

std::string fileFormatTarget

Definition at line 423 of file primIndex.h.

◆ includedPayloads

const PayloadSet* includedPayloads

Definition at line 419 of file primIndex.h.

◆ includedPayloadsMutex

tbb::spin_rw_mutex* includedPayloadsMutex

Definition at line 420 of file primIndex.h.

◆ includePayloadPredicate

std::function<bool (const SdfPath &)> includePayloadPredicate

Definition at line 421 of file primIndex.h.

◆ parentIndex

const PcpPrimIndex* parentIndex

Definition at line 422 of file primIndex.h.

◆ usd

bool usd

Definition at line 425 of file primIndex.h.

◆ variantFallbacks

const PcpVariantFallbackMap* variantFallbacks

Definition at line 418 of file primIndex.h.

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