targetIndex.h File Reference

#include "pxr/pxr.h"
#include "pxr/usd/pcp/api.h"
#include "pxr/usd/pcp/errors.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/sdf/path.h"

Include dependency graph for targetIndex.h:

Go to the source code of this file.

Classes
class	PcpTargetIndex

Functions
PXR_NAMESPACE_OPEN_SCOPE	SDF_DECLARE_HANDLES (SdfSpec)
PCP_API void	PcpBuildTargetIndex (const PcpSite &propSite, const PcpPropertyIndex &propIndex, const SdfSpecType relOrAttrType, PcpTargetIndex *targetIndex, PcpErrorVector *allErrors)
PCP_API void	PcpBuildFilteredTargetIndex (const PcpSite &propSite, const PcpPropertyIndex &propIndex, const SdfSpecType relOrAttrType, const bool localOnly, const SdfSpecHandle &stopProperty, const bool includeStopProperty, PcpCache *cacheForValidation, PcpTargetIndex *targetIndex, SdfPathVector *deletedPaths, PcpErrorVector *allErrors)

Function Documentation

PCP_API void PcpBuildFilteredTargetIndex	(	const PcpSite &	propSite,
		const PcpPropertyIndex &	propIndex,
		const SdfSpecType	relOrAttrType,
		const bool	localOnly,
		const SdfSpecHandle &	stopProperty,
		const bool	includeStopProperty,
		PcpCache *	cacheForValidation,
		PcpTargetIndex *	targetIndex,
		SdfPathVector *	deletedPaths,
		PcpErrorVector *	allErrors
	)

Like PcpBuildTargetIndex, but optionally filters the result by enforcing permissions restrictions and a stopProperty.

If localOnly is true then this will compose relationship targets from local nodes only. If stopProperty is not NULL then this will stop composing relationship targets at stopProperty, including stopProperty iff includeStopProperty is true.

cacheForValidation is a PcpCache that will be used to compute additional prim indexes as needed for validation. NULL may be passed in, but doing so will disable validation that relies on this cache, which includes permissions checks.

deletedPaths, if not NULL, will be populated with target paths whose deletion contributed to the computed value of targetIndex->paths.

allErrors will contain any errors encountered while performing this operation.

PCP_API void PcpBuildTargetIndex	(	const PcpSite &	propSite,
		const PcpPropertyIndex &	propIndex,
		const SdfSpecType	relOrAttrType,
		PcpTargetIndex *	targetIndex,
		PcpErrorVector *	allErrors
	)

Build a PcpTargetIndex representing the target paths of the given property.

propIndex is a PcpPropertyIndex of the relationship or attribute. relOrAttrType indicates if the property is a relationship or attribute. allErrors will contain any errors encountered while performing this operation.

Note that this function will skip the validation checks performed by PcpBuildFilteredTargetIndex. See documentation below for details.

PXR_NAMESPACE_OPEN_SCOPE SDF_DECLARE_HANDLES

(

SdfSpec

)