Usd module#

Summary: The core client-facing module for authoring, compositing, and reading Universal Scene Description.

Classes:

class pxr.Usd.APISchemaBase#

Methods:

GetSchemaAttributeNames

static GetSchemaAttributeNames()#

class pxr.Usd.AssetInfoKeys#

Attributes:

`identifier`
`name`
`payloadAssetDependencies`
`version`

identifier = 'identifier'#

name = 'name'#

payloadAssetDependencies = 'payloadAssetDependencies'#

version = 'version'#

class pxr.Usd.Attribute#

Methods:

AddConnection()#

Block()#

Clear()#

ClearAtTime()#

ClearColorSpace()#

ClearConnections()#

ClearDefault()#

Get()#

GetBracketingTimeSamples()#

GetColorSpace()#

GetConnections()#

GetNumTimeSamples()#

GetResolveInfo()#

GetRoleName()#

GetSpline()#

GetTimeSamples()#

GetTimeSamplesInInterval()#

GetTypeName()#

static GetUnionedTimeSamples()#

static GetUnionedTimeSamplesInInterval()#

GetVariability()#

HasAuthoredConnections()#

HasAuthoredValue()#

HasAuthoredValueOpinion()#

HasColorSpace()#

HasFallbackValue()#

HasSpline()#

HasValue()#

RemoveConnection()#

Set()#

SetColorSpace()#

SetConnections()#

SetSpline()#

SetTypeName()#

SetVariability()#

ValueMightBeTimeVarying()#

class pxr.Usd.AttributeQuery#

Methods:

`CreateQueries`
`Get`
`GetAttribute`
`GetBracketingTimeSamples`
`GetNumTimeSamples`
`GetTimeSamples`
`GetTimeSamplesInInterval`
`GetUnionedTimeSamples`
`GetUnionedTimeSamplesInInterval`
`HasAuthoredValue`
`HasAuthoredValueOpinion`
`HasFallbackValue`
`HasValue`
`IsValid`
`ValueMightBeTimeVarying`

static CreateQueries()#

Get()#

GetAttribute()#

GetBracketingTimeSamples()#

GetNumTimeSamples()#

GetTimeSamples()#

GetTimeSamplesInInterval()#

static GetUnionedTimeSamples()#

static GetUnionedTimeSamplesInInterval()#

HasAuthoredValue()#

HasAuthoredValueOpinion()#

HasFallbackValue()#

HasValue()#

IsValid()#

ValueMightBeTimeVarying()#

class pxr.Usd.ClipsAPI#

Methods:

ComputeClipAssetPaths()#

GenerateClipManifest()#

static GenerateClipManifestFromLayers()#

static Get()#

GetClipActive()#

GetClipAssetPaths()#

GetClipManifestAssetPath()#

GetClipPrimPath()#

GetClipSets()#

GetClipTemplateActiveOffset()#

GetClipTemplateAssetPath()#

GetClipTemplateEndTime()#

GetClipTemplateStartTime()#

GetClipTemplateStride()#

GetClipTimes()#

GetClips()#

GetInterpolateMissingClipValues()#

static GetSchemaAttributeNames()#

SetClipActive()#

SetClipAssetPaths()#

SetClipManifestAssetPath()#

SetClipPrimPath()#

SetClipSets()#

SetClipTemplateActiveOffset()#

SetClipTemplateAssetPath()#

SetClipTemplateEndTime()#

SetClipTemplateStartTime()#

SetClipTemplateStride()#

SetClipTimes()#

SetClips()#

SetInterpolateMissingClipValues()#

class pxr.Usd.CollectionAPI#

Methods:

static Apply()#

BlockCollection()#

static CanApply()#

static CanContainPropertyName()#

static ComputeIncludedObjects()#

static ComputeIncludedPaths()#

ComputeMembershipQuery()#

CreateCollectionAttr()#

CreateExcludesRel()#

CreateExpansionRuleAttr()#

CreateIncludeRootAttr()#

CreateIncludesRel()#

CreateMembershipExpressionAttr()#

ExcludePath()#

static Get()#

static GetAll()#

static GetAllCollections()#

static GetCollection()#

GetCollectionAttr()#

GetCollectionPath()#

GetExcludesRel()#

GetExpansionRuleAttr()#

GetIncludeRootAttr()#

GetIncludesRel()#

GetMembershipExpressionAttr()#

GetName()#

static GetNamedCollectionPath()#

static GetSchemaAttributeNames()#

HasNoIncludedPaths()#

IncludePath()#

static IsCollectionAPIPath()#

IsInExpressionMode()#

IsInRelationshipsMode()#

static IsSchemaPropertyBaseName()#

ResetCollection()#

ResolveCompleteMembershipExpression()#

Validate()#

class pxr.Usd.ColorSpaceAPI#

Methods:

`Apply`
`CanApply`
`ComputeColorSpace`
`ComputeColorSpaceName`
`CreateColorSpaceNameAttr`
`Get`
`GetColorSpaceNameAttr`
`GetSchemaAttributeNames`
`IsValidColorSpaceName`

static Apply()#

static CanApply()#

ComputeColorSpace()#

ComputeColorSpaceName()#

CreateColorSpaceNameAttr()#

static Get()#

GetColorSpaceNameAttr()#

static GetSchemaAttributeNames()#

IsValidColorSpaceName()#

class pxr.Usd.ColorSpaceCache#

Methods:

`Find`
`Insert`

Find()#

Insert()#

class pxr.Usd.ColorSpaceDefinitionAPI#

Methods:

static Apply()#

static CanApply()#

ComputeColorSpaceFromDefinitionAttributes()#

CreateBlueChromaAttr()#

CreateColorSpaceAttrsWithChroma()#

CreateColorSpaceAttrsWithMatrix()#

CreateGammaAttr()#

CreateGreenChromaAttr()#

CreateLinearBiasAttr()#

CreateNameAttr()#

CreateRedChromaAttr()#

CreateWhitePointAttr()#

static Get()#

static GetAll()#

GetBlueChromaAttr()#

GetGammaAttr()#

GetGreenChromaAttr()#

GetLinearBiasAttr()#

GetNameAttr()#

GetRedChromaAttr()#

static GetSchemaAttributeNames()#

GetWhitePointAttr()#

static IsColorSpaceDefinitionAPIPath()#

class pxr.Usd.ColorSpaceHashCache#

Methods:

`Find`
`Insert`

Find()#

Insert()#

class pxr.Usd.CompositionArc#

Methods:

`GetArcType`
`GetIntroducingLayer`
`GetIntroducingListEditor`
`GetIntroducingNode`
`GetIntroducingPrimPath`
`GetTargetLayer`
`GetTargetNode`
`GetTargetPrimPath`
`HasSpecs`
`IsAncestral`
`IsImplicit`
`IsIntroducedInRootLayerPrimSpec`
`IsIntroducedInRootLayerStack`
`MakeResolveTargetStrongerThan`
`MakeResolveTargetUpTo`

GetArcType()#

GetIntroducingLayer()#

GetIntroducingListEditor()#

GetIntroducingNode()#

GetIntroducingPrimPath()#

GetTargetLayer()#

GetTargetNode()#

GetTargetPrimPath()#

HasSpecs()#

IsAncestral()#

IsImplicit()#

IsIntroducedInRootLayerPrimSpec()#

IsIntroducedInRootLayerStack()#

MakeResolveTargetStrongerThan()#

MakeResolveTargetUpTo()#

class pxr.Usd.CrateInfo#

Classes:

`Section`
`SummaryStats`

Methods:

`GetFileVersion`
`GetSections`
`GetSoftwareVersion`
`GetSummaryStats`
`Open`

class Section#

Attributes:

`name`
`size`
`start`

property name#

property size#

property start#

class SummaryStats#

Attributes:

`numSpecs`
`numUniqueFieldSets`
`numUniqueFields`
`numUniquePaths`
`numUniqueStrings`
`numUniqueTokens`

property numSpecs#

property numUniqueFieldSets#

property numUniqueFields#

property numUniquePaths#

property numUniqueStrings#

property numUniqueTokens#

GetFileVersion()#

GetSections()#

GetSoftwareVersion()#

GetSummaryStats()#

static Open()#

class pxr.Usd.EditContext#

class pxr.Usd.EditTarget#

Methods:

`ComposeOver`
`ForLocalDirectVariant`
`GetAttributeSpecForScenePath`
`GetLayer`
`GetMapFunction`
`GetPrimSpecForScenePath`
`GetPropertySpecForScenePath`
`GetRelationshipSpecForScenePath`
`GetSpecForScenePath`
`IsNull`
`IsValid`
`MapToSpecPath`

ComposeOver()#

static ForLocalDirectVariant()#

GetAttributeSpecForScenePath()#

GetLayer()#

GetMapFunction()#

GetPrimSpecForScenePath()#

GetPropertySpecForScenePath()#

GetRelationshipSpecForScenePath()#

GetSpecForScenePath()#

IsNull()#

IsValid()#

MapToSpecPath()#

class pxr.Usd.FlattenResolveAssetPathContext#

Attributes:

`assetPath`
`expressionVariables`
`sourceLayer`

property assetPath#

property expressionVariables#

property sourceLayer#

class pxr.Usd.Inherits#

Methods:

`AddInherit`
`ClearInherits`
`GetAllDirectInherits`
`GetPrim`
`RemoveInherit`
`SetInherits`

AddInherit()#

ClearInherits()#

GetAllDirectInherits()#

GetPrim()#

RemoveInherit()#

SetInherits()#

class pxr.Usd.InterpolationType#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Usd.InterpolationTypeHeld, Usd.InterpolationTypeLinear)#

class pxr.Usd.ListPosition#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Usd.ListPositionFrontOfPrependList, Usd.ListPositionBackOfPrependList, Usd.ListPositionFrontOfAppendList, Usd.ListPositionBackOfAppendList)#

class pxr.Usd.LoadPolicy#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Usd.LoadWithDescendants, Usd.LoadWithoutDescendants)#

class pxr.Usd.ModelAPI#

Classes:

KindValidation

Methods:

`Get`
`GetAssetIdentifier`
`GetAssetInfo`
`GetAssetName`
`GetAssetVersion`
`GetKind`
`GetPayloadAssetDependencies`
`GetSchemaAttributeNames`
`IsGroup`
`IsKind`
`IsModel`
`SetAssetIdentifier`
`SetAssetInfo`
`SetAssetName`
`SetAssetVersion`
`SetKind`
`SetPayloadAssetDependencies`

Attributes:

`KindValidationModelHierarchy`
`KindValidationNone`

class KindValidation#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Usd.ModelAPI.KindValidationNone, Usd.ModelAPI.KindValidationModelHierarchy)#

static Get()#

GetAssetIdentifier()#

GetAssetInfo()#

GetAssetName()#

GetAssetVersion()#

GetKind()#

GetPayloadAssetDependencies()#

static GetSchemaAttributeNames()#

IsGroup()#

IsKind()#

IsModel()#

SetAssetIdentifier()#

SetAssetInfo()#

SetAssetName()#

SetAssetVersion()#

SetKind()#

SetPayloadAssetDependencies()#

KindValidationModelHierarchy = Usd.ModelAPI.KindValidationModelHierarchy#

KindValidationNone = Usd.ModelAPI.KindValidationNone#

class pxr.Usd.NamespaceEditor#

Classes:

EditOptions

Methods:

`AddDependentStage`
`ApplyEdits`
`CanApplyEdits`
`DeletePrim`
`DeletePrimAtPath`
`DeleteProperty`
`DeletePropertyAtPath`
`MovePrimAtPath`
`MovePropertyAtPath`
`RemoveDependentStage`
`RenamePrim`
`RenameProperty`
`ReparentPrim`
`ReparentProperty`
`SetDependentStages`

class EditOptions#

Attributes:

allowRelocatesAuthoring

property allowRelocatesAuthoring#

AddDependentStage()#

ApplyEdits()#

CanApplyEdits()#

DeletePrim()#

DeletePrimAtPath()#

DeleteProperty()#

DeletePropertyAtPath()#

MovePrimAtPath()#

MovePropertyAtPath()#

RemoveDependentStage()#

RenamePrim()#

RenameProperty()#

ReparentPrim()#

ReparentProperty()#

SetDependentStages()#

class pxr.Usd.Notice#

Classes:

`LayerMutingChanged`
`ObjectsChanged`
`StageContentsChanged`
`StageEditTargetChanged`
`StageNotice`

class LayerMutingChanged#

Methods:

`GetMutedLayers`
`GetUnmutedLayers`

GetMutedLayers()#

GetUnmutedLayers()#

class ObjectsChanged#

Methods:

`AffectedObject`
`ChangedInfoOnly`
`GetChangedFields`
`GetChangedInfoOnlyPaths`
`GetResolvedAssetPathsResyncedPaths`
`GetResyncedPaths`
`HasChangedFields`
`ResolvedAssetPathsResynced`
`ResyncedObject`

AffectedObject()#

ChangedInfoOnly()#

GetChangedFields()#

GetChangedInfoOnlyPaths()#

GetResolvedAssetPathsResyncedPaths()#

GetResyncedPaths()#

HasChangedFields()#

ResolvedAssetPathsResynced()#

ResyncedObject()#

class StageContentsChanged#

class StageEditTargetChanged#

class StageNotice#

Methods:

GetStage

GetStage()#

class pxr.Usd.Object#

Methods:

`ClearAssetInfo`
`ClearAssetInfoByKey`
`ClearCustomData`
`ClearCustomDataByKey`
`ClearDisplayName`
`ClearDocumentation`
`ClearHidden`
`ClearMetadata`
`ClearMetadataByDictKey`
`GetAllAuthoredMetadata`
`GetAllMetadata`
`GetAssetInfo`
`GetAssetInfoByKey`
`GetCustomData`
`GetCustomDataByKey`
`GetDescription`
`GetDisplayName`
`GetDocumentation`
`GetMetadata`
`GetMetadataByDictKey`
`GetName`
`GetNamespaceDelimiter`
`GetPath`
`GetPrim`
`GetPrimPath`
`GetStage`
`HasAssetInfo`
`HasAssetInfoKey`
`HasAuthoredAssetInfo`
`HasAuthoredAssetInfoKey`
`HasAuthoredCustomData`
`HasAuthoredCustomDataKey`
`HasAuthoredDisplayName`
`HasAuthoredDocumentation`
`HasAuthoredHidden`
`HasAuthoredMetadata`
`HasAuthoredMetadataDictKey`
`HasCustomData`
`HasCustomDataKey`
`HasMetadata`
`HasMetadataDictKey`
`IsHidden`
`IsValid`
`SetAssetInfo`
`SetAssetInfoByKey`
`SetCustomData`
`SetCustomDataByKey`
`SetDisplayName`
`SetDocumentation`
`SetHidden`
`SetMetadata`
`SetMetadataByDictKey`

ClearAssetInfo()#

ClearAssetInfoByKey()#

ClearCustomData()#

ClearCustomDataByKey()#

ClearDisplayName()#

ClearDocumentation()#

ClearHidden()#

ClearMetadata()#

ClearMetadataByDictKey()#

GetAllAuthoredMetadata()#

GetAllMetadata()#

GetAssetInfo()#

GetAssetInfoByKey()#

GetCustomData()#

GetCustomDataByKey()#

GetDescription()#

GetDisplayName()#

GetDocumentation()#

GetMetadata()#

GetMetadataByDictKey()#

GetName()#

static GetNamespaceDelimiter()#

GetPath()#

GetPrim()#

GetPrimPath()#

GetStage()#

HasAssetInfo()#

HasAssetInfoKey()#

HasAuthoredAssetInfo()#

HasAuthoredAssetInfoKey()#

HasAuthoredCustomData()#

HasAuthoredCustomDataKey()#

HasAuthoredDisplayName()#

HasAuthoredDocumentation()#

HasAuthoredHidden()#

HasAuthoredMetadata()#

HasAuthoredMetadataDictKey()#

HasCustomData()#

HasCustomDataKey()#

HasMetadata()#

HasMetadataDictKey()#

IsHidden()#

IsValid()#

SetAssetInfo()#

SetAssetInfoByKey()#

SetCustomData()#

SetCustomDataByKey()#

SetDisplayName()#

SetDocumentation()#

SetHidden()#

SetMetadata()#

SetMetadataByDictKey()#

class pxr.Usd.Payloads#

Methods:

`AddInternalPayload`
`AddPayload`
`ClearPayloads`
`GetPrim`
`RemovePayload`
`SetPayloads`

AddInternalPayload()#

AddPayload()#

ClearPayloads()#

GetPrim()#

RemovePayload()#

SetPayloads()#

class pxr.Usd.Prim#

Methods:

`AddAppliedSchema`
`ApplyAPI`
`CanApplyAPI`
`ClearActive`
`ClearChildrenReorder`
`ClearInstanceable`
`ClearPayload`
`ClearPropertyOrder`
`ClearTypeName`
`ComputeExpandedPrimIndex`
`CreateAttribute`
`CreateRelationship`
`FindAllAttributeConnectionPaths`
`FindAllRelationshipTargetPaths`
`GetAllChildren`
`GetAllChildrenNames`
`GetAppliedSchemas`
`GetAttribute`
`GetAttributeAtPath`
`GetAttributes`
`GetAuthoredAttributes`
`GetAuthoredProperties`
`GetAuthoredPropertiesInNamespace`
`GetAuthoredPropertyNames`
`GetAuthoredRelationships`
`GetChild`
`GetChildren`
`GetChildrenNames`
`GetChildrenReorder`
`GetFilteredChildren`
`GetFilteredChildrenNames`
`GetFilteredNextSibling`
`GetInherits`
`GetInstances`
`GetKind`
`GetNextSibling`
`GetObjectAtPath`
`GetParent`
`GetPayloads`
`GetPrimAtPath`
`GetPrimDefinition`
`GetPrimInPrototype`
`GetPrimIndex`
`GetPrimStack`
`GetPrimStackWithLayerOffsets`
`GetPrimTypeInfo`
`GetProperties`
`GetPropertiesInNamespace`
`GetProperty`
`GetPropertyAtPath`
`GetPropertyNames`
`GetPropertyOrder`
`GetPrototype`
`GetReferences`
`GetRelationship`
`GetRelationshipAtPath`
`GetRelationships`
`GetSpecializes`
`GetSpecifier`
`GetTypeName`
`GetVariantSet`
`GetVariantSets`
`GetVersionIfHasAPIInFamily`
`GetVersionIfIsInFamily`
`HasAPI`
`HasAPIInFamily`
`HasAttribute`
`HasAuthoredActive`
`HasAuthoredInherits`
`HasAuthoredInstanceable`
`HasAuthoredPayloads`
`HasAuthoredReferences`
`HasAuthoredSpecializes`
`HasAuthoredTypeName`
`HasDefiningSpecifier`
`HasPayload`
`HasProperty`
`HasRelationship`
`HasVariantSets`
`IsA`
`IsAbstract`
`IsActive`
`IsComponent`
`IsDefined`
`IsGroup`
`IsInFamily`
`IsInPrototype`
`IsInstance`
`IsInstanceProxy`
`IsInstanceable`
`IsLoaded`
`IsModel`
`IsPathInPrototype`
`IsPrototype`
`IsPrototypePath`
`IsPseudoRoot`
`IsSubComponent`
`Load`
`MakeResolveTargetStrongerThanEditTarget`
`MakeResolveTargetUpToEditTarget`
`RemoveAPI`
`RemoveAppliedSchema`
`RemoveProperty`
`SetActive`
`SetChildrenReorder`
`SetInstanceable`
`SetKind`
`SetPayload`
`SetPropertyOrder`
`SetSpecifier`
`SetTypeName`
`Unload`

AddAppliedSchema()#

ApplyAPI()#

CanApplyAPI()#

ClearActive()#

ClearChildrenReorder()#

ClearInstanceable()#

ClearPayload()#

ClearPropertyOrder()#

ClearTypeName()#

ComputeExpandedPrimIndex()#

CreateAttribute()#

CreateRelationship()#

FindAllAttributeConnectionPaths()#

FindAllRelationshipTargetPaths()#

GetAllChildren()#

GetAllChildrenNames()#

GetAppliedSchemas()#

GetAttribute()#

GetAttributeAtPath()#

GetAttributes()#

GetAuthoredAttributes()#

GetAuthoredProperties()#

GetAuthoredPropertiesInNamespace()#

GetAuthoredPropertyNames()#

GetAuthoredRelationships()#

GetChild()#

GetChildren()#

GetChildrenNames()#

GetChildrenReorder()#

GetFilteredChildren()#

GetFilteredChildrenNames()#

GetFilteredNextSibling()#

GetInherits()#

GetInstances()#

GetKind()#

GetNextSibling()#

GetObjectAtPath()#

GetParent()#

GetPayloads()#

GetPrimAtPath()#

GetPrimDefinition()#

GetPrimInPrototype()#

GetPrimIndex()#

GetPrimStack()#

GetPrimStackWithLayerOffsets()#

GetPrimTypeInfo()#

GetProperties()#

GetPropertiesInNamespace()#

GetProperty()#

GetPropertyAtPath()#

GetPropertyNames()#

GetPropertyOrder()#

GetPrototype()#

GetReferences()#

GetRelationship()#

GetRelationshipAtPath()#

GetRelationships()#

GetSpecializes()#

GetSpecifier()#

GetTypeName()#

GetVariantSet()#

GetVariantSets()#

GetVersionIfHasAPIInFamily()#

GetVersionIfIsInFamily()#

HasAPI()#

HasAPIInFamily()#

HasAttribute()#

HasAuthoredActive()#

HasAuthoredInherits()#

HasAuthoredInstanceable()#

HasAuthoredPayloads()#

HasAuthoredReferences()#

HasAuthoredSpecializes()#

HasAuthoredTypeName()#

HasDefiningSpecifier()#

HasPayload()#

HasProperty()#

HasRelationship()#

HasVariantSets()#

IsA()#

IsAbstract()#

IsActive()#

IsComponent()#

IsDefined()#

IsGroup()#

IsInFamily()#

IsInPrototype()#

IsInstance()#

IsInstanceProxy()#

IsInstanceable()#

IsLoaded()#

IsModel()#

static IsPathInPrototype()#

IsPrototype()#

static IsPrototypePath()#

IsPseudoRoot()#

IsSubComponent()#

Load()#

MakeResolveTargetStrongerThanEditTarget()#

MakeResolveTargetUpToEditTarget()#

RemoveAPI()#

RemoveAppliedSchema()#

RemoveProperty()#

SetActive()#

SetChildrenReorder()#

SetInstanceable()#

SetKind()#

SetPayload()#

SetPropertyOrder()#

SetSpecifier()#

SetTypeName()#

Unload()#

class pxr.Usd.PrimCompositionQuery#

Classes:

`ArcIntroducedFilter`
`ArcTypeFilter`
`DependencyTypeFilter`
`Filter`
`HasSpecsFilter`

Methods:

`GetCompositionArcs`
`GetDirectInherits`
`GetDirectReferences`
`GetDirectRootLayerArcs`

Attributes:

filter

class ArcIntroducedFilter#

Attributes:

`All`
`IntroducedInRootLayerPrimSpec`
`IntroducedInRootLayerStack`
`names`
`values`

All = pxr.Usd.ArcIntroducedFilter.All#

IntroducedInRootLayerPrimSpec = pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerPrimSpec#

IntroducedInRootLayerStack = pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerStack#

names = {'All': pxr.Usd.ArcIntroducedFilter.All, 'IntroducedInRootLayerPrimSpec': pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerPrimSpec, 'IntroducedInRootLayerStack': pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerStack}#

values = {0: pxr.Usd.ArcIntroducedFilter.All, 1: pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerStack, 2: pxr.Usd.ArcIntroducedFilter.IntroducedInRootLayerPrimSpec}#

class ArcTypeFilter#

Attributes:

`All`
`Inherit`
`InheritOrSpecialize`
`NotInheritOrSpecialize`
`NotReferenceOrPayload`
`NotVariant`
`Payload`
`Reference`
`ReferenceOrPayload`
`Specialize`
`Variant`
`names`
`values`

All = pxr.Usd.ArcTypeFilter.All#

Inherit = pxr.Usd.ArcTypeFilter.Inherit#

InheritOrSpecialize = pxr.Usd.ArcTypeFilter.InheritOrSpecialize#

NotInheritOrSpecialize = pxr.Usd.ArcTypeFilter.NotInheritOrSpecialize#

NotReferenceOrPayload = pxr.Usd.ArcTypeFilter.NotReferenceOrPayload#

NotVariant = pxr.Usd.ArcTypeFilter.NotVariant#

Payload = pxr.Usd.ArcTypeFilter.Payload#

Reference = pxr.Usd.ArcTypeFilter.Reference#

ReferenceOrPayload = pxr.Usd.ArcTypeFilter.ReferenceOrPayload#

Specialize = pxr.Usd.ArcTypeFilter.Specialize#

Variant = pxr.Usd.ArcTypeFilter.Variant#

names = {'All': pxr.Usd.ArcTypeFilter.All, 'Inherit': pxr.Usd.ArcTypeFilter.Inherit, 'InheritOrSpecialize': pxr.Usd.ArcTypeFilter.InheritOrSpecialize, 'NotInheritOrSpecialize': pxr.Usd.ArcTypeFilter.NotInheritOrSpecialize, 'NotReferenceOrPayload': pxr.Usd.ArcTypeFilter.NotReferenceOrPayload, 'NotVariant': pxr.Usd.ArcTypeFilter.NotVariant, 'Payload': pxr.Usd.ArcTypeFilter.Payload, 'Reference': pxr.Usd.ArcTypeFilter.Reference, 'ReferenceOrPayload': pxr.Usd.ArcTypeFilter.ReferenceOrPayload, 'Specialize': pxr.Usd.ArcTypeFilter.Specialize, 'Variant': pxr.Usd.ArcTypeFilter.Variant}#

values = {0: pxr.Usd.ArcTypeFilter.All, 1: pxr.Usd.ArcTypeFilter.Reference, 2: pxr.Usd.ArcTypeFilter.Payload, 3: pxr.Usd.ArcTypeFilter.Inherit, 4: pxr.Usd.ArcTypeFilter.Specialize, 5: pxr.Usd.ArcTypeFilter.Variant, 6: pxr.Usd.ArcTypeFilter.ReferenceOrPayload, 7: pxr.Usd.ArcTypeFilter.InheritOrSpecialize, 8: pxr.Usd.ArcTypeFilter.NotReferenceOrPayload, 9: pxr.Usd.ArcTypeFilter.NotInheritOrSpecialize, 10: pxr.Usd.ArcTypeFilter.NotVariant}#

class DependencyTypeFilter#

Attributes:

`All`
`Ancestral`
`Direct`
`names`
`values`

All = pxr.Usd.DependencyTypeFilter.All#

Ancestral = pxr.Usd.DependencyTypeFilter.Ancestral#

Direct = pxr.Usd.DependencyTypeFilter.Direct#

names = {'All': pxr.Usd.DependencyTypeFilter.All, 'Ancestral': pxr.Usd.DependencyTypeFilter.Ancestral, 'Direct': pxr.Usd.DependencyTypeFilter.Direct}#

values = {0: pxr.Usd.DependencyTypeFilter.All, 1: pxr.Usd.DependencyTypeFilter.Direct, 2: pxr.Usd.DependencyTypeFilter.Ancestral}#

class Filter#

Attributes:

`arcIntroducedFilter`
`arcTypeFilter`
`dependencyTypeFilter`
`hasSpecsFilter`

property arcIntroducedFilter#

property arcTypeFilter#

property dependencyTypeFilter#

property hasSpecsFilter#

class HasSpecsFilter#

Attributes:

`All`
`HasNoSpecs`
`HasSpecs`
`names`
`values`

All = pxr.Usd.HasSpecsFilter.All#

HasNoSpecs = pxr.Usd.HasSpecsFilter.HasNoSpecs#

HasSpecs = pxr.Usd.HasSpecsFilter.HasSpecs#

names = {'All': pxr.Usd.HasSpecsFilter.All, 'HasNoSpecs': pxr.Usd.HasSpecsFilter.HasNoSpecs, 'HasSpecs': pxr.Usd.HasSpecsFilter.HasSpecs}#

values = {0: pxr.Usd.HasSpecsFilter.All, 1: pxr.Usd.HasSpecsFilter.HasSpecs, 2: pxr.Usd.HasSpecsFilter.HasNoSpecs}#

GetCompositionArcs()#

static GetDirectInherits()#

static GetDirectReferences()#

static GetDirectRootLayerArcs()#

property filter#

class pxr.Usd.PrimDefinition#

Classes:

`Attribute`
`Property`
`Relationship`

Methods:

`FlattenTo`
`GetAppliedAPISchemas`
`GetAttributeDefinition`
`GetAttributeFallbackValue`
`GetDocumentation`
`GetMetadata`
`GetMetadataByDictKey`
`GetPropertyDefinition`
`GetPropertyDocumentation`
`GetPropertyMetadata`
`GetPropertyMetadataByDictKey`
`GetPropertyNames`
`GetRelationshipDefinition`
`GetSchemaAttributeSpec`
`GetSchemaPropertySpec`
`GetSchemaRelationshipSpec`
`GetSpecType`
`ListMetadataFields`
`ListPropertyMetadataFields`

class Attribute#

Methods:

`GetFallbackValue`
`GetTypeName`
`GetTypeNameToken`

GetFallbackValue()#

GetTypeName()#

GetTypeNameToken()#

class Property#

Methods:

`GetDocumentation`
`GetMetadata`
`GetMetadataByDictKey`
`GetName`
`GetSpecType`
`GetVariability`
`IsAttribute`
`IsRelationship`
`ListMetadataFields`

GetDocumentation()#

GetMetadata()#

GetMetadataByDictKey()#

GetName()#

GetSpecType()#

GetVariability()#

IsAttribute()#

IsRelationship()#

ListMetadataFields()#

class Relationship#

FlattenTo()#

GetAppliedAPISchemas()#

GetAttributeDefinition()#

GetAttributeFallbackValue()#

GetDocumentation()#

GetMetadata()#

GetMetadataByDictKey()#

GetPropertyDefinition()#

GetPropertyDocumentation()#

GetPropertyMetadata()#

GetPropertyMetadataByDictKey()#

GetPropertyNames()#

GetRelationshipDefinition()#

GetSchemaAttributeSpec()#

GetSchemaPropertySpec()#

GetSchemaRelationshipSpec()#

GetSpecType()#

ListMetadataFields()#

ListPropertyMetadataFields()#

class pxr.Usd.PrimRange#

Methods:

`AllPrims`
`AllPrimsPreAndPostVisit`
`IsValid`	true if the iterator is not yet exhausted
`PreAndPostVisit`
`Stage`

static AllPrims()#

static AllPrimsPreAndPostVisit()#

IsValid()#: true if the iterator is not yet exhausted

static PreAndPostVisit()#

static Stage()#

class pxr.Usd.PrimTypeInfo#

Methods:

`GetAppliedAPISchemas`
`GetEmptyPrimType`
`GetPrimDefinition`
`GetSchemaType`
`GetSchemaTypeName`
`GetTypeName`

GetAppliedAPISchemas()#

static GetEmptyPrimType()#

GetPrimDefinition()#

GetSchemaType()#

GetSchemaTypeName()#

GetTypeName()#

class pxr.Usd.Property#

Methods:

`ClearDisplayGroup`
`FlattenTo`
`GetBaseName`
`GetDisplayGroup`
`GetNamespace`
`GetNestedDisplayGroups`
`GetPropertyStack`
`GetPropertyStackWithLayerOffsets`
`HasAuthoredDisplayGroup`
`IsAuthored`
`IsAuthoredAt`
`IsCustom`
`IsDefined`
`SetCustom`
`SetDisplayGroup`
`SetNestedDisplayGroups`
`SplitName`

ClearDisplayGroup()#

FlattenTo()#

GetBaseName()#

GetDisplayGroup()#

GetNamespace()#

GetNestedDisplayGroups()#

GetPropertyStack()#

GetPropertyStackWithLayerOffsets()#

HasAuthoredDisplayGroup()#

IsAuthored()#

IsAuthoredAt()#

IsCustom()#

IsDefined()#

SetCustom()#

SetDisplayGroup()#

SetNestedDisplayGroups()#

SplitName()#

class pxr.Usd.References#

Methods:

`AddInternalReference`
`AddReference`
`ClearReferences`
`GetPrim`
`RemoveReference`
`SetReferences`

AddInternalReference()#

AddReference()#

ClearReferences()#

GetPrim()#

RemoveReference()#

SetReferences()#

class pxr.Usd.Relationship#

Methods:

`AddTarget`
`ClearTargets`
`GetForwardedTargets`
`GetTargets`
`HasAuthoredTargets`
`RemoveTarget`
`SetTargets`

AddTarget()#

ClearTargets()#

GetForwardedTargets()#

GetTargets()#

HasAuthoredTargets()#

RemoveTarget()#

SetTargets()#

class pxr.Usd.ResolveInfo#

Methods:

`GetNode`
`GetSource`
`ValueIsBlocked`

GetNode()#

GetSource()#

ValueIsBlocked()#

class pxr.Usd.ResolveInfoSource#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Usd.ResolveInfoSourceNone, Usd.ResolveInfoSourceFallback, Usd.ResolveInfoSourceDefault, Usd.ResolveInfoSourceTimeSamples, Usd.ResolveInfoSourceValueClips)#

class pxr.Usd.ResolveTarget#

Methods:

`GetPrimIndex`
`GetStartLayer`
`GetStartNode`
`GetStopLayer`
`GetStopNode`
`IsNull`

GetPrimIndex()#

GetStartLayer()#

GetStartNode()#

GetStopLayer()#

GetStopNode()#

IsNull()#

class pxr.Usd.SchemaBase#

Methods:

`GetPath`
`GetPrim`
`GetSchemaAttributeNames`
`GetSchemaClassPrimDefinition`
`GetSchemaKind`
`IsAPISchema`
`IsAppliedAPISchema`
`IsConcrete`
`IsMultipleApplyAPISchema`
`IsTyped`

GetPath()#

GetPrim()#

static GetSchemaAttributeNames()#

GetSchemaClassPrimDefinition()#

GetSchemaKind()#

IsAPISchema()#

IsAppliedAPISchema()#

IsConcrete()#

IsMultipleApplyAPISchema()#

IsTyped()#

class pxr.Usd.SchemaKind#

Attributes:

`AbstractBase`
`AbstractTyped`
`ConcreteTyped`
`Invalid`
`MultipleApplyAPI`
`NonAppliedAPI`
`SingleApplyAPI`
`names`
`values`

AbstractBase = pxr.Usd.SchemaKind.AbstractBase#

AbstractTyped = pxr.Usd.SchemaKind.AbstractTyped#

ConcreteTyped = pxr.Usd.SchemaKind.ConcreteTyped#

Invalid = pxr.Usd.SchemaKind.Invalid#

MultipleApplyAPI = pxr.Usd.SchemaKind.MultipleApplyAPI#

NonAppliedAPI = pxr.Usd.SchemaKind.NonAppliedAPI#

SingleApplyAPI = pxr.Usd.SchemaKind.SingleApplyAPI#

names = {'AbstractBase': pxr.Usd.SchemaKind.AbstractBase, 'AbstractTyped': pxr.Usd.SchemaKind.AbstractTyped, 'ConcreteTyped': pxr.Usd.SchemaKind.ConcreteTyped, 'Invalid': pxr.Usd.SchemaKind.Invalid, 'MultipleApplyAPI': pxr.Usd.SchemaKind.MultipleApplyAPI, 'NonAppliedAPI': pxr.Usd.SchemaKind.NonAppliedAPI, 'SingleApplyAPI': pxr.Usd.SchemaKind.SingleApplyAPI}#

values = {0: pxr.Usd.SchemaKind.Invalid, 1: pxr.Usd.SchemaKind.AbstractBase, 2: pxr.Usd.SchemaKind.AbstractTyped, 3: pxr.Usd.SchemaKind.ConcreteTyped, 4: pxr.Usd.SchemaKind.NonAppliedAPI, 5: pxr.Usd.SchemaKind.SingleApplyAPI, 6: pxr.Usd.SchemaKind.MultipleApplyAPI}#

class pxr.Usd.SchemaRegistry#

Classes:

`SchemaInfo`
`VersionPolicy`

Methods:

`BuildComposedPrimDefinition`
`FindAppliedAPIPrimDefinition`
`FindConcretePrimDefinition`
`FindSchemaInfo`
`FindSchemaInfosInFamily`
`GetAPISchemaCanOnlyApplyToTypeNames`
`GetAPISchemaTypeName`
`GetAPITypeFromSchemaTypeName`
`GetAutoApplyAPISchemas`
`GetConcreteSchemaTypeName`
`GetConcreteTypeFromSchemaTypeName`
`GetEmptyPrimDefinition`
`GetFallbackPrimTypes`
`GetMultipleApplyNameTemplateBaseName`
`GetSchemaKind`
`GetSchemaTypeName`
`GetTypeFromName`
`GetTypeFromSchemaTypeName`
`GetTypeNameAndInstance`
`IsAbstract`
`IsAllowedAPISchemaInstanceName`
`IsAllowedSchemaFamily`
`IsAllowedSchemaIdentifier`
`IsAppliedAPISchema`
`IsConcrete`
`IsDisallowedField`
`IsMultipleApplyAPISchema`
`IsMultipleApplyNameTemplate`
`IsTyped`
`MakeMultipleApplyNameInstance`
`MakeMultipleApplyNameTemplate`
`MakeSchemaIdentifierForFamilyAndVersion`
`ParseSchemaFamilyAndVersionFromIdentifier`

Attributes:

expired

True if this object has expired, False otherwise.

class SchemaInfo#

Attributes:

`family`
`identifier`
`kind`
`type`
`version`

property family#

property identifier#

property kind#

property type#

property version#

class VersionPolicy#

Attributes:

`All`
`GreaterThan`
`GreaterThanOrEqual`
`LessThan`
`LessThanOrEqual`
`names`
`values`

All = pxr.Usd.VersionPolicy.All#

GreaterThan = pxr.Usd.VersionPolicy.GreaterThan#

GreaterThanOrEqual = pxr.Usd.VersionPolicy.GreaterThanOrEqual#

LessThan = pxr.Usd.VersionPolicy.LessThan#

LessThanOrEqual = pxr.Usd.VersionPolicy.LessThanOrEqual#

names = {'All': pxr.Usd.VersionPolicy.All, 'GreaterThan': pxr.Usd.VersionPolicy.GreaterThan, 'GreaterThanOrEqual': pxr.Usd.VersionPolicy.GreaterThanOrEqual, 'LessThan': pxr.Usd.VersionPolicy.LessThan, 'LessThanOrEqual': pxr.Usd.VersionPolicy.LessThanOrEqual}#

values = {0: pxr.Usd.VersionPolicy.All, 1: pxr.Usd.VersionPolicy.GreaterThan, 2: pxr.Usd.VersionPolicy.GreaterThanOrEqual, 3: pxr.Usd.VersionPolicy.LessThan, 4: pxr.Usd.VersionPolicy.LessThanOrEqual}#

BuildComposedPrimDefinition()#

FindAppliedAPIPrimDefinition()#

FindConcretePrimDefinition()#

static FindSchemaInfo()#

static FindSchemaInfosInFamily()#

static GetAPISchemaCanOnlyApplyToTypeNames()#

static GetAPISchemaTypeName()#

static GetAPITypeFromSchemaTypeName()#

static GetAutoApplyAPISchemas()#

static GetConcreteSchemaTypeName()#

static GetConcreteTypeFromSchemaTypeName()#

GetEmptyPrimDefinition()#

GetFallbackPrimTypes()#

static GetMultipleApplyNameTemplateBaseName()#

static GetSchemaKind()#

static GetSchemaTypeName()#

static GetTypeFromName()#

static GetTypeFromSchemaTypeName()#

static GetTypeNameAndInstance()#

static IsAbstract()#

static IsAllowedAPISchemaInstanceName()#

static IsAllowedSchemaFamily()#

static IsAllowedSchemaIdentifier()#

static IsAppliedAPISchema()#

static IsConcrete()#

static IsDisallowedField()#

static IsMultipleApplyAPISchema()#

static IsMultipleApplyNameTemplate()#

static IsTyped()#

static MakeMultipleApplyNameInstance()#

static MakeMultipleApplyNameTemplate()#

static MakeSchemaIdentifierForFamilyAndVersion()#

static ParseSchemaFamilyAndVersionFromIdentifier()#

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

class pxr.Usd.Specializes#

Methods:

`AddSpecialize`
`ClearSpecializes`
`GetPrim`
`RemoveSpecialize`
`SetSpecializes`

AddSpecialize()#

ClearSpecializes()#

GetPrim()#

RemoveSpecialize()#

SetSpecializes()#

class pxr.Usd.Stage#

Classes:

InitialLoadSet

Methods:

`ClearDefaultPrim`
`ClearMetadata`
`ClearMetadataByDictKey`
`CreateClassPrim`
`CreateInMemory`
`CreateNew`
`DefinePrim`
`ExpandPopulationMask`
`Export`
`ExportToString`
`FindLoadable`
`Flatten`
`GetAttributeAtPath`
`GetColorConfigFallbacks`
`GetColorConfiguration`
`GetColorManagementSystem`
`GetCompositionErrors`
`GetDefaultPrim`
`GetEditTarget`
`GetEditTargetForLocalLayer`
`GetEndTimeCode`
`GetFramesPerSecond`
`GetGlobalVariantFallbacks`
`GetInterpolationType`
`GetLayerStack`
`GetLoadRules`
`GetLoadSet`
`GetMetadata`
`GetMetadataByDictKey`
`GetMutedLayers`
`GetObjectAtPath`
`GetPathResolverContext`
`GetPopulationMask`
`GetPrimAtPath`
`GetPropertyAtPath`
`GetPrototypes`
`GetPseudoRoot`
`GetRelationshipAtPath`
`GetRootLayer`
`GetSessionLayer`
`GetStartTimeCode`
`GetTimeCodesPerSecond`
`GetUsedLayers`
`HasAuthoredMetadata`
`HasAuthoredMetadataDictKey`
`HasAuthoredTimeCodeRange`
`HasDefaultPrim`
`HasLocalLayer`
`HasMetadata`
`HasMetadataDictKey`
`IsLayerMuted`
`IsSupportedFile`
`Load`
`LoadAndUnload`
`MuteAndUnmuteLayers`
`MuteLayer`
`Open`
`OpenMasked`
`OverridePrim`
`Reload`
`RemovePrim`
`ResolveIdentifierToEditTarget`
`Save`
`SaveSessionLayers`
`SetColorConfigFallbacks`
`SetColorConfiguration`
`SetColorManagementSystem`
`SetDefaultPrim`
`SetEditTarget`
`SetEndTimeCode`
`SetFramesPerSecond`
`SetGlobalVariantFallbacks`
`SetInterpolationType`
`SetLoadRules`
`SetMetadata`
`SetMetadataByDictKey`
`SetPopulationMask`
`SetStartTimeCode`
`SetTimeCodesPerSecond`
`Traverse`
`TraverseAll`
`Unload`
`UnmuteLayer`
`WriteFallbackPrimTypes`

Attributes:

`LoadAll`
`LoadNone`
`expired`	True if this object has expired, False otherwise.

class InitialLoadSet#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Usd.Stage.LoadAll, Usd.Stage.LoadNone)#

ClearDefaultPrim()#

ClearMetadata()#

ClearMetadataByDictKey()#

CreateClassPrim()#

static CreateInMemory()#

static CreateNew()#

DefinePrim()#

ExpandPopulationMask()#

Export()#

ExportToString()#

FindLoadable()#

Flatten()#

GetAttributeAtPath()#

static GetColorConfigFallbacks()#

GetColorConfiguration()#

GetColorManagementSystem()#

GetCompositionErrors()#

GetDefaultPrim()#

GetEditTarget()#

GetEditTargetForLocalLayer()#

GetEndTimeCode()#

GetFramesPerSecond()#

static GetGlobalVariantFallbacks()#

GetInterpolationType()#

GetLayerStack()#

GetLoadRules()#

GetLoadSet()#

GetMetadata()#

GetMetadataByDictKey()#

GetMutedLayers()#

GetObjectAtPath()#

GetPathResolverContext()#

GetPopulationMask()#

GetPrimAtPath()#

GetPropertyAtPath()#

GetPrototypes()#

GetPseudoRoot()#

GetRelationshipAtPath()#

GetRootLayer()#

GetSessionLayer()#

GetStartTimeCode()#

GetTimeCodesPerSecond()#

GetUsedLayers()#

HasAuthoredMetadata()#

HasAuthoredMetadataDictKey()#

HasAuthoredTimeCodeRange()#

HasDefaultPrim()#

HasLocalLayer()#

HasMetadata()#

HasMetadataDictKey()#

IsLayerMuted()#

static IsSupportedFile()#

Load()#

LoadAndUnload()#

MuteAndUnmuteLayers()#

MuteLayer()#

static Open()#

static OpenMasked()#

OverridePrim()#

Reload()#

RemovePrim()#

ResolveIdentifierToEditTarget()#

Save()#

SaveSessionLayers()#

static SetColorConfigFallbacks()#

SetColorConfiguration()#

SetColorManagementSystem()#

SetDefaultPrim()#

SetEditTarget()#

SetEndTimeCode()#

SetFramesPerSecond()#

static SetGlobalVariantFallbacks()#

SetInterpolationType()#

SetLoadRules()#

SetMetadata()#

SetMetadataByDictKey()#

SetPopulationMask()#

SetStartTimeCode()#

SetTimeCodesPerSecond()#

Traverse()#

TraverseAll()#

Unload()#

UnmuteLayer()#

WriteFallbackPrimTypes()#

LoadAll = Usd.Stage.LoadAll#

LoadNone = Usd.Stage.LoadNone#

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

class pxr.Usd.StageCache#

Classes:

Id

Methods:

`Clear`
`Contains`
`Erase`
`EraseAll`
`Find`
`FindAllMatching`
`FindOneMatching`
`GetAllStages`
`GetDebugName`
`GetId`
`Insert`
`IsEmpty`
`SetDebugName`
`Size`
`swap`

class Id#

Methods:

`FromLongInt`
`FromString`
`IsValid`
`ToLongInt`
`ToString`

static FromLongInt()#

static FromString()#

IsValid()#

ToLongInt()#

ToString()#

Clear()#

Contains()#

Erase()#

EraseAll()#

Find()#

FindAllMatching()#

FindOneMatching()#

GetAllStages()#

GetDebugName()#

GetId()#

Insert()#

IsEmpty()#

SetDebugName()#

Size()#

swap()#

class pxr.Usd.StageCacheContext#

class pxr.Usd.StageCacheContextBlockType#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Usd.BlockStageCaches, Usd.BlockStageCachePopulation, Usd._NoBlock)#

class pxr.Usd.StageLoadRules#

Classes:

Rule

Methods:

`AddRule`
`GetEffectiveRuleForPath`
`GetRules`
`IsLoaded`
`IsLoadedWithAllDescendants`
`IsLoadedWithNoDescendants`
`LoadAll`
`LoadAndUnload`
`LoadNone`
`LoadWithDescendants`
`LoadWithoutDescendants`
`Minimize`
`SetRules`
`Unload`
`swap`

Attributes:

`AllRule`
`NoneRule`
`OnlyRule`

class Rule#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Usd.StageLoadRules.AllRule, Usd.StageLoadRules.OnlyRule, Usd.StageLoadRules.NoneRule)#

AddRule()#

GetEffectiveRuleForPath()#

GetRules()#

IsLoaded()#

IsLoadedWithAllDescendants()#

IsLoadedWithNoDescendants()#

static LoadAll()#

LoadAndUnload()#

static LoadNone()#

LoadWithDescendants()#

LoadWithoutDescendants()#

Minimize()#

SetRules()#

Unload()#

swap()#

AllRule = Usd.StageLoadRules.AllRule#

NoneRule = Usd.StageLoadRules.NoneRule#

OnlyRule = Usd.StageLoadRules.OnlyRule#

class pxr.Usd.StagePopulationMask#

Methods:

`Add`
`All`
`GetIncludedChildNames`
`GetIntersection`
`GetPaths`
`GetUnion`
`Includes`
`IncludesSubtree`
`Intersection`
`IsEmpty`
`Union`

Add()#

static All()#

GetIncludedChildNames()#

GetIntersection()#

GetPaths()#

GetUnion()#

Includes()#

IncludesSubtree()#

static Intersection()#

IsEmpty()#

static Union()#

class pxr.Usd.TimeCode#

Classes:

Tokens

Methods:

`Default`
`EarliestTime`
`GetValue`
`IsDefault`
`IsEarliestTime`
`IsNumeric`
`SafeStep`
`Test_TimeCodeSequenceRoundTrip`

class Tokens#

Attributes:

`DEFAULT`
`EARLIEST`

DEFAULT = 'DEFAULT'#

EARLIEST = 'EARLIEST'#

static Default()#

static EarliestTime()#

GetValue()#

IsDefault()#

IsEarliestTime()#

IsNumeric()#

static SafeStep()#

Test_TimeCodeSequenceRoundTrip()#

class pxr.Usd.Tokens#

Attributes:

`APISchemaBase`
`ClipsAPI`
`CollectionAPI`
`ColorSpaceAPI`
`ColorSpaceDefinitionAPI`
`ModelAPI`
`Typed`
`apiSchemas`
`clipSets`
`clips`
`collection`
`collection_MultipleApplyTemplate_`
`collection_MultipleApplyTemplate_Excludes`
`collection_MultipleApplyTemplate_ExpansionRule`
`collection_MultipleApplyTemplate_IncludeRoot`
`collection_MultipleApplyTemplate_Includes`
`collection_MultipleApplyTemplate_MembershipExpression`
`colorSpaceDefinition`
`colorSpaceDefinition_MultipleApplyTemplate_BlueChroma`
`colorSpaceDefinition_MultipleApplyTemplate_Gamma`
`colorSpaceDefinition_MultipleApplyTemplate_GreenChroma`
`colorSpaceDefinition_MultipleApplyTemplate_LinearBias`
`colorSpaceDefinition_MultipleApplyTemplate_Name`
`colorSpaceDefinition_MultipleApplyTemplate_RedChroma`
`colorSpaceDefinition_MultipleApplyTemplate_WhitePoint`
`colorSpaceName`
`custom`
`exclude`
`expandPrims`
`expandPrimsAndProperties`
`explicitOnly`
`fallbackPrimTypes`

APISchemaBase = 'APISchemaBase'#

ClipsAPI = 'ClipsAPI'#

CollectionAPI = 'CollectionAPI'#

ColorSpaceAPI = 'ColorSpaceAPI'#

ColorSpaceDefinitionAPI = 'ColorSpaceDefinitionAPI'#

ModelAPI = 'ModelAPI'#

Typed = 'Typed'#

apiSchemas = 'apiSchemas'#

clipSets = 'clipSets'#

clips = 'clips'#

collection = 'collection'#

collection_MultipleApplyTemplate_ = 'collection:__INSTANCE_NAME__'#

collection_MultipleApplyTemplate_Excludes = 'collection:__INSTANCE_NAME__:excludes'#

collection_MultipleApplyTemplate_ExpansionRule = 'collection:__INSTANCE_NAME__:expansionRule'#

collection_MultipleApplyTemplate_IncludeRoot = 'collection:__INSTANCE_NAME__:includeRoot'#

collection_MultipleApplyTemplate_Includes = 'collection:__INSTANCE_NAME__:includes'#

collection_MultipleApplyTemplate_MembershipExpression = 'collection:__INSTANCE_NAME__:membershipExpression'#

colorSpaceDefinition = 'colorSpaceDefinition'#

colorSpaceDefinition_MultipleApplyTemplate_BlueChroma = 'colorSpaceDefinition:__INSTANCE_NAME__:blueChroma'#

colorSpaceDefinition_MultipleApplyTemplate_Gamma = 'colorSpaceDefinition:__INSTANCE_NAME__:gamma'#

colorSpaceDefinition_MultipleApplyTemplate_GreenChroma = 'colorSpaceDefinition:__INSTANCE_NAME__:greenChroma'#

colorSpaceDefinition_MultipleApplyTemplate_LinearBias = 'colorSpaceDefinition:__INSTANCE_NAME__:linearBias'#

colorSpaceDefinition_MultipleApplyTemplate_Name = 'colorSpaceDefinition:__INSTANCE_NAME__:name'#

colorSpaceDefinition_MultipleApplyTemplate_RedChroma = 'colorSpaceDefinition:__INSTANCE_NAME__:redChroma'#

colorSpaceDefinition_MultipleApplyTemplate_WhitePoint = 'colorSpaceDefinition:__INSTANCE_NAME__:whitePoint'#

colorSpaceName = 'colorSpace:name'#

custom = 'custom'#

exclude = 'exclude'#

expandPrims = 'expandPrims'#

expandPrimsAndProperties = 'expandPrimsAndProperties'#

explicitOnly = 'explicitOnly'#

fallbackPrimTypes = 'fallbackPrimTypes'#

class pxr.Usd.Typed#

Methods:

`Get`
`GetSchemaAttributeNames`

static Get()#

static GetSchemaAttributeNames()#

class pxr.Usd.UsdCollectionMembershipQuery#

Methods:

`GetAsPathExpansionRuleMap`
`GetIncludedCollections`
`HasExcludes`
`IsPathIncluded`
`UsesPathExpansionRuleMap`

GetAsPathExpansionRuleMap()#

GetIncludedCollections()#

HasExcludes()#

IsPathIncluded()#

UsesPathExpansionRuleMap()#

class pxr.Usd.UsdFileFormat#

Classes:

Tokens

Methods:

GetUnderlyingFormatForLayer

class Tokens#

Attributes:

`FormatArg`
`Id`
`Target`
`Version`

FormatArg = 'format'#

Id = 'usd'#

Target = 'usd'#

Version = '1.0'#

static GetUnderlyingFormatForLayer()#

class pxr.Usd.VariantSet#

Methods:

`AddVariant`
`BlockVariantSelection`
`ClearVariantSelection`
`GetName`
`GetPrim`
`GetVariantEditContext`
`GetVariantEditTarget`
`GetVariantNames`
`GetVariantSelection`
`HasAuthoredVariant`
`HasAuthoredVariantSelection`
`IsValid`
`SetVariantSelection`

AddVariant()#

BlockVariantSelection()#

ClearVariantSelection()#

GetName()#

GetPrim()#

GetVariantEditContext()#

GetVariantEditTarget()#

GetVariantNames()#

GetVariantSelection()#

HasAuthoredVariant()#

HasAuthoredVariantSelection()#

IsValid()#

SetVariantSelection()#

class pxr.Usd.VariantSets#

Methods:

`AddVariantSet`
`GetAllVariantSelections`
`GetNames`
`GetVariantSelection`
`GetVariantSet`
`HasVariantSet`
`SetSelection`

AddVariantSet()#

GetAllVariantSelections()#

GetNames()#

GetVariantSelection()#

GetVariantSet()#

HasVariantSet()#

SetSelection()#

class pxr.Usd.ZipFile#

Classes:

FileInfo

Methods:

`DumpContents`
`GetFile`
`GetFileInfo`
`GetFileNames`
`Open`

class FileInfo#

Attributes:

`compressionMethod`
`crc`
`dataOffset`
`encrypted`
`size`
`uncompressedSize`

property compressionMethod#

property crc#

property dataOffset#

property encrypted#

property size#

property uncompressedSize#

DumpContents()#

GetFile()#

GetFileInfo()#

GetFileNames()#

static Open()#

class pxr.Usd.ZipFileWriter#

Methods:

`AddFile`
`CreateNew`
`Discard`
`Save`

AddFile()#

static CreateNew()#

Discard()#

Save()#

`APISchemaBase`
`AssetInfoKeys`
`Attribute`
`AttributeQuery`
`ClipsAPI`
`CollectionAPI`
`ColorSpaceAPI`
`ColorSpaceCache`
`ColorSpaceDefinitionAPI`
`ColorSpaceHashCache`
`CompositionArc`
`CrateInfo`
`EditContext`
`EditTarget`
`FlattenResolveAssetPathContext`
`Inherits`
`InterpolationType`
`ListPosition`
`LoadPolicy`
`ModelAPI`
`NamespaceEditor`
`Notice`
`Object`
`Payloads`
`Prim`
`PrimCompositionQuery`
`PrimDefinition`
`PrimRange`
`PrimTypeInfo`
`Property`
`References`
`Relationship`
`ResolveInfo`
`ResolveInfoSource`
`ResolveTarget`
`SchemaBase`
`SchemaKind`
`SchemaRegistry`
`Specializes`
`Stage`
`StageCache`
`StageCacheContext`
`StageCacheContextBlockType`
`StageLoadRules`
`StagePopulationMask`
`TimeCode`
`Tokens`
`Typed`
`UsdCollectionMembershipQuery`
`UsdFileFormat`
`VariantSet`
`VariantSets`
`ZipFile`
`ZipFileWriter`

`AddConnection`
`Block`
`Clear`
`ClearAtTime`
`ClearColorSpace`
`ClearConnections`
`ClearDefault`
`Get`
`GetBracketingTimeSamples`
`GetColorSpace`
`GetConnections`
`GetNumTimeSamples`
`GetResolveInfo`
`GetRoleName`
`GetSpline`
`GetTimeSamples`
`GetTimeSamplesInInterval`
`GetTypeName`
`GetUnionedTimeSamples`
`GetUnionedTimeSamplesInInterval`
`GetVariability`
`HasAuthoredConnections`
`HasAuthoredValue`
`HasAuthoredValueOpinion`
`HasColorSpace`
`HasFallbackValue`
`HasSpline`
`HasValue`
`RemoveConnection`
`Set`
`SetColorSpace`
`SetConnections`
`SetSpline`
`SetTypeName`
`SetVariability`
`ValueMightBeTimeVarying`

`ComputeClipAssetPaths`
`GenerateClipManifest`
`GenerateClipManifestFromLayers`
`Get`
`GetClipActive`
`GetClipAssetPaths`
`GetClipManifestAssetPath`
`GetClipPrimPath`
`GetClipSets`
`GetClipTemplateActiveOffset`
`GetClipTemplateAssetPath`
`GetClipTemplateEndTime`
`GetClipTemplateStartTime`
`GetClipTemplateStride`
`GetClipTimes`
`GetClips`
`GetInterpolateMissingClipValues`
`GetSchemaAttributeNames`
`SetClipActive`
`SetClipAssetPaths`
`SetClipManifestAssetPath`
`SetClipPrimPath`
`SetClipSets`
`SetClipTemplateActiveOffset`
`SetClipTemplateAssetPath`
`SetClipTemplateEndTime`
`SetClipTemplateStartTime`
`SetClipTemplateStride`
`SetClipTimes`
`SetClips`
`SetInterpolateMissingClipValues`

`Apply`
`BlockCollection`
`CanApply`
`CanContainPropertyName`
`ComputeIncludedObjects`
`ComputeIncludedPaths`
`ComputeMembershipQuery`
`CreateCollectionAttr`
`CreateExcludesRel`
`CreateExpansionRuleAttr`
`CreateIncludeRootAttr`
`CreateIncludesRel`
`CreateMembershipExpressionAttr`
`ExcludePath`
`Get`
`GetAll`
`GetAllCollections`
`GetCollection`
`GetCollectionAttr`
`GetCollectionPath`
`GetExcludesRel`
`GetExpansionRuleAttr`
`GetIncludeRootAttr`
`GetIncludesRel`
`GetMembershipExpressionAttr`
`GetName`
`GetNamedCollectionPath`
`GetSchemaAttributeNames`
`HasNoIncludedPaths`
`IncludePath`
`IsCollectionAPIPath`
`IsInExpressionMode`
`IsInRelationshipsMode`
`IsSchemaPropertyBaseName`
`ResetCollection`
`ResolveCompleteMembershipExpression`
`Validate`

`Apply`
`CanApply`
`ComputeColorSpaceFromDefinitionAttributes`
`CreateBlueChromaAttr`
`CreateColorSpaceAttrsWithChroma`
`CreateColorSpaceAttrsWithMatrix`
`CreateGammaAttr`
`CreateGreenChromaAttr`
`CreateLinearBiasAttr`
`CreateNameAttr`
`CreateRedChromaAttr`
`CreateWhitePointAttr`
`Get`
`GetAll`
`GetBlueChromaAttr`
`GetGammaAttr`
`GetGreenChromaAttr`
`GetLinearBiasAttr`
`GetNameAttr`
`GetRedChromaAttr`
`GetSchemaAttributeNames`
`GetWhitePointAttr`
`IsColorSpaceDefinitionAPIPath`