Single-site composition. More...

Include dependency graph for composeSite.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	PcpSourceArcInfo
	Information about the source of the target of an arc. More...

Typedefs
typedef std::vector< PcpSourceArcInfo >	PcpSourceArcInfoVector
	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, PcpSourceArcInfoVector info, std::unordered_set< std::string > exprVarDependencies, PcpErrorVector errors)
	References.

void	PcpComposeSiteReferences (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfReferenceVector result, PcpSourceArcInfoVector info)

void	PcpComposeSiteReferences (PcpNodeRef const &node, SdfReferenceVector result, PcpSourceArcInfoVector info, std::unordered_set< std::string > exprVarDependencies, PcpErrorVector errors)

void	PcpComposeSiteReferences (PcpNodeRef const &node, SdfReferenceVector result, PcpSourceArcInfoVector info)

PCP_API void	PcpComposeSitePayloads (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfPayloadVector result, PcpSourceArcInfoVector info, std::unordered_set< std::string > exprVarDependencies, PcpErrorVector errors)
	Payloads.

void	PcpComposeSitePayloads (PcpLayerStackRefPtr const &layerStack, SdfPath const &path, SdfPayloadVector result, PcpSourceArcInfoVector info)

void	PcpComposeSitePayloads (PcpNodeRef const &node, SdfPayloadVector result, PcpSourceArcInfoVector info, std::unordered_set< std::string > exprVarDependencies, PcpErrorVector errors)

void	PcpComposeSitePayloads (PcpNodeRef const &node, SdfPayloadVector result, PcpSourceArcInfoVector 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)
	Has prim specs.

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, PcpSourceArcInfoVector 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, PcpSourceArcInfoVector 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, PcpSourceArcInfoVector 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.

Detailed Description

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.

Class Documentation

◆ PcpSourceArcInfo

struct PcpSourceArcInfo

Information about the source of the target of 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 81 of file composeSite.h.

Class Members
string	authoredAssetPath
SdfLayerHandle	layer
SdfLayerOffset	layerStackOffset

Typedef Documentation

◆ PcpSourceArcInfoVector

typedef std::vector<PcpSourceArcInfo> PcpSourceArcInfoVector

A vector of reference or payload arc information.

Definition at line 88 of file composeSite.h.

Function Documentation

◆ PcpComposeSiteChildNames()

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.

◆ PcpComposeSiteHasPrimSpecs() [1/2]

PCP_API bool PcpComposeSiteHasPrimSpecs	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path
	)

Has prim specs.

◆ PcpComposeSiteHasPrimSpecs() [2/2]

bool PcpComposeSiteHasPrimSpecs ( PcpNodeRef const & node )

inline

Definition at line 226 of file composeSite.h.

◆ PcpComposeSiteHasSymmetry() [1/2]

PCP_API bool PcpComposeSiteHasSymmetry	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path
	)

Symmetry.

◆ PcpComposeSiteHasSymmetry() [2/2]

bool PcpComposeSiteHasSymmetry ( PcpNodeRef const & node )

inline

Definition at line 237 of file composeSite.h.

◆ PcpComposeSiteInherits() [1/2]

PCP_API void PcpComposeSiteInherits	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfPathVector *	result,
		PcpSourceArcInfoVector *	info
	)

Inherits.

◆ PcpComposeSiteInherits() [2/2]

void PcpComposeSiteInherits	(	PcpNodeRef const &	node,
		SdfPathVector *	result
	)

inline

Definition at line 255 of file composeSite.h.

◆ PcpComposeSitePayloads() [1/4]

void PcpComposeSitePayloads	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfPayloadVector *	result,
		PcpSourceArcInfoVector *	info
	)

inline

Definition at line 147 of file composeSite.h.

◆ PcpComposeSitePayloads() [2/4]

PCP_API void PcpComposeSitePayloads	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfPayloadVector *	result,
		PcpSourceArcInfoVector *	info,
		std::unordered_set< std::string > *	exprVarDependencies,
		PcpErrorVector *	errors
	)

Payloads.

◆ PcpComposeSitePayloads() [3/4]

void PcpComposeSitePayloads	(	PcpNodeRef const &	node,
		SdfPayloadVector *	result,
		PcpSourceArcInfoVector *	info
	)

inline

Definition at line 171 of file composeSite.h.

◆ PcpComposeSitePayloads() [4/4]

void PcpComposeSitePayloads	(	PcpNodeRef const &	node,
		SdfPayloadVector *	result,
		PcpSourceArcInfoVector *	info,
		std::unordered_set< std::string > *	exprVarDependencies,
		PcpErrorVector *	errors
	)

inline

Definition at line 158 of file composeSite.h.

◆ PcpComposeSitePermission() [1/2]

PCP_API SdfPermission PcpComposeSitePermission	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path
	)

Permission.

◆ PcpComposeSitePermission() [2/2]

SdfPermission PcpComposeSitePermission ( PcpNodeRef const & node )

inline

Definition at line 187 of file composeSite.h.

◆ PcpComposeSitePrimSites() [1/2]

PCP_API void PcpComposeSitePrimSites	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfSiteVector *	result
	)

Prim sites.

◆ PcpComposeSitePrimSites() [2/2]

void PcpComposeSitePrimSites	(	PcpNodeRef const &	node,
		SdfSiteVector *	result
	)

inline

Definition at line 200 of file composeSite.h.

◆ PcpComposeSiteReferences() [1/4]

void PcpComposeSiteReferences	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfReferenceVector *	result,
		PcpSourceArcInfoVector *	info
	)

inline

Definition at line 102 of file composeSite.h.

◆ PcpComposeSiteReferences() [2/4]

PCP_API void PcpComposeSiteReferences	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfReferenceVector *	result,
		PcpSourceArcInfoVector *	info,
		std::unordered_set< std::string > *	exprVarDependencies,
		PcpErrorVector *	errors
	)

References.

◆ PcpComposeSiteReferences() [3/4]

void PcpComposeSiteReferences	(	PcpNodeRef const &	node,
		SdfReferenceVector *	result,
		PcpSourceArcInfoVector *	info
	)

inline

Definition at line 126 of file composeSite.h.

◆ PcpComposeSiteReferences() [4/4]

void PcpComposeSiteReferences	(	PcpNodeRef const &	node,
		SdfReferenceVector *	result,
		PcpSourceArcInfoVector *	info,
		std::unordered_set< std::string > *	exprVarDependencies,
		PcpErrorVector *	errors
	)

inline

Definition at line 113 of file composeSite.h.

◆ PcpComposeSiteRelocates() [1/2]

PCP_API void PcpComposeSiteRelocates	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfRelocatesMap *	result
	)

Relocates.

◆ PcpComposeSiteRelocates() [2/2]

void PcpComposeSiteRelocates	(	PcpNodeRef const &	node,
		SdfRelocatesMap *	result
	)

inline

Definition at line 214 of file composeSite.h.

◆ PcpComposeSiteSpecializes() [1/2]

PCP_API void PcpComposeSiteSpecializes	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfPathVector *	result,
		PcpSourceArcInfoVector *	info
	)

Specializes.

◆ PcpComposeSiteSpecializes() [2/2]

void PcpComposeSiteSpecializes	(	PcpNodeRef const &	node,
		SdfPathVector *	result
	)

inline

Definition at line 273 of file composeSite.h.

◆ PcpComposeSiteVariantSelection() [1/3]

bool PcpComposeSiteVariantSelection	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		std::string const &	vsetName,
		std::string *	result
	)

inline

Definition at line 327 of file composeSite.h.

◆ PcpComposeSiteVariantSelection() [2/3]

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.

◆ PcpComposeSiteVariantSelection() [3/3]

bool PcpComposeSiteVariantSelection	(	PcpNodeRef const &	node,
		std::string const &	vsetName,
		std::string *	result
	)

inline

Definition at line 338 of file composeSite.h.

◆ PcpComposeSiteVariantSelections() [1/3]

void PcpComposeSiteVariantSelections	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfVariantSelectionMap *	result
	)

inline

Definition at line 357 of file composeSite.h.

◆ PcpComposeSiteVariantSelections() [2/3]

PCP_API void PcpComposeSiteVariantSelections	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		SdfVariantSelectionMap *	result,
		std::unordered_set< std::string > *	exprVarDependencies,
		PcpErrorVector *	errors
	)

VariantSelections.

◆ PcpComposeSiteVariantSelections() [3/3]

void PcpComposeSiteVariantSelections	(	PcpNodeRef const &	node,
		SdfVariantSelectionMap *	result
	)

inline

Definition at line 367 of file composeSite.h.

◆ PcpComposeSiteVariantSetOptions() [1/2]

PCP_API void PcpComposeSiteVariantSetOptions	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		std::string const &	vsetName,
		std::set< std::string > *	result
	)

VariantSetOptions.

◆ PcpComposeSiteVariantSetOptions() [2/2]

void PcpComposeSiteVariantSetOptions	(	PcpNodeRef const &	node,
		std::string const &	vsetName,
		std::set< std::string > *	result
	)

inline

Definition at line 307 of file composeSite.h.

◆ PcpComposeSiteVariantSets() [1/2]

PCP_API void PcpComposeSiteVariantSets	(	PcpLayerStackRefPtr const &	layerStack,
		SdfPath const &	path,
		std::vector< std::string > *	result,
		PcpSourceArcInfoVector *	info
	)

VariantSets.

◆ PcpComposeSiteVariantSets() [2/2]

void PcpComposeSiteVariantSets	(	PcpNodeRef const &	node,
		std::vector< std::string > *	result
	)

inline

Definition at line 293 of file composeSite.h.

Classes

Typedefs

Functions

Detailed Description

Class Documentation

◆ PcpSourceArcInfo

Typedef Documentation

◆ PcpSourceArcInfoVector

Function Documentation

◆ PcpComposeSiteChildNames()

◆ PcpComposeSiteHasPrimSpecs() [1/2]

◆ PcpComposeSiteHasPrimSpecs() [2/2]

◆ PcpComposeSiteHasSymmetry() [1/2]

◆ PcpComposeSiteHasSymmetry() [2/2]

◆ PcpComposeSiteInherits() [1/2]

◆ PcpComposeSiteInherits() [2/2]

◆ PcpComposeSitePayloads() [1/4]

◆ PcpComposeSitePayloads() [2/4]

◆ PcpComposeSitePayloads() [3/4]

◆ PcpComposeSitePayloads() [4/4]

◆ PcpComposeSitePermission() [1/2]

◆ PcpComposeSitePermission() [2/2]

◆ PcpComposeSitePrimSites() [1/2]

◆ PcpComposeSitePrimSites() [2/2]

◆ PcpComposeSiteReferences() [1/4]

◆ PcpComposeSiteReferences() [2/4]

◆ PcpComposeSiteReferences() [3/4]

◆ PcpComposeSiteReferences() [4/4]

◆ PcpComposeSiteRelocates() [1/2]

◆ PcpComposeSiteRelocates() [2/2]

◆ PcpComposeSiteSpecializes() [1/2]

◆ PcpComposeSiteSpecializes() [2/2]

◆ PcpComposeSiteVariantSelection() [1/3]

◆ PcpComposeSiteVariantSelection() [2/3]

◆ PcpComposeSiteVariantSelection() [3/3]

◆ PcpComposeSiteVariantSelections() [1/3]

◆ PcpComposeSiteVariantSelections() [2/3]

◆ PcpComposeSiteVariantSelections() [3/3]

◆ PcpComposeSiteVariantSetOptions() [1/2]

◆ PcpComposeSiteVariantSetOptions() [2/2]

◆ PcpComposeSiteVariantSets() [1/2]

◆ PcpComposeSiteVariantSets() [2/2]