layerStack.h File Reference

#include "pxr/pxr.h"
#include "pxr/usd/pcp/api.h"
#include "pxr/usd/pcp/errors.h"
#include "pxr/usd/pcp/layerStackIdentifier.h"
#include "pxr/usd/pcp/mapExpression.h"
#include "pxr/usd/sdf/layerTree.h"
#include "pxr/base/tf/declarePtrs.h"
#include <tbb/spin_mutex.h>
#include <iosfwd>
#include <memory>
#include <string>
#include <unordered_set>
#include <vector>

Include dependency graph for layerStack.h:

Go to the source code of this file.

Classes
class	PcpLayerStack

Functions
PXR_NAMESPACE_OPEN_SCOPE	TF_DECLARE_REF_PTRS (SdfLayer)
	TF_DECLARE_WEAK_AND_REF_PTRS (PcpLayerStack)
	TF_DECLARE_WEAK_AND_REF_PTRS (Pcp_LayerStackRegistry)
PCP_API std::ostream &	operator<< (std::ostream &, const PcpLayerStackPtr &)
PCP_API std::ostream &	operator<< (std::ostream &, const PcpLayerStackRefPtr &)
PCP_API bool	PcpNegativeLayerOffsetScaleAllowed ()
bool	Pcp_IsValidRelocatesEntry (const SdfPath &source, const SdfPath &target, std::string *errorMessage)
void	Pcp_BuildRelocateMap (const std::vector< std::pair< SdfLayerHandle, SdfRelocates >> &layerRelocates, SdfRelocatesMap *relocatesMap, PcpErrorVector *errors)
	Builds a relocates map from a list of layer and SdfRelocates value pairs. More...
void	Pcp_ComputeRelocationsForLayerStack (const PcpLayerStack &layerStack, SdfRelocatesMap *relocatesSourceToTarget, SdfRelocatesMap *relocatesTargetToSource, SdfRelocatesMap *incrementalRelocatesSourceToTarget, SdfRelocatesMap *incrementalRelocatesTargetToSource, SdfPathVector *relocatesPrimPaths, PcpErrorVector *errors)
bool	Pcp_NeedToRecomputeDueToAssetPathChange (const PcpLayerStackPtr &layerStack)
bool	Pcp_NeedToRecomputeLayerStackTimeCodesPerSecond (const PcpLayerStackPtr &layerStack, const SdfLayerHandle &changedLayer)

Function Documentation

PCP_API std::ostream& operator<<	(	std::ostream &	,
		const PcpLayerStackPtr &
	)

PCP_API std::ostream& operator<<	(	std::ostream &	,
		const PcpLayerStackRefPtr &
	)

void Pcp_BuildRelocateMap	(	const std::vector< std::pair< SdfLayerHandle, SdfRelocates >> &	layerRelocates,
		SdfRelocatesMap *	relocatesMap,
		PcpErrorVector *	errors
	)

Builds a relocates map from a list of layer and SdfRelocates value pairs.

void Pcp_ComputeRelocationsForLayerStack	(	const PcpLayerStack &	layerStack,
		SdfRelocatesMap *	relocatesSourceToTarget,
		SdfRelocatesMap *	relocatesTargetToSource,
		SdfRelocatesMap *	incrementalRelocatesSourceToTarget,
		SdfRelocatesMap *	incrementalRelocatesTargetToSource,
		SdfPathVector *	relocatesPrimPaths,
		PcpErrorVector *	errors
	)

Compose the relocation arcs in the given stack of layers, putting the results into the given sourceToTarget and targetToSource maps.

bool Pcp_IsValidRelocatesEntry	(	const SdfPath &	source,
		const SdfPath &	target,
		std::string *	errorMessage
	)

Checks if the source and target paths constitute a valid relocates. This validation is not context specific, i.e. if this returns false, the combination of source and target paths is always invalid for any attempted relocation.

bool Pcp_NeedToRecomputeDueToAssetPathChange

(

const PcpLayerStackPtr &

layerStack

)

bool Pcp_NeedToRecomputeLayerStackTimeCodesPerSecond	(	const PcpLayerStackPtr &	layerStack,
		const SdfLayerHandle &	changedLayer
	)

PCP_API bool PcpNegativeLayerOffsetScaleAllowed

(

)

Returns true if negative layer offsets and scales are allowed.

Negative layer offset scales are deprecated and a warning will be issued when commulative scale during composition is negative with PCP_ALLOW_NEGATIVE_LAYER_OFFSET_SCALE is set to true (default right now). If PCP_ALLOW_NEGATIVE_LAYER_OFFSET_SCALE is set to false, a coding error will be issued when a negative scale is encountered.

PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_REF_PTRS

(

SdfLayer

)

TF_DECLARE_WEAK_AND_REF_PTRS

(

PcpLayerStack

)

TF_DECLARE_WEAK_AND_REF_PTRS

(

Pcp_LayerStackRegistry

)