|
Single-site composition. More...
Go to the source code of this file.
Classes | |
struct | PcpArcInfo |
Helper information about an arc. More... | |
Typedefs | |
typedef std::vector< PcpArcInfo > | PcpArcInfoVector |
A vector of reference or payload arc information. | |
Functions | |
TF_DECLARE_WEAK_AND_REF_PTRS (PcpLayerStack) | |
PCP_API void | PcpComposeSiteReferences (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfReferenceVector *result, PcpArcInfoVector *info, std::unordered_set< std::string > *exprVarDependencies, PcpErrorVector *errors) |
References. | |
void | PcpComposeSiteReferences (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfReferenceVector *result, PcpArcInfoVector *info) |
void | PcpComposeSiteReferences (PcpNodeRef const &node, SdfReferenceVector *result, PcpArcInfoVector *info, std::unordered_set< std::string > *exprVarDependencies, PcpErrorVector *errors) |
void | PcpComposeSiteReferences (PcpNodeRef const &node, SdfReferenceVector *result, PcpArcInfoVector *info) |
PCP_API void | PcpComposeSitePayloads (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfPayloadVector *result, PcpArcInfoVector *info, std::unordered_set< std::string > *exprVarDependencies, PcpErrorVector *errors) |
Payloads. | |
void | PcpComposeSitePayloads (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfPayloadVector *result, PcpArcInfoVector *info) |
void | PcpComposeSitePayloads (PcpNodeRef const &node, SdfPayloadVector *result, PcpArcInfoVector *info, std::unordered_set< std::string > *exprVarDependencies, PcpErrorVector *errors) |
void | PcpComposeSitePayloads (PcpNodeRef const &node, SdfPayloadVector *result, PcpArcInfoVector *info) |
PCP_API SdfPermission | PcpComposeSitePermission (PcpLayerStackRefPtr const &layerStack, SdfPath const &path) |
Permission. | |
SdfPermission | PcpComposeSitePermission (PcpNodeRef const &node) |
PCP_API void | PcpComposeSitePrimSites (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfSiteVector *result) |
Prim sites. | |
void | PcpComposeSitePrimSites (PcpNodeRef const &node, SdfSiteVector *result) |
PCP_API void | PcpComposeSiteRelocates (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfRelocatesMap *result) |
Relocates. | |
void | PcpComposeSiteRelocates (PcpNodeRef const &node, SdfRelocatesMap *result) |
PCP_API bool | PcpComposeSiteHasPrimSpecs (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, const std::unordered_set< SdfLayerHandle, TfHash > &layersToIgnore) |
Has prim specs. | |
PCP_API bool | PcpComposeSiteHasPrimSpecs (PcpLayerStackRefPtr const &layerStack, SdfPath const &path) |
bool | PcpComposeSiteHasPrimSpecs (PcpNodeRef const &node) |
PCP_API bool | PcpComposeSiteHasSymmetry (PcpLayerStackRefPtr const &layerStack, SdfPath const &path) |
Symmetry. | |
bool | PcpComposeSiteHasSymmetry (PcpNodeRef const &node) |
PCP_API void | PcpComposeSiteInherits (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfPathVector *result, PcpArcInfoVector *info) |
Inherits. | |
PCP_API void | PcpComposeSiteInherits (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfPathVector *result) |
void | PcpComposeSiteInherits (PcpNodeRef const &node, SdfPathVector *result) |
PCP_API void | PcpComposeSiteSpecializes (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfPathVector *result, PcpArcInfoVector *info) |
Specializes. | |
PCP_API void | PcpComposeSiteSpecializes (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfPathVector *result) |
void | PcpComposeSiteSpecializes (PcpNodeRef const &node, SdfPathVector *result) |
PCP_API void | PcpComposeSiteVariantSets (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, std::vector< std::string > *result, PcpArcInfoVector *info) |
VariantSets. | |
PCP_API void | PcpComposeSiteVariantSets (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, std::vector< std::string > *result) |
void | PcpComposeSiteVariantSets (PcpNodeRef const &node, std::vector< std::string > *result) |
PCP_API void | PcpComposeSiteVariantSetOptions (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, std::string const &vsetName, std::set< std::string > *result) |
VariantSetOptions. | |
void | PcpComposeSiteVariantSetOptions (PcpNodeRef const &node, std::string const &vsetName, std::set< std::string > *result) |
PCP_API bool | PcpComposeSiteVariantSelection (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, std::string const &vsetName, std::string *result, std::unordered_set< std::string > *exprVarDependencies, PcpErrorVector *errors) |
VariantSelection. | |
bool | PcpComposeSiteVariantSelection (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, std::string const &vsetName, std::string *result) |
bool | PcpComposeSiteVariantSelection (PcpNodeRef const &node, std::string const &vsetName, std::string *result) |
PCP_API void | PcpComposeSiteVariantSelections (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfVariantSelectionMap *result, std::unordered_set< std::string > *exprVarDependencies, PcpErrorVector *errors) |
VariantSelections. | |
void | PcpComposeSiteVariantSelections (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfVariantSelectionMap *result) |
void | PcpComposeSiteVariantSelections (PcpNodeRef const &node, SdfVariantSelectionMap *result) |
PCP_API bool | PcpComposeSiteHasVariantSelections (PcpLayerStackRefPtr const &layerStack, SdfPath const &path) |
PCP_API void | PcpComposeSiteChildNames (SdfLayerRefPtrVector const &layers, SdfPath const &path, const TfToken &namesField, TfTokenVector *nameOrder, PcpTokenSet *nameSet, const TfToken *orderField=nullptr) |
Compose child names. | |
Single-site composition.
These are helpers that compose specific fields at single sites. They compose the field for a given path across a layer stack, using field-specific rules to combine the values.
These helpers are low-level utilities used by the rest of the Pcp algorithms, to discover composition arcs in scene description. These arcs are what guide the algorithm to pull additional sites of scene description into the PcpPrimIndex.
Some of these field types support list-editing. (See SdListOp.) List-editing for these fields is applied across the fixed domain of a single site; you cannot apply list-ops across sites. The intention is to avoid subtle ordering issues in composition semantics.
Note that these helpers do not take PcpSite as a literal parameter; instead, they require the actual computed layer stack that a site identified. Rather than tying these helpers to PcpCache and its process of computing layer stacks, they just employ the result. Conceptually, though, they are operating on the scene description identified by a PcpSite.
Definition in file composeSite.h.
struct PcpArcInfo |
Helper information about an arc.
All arcs have a layer that the arc comes from. References and payloads supply an authored asset path as well.
Definition at line 64 of file composeSite.h.
Class Members | ||
---|---|---|
int | arcNum | |
string | authoredAssetPath | |
SdfLayerHandle | sourceLayer | |
SdfLayerOffset | sourceLayerStackOffset |
typedef std::vector<PcpArcInfo> PcpArcInfoVector |
A vector of reference or payload arc information.
Definition at line 72 of file composeSite.h.
PCP_API void PcpComposeSiteChildNames | ( | SdfLayerRefPtrVector const & | layers, |
SdfPath const & | path, | ||
const TfToken & | namesField, | ||
TfTokenVector * | nameOrder, | ||
PcpTokenSet * | nameSet, | ||
const TfToken * | orderField = nullptr |
||
) |
Compose child names.
If the optional orderField
is provided, its order will be applied.
PCP_API bool PcpComposeSiteHasPrimSpecs | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
const std::unordered_set< SdfLayerHandle, TfHash > & | layersToIgnore | ||
) |
Has prim specs.
|
inline |
Definition at line 218 of file composeSite.h.
PCP_API bool PcpComposeSiteHasSymmetry | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path | ||
) |
Symmetry.
|
inline |
Definition at line 229 of file composeSite.h.
PCP_API void PcpComposeSiteInherits | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
SdfPathVector * | result, | ||
PcpArcInfoVector * | info | ||
) |
Inherits.
|
inline |
Definition at line 247 of file composeSite.h.
|
inline |
Definition at line 131 of file composeSite.h.
PCP_API void PcpComposeSitePayloads | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
SdfPayloadVector * | result, | ||
PcpArcInfoVector * | info, | ||
std::unordered_set< std::string > * | exprVarDependencies, | ||
PcpErrorVector * | errors | ||
) |
Payloads.
|
inline |
Definition at line 155 of file composeSite.h.
|
inline |
Definition at line 142 of file composeSite.h.
PCP_API SdfPermission PcpComposeSitePermission | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path | ||
) |
Permission.
|
inline |
Definition at line 171 of file composeSite.h.
PCP_API void PcpComposeSitePrimSites | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
SdfSiteVector * | result | ||
) |
Prim sites.
|
inline |
Definition at line 184 of file composeSite.h.
|
inline |
Definition at line 86 of file composeSite.h.
PCP_API void PcpComposeSiteReferences | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
SdfReferenceVector * | result, | ||
PcpArcInfoVector * | info, | ||
std::unordered_set< std::string > * | exprVarDependencies, | ||
PcpErrorVector * | errors | ||
) |
References.
|
inline |
Definition at line 110 of file composeSite.h.
|
inline |
Definition at line 97 of file composeSite.h.
PCP_API void PcpComposeSiteRelocates | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
SdfRelocatesMap * | result | ||
) |
Relocates.
|
inline |
Definition at line 198 of file composeSite.h.
PCP_API void PcpComposeSiteSpecializes | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
SdfPathVector * | result, | ||
PcpArcInfoVector * | info | ||
) |
Specializes.
|
inline |
Definition at line 265 of file composeSite.h.
|
inline |
Definition at line 319 of file composeSite.h.
PCP_API bool PcpComposeSiteVariantSelection | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
std::string const & | vsetName, | ||
std::string * | result, | ||
std::unordered_set< std::string > * | exprVarDependencies, | ||
PcpErrorVector * | errors | ||
) |
VariantSelection.
|
inline |
Definition at line 330 of file composeSite.h.
|
inline |
Definition at line 349 of file composeSite.h.
PCP_API void PcpComposeSiteVariantSelections | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
SdfVariantSelectionMap * | result, | ||
std::unordered_set< std::string > * | exprVarDependencies, | ||
PcpErrorVector * | errors | ||
) |
VariantSelections.
|
inline |
Definition at line 359 of file composeSite.h.
PCP_API void PcpComposeSiteVariantSetOptions | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
std::string const & | vsetName, | ||
std::set< std::string > * | result | ||
) |
VariantSetOptions.
|
inline |
Definition at line 299 of file composeSite.h.
PCP_API void PcpComposeSiteVariantSets | ( | PcpLayerStackRefPtr const & | layerStack, |
SdfPath const & | path, | ||
std::vector< std::string > * | result, | ||
PcpArcInfoVector * | info | ||
) |
VariantSets.
|
inline |
Definition at line 285 of file composeSite.h.