Class UsdStage
Namespace: pxr
Syntax
public class UsdStage : IDisposable
Methods
ClearDefaultPrim()
Declaration
public void ClearDefaultPrim()
Declaration
public bool ClearMetadata(TfToken key)
Parameters
Returns
Declaration
public bool ClearMetadataByDictKey(TfToken key, TfToken keyPath)
Parameters
Returns
CreateClassPrim(SdfPath)
Declaration
public UsdPrim CreateClassPrim(SdfPath rootPrimPath)
Parameters
Type |
Name |
Description |
SdfPath |
rootPrimPath |
|
Returns
CreateInMemory()
Declaration
public static UsdStage CreateInMemory()
Returns
CreateInMemory(UsdStage.InitialLoadSet)
Declaration
public static UsdStage CreateInMemory(UsdStage.InitialLoadSet load)
Parameters
Returns
CreateInMemory(String)
Declaration
public static UsdStage CreateInMemory(string identifier)
Parameters
Type |
Name |
Description |
String |
identifier |
|
Returns
CreateInMemory(String, ArResolverContext)
Declaration
public static UsdStage CreateInMemory(string identifier, ArResolverContext pathResolverContext)
Parameters
Returns
CreateInMemory(String, ArResolverContext, UsdStage.InitialLoadSet)
Declaration
public static UsdStage CreateInMemory(string identifier, ArResolverContext pathResolverContext, UsdStage.InitialLoadSet load)
Parameters
Returns
CreateInMemory(String, SdfLayerHandle)
Declaration
public static UsdStage CreateInMemory(string identifier, SdfLayerHandle sessionLayer)
Parameters
Returns
CreateInMemory(String, SdfLayerHandle, ArResolverContext)
Declaration
public static UsdStage CreateInMemory(string identifier, SdfLayerHandle sessionLayer, ArResolverContext pathResolverContext)
Parameters
Returns
CreateInMemory(String, SdfLayerHandle, ArResolverContext, UsdStage.InitialLoadSet)
Declaration
public static UsdStage CreateInMemory(string identifier, SdfLayerHandle sessionLayer, ArResolverContext pathResolverContext, UsdStage.InitialLoadSet load)
Parameters
Returns
CreateInMemory(String, SdfLayerHandle, UsdStage.InitialLoadSet)
Declaration
public static UsdStage CreateInMemory(string identifier, SdfLayerHandle sessionLayer, UsdStage.InitialLoadSet load)
Parameters
Returns
CreateInMemory(String, UsdStage.InitialLoadSet)
Declaration
public static UsdStage CreateInMemory(string identifier, UsdStage.InitialLoadSet load)
Parameters
Returns
CreateNew(String)
Declaration
public static UsdStage CreateNew(string identifier)
Parameters
Type |
Name |
Description |
String |
identifier |
|
Returns
CreateNew(String, ArResolverContext)
Declaration
public static UsdStage CreateNew(string identifier, ArResolverContext pathResolverContext)
Parameters
Returns
CreateNew(String, ArResolverContext, UsdStage.InitialLoadSet)
Declaration
public static UsdStage CreateNew(string identifier, ArResolverContext pathResolverContext, UsdStage.InitialLoadSet load)
Parameters
Returns
CreateNew(String, SdfLayerHandle)
Declaration
public static UsdStage CreateNew(string identifier, SdfLayerHandle sessionLayer)
Parameters
Returns
CreateNew(String, SdfLayerHandle, ArResolverContext)
Declaration
public static UsdStage CreateNew(string identifier, SdfLayerHandle sessionLayer, ArResolverContext pathResolverContext)
Parameters
Returns
CreateNew(String, SdfLayerHandle, ArResolverContext, UsdStage.InitialLoadSet)
Declaration
public static UsdStage CreateNew(string identifier, SdfLayerHandle sessionLayer, ArResolverContext pathResolverContext, UsdStage.InitialLoadSet load)
Parameters
Returns
CreateNew(String, SdfLayerHandle, UsdStage.InitialLoadSet)
Declaration
public static UsdStage CreateNew(string identifier, SdfLayerHandle sessionLayer, UsdStage.InitialLoadSet load)
Parameters
Returns
CreateNew(String, UsdStage.InitialLoadSet)
Declaration
public static UsdStage CreateNew(string identifier, UsdStage.InitialLoadSet load)
Parameters
Returns
DefinePrim(SdfPath)
Declaration
public UsdPrim DefinePrim(SdfPath path)
Parameters
Returns
DefinePrim(SdfPath, TfToken)
Declaration
public UsdPrim DefinePrim(SdfPath path, TfToken typeName)
Parameters
Returns
Dispose()
Declaration
public virtual void Dispose()
Implements
Export(String)
Declaration
public bool Export(string filename)
Parameters
Type |
Name |
Description |
String |
filename |
|
Returns
Export(String, Boolean)
Declaration
public bool Export(string filename, bool addSourceFileComment)
Parameters
Type |
Name |
Description |
String |
filename |
|
Boolean |
addSourceFileComment |
|
Returns
Export(String, Boolean, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)
Declaration
public bool Export(string filename, bool addSourceFileComment, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Returns
ExportToString(out String)
Declaration
public bool ExportToString(out string result)
Parameters
Type |
Name |
Description |
String |
result |
|
Returns
ExportToString(out String, Boolean)
Declaration
public bool ExportToString(out string result, bool addSourceFileComment)
Parameters
Returns
Finalize()
Declaration
protected void Finalize()
FindLoadable()
Declaration
public SWIGTYPE_p_std__setT_SdfPath_t FindLoadable()
Returns
FindLoadable(SdfPath)
Declaration
public SWIGTYPE_p_std__setT_SdfPath_t FindLoadable(SdfPath rootPath)
Parameters
Type |
Name |
Description |
SdfPath |
rootPath |
|
Returns
Flatten()
Declaration
public SdfLayer Flatten()
Returns
Flatten(Boolean)
Declaration
public SdfLayer Flatten(bool addSourceFileComment)
Parameters
Type |
Name |
Description |
Boolean |
addSourceFileComment |
|
Returns
GetAllPaths()
Declaration
public SdfPathVector GetAllPaths()
Returns
GetAllPathsByType(String, SdfPath)
Declaration
public SdfPathVector GetAllPathsByType(string typeName, SdfPath rootPath)
Parameters
Returns
GetAllPrims()
Declaration
public UsdPrimVector GetAllPrims()
Returns
GetAllPrimsByType(String)
Declaration
public UsdPrimVector GetAllPrimsByType(string typeName)
Parameters
Type |
Name |
Description |
String |
typeName |
|
Returns
GetAttributeAtPath(SdfPath)
Declaration
public UsdAttribute GetAttributeAtPath(SdfPath path)
Parameters
Returns
GetColorConfigFallbacks(SdfAssetPath, TfToken)
Declaration
public static void GetColorConfigFallbacks(SdfAssetPath colorConfiguration, TfToken colorManagementSystem)
Parameters
GetColorConfiguration()
Declaration
public SdfAssetPath GetColorConfiguration()
Returns
GetColorManagementSystem()
Declaration
public TfToken GetColorManagementSystem()
Returns
GetDefaultPrim()
Declaration
public UsdPrim GetDefaultPrim()
Returns
GetEditTarget()
Declaration
public UsdEditTarget GetEditTarget()
Returns
GetEditTargetForLocalLayer(SdfLayerHandle)
Declaration
public UsdEditTarget GetEditTargetForLocalLayer(SdfLayerHandle layer)
Parameters
Returns
GetEditTargetForLocalLayer(UInt32)
Declaration
public UsdEditTarget GetEditTargetForLocalLayer(uint i)
Parameters
Type |
Name |
Description |
UInt32 |
i |
|
Returns
GetEndTimeCode()
Declaration
public double GetEndTimeCode()
Returns
GetFramesPerSecond()
Declaration
public double GetFramesPerSecond()
Returns
GetGlobalVariantFallbacks()
Declaration
public static SWIGTYPE_p_std__mapT_std__string_std__vectorT_std__string_t_std__lessT_std__string_t_t GetGlobalVariantFallbacks()
Returns
GetInterpolationType()
Declaration
public UsdInterpolationType GetInterpolationType()
Returns
GetLayerStack()
Declaration
public SdfLayerHandleVector GetLayerStack()
Returns
GetLayerStack(Boolean)
Declaration
public SdfLayerHandleVector GetLayerStack(bool includeSessionLayers)
Parameters
Type |
Name |
Description |
Boolean |
includeSessionLayers |
|
Returns
GetLoadRules()
Declaration
public UsdStageLoadRules GetLoadRules()
Returns
GetLoadSet()
Declaration
public SWIGTYPE_p_std__setT_SdfPath_t GetLoadSet()
Returns
GetMasters()
Declaration
public UsdPrimVector GetMasters()
Returns
Declaration
public bool GetMetadata(TfToken key, VtValue value)
Parameters
Returns
Declaration
public bool GetMetadataByDictKey(TfToken key, TfToken keyPath, VtValue value)
Parameters
Returns
GetMutedLayers()
Declaration
public StdStringVector GetMutedLayers()
Returns
GetObjectAtPath(SdfPath)
Declaration
public UsdObject GetObjectAtPath(SdfPath path)
Parameters
Returns
GetPathResolverContext()
Declaration
public ArResolverContext GetPathResolverContext()
Returns
GetPopulationMask()
Declaration
public UsdStagePopulationMask GetPopulationMask()
Returns
GetPrimAtPath(SdfPath)
Declaration
public UsdPrim GetPrimAtPath(SdfPath path)
Parameters
Returns
GetPropertyAtPath(SdfPath)
Declaration
public UsdProperty GetPropertyAtPath(SdfPath path)
Parameters
Returns
GetPseudoRoot()
Declaration
public UsdPrim GetPseudoRoot()
Returns
GetRelationshipAtPath(SdfPath)
Declaration
public UsdRelationship GetRelationshipAtPath(SdfPath path)
Parameters
Returns
GetRootLayer()
Declaration
public SdfLayerHandle GetRootLayer()
Returns
GetSessionLayer()
Declaration
public SdfLayerHandle GetSessionLayer()
Returns
GetStartTimeCode()
Declaration
public double GetStartTimeCode()
Returns
GetTimeCodesPerSecond()
Declaration
public double GetTimeCodesPerSecond()
Returns
GetUsedLayers()
Declaration
public SdfLayerHandleVector GetUsedLayers()
Returns
GetUsedLayers(Boolean)
Declaration
public SdfLayerHandleVector GetUsedLayers(bool includeClipLayers)
Parameters
Type |
Name |
Description |
Boolean |
includeClipLayers |
|
Returns
Declaration
public bool HasAuthoredMetadata(TfToken key)
Parameters
Returns
Declaration
public bool HasAuthoredMetadataDictKey(TfToken key, TfToken keyPath)
Parameters
Returns
HasAuthoredTimeCodeRange()
Declaration
public bool HasAuthoredTimeCodeRange()
Returns
HasDefaultPrim()
Declaration
public bool HasDefaultPrim()
Returns
HasLocalLayer(SdfLayerHandle)
Declaration
public bool HasLocalLayer(SdfLayerHandle layer)
Parameters
Returns
Declaration
public bool HasMetadata(TfToken key)
Parameters
Returns
Declaration
public bool HasMetadataDictKey(TfToken key, TfToken keyPath)
Parameters
Returns
IsLayerMuted(String)
Declaration
public bool IsLayerMuted(string layerIdentifier)
Parameters
Type |
Name |
Description |
String |
layerIdentifier |
|
Returns
IsSupportedFile(String)
Declaration
public static bool IsSupportedFile(string filePath)
Parameters
Type |
Name |
Description |
String |
filePath |
|
Returns
Load()
Declaration
Returns
Load(SdfPath)
Declaration
public UsdPrim Load(SdfPath path)
Parameters
Returns
Load(SdfPath, UsdLoadPolicy)
Declaration
public UsdPrim Load(SdfPath path, UsdLoadPolicy policy)
Parameters
Returns
LoadAndUnload(SWIGTYPE_p_std__setT_SdfPath_t, SWIGTYPE_p_std__setT_SdfPath_t)
Declaration
public void LoadAndUnload(SWIGTYPE_p_std__setT_SdfPath_t loadSet, SWIGTYPE_p_std__setT_SdfPath_t unloadSet)
Parameters
LoadAndUnload(SWIGTYPE_p_std__setT_SdfPath_t, SWIGTYPE_p_std__setT_SdfPath_t, UsdLoadPolicy)
Declaration
public void LoadAndUnload(SWIGTYPE_p_std__setT_SdfPath_t loadSet, SWIGTYPE_p_std__setT_SdfPath_t unloadSet, UsdLoadPolicy policy)
Parameters
MuteAndUnmuteLayers(StdStringVector, StdStringVector)
Declaration
public void MuteAndUnmuteLayers(StdStringVector muteLayers, StdStringVector unmuteLayers)
Parameters
MuteLayer(String)
Declaration
public void MuteLayer(string layerIdentifier)
Parameters
Type |
Name |
Description |
String |
layerIdentifier |
|
Open(SdfLayerHandle)
Declaration
public static UsdStage Open(SdfLayerHandle rootLayer)
Parameters
Returns
Open(SdfLayerHandle, ArResolverContext)
Declaration
public static UsdStage Open(SdfLayerHandle rootLayer, ArResolverContext pathResolverContext)
Parameters
Returns
Open(SdfLayerHandle, ArResolverContext, UsdStage.InitialLoadSet)
Declaration
public static UsdStage Open(SdfLayerHandle rootLayer, ArResolverContext pathResolverContext, UsdStage.InitialLoadSet load)
Parameters
Returns
Open(SdfLayerHandle, SdfLayerHandle)
Declaration
public static UsdStage Open(SdfLayerHandle rootLayer, SdfLayerHandle sessionLayer)
Parameters
Returns
Open(SdfLayerHandle, SdfLayerHandle, ArResolverContext)
Declaration
public static UsdStage Open(SdfLayerHandle rootLayer, SdfLayerHandle sessionLayer, ArResolverContext pathResolverContext)
Parameters
Returns
Open(SdfLayerHandle, SdfLayerHandle, ArResolverContext, UsdStage.InitialLoadSet)
Declaration
public static UsdStage Open(SdfLayerHandle rootLayer, SdfLayerHandle sessionLayer, ArResolverContext pathResolverContext, UsdStage.InitialLoadSet load)
Parameters
Returns
Open(SdfLayerHandle, SdfLayerHandle, UsdStage.InitialLoadSet)
Declaration
public static UsdStage Open(SdfLayerHandle rootLayer, SdfLayerHandle sessionLayer, UsdStage.InitialLoadSet load)
Parameters
Returns
Open(SdfLayerHandle, UsdStage.InitialLoadSet)
Declaration
public static UsdStage Open(SdfLayerHandle rootLayer, UsdStage.InitialLoadSet load)
Parameters
Returns
Open(String)
Declaration
public static UsdStage Open(string filePath)
Parameters
Type |
Name |
Description |
String |
filePath |
|
Returns
Open(String, ArResolverContext)
Declaration
public static UsdStage Open(string filePath, ArResolverContext pathResolverContext)
Parameters
Returns
Open(String, ArResolverContext, UsdStage.InitialLoadSet)
Declaration
public static UsdStage Open(string filePath, ArResolverContext pathResolverContext, UsdStage.InitialLoadSet load)
Parameters
Returns
Open(String, UsdStage.InitialLoadSet)
Declaration
public static UsdStage Open(string filePath, UsdStage.InitialLoadSet load)
Parameters
Returns
OpenMasked(SdfLayerHandle, ArResolverContext, UsdStagePopulationMask)
Declaration
public static UsdStage OpenMasked(SdfLayerHandle rootLayer, ArResolverContext pathResolverContext, UsdStagePopulationMask mask)
Parameters
Returns
OpenMasked(SdfLayerHandle, ArResolverContext, UsdStagePopulationMask, UsdStage.InitialLoadSet)
Declaration
public static UsdStage OpenMasked(SdfLayerHandle rootLayer, ArResolverContext pathResolverContext, UsdStagePopulationMask mask, UsdStage.InitialLoadSet load)
Parameters
Returns
OpenMasked(SdfLayerHandle, SdfLayerHandle, ArResolverContext, UsdStagePopulationMask)
Declaration
public static UsdStage OpenMasked(SdfLayerHandle rootLayer, SdfLayerHandle sessionLayer, ArResolverContext pathResolverContext, UsdStagePopulationMask mask)
Parameters
Returns
OpenMasked(SdfLayerHandle, SdfLayerHandle, ArResolverContext, UsdStagePopulationMask, UsdStage.InitialLoadSet)
Declaration
public static UsdStage OpenMasked(SdfLayerHandle rootLayer, SdfLayerHandle sessionLayer, ArResolverContext pathResolverContext, UsdStagePopulationMask mask, UsdStage.InitialLoadSet load)
Parameters
Returns
OpenMasked(SdfLayerHandle, SdfLayerHandle, UsdStagePopulationMask)
Declaration
public static UsdStage OpenMasked(SdfLayerHandle rootLayer, SdfLayerHandle sessionLayer, UsdStagePopulationMask mask)
Parameters
Returns
OpenMasked(SdfLayerHandle, SdfLayerHandle, UsdStagePopulationMask, UsdStage.InitialLoadSet)
Declaration
public static UsdStage OpenMasked(SdfLayerHandle rootLayer, SdfLayerHandle sessionLayer, UsdStagePopulationMask mask, UsdStage.InitialLoadSet load)
Parameters
Returns
OpenMasked(SdfLayerHandle, UsdStagePopulationMask)
Declaration
public static UsdStage OpenMasked(SdfLayerHandle rootLayer, UsdStagePopulationMask mask)
Parameters
Returns
OpenMasked(SdfLayerHandle, UsdStagePopulationMask, UsdStage.InitialLoadSet)
Declaration
public static UsdStage OpenMasked(SdfLayerHandle rootLayer, UsdStagePopulationMask mask, UsdStage.InitialLoadSet load)
Parameters
Returns
OpenMasked(String, ArResolverContext, UsdStagePopulationMask)
Declaration
public static UsdStage OpenMasked(string filePath, ArResolverContext pathResolverContext, UsdStagePopulationMask mask)
Parameters
Returns
OpenMasked(String, ArResolverContext, UsdStagePopulationMask, UsdStage.InitialLoadSet)
Declaration
public static UsdStage OpenMasked(string filePath, ArResolverContext pathResolverContext, UsdStagePopulationMask mask, UsdStage.InitialLoadSet load)
Parameters
Returns
OpenMasked(String, UsdStagePopulationMask)
Declaration
public static UsdStage OpenMasked(string filePath, UsdStagePopulationMask mask)
Parameters
Returns
OpenMasked(String, UsdStagePopulationMask, UsdStage.InitialLoadSet)
Declaration
public static UsdStage OpenMasked(string filePath, UsdStagePopulationMask mask, UsdStage.InitialLoadSet load)
Parameters
Returns
OverridePrim(SdfPath)
Declaration
public UsdPrim OverridePrim(SdfPath path)
Parameters
Returns
Reload()
Declaration
RemovePrim(SdfPath)
Declaration
public bool RemovePrim(SdfPath path)
Parameters
Returns
ResolveIdentifierToEditTarget(String)
Declaration
public string ResolveIdentifierToEditTarget(string identifier)
Parameters
Type |
Name |
Description |
String |
identifier |
|
Returns
Save()
Declaration
SaveSessionLayers()
Declaration
public void SaveSessionLayers()
SetColorConfigFallbacks(SdfAssetPath, TfToken)
Declaration
public static void SetColorConfigFallbacks(SdfAssetPath colorConfiguration, TfToken colorManagementSystem)
Parameters
SetColorConfiguration(SdfAssetPath)
Declaration
public void SetColorConfiguration(SdfAssetPath colorConfig)
Parameters
SetColorManagementSystem(TfToken)
Declaration
public void SetColorManagementSystem(TfToken cms)
Parameters
SetDefaultPrim(UsdPrim)
Declaration
public void SetDefaultPrim(UsdPrim prim)
Parameters
SetEditTarget(UsdEditTarget)
Declaration
public void SetEditTarget(UsdEditTarget editTarget)
Parameters
SetEndTimeCode(Double)
Declaration
public void SetEndTimeCode(double arg0)
Parameters
Type |
Name |
Description |
Double |
arg0 |
|
SetFramesPerSecond(Double)
Declaration
public void SetFramesPerSecond(double framesPerSecond)
Parameters
Type |
Name |
Description |
Double |
framesPerSecond |
|
SetGlobalVariantFallbacks(SWIGTYPE_p_std__mapT_std__string_std__vectorT_std__string_t_std__lessT_std__string_t_t)
Declaration
public static void SetGlobalVariantFallbacks(SWIGTYPE_p_std__mapT_std__string_std__vectorT_std__string_t_std__lessT_std__string_t_t fallbacks)
Parameters
SetInterpolationType(UsdInterpolationType)
Declaration
public void SetInterpolationType(UsdInterpolationType interpolationType)
Parameters
SetLoadRules(UsdStageLoadRules)
Declaration
public void SetLoadRules(UsdStageLoadRules rules)
Parameters
Declaration
public bool SetMetadata(TfToken key, VtValue value)
Parameters
Returns
Declaration
public bool SetMetadataByDictKey(TfToken key, TfToken keyPath, VtValue value)
Parameters
Returns
SetPopulationMask(UsdStagePopulationMask)
Declaration
public void SetPopulationMask(UsdStagePopulationMask mask)
Parameters
SetStartTimeCode(Double)
Declaration
public void SetStartTimeCode(double arg0)
Parameters
Type |
Name |
Description |
Double |
arg0 |
|
SetTimeCodesPerSecond(Double)
Declaration
public void SetTimeCodesPerSecond(double timeCodesPerSecond)
Parameters
Type |
Name |
Description |
Double |
timeCodesPerSecond |
|
Traverse()
Declaration
public UsdPrimRange Traverse()
Returns
Traverse(Usd_PrimFlagsPredicate)
Declaration
public UsdPrimRange Traverse(Usd_PrimFlagsPredicate predicate)
Parameters
Returns
TraverseAll()
Declaration
public UsdPrimRange TraverseAll()
Returns
Unload()
Declaration
Unload(SdfPath)
Declaration
public void Unload(SdfPath path)
Parameters
UnmuteLayer(String)
Declaration
public void UnmuteLayer(string layerIdentifier)
Parameters
Type |
Name |
Description |
String |
layerIdentifier |
|
WriteFallbackPrimTypes()
Declaration
public void WriteFallbackPrimTypes()