Structure for bundling all the edits that need to be performed in order to perform a namespace edit and fix up downstream composition dependencies on dependent prim indexes in dependent PcpCaches. More...

#include <dependentNamespaceEditUtils.h>

Classes
struct	CompositionFieldEdit
	Description of an edit to a prim spec composition field, such as references, inherits, or relocates. More...

struct	MoveEditDescription
	Description of move edit which consists of the old (source) path and the new (destination) path. More...

Public Types
using	MoveEditDescriptionVector = std::vector< MoveEditDescription >

using	LayerSpecMoveEdits = std::unordered_map< SdfLayerHandle, MoveEditDescriptionVector, TfHash >
	Map of layer to the spec moves edits to perform on the layer.

using	LayerRelocatesEdits = std::unordered_map< SdfLayerHandle, SdfRelocates, TfHash >
	Map of layer to relocates value to set in the layer metadata relocates field.

Public Attributes
std::vector< CompositionFieldEdit >	compositionFieldEdits
	List of all composition fields edits to perform.

LayerSpecMoveEdits	layerSpecMoves

LayerRelocatesEdits	dependentRelocatesEdits

std::vector< std::string >	errors
	Errors encountered during the processing of the dependent namespace edits.

std::vector< std::string >	warnings
	Warnings encountered during the processing of the dependent namespace edits.

std::unordered_map< const PcpCache *, MoveEditDescriptionVector >	dependentCachePathChanges
	Lists of composed prim paths in each affected cache whose prim indexes will need to be recomputed after the changes in this object are applied.

Detailed Description

Structure for bundling all the edits that need to be performed in order to perform a namespace edit and fix up downstream composition dependencies on dependent prim indexes in dependent PcpCaches.

This is the return value of PcpGatherDependentNamespaceEdits.

Definition at line 32 of file dependentNamespaceEditUtils.h.

Class Documentation

◆ PcpDependentNamespaceEdits::CompositionFieldEdit

struct PcpDependentNamespaceEdits::CompositionFieldEdit

Description of an edit to a prim spec composition field, such as references, inherits, or relocates.

Definition at line 36 of file dependentNamespaceEditUtils.h.

Class Members
TfToken	fieldName	Name of the composition field.
SdfLayerHandle	layer	Layer containing the prim spec to edit.
VtValue	newFieldValue	New value of the composition field to set.
SdfPath	path	Path of the prim spec to edit.

◆ PcpDependentNamespaceEdits::MoveEditDescription

struct PcpDependentNamespaceEdits::MoveEditDescription

Description of move edit which consists of the old (source) path and the new (destination) path.

Definition at line 55 of file dependentNamespaceEditUtils.h.

Class Members
SdfPath	newPath
SdfPath	oldPath

Member Typedef Documentation

◆ LayerRelocatesEdits

using LayerRelocatesEdits = std::unordered_map<SdfLayerHandle, SdfRelocates, TfHash>

Map of layer to relocates value to set in the layer metadata relocates field.

Definition at line 68 of file dependentNamespaceEditUtils.h.

◆ LayerSpecMoveEdits

using LayerSpecMoveEdits = std::unordered_map< SdfLayerHandle, MoveEditDescriptionVector, TfHash>

Map of layer to the spec moves edits to perform on the layer.

Definition at line 62 of file dependentNamespaceEditUtils.h.

◆ MoveEditDescriptionVector

using MoveEditDescriptionVector = std::vector<MoveEditDescription>

Definition at line 59 of file dependentNamespaceEditUtils.h.

Member Data Documentation

◆ compositionFieldEdits

std::vector<CompositionFieldEdit> compositionFieldEdits

List of all composition fields edits to perform.

Definition at line 51 of file dependentNamespaceEditUtils.h.

◆ dependentCachePathChanges

std::unordered_map<const PcpCache *, MoveEditDescriptionVector> dependentCachePathChanges

Lists of composed prim paths in each affected cache whose prim indexes will need to be recomputed after the changes in this object are applied.

This information can be useful during change processing and notification to help report the intended effects of all the layer spec edits that are performed during a namespace edit.

Definition at line 86 of file dependentNamespaceEditUtils.h.