Pcp module#

Summary: The PrimCache Population module implements core scenegraph composition semantics - behaviors informally referred to as Layering & Referencing.

Classes:

`ArcType`
`Cache`
`Dependency`
`DependencyType`
`DynamicFileFormatDependencyData`
`ErrorArcCycle`
`ErrorArcPermissionDenied`
`ErrorArcToProhibitedChild`
`ErrorBase`
`ErrorCapacityExceeded`
`ErrorInconsistentAttributeType`
`ErrorInconsistentAttributeVariability`
`ErrorInconsistentPropertyType`
`ErrorInvalidAssetPath`
`ErrorInvalidAssetPathBase`
`ErrorInvalidAuthoredRelocation`
`ErrorInvalidConflictingRelocation`
`ErrorInvalidExternalTargetPath`
`ErrorInvalidInstanceTargetPath`
`ErrorInvalidPrimPath`
`ErrorInvalidReferenceOffset`
`ErrorInvalidSameTargetRelocations`
`ErrorInvalidSublayerOffset`
`ErrorInvalidSublayerOwnership`
`ErrorInvalidSublayerPath`
`ErrorInvalidTargetPath`
`ErrorMutedAssetPath`
`ErrorOpinionAtRelocationSource`
`ErrorPrimPermissionDenied`
`ErrorPropertyPermissionDenied`
`ErrorRelocationBase`
`ErrorSublayerCycle`
`ErrorTargetPathBase`
`ErrorTargetPermissionDenied`
`ErrorType`
`ErrorUnresolvedPrimPath`
`ErrorVariableExpressionError`
`ExpressionVariables`
`ExpressionVariablesSource`
`InstanceKey`
`LayerRelocatesEditBuilder`
`LayerStack`
`LayerStackIdentifier`
`LayerStackSite`
`MapExpression`
`MapFunction`
`NodeRef`
`PrimIndex`
`PropertyIndex`
`Site`

class pxr.Pcp.ArcType#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Pcp.ArcTypeRoot, Pcp.ArcTypeInherit, Pcp.ArcTypeRelocate, Pcp.ArcTypeVariant, Pcp.ArcTypeReference, Pcp.ArcTypePayload, Pcp.ArcTypeSpecialize)#

class pxr.Pcp.Cache#

Methods:

`ComputeAttributeConnectionPaths`
`ComputeLayerStack`
`ComputePrimIndex`
`ComputePropertyIndex`
`ComputeRelationshipTargetPaths`
`FindAllLayerStacksUsingLayer`
`FindPrimIndex`
`FindPropertyIndex`
`FindSiteDependencies`
`GetDynamicFileFormatArgumentDependencyData`
`GetExpressionVariablesFromLayerStackUsedByPrim`
`GetLayerStackIdentifier`
`GetMutedLayers`
`GetPrimsUsingExpressionVariablesFromLayerStack`
`GetUsedLayers`
`GetUsedLayersRevision`
`GetVariantFallbacks`
`HasAnyDynamicFileFormatArgumentAttributeDependencies`
`HasAnyDynamicFileFormatArgumentFieldDependencies`
`HasRootLayerStack`
`IsInvalidAssetPath`
`IsInvalidSublayerIdentifier`
`IsLayerMuted`
`IsPayloadIncluded`
`IsPossibleDynamicFileFormatArgumentAttribute`
`IsPossibleDynamicFileFormatArgumentField`
`PrintStatistics`
`Reload`
`RequestLayerMuting`
`RequestPayloads`
`SetVariantFallbacks`
`UsesLayerStack`

Attributes:

`fileFormatTarget`
`layerStack`

ComputeAttributeConnectionPaths()#

ComputeLayerStack()#

ComputePrimIndex()#

ComputePropertyIndex()#

ComputeRelationshipTargetPaths()#

FindAllLayerStacksUsingLayer()#

FindPrimIndex()#

FindPropertyIndex()#

FindSiteDependencies()#

GetDynamicFileFormatArgumentDependencyData()#

GetExpressionVariablesFromLayerStackUsedByPrim()#

GetLayerStackIdentifier()#

GetMutedLayers()#

GetPrimsUsingExpressionVariablesFromLayerStack()#

GetUsedLayers()#

GetUsedLayersRevision()#

GetVariantFallbacks()#

HasAnyDynamicFileFormatArgumentAttributeDependencies()#

HasAnyDynamicFileFormatArgumentFieldDependencies()#

HasRootLayerStack()#

IsInvalidAssetPath()#

IsInvalidSublayerIdentifier()#

IsLayerMuted()#

IsPayloadIncluded()#

IsPossibleDynamicFileFormatArgumentAttribute()#

IsPossibleDynamicFileFormatArgumentField()#

PrintStatistics()#

Reload()#

RequestLayerMuting()#

RequestPayloads()#

SetVariantFallbacks()#

UsesLayerStack()#

property fileFormatTarget#

property layerStack#

class pxr.Pcp.Dependency#

Attributes:

`indexPath`
`mapFunc`
`sitePath`

property indexPath#

property mapFunc#

property sitePath#

class pxr.Pcp.DependencyType#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Pcp.DependencyTypeNone, Pcp.DependencyTypeRoot, Pcp.DependencyTypePurelyDirect, Pcp.DependencyTypePartlyDirect, Pcp.DependencyTypeDirect, Pcp.DependencyTypeAncestral, Pcp.DependencyTypeVirtual, Pcp.DependencyTypeNonVirtual, Pcp.DependencyTypeAnyNonVirtual, Pcp.DependencyTypeAnyIncludingVirtual)#

class pxr.Pcp.DynamicFileFormatDependencyData#

Methods:

`CanAttributeDefaultValueChangeAffectFileFormatArguments`
`CanFieldChangeAffectFileFormatArguments`
`GetRelevantAttributeNames`
`GetRelevantFieldNames`
`IsEmpty`

CanAttributeDefaultValueChangeAffectFileFormatArguments()#

CanFieldChangeAffectFileFormatArguments()#

GetRelevantAttributeNames()#

GetRelevantFieldNames()#

IsEmpty()#

class pxr.Pcp.ErrorArcCycle#

class pxr.Pcp.ErrorArcPermissionDenied#

class pxr.Pcp.ErrorArcToProhibitedChild#

class pxr.Pcp.ErrorBase#

Attributes:

`errorType`
`rootSite`

property errorType#

property rootSite#

class pxr.Pcp.ErrorCapacityExceeded#

class pxr.Pcp.ErrorInconsistentAttributeType#

class pxr.Pcp.ErrorInconsistentAttributeVariability#

class pxr.Pcp.ErrorInconsistentPropertyType#

class pxr.Pcp.ErrorInvalidAssetPath#

class pxr.Pcp.ErrorInvalidAssetPathBase#

class pxr.Pcp.ErrorInvalidAuthoredRelocation#

class pxr.Pcp.ErrorInvalidConflictingRelocation#

class pxr.Pcp.ErrorInvalidExternalTargetPath#

class pxr.Pcp.ErrorInvalidInstanceTargetPath#

class pxr.Pcp.ErrorInvalidPrimPath#

class pxr.Pcp.ErrorInvalidReferenceOffset#

class pxr.Pcp.ErrorInvalidSameTargetRelocations#

class pxr.Pcp.ErrorInvalidSublayerOffset#

class pxr.Pcp.ErrorInvalidSublayerOwnership#

class pxr.Pcp.ErrorInvalidSublayerPath#

class pxr.Pcp.ErrorInvalidTargetPath#

class pxr.Pcp.ErrorMutedAssetPath#

class pxr.Pcp.ErrorOpinionAtRelocationSource#

class pxr.Pcp.ErrorPrimPermissionDenied#

class pxr.Pcp.ErrorPropertyPermissionDenied#

class pxr.Pcp.ErrorRelocationBase#

class pxr.Pcp.ErrorSublayerCycle#

class pxr.Pcp.ErrorTargetPathBase#

class pxr.Pcp.ErrorTargetPermissionDenied#

class pxr.Pcp.ErrorType#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Pcp.ErrorType_ArcCycle, Pcp.ErrorType_ArcPermissionDenied, Pcp.ErrorType_IndexCapacityExceeded, Pcp.ErrorType_ArcCapacityExceeded, Pcp.ErrorType_ArcNamespaceDepthCapacityExceeded, Pcp.ErrorType_InconsistentPropertyType, Pcp.ErrorType_InconsistentAttributeType, Pcp.ErrorType_InconsistentAttributeVariability, Pcp.ErrorType_InternalAssetPath, Pcp.ErrorType_InvalidPrimPath, Pcp.ErrorType_InvalidAssetPath, Pcp.ErrorType_InvalidInstanceTargetPath, Pcp.ErrorType_InvalidExternalTargetPath, Pcp.ErrorType_InvalidTargetPath, Pcp.ErrorType_InvalidReferenceOffset, Pcp.ErrorType_InvalidSublayerOffset, Pcp.ErrorType_InvalidSublayerOwnership, Pcp.ErrorType_InvalidSublayerPath, Pcp.ErrorType_InvalidVariantSelection, Pcp.ErrorType_MutedAssetPath, Pcp.ErrorType_InvalidAuthoredRelocation, Pcp.ErrorType_InvalidConflictingRelocation, Pcp.ErrorType_InvalidSameTargetRelocations, Pcp.ErrorType_OpinionAtRelocationSource, Pcp.ErrorType_PrimPermissionDenied, Pcp.ErrorType_PropertyPermissionDenied, Pcp.ErrorType_SublayerCycle, Pcp.ErrorType_TargetPermissionDenied, Pcp.ErrorType_UnresolvedPrimPath, Pcp.ErrorType_VariableExpressionError)#

class pxr.Pcp.ErrorUnresolvedPrimPath#

class pxr.Pcp.ErrorVariableExpressionError#

class pxr.Pcp.ExpressionVariables#

Methods:

`Compute`
`GetSource`
`GetVariables`

static Compute()#

GetSource()#

GetVariables()#

class pxr.Pcp.ExpressionVariablesSource#

Methods:

`GetLayerStackIdentifier`
`IsRootLayerStack`
`ResolveLayerStackIdentifier`

GetLayerStackIdentifier()#

IsRootLayerStack()#

ResolveLayerStackIdentifier()#

class pxr.Pcp.InstanceKey#

class pxr.Pcp.LayerRelocatesEditBuilder#

Methods:

`GetEditedRelocatesMap`
`GetEdits`
`Relocate`
`RemoveRelocate`

GetEditedRelocatesMap()#

GetEdits()#

Relocate()#

RemoveRelocate()#

class pxr.Pcp.LayerStack#

Attributes:

`expired`	True if this object has expired, False otherwise.
`expressionVariableDependencies`
`expressionVariables`
`identifier`
`incrementalRelocatesSourceToTarget`
`incrementalRelocatesTargetToSource`
`layerOffsets`
`layerTree`
`layers`
`localErrors`
`mutedLayers`
`pathsToPrimsWithRelocates`
`relocatesSourceToTarget`
`relocatesTargetToSource`
`sessionLayerTree`

property expired#: True if this object has expired, False otherwise.

property expressionVariableDependencies#

property expressionVariables#

property identifier#

property incrementalRelocatesSourceToTarget#

property incrementalRelocatesTargetToSource#

property layerOffsets#

property layerTree#

property layers#

property localErrors#

property mutedLayers#

property pathsToPrimsWithRelocates#

property relocatesSourceToTarget#

property relocatesTargetToSource#

property sessionLayerTree#

class pxr.Pcp.LayerStackIdentifier#

Attributes:

`expressionVariablesOverrideSource`
`pathResolverContext`
`rootLayer`
`sessionLayer`

property expressionVariablesOverrideSource#

property pathResolverContext#

property rootLayer#

property sessionLayer#

class pxr.Pcp.LayerStackSite#

Attributes:

`layerStack`
`path`

property layerStack#

property path#

class pxr.Pcp.MapExpression#

Methods:

`AddRootIdentity`
`Compose`
`Constant`
`Evaluate`
`Identity`
`Inverse`
`MapSourceToTarget`
`MapTargetToSource`

Attributes:

`isIdentity`
`isNull`
`timeOffset`

AddRootIdentity()#

Compose()#

static Constant()#

Evaluate()#

static Identity()#

static Inverse()#

MapSourceToTarget()#

MapTargetToSource()#

property isIdentity#

property isNull#

property timeOffset#

class pxr.Pcp.MapFunction#

Methods:

`Compose`
`ComposeOffset`
`GetInverse`
`Identity`
`IdentityPathMap`
`MapSourceToTarget`
`MapTargetToSource`

Attributes:

`isIdentity`
`isIdentityPathMapping`
`isNull`
`sourceToTargetMap`
`timeOffset`

Compose()#

ComposeOffset()#

GetInverse()#

static Identity()#

static IdentityPathMap()#

MapSourceToTarget()#

MapTargetToSource()#

property isIdentity#

property isIdentityPathMapping#

property isNull#

property sourceToTargetMap#

property timeOffset#

class pxr.Pcp.NodeRef#

Methods:

`CanContributeSpecs`
`GetDepthBelowIntroduction`
`GetIntroPath`
`GetOriginRootNode`
`GetPathAtIntroduction`
`GetRootNode`
`GetSpecContributionRestrictedDepth`
`IsDueToAncestor`
`IsRootNode`

Attributes:

`arcType`
`children`
`hasSpecs`
`hasSymmetry`
`isCulled`
`isInert`
`isRestricted`
`layerStack`
`mapToParent`
`mapToRoot`
`namespaceDepth`
`origin`
`parent`
`path`
`permission`
`siblingNumAtOrigin`
`site`

CanContributeSpecs()#

GetDepthBelowIntroduction()#

GetIntroPath()#

GetOriginRootNode()#

GetPathAtIntroduction()#

GetRootNode()#

GetSpecContributionRestrictedDepth()#

IsDueToAncestor()#

IsRootNode()#

property arcType#

property children#

property hasSpecs#

property hasSymmetry#

property isCulled#

property isInert#

property isRestricted#

property layerStack#

property mapToParent#

property mapToRoot#

property namespaceDepth#

property origin#

property parent#

property path#

property permission#

property siblingNumAtOrigin#

property site#

class pxr.Pcp.PrimIndex#

Methods:

`ComposeAuthoredVariantSelections`
`ComputePrimChildNames`
`ComputePrimPropertyNames`
`DumpToDotGraph`
`DumpToString`
`GetNodeProvidingSpec`
`GetSelectionAppliedForVariantSet`
`IsInstanceable`
`IsValid`
`PrintStatistics`

Attributes:

`hasAnyPayloads`
`localErrors`
`primStack`
`rootNode`

ComposeAuthoredVariantSelections()#

ComputePrimChildNames()#

ComputePrimPropertyNames()#

DumpToDotGraph()#

DumpToString()#

GetNodeProvidingSpec()#

GetSelectionAppliedForVariantSet()#

IsInstanceable()#

IsValid()#

PrintStatistics()#

property hasAnyPayloads#

property localErrors#

property primStack#

property rootNode#

class pxr.Pcp.PropertyIndex#

Attributes:

`localErrors`
`localPropertyStack`
`propertyStack`

property localErrors#

property localPropertyStack#

property propertyStack#

class pxr.Pcp.Site#

Attributes:

`layerStack`
`path`

property layerStack#

property path#