PcpPrimIndexInputs Class Reference

#include <primIndex.h>

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

Public Member Functions
	PcpPrimIndexInputs ()
bool	IsEquivalentTo (const PcpPrimIndexInputs &params) const
PcpPrimIndexInputs &	Cache (PcpCache *cache_)
PcpPrimIndexInputs &	VariantFallbacks (const PcpVariantFallbackMap *map)
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)
PcpPrimIndexInputs &	AncestorIsInstanceablePredicate (std::function< bool(const SdfPath &)> predicate)
PcpPrimIndexInputs &	Cull (bool doCulling=true)
PcpPrimIndexInputs &	USD (bool doUSD=true)
PcpPrimIndexInputs &	FileFormatTarget (const std::string &target)

Public Attributes
PcpCache *	cache
const PcpVariantFallbackMap *	variantFallbacks
const PayloadSet *	includedPayloads
tbb::spin_rw_mutex *	includedPayloadsMutex
std::function< bool(const SdfPath &)>	includePayloadPredicate
std::function< bool(const SdfPath &)>	ancestorIsInstanceablePredicate
const PcpPrimIndex *	parentIndex
std::string	fileFormatTarget
bool	cull
bool	usd

Detailed Description

Inputs for the prim indexing procedure.

Definition at line 355 of file primIndex.h.

Member Typedef Documentation

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

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

Definition at line 383 of file primIndex.h.

Constructor & Destructor Documentation

PcpPrimIndexInputs::PcpPrimIndexInputs ( )

inline

Definition at line 357 of file primIndex.h.

Member Function Documentation

PcpPrimIndexInputs& PcpPrimIndexInputs::AncestorIsInstanceablePredicate ( std::function< bool(const SdfPath &)>  predicate )

inline

Predicate for determining whether the prim index for an ancestor of the index being computed is instanceable.

Definition at line 401 of file primIndex.h.

PcpPrimIndexInputs& PcpPrimIndexInputs::Cache ( PcpCache *  cache_ )

inline

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

Definition at line 373 of file primIndex.h.

PcpPrimIndexInputs& PcpPrimIndexInputs::Cull ( bool  doCulling = true )

inline

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

Definition at line 407 of file primIndex.h.

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

inline

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

Definition at line 418 of file primIndex.h.

PcpPrimIndexInputs& PcpPrimIndexInputs::IncludedPayloads ( const PayloadSet *  payloadSet )

inline

Definition at line 384 of file primIndex.h.

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

inline

Optional mutex for accessing includedPayloads.

Definition at line 388 of file primIndex.h.

PcpPrimIndexInputs& 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 395 of file primIndex.h.

bool PcpPrimIndexInputs::IsEquivalentTo

(

const PcpPrimIndexInputs &

params

)

const

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

PcpPrimIndexInputs& 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 413 of file primIndex.h.

PcpPrimIndexInputs& 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 378 of file primIndex.h.

Member Data Documentation

std::function<bool (const SdfPath &)> PcpPrimIndexInputs::ancestorIsInstanceablePredicate

Definition at line 427 of file primIndex.h.

PcpCache* PcpPrimIndexInputs::cache

Definition at line 422 of file primIndex.h.

bool PcpPrimIndexInputs::cull

Definition at line 430 of file primIndex.h.

std::string PcpPrimIndexInputs::fileFormatTarget

Definition at line 429 of file primIndex.h.

const PayloadSet* PcpPrimIndexInputs::includedPayloads

Definition at line 424 of file primIndex.h.

tbb::spin_rw_mutex* PcpPrimIndexInputs::includedPayloadsMutex

Definition at line 425 of file primIndex.h.

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

Definition at line 426 of file primIndex.h.

const PcpPrimIndex* PcpPrimIndexInputs::parentIndex

Definition at line 428 of file primIndex.h.

bool PcpPrimIndexInputs::usd

Definition at line 431 of file primIndex.h.

const PcpVariantFallbackMap* PcpPrimIndexInputs::variantFallbacks

Definition at line 423 of file primIndex.h.

---

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

• pxr/usd/pcp/primIndex.h