Class SdfLayerHandle

Inheritance
Object
SdfLayerHandle
Inherited Members
Namespace: pxr
Syntax
public class SdfLayerHandle : IDisposable

Constructors

SdfLayerHandle(SdfLayer)

Declaration
public SdfLayerHandle(SdfLayer layer)
Parameters
Type Name Description
SdfLayer layer

Fields

swigCMemOwn

Declaration
protected bool swigCMemOwn
Field Value
Type Description
Boolean

Methods

__deref__()

Declaration
public SdfLayer __deref__()
Returns
Type Description
SdfLayer

AddToMutedLayers(String)

Declaration
public void AddToMutedLayers(string mutedPath)
Parameters
Type Name Description
String mutedPath

Apply(SdfBatchNamespaceEdit)

Declaration
public bool Apply(SdfBatchNamespaceEdit arg0)
Parameters
Type Name Description
SdfBatchNamespaceEdit arg0
Returns
Type Description
Boolean

ApplyRootPrimOrder(TfTokenVector)

Declaration
public void ApplyRootPrimOrder(TfTokenVector vec)
Parameters
Type Name Description
TfTokenVector vec

CanApply(SdfBatchNamespaceEdit)

Declaration
public SdfNamespaceEditDetail.Result CanApply(SdfBatchNamespaceEdit arg0)
Parameters
Type Name Description
SdfBatchNamespaceEdit arg0
Returns
Type Description
SdfNamespaceEditDetail.Result

CanApply(SdfBatchNamespaceEdit, SdfNamespaceEditDetailVector)

Declaration
public SdfNamespaceEditDetail.Result CanApply(SdfBatchNamespaceEdit arg0, SdfNamespaceEditDetailVector details)
Parameters
Type Name Description
SdfBatchNamespaceEdit arg0
SdfNamespaceEditDetailVector details
Returns
Type Description
SdfNamespaceEditDetail.Result

Clear()

Declaration
public void Clear()

ClearColorConfiguration()

Declaration
public void ClearColorConfiguration()

ClearColorManagementSystem()

Declaration
public void ClearColorManagementSystem()

ClearCustomLayerData()

Declaration
public void ClearCustomLayerData()

ClearDefaultPrim()

Declaration
public void ClearDefaultPrim()

ClearEndTimeCode()

Declaration
public void ClearEndTimeCode()

ClearFramePrecision()

Declaration
public void ClearFramePrecision()

ClearFramesPerSecond()

Declaration
public void ClearFramesPerSecond()

ClearOwner()

Declaration
public void ClearOwner()

ClearSessionOwner()

Declaration
public void ClearSessionOwner()

ClearStartTimeCode()

Declaration
public void ClearStartTimeCode()

ClearTimeCodesPerSecond()

Declaration
public void ClearTimeCodesPerSecond()

ComputeAbsolutePath(String)

Declaration
public string ComputeAbsolutePath(string relativePath)
Parameters
Type Name Description
String relativePath
Returns
Type Description
String

ComputeRealPath(String)

Declaration
public string ComputeRealPath(string layerPath)
Parameters
Type Name Description
String layerPath
Returns
Type Description
String

CreateAnonymous()

Declaration
public SdfLayer CreateAnonymous()
Returns
Type Description
SdfLayer

CreateAnonymous(String)

Declaration
public SdfLayer CreateAnonymous(string tag)
Parameters
Type Name Description
String tag
Returns
Type Description
SdfLayer

CreateAnonymous(String, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public SdfLayer CreateAnonymous(string tag, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Type Name Description
String tag
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args
Returns
Type Description
SdfLayer

CreateAnonymous(String, SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr)

Declaration
public SdfLayer CreateAnonymous(string tag, SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr format)
Parameters
Type Name Description
String tag
SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr format
Returns
Type Description
SdfLayer

CreateAnonymous(String, SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public SdfLayer CreateAnonymous(string tag, SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr format, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Type Name Description
String tag
SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr format
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args
Returns
Type Description
SdfLayer

CreateIdentifier(String, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public string CreateIdentifier(string layerPath, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t arguments)
Parameters
Type Name Description
String layerPath
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t arguments
Returns
Type Description
String

CreateNew(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr, String)

Declaration
public SdfLayer CreateNew(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat, string identifier)
Parameters
Type Name Description
SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat
String identifier
Returns
Type Description
SdfLayer

CreateNew(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr, String, String)

Declaration
public SdfLayer CreateNew(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat, string identifier, string realPath)
Parameters
Type Name Description
SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat
String identifier
String realPath
Returns
Type Description
SdfLayer

CreateNew(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr, String, String, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public SdfLayer CreateNew(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat, string identifier, string realPath, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Type Name Description
SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat
String identifier
String realPath
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args
Returns
Type Description
SdfLayer

CreateNew(String)

Declaration
public SdfLayer CreateNew(string identifier)
Parameters
Type Name Description
String identifier
Returns
Type Description
SdfLayer

CreateNew(String, String)

Declaration
public SdfLayer CreateNew(string identifier, string realPath)
Parameters
Type Name Description
String identifier
String realPath
Returns
Type Description
SdfLayer

CreateNew(String, String, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public SdfLayer CreateNew(string identifier, string realPath, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Type Name Description
String identifier
String realPath
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args
Returns
Type Description
SdfLayer

Dispose()

Declaration
public virtual void Dispose()
Implements

DumpLayerInfo()

Declaration
public void DumpLayerInfo()

EraseField(SdfPath, TfToken)

Declaration
public void EraseField(SdfPath path, TfToken fieldName)
Parameters
Type Name Description
SdfPath path
TfToken fieldName

EraseFieldDictValueByKey(SdfPath, TfToken, TfToken)

Declaration
public void EraseFieldDictValueByKey(SdfPath path, TfToken fieldName, TfToken keyPath)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
TfToken keyPath

EraseTimeSample(SdfPath, Double)

Declaration
public void EraseTimeSample(SdfPath path, double time)
Parameters
Type Name Description
SdfPath path
Double time

Export(String)

Declaration
public bool Export(string filename)
Parameters
Type Name Description
String filename
Returns
Type Description
Boolean

Export(String, String)

Declaration
public bool Export(string filename, string comment)
Parameters
Type Name Description
String filename
String comment
Returns
Type Description
Boolean

Export(String, String, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public bool Export(string filename, string comment, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Type Name Description
String filename
String comment
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args
Returns
Type Description
Boolean

ExportToString()

Declaration
public string ExportToString()
Returns
Type Description
String

Finalize()

Declaration
protected void Finalize()

Find(String)

Declaration
public SdfLayerHandle Find(string identifier)
Parameters
Type Name Description
String identifier
Returns
Type Description
SdfLayerHandle

Find(String, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public SdfLayerHandle Find(string identifier, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Type Name Description
String identifier
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args
Returns
Type Description
SdfLayerHandle

FindOrOpen(String)

Declaration
public SdfLayer FindOrOpen(string identifier)
Parameters
Type Name Description
String identifier
Returns
Type Description
SdfLayer

FindOrOpen(String, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public SdfLayer FindOrOpen(string identifier, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Type Name Description
String identifier
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args
Returns
Type Description
SdfLayer

FindRelativeToLayer(SdfLayerHandle, String)

Declaration
public SdfLayerHandle FindRelativeToLayer(SdfLayerHandle anchor, string layerPath)
Parameters
Type Name Description
SdfLayerHandle anchor
String layerPath
Returns
Type Description
SdfLayerHandle

FindRelativeToLayer(SdfLayerHandle, String, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public SdfLayerHandle FindRelativeToLayer(SdfLayerHandle anchor, string layerPath, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Type Name Description
SdfLayerHandle anchor
String layerPath
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args
Returns
Type Description
SdfLayerHandle

GetAssetInfo()

Declaration
public VtValue GetAssetInfo()
Returns
Type Description
VtValue

GetAssetName()

Declaration
public string GetAssetName()
Returns
Type Description
String

GetAttributeAtPath(SdfPath)

Declaration
public SdfAttributeSpecHandle GetAttributeAtPath(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
SdfAttributeSpecHandle

GetBracketingTimeSamples(Double, ref Double, ref Double)

Declaration
public bool GetBracketingTimeSamples(double time, ref double tLower, ref double tUpper)
Parameters
Type Name Description
Double time
Double tLower
Double tUpper
Returns
Type Description
Boolean

GetBracketingTimeSamplesForPath(SdfPath, Double, ref Double, ref Double)

Declaration
public bool GetBracketingTimeSamplesForPath(SdfPath path, double time, ref double tLower, ref double tUpper)
Parameters
Type Name Description
SdfPath path
Double time
Double tLower
Double tUpper
Returns
Type Description
Boolean

GetColorConfiguration()

Declaration
public SdfAssetPath GetColorConfiguration()
Returns
Type Description
SdfAssetPath

GetColorManagementSystem()

Declaration
public TfToken GetColorManagementSystem()
Returns
Type Description
TfToken

GetComment()

Declaration
public string GetComment()
Returns
Type Description
String

GetCustomLayerData()

Declaration
public VtDictionary GetCustomLayerData()
Returns
Type Description
VtDictionary

GetDefaultPrim()

Declaration
public TfToken GetDefaultPrim()
Returns
Type Description
TfToken

GetDisplayName()

Declaration
public string GetDisplayName()
Returns
Type Description
String

GetDisplayNameFromIdentifier(String)

Declaration
public string GetDisplayNameFromIdentifier(string identifier)
Parameters
Type Name Description
String identifier
Returns
Type Description
String

GetDocumentation()

Declaration
public string GetDocumentation()
Returns
Type Description
String

GetEndTimeCode()

Declaration
public double GetEndTimeCode()
Returns
Type Description
Double

GetExternalReferences()

Declaration
public SWIGTYPE_p_std__setT_std__string_t GetExternalReferences()
Returns
Type Description
SWIGTYPE_p_std__setT_std__string_t

GetField(SdfPath, TfToken)

Declaration
public VtValue GetField(SdfPath path, TfToken fieldName)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
Returns
Type Description
VtValue

GetFieldDictValueByKey(SdfPath, TfToken, TfToken)

Declaration
public VtValue GetFieldDictValueByKey(SdfPath path, TfToken fieldName, TfToken keyPath)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
TfToken keyPath
Returns
Type Description
VtValue

GetFieldTypeid(SdfPath, TfToken)

Declaration
public SWIGTYPE_p_std__type_info GetFieldTypeid(SdfPath path, TfToken name)
Parameters
Type Name Description
SdfPath path
TfToken name
Returns
Type Description
SWIGTYPE_p_std__type_info

GetFileExtension()

Declaration
public string GetFileExtension()
Returns
Type Description
String

GetFileFormat()

Declaration
public SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr GetFileFormat()
Returns
Type Description
SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr

GetFileFormatArguments()

Declaration
public SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t GetFileFormatArguments()
Returns
Type Description
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t

GetFramePrecision()

Declaration
public int GetFramePrecision()
Returns
Type Description
Int32

GetFramesPerSecond()

Declaration
public double GetFramesPerSecond()
Returns
Type Description
Double

GetHasOwnedSubLayers()

Declaration
public bool GetHasOwnedSubLayers()
Returns
Type Description
Boolean

GetIdentifier()

Declaration
public string GetIdentifier()
Returns
Type Description
String

GetLoadedLayers()

Declaration
public SWIGTYPE_p_SdfLayerHandleSet GetLoadedLayers()
Returns
Type Description
SWIGTYPE_p_SdfLayerHandleSet

GetMutedLayers()

Declaration
public SWIGTYPE_p_std__setT_std__string_t GetMutedLayers()
Returns
Type Description
SWIGTYPE_p_std__setT_std__string_t

GetNumSubLayerPaths()

Declaration
public uint GetNumSubLayerPaths()
Returns
Type Description
UInt32

GetNumTimeSamplesForPath(SdfPath)

Declaration
public uint GetNumTimeSamplesForPath(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
UInt32

GetObjectAtPath(SdfPath)

Declaration
public SdfSpecHandle GetObjectAtPath(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
SdfSpecHandle

GetOwner()

Declaration
public string GetOwner()
Returns
Type Description
String

GetPrimAtPath(SdfPath)

Declaration
public SdfPrimSpecHandle GetPrimAtPath(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
SdfPrimSpecHandle

GetPropertyAtPath(SdfPath)

Declaration
public SdfPropertySpecHandle GetPropertyAtPath(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
SdfPropertySpecHandle

GetPseudoRoot()

Declaration
public SdfPrimSpecHandle GetPseudoRoot()
Returns
Type Description
SdfPrimSpecHandle

GetRealPath()

Declaration
public string GetRealPath()
Returns
Type Description
String

GetRelationshipAtPath(SdfPath)

Declaration
public SdfRelationshipSpecHandle GetRelationshipAtPath(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
SdfRelationshipSpecHandle

GetRepositoryPath()

Declaration
public string GetRepositoryPath()
Returns
Type Description
String

GetRootPrims()

Declaration
public SWIGTYPE_p_SdfPrimSpecView GetRootPrims()
Returns
Type Description
SWIGTYPE_p_SdfPrimSpecView

GetSchema()

Declaration
public SWIGTYPE_p_SdfSchemaBase GetSchema()
Returns
Type Description
SWIGTYPE_p_SdfSchemaBase

GetSessionOwner()

Declaration
public string GetSessionOwner()
Returns
Type Description
String

GetSpecType(SdfPath)

Declaration
public SdfSpecType GetSpecType(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
SdfSpecType

GetStartTimeCode()

Declaration
public double GetStartTimeCode()
Returns
Type Description
Double

GetStateDelegate()

Declaration
public SWIGTYPE_p_TfDeclarePtrsT_SdfLayerStateDelegateBase_t__Ptr GetStateDelegate()
Returns
Type Description
SWIGTYPE_p_TfDeclarePtrsT_SdfLayerStateDelegateBase_t__Ptr

GetSubLayerOffset(Int32)

Declaration
public SdfLayerOffset GetSubLayerOffset(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
SdfLayerOffset

GetSubLayerOffsets()

Declaration
public SdfLayerOffsetVector GetSubLayerOffsets()
Returns
Type Description
SdfLayerOffsetVector

GetSubLayerPaths()

Declaration
public SdfSubLayerProxy GetSubLayerPaths()
Returns
Type Description
SdfSubLayerProxy

GetTimeCodesPerSecond()

Declaration
public double GetTimeCodesPerSecond()
Returns
Type Description
Double

GetVersion()

Declaration
public string GetVersion()
Returns
Type Description
String

HasColorConfiguration()

Declaration
public bool HasColorConfiguration()
Returns
Type Description
Boolean

HasColorManagementSystem()

Declaration
public bool HasColorManagementSystem()
Returns
Type Description
Boolean

HasCustomLayerData()

Declaration
public bool HasCustomLayerData()
Returns
Type Description
Boolean

HasDefaultPrim()

Declaration
public bool HasDefaultPrim()
Returns
Type Description
Boolean

HasEndTimeCode()

Declaration
public bool HasEndTimeCode()
Returns
Type Description
Boolean

HasField(SdfPath, TfToken)

Declaration
public bool HasField(SdfPath path, TfToken fieldName)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
Returns
Type Description
Boolean

HasField(SdfPath, TfToken, SWIGTYPE_p_SdfAbstractDataValue)

Declaration
public bool HasField(SdfPath path, TfToken fieldName, SWIGTYPE_p_SdfAbstractDataValue value)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
SWIGTYPE_p_SdfAbstractDataValue value
Returns
Type Description
Boolean

HasField(SdfPath, TfToken, VtValue)

Declaration
public bool HasField(SdfPath path, TfToken fieldName, VtValue value)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
VtValue value
Returns
Type Description
Boolean

HasFieldDictKey(SdfPath, TfToken, TfToken)

Declaration
public bool HasFieldDictKey(SdfPath path, TfToken fieldName, TfToken keyPath)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
TfToken keyPath
Returns
Type Description
Boolean

HasFieldDictKey(SdfPath, TfToken, TfToken, SWIGTYPE_p_SdfAbstractDataValue)

Declaration
public bool HasFieldDictKey(SdfPath path, TfToken fieldName, TfToken keyPath, SWIGTYPE_p_SdfAbstractDataValue value)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
TfToken keyPath
SWIGTYPE_p_SdfAbstractDataValue value
Returns
Type Description
Boolean

HasFieldDictKey(SdfPath, TfToken, TfToken, VtValue)

Declaration
public bool HasFieldDictKey(SdfPath path, TfToken fieldName, TfToken keyPath, VtValue value)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
TfToken keyPath
VtValue value
Returns
Type Description
Boolean

HasFramePrecision()

Declaration
public bool HasFramePrecision()
Returns
Type Description
Boolean

HasFramesPerSecond()

Declaration
public bool HasFramesPerSecond()
Returns
Type Description
Boolean

HasOwner()

Declaration
public bool HasOwner()
Returns
Type Description
Boolean

HasSessionOwner()

Declaration
public bool HasSessionOwner()
Returns
Type Description
Boolean

HasSpec(SdfPath)

Declaration
public bool HasSpec(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
Boolean

HasStartTimeCode()

Declaration
public bool HasStartTimeCode()
Returns
Type Description
Boolean

HasTimeCodesPerSecond()

Declaration
public bool HasTimeCodesPerSecond()
Returns
Type Description
Boolean

Import(String)

Declaration
public bool Import(string layerPath)
Parameters
Type Name Description
String layerPath
Returns
Type Description
Boolean

ImportFromString(String)

Declaration
public bool ImportFromString(string arg0)
Parameters
Type Name Description
String arg0
Returns
Type Description
Boolean

InsertInRootPrimOrder(TfToken)

Declaration
public void InsertInRootPrimOrder(TfToken name)
Parameters
Type Name Description
TfToken name

InsertInRootPrimOrder(TfToken, Int32)

Declaration
public void InsertInRootPrimOrder(TfToken name, int index)
Parameters
Type Name Description
TfToken name
Int32 index

InsertRootPrim(SdfPrimSpecHandle)

Declaration
public bool InsertRootPrim(SdfPrimSpecHandle prim)
Parameters
Type Name Description
SdfPrimSpecHandle prim
Returns
Type Description
Boolean

InsertRootPrim(SdfPrimSpecHandle, Int32)

Declaration
public bool InsertRootPrim(SdfPrimSpecHandle prim, int index)
Parameters
Type Name Description
SdfPrimSpecHandle prim
Int32 index
Returns
Type Description
Boolean

InsertSubLayerPath(String)

Declaration
public void InsertSubLayerPath(string path)
Parameters
Type Name Description
String path

InsertSubLayerPath(String, Int32)

Declaration
public void InsertSubLayerPath(string path, int index)
Parameters
Type Name Description
String path
Int32 index

IsAnonymous()

Declaration
public bool IsAnonymous()
Returns
Type Description
Boolean

IsAnonymousLayerIdentifier(String)

Declaration
public bool IsAnonymousLayerIdentifier(string identifier)
Parameters
Type Name Description
String identifier
Returns
Type Description
Boolean

IsDirty()

Declaration
public bool IsDirty()
Returns
Type Description
Boolean

IsEmpty()

Declaration
public bool IsEmpty()
Returns
Type Description
Boolean

IsMuted()

Declaration
public bool IsMuted()
Returns
Type Description
Boolean

IsMuted(String)

Declaration
public bool IsMuted(string path)
Parameters
Type Name Description
String path
Returns
Type Description
Boolean

ListAllTimeSamples()

Declaration
public SWIGTYPE_p_std__setT_double_t ListAllTimeSamples()
Returns
Type Description
SWIGTYPE_p_std__setT_double_t

ListFields(SdfPath)

Declaration
public TfTokenVector ListFields(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
TfTokenVector

ListTimeSamplesForPath(SdfPath)

Declaration
public SWIGTYPE_p_std__setT_double_t ListTimeSamplesForPath(SdfPath path)
Parameters
Type Name Description
SdfPath path
Returns
Type Description
SWIGTYPE_p_std__setT_double_t

New(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr, String)

Declaration
public SdfLayer New(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat, string identifier)
Parameters
Type Name Description
SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat
String identifier
Returns
Type Description
SdfLayer

New(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr, String, String)

Declaration
public SdfLayer New(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat, string identifier, string realPath)
Parameters
Type Name Description
SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat
String identifier
String realPath
Returns
Type Description
SdfLayer

New(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr, String, String, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public SdfLayer New(SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat, string identifier, string realPath, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args)
Parameters
Type Name Description
SWIGTYPE_p_TfDeclarePtrsT_SdfFileFormat_t__ConstPtr fileFormat
String identifier
String realPath
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t args
Returns
Type Description
SdfLayer

OpenAsAnonymous(String)

Declaration
public SdfLayer OpenAsAnonymous(string layerPath)
Parameters
Type Name Description
String layerPath
Returns
Type Description
SdfLayer

OpenAsAnonymous(String, Boolean)

Declaration
public SdfLayer OpenAsAnonymous(string layerPath, bool metadataOnly)
Parameters
Type Name Description
String layerPath
Boolean metadataOnly
Returns
Type Description
SdfLayer

OpenAsAnonymous(String, Boolean, String)

Declaration
public SdfLayer OpenAsAnonymous(string layerPath, bool metadataOnly, string tag)
Parameters
Type Name Description
String layerPath
Boolean metadataOnly
String tag
Returns
Type Description
SdfLayer

PermissionToEdit()

Declaration
public bool PermissionToEdit()
Returns
Type Description
Boolean

PermissionToSave()

Declaration
public bool PermissionToSave()
Returns
Type Description
Boolean

QueryTimeSample(SdfPath, Double)

Declaration
public bool QueryTimeSample(SdfPath path, double time)
Parameters
Type Name Description
SdfPath path
Double time
Returns
Type Description
Boolean

QueryTimeSample(SdfPath, Double, SWIGTYPE_p_SdfAbstractDataValue)

Declaration
public bool QueryTimeSample(SdfPath path, double time, SWIGTYPE_p_SdfAbstractDataValue value)
Parameters
Type Name Description
SdfPath path
Double time
SWIGTYPE_p_SdfAbstractDataValue value
Returns
Type Description
Boolean

QueryTimeSample(SdfPath, Double, VtValue)

Declaration
public bool QueryTimeSample(SdfPath path, double time, VtValue value)
Parameters
Type Name Description
SdfPath path
Double time
VtValue value
Returns
Type Description
Boolean

Reload()

Declaration
public bool Reload()
Returns
Type Description
Boolean

Reload(Boolean)

Declaration
public bool Reload(bool force)
Parameters
Type Name Description
Boolean force
Returns
Type Description
Boolean

ReloadLayers(SWIGTYPE_p_std__setT_SdfLayerHandle_t)

Declaration
public bool ReloadLayers(SWIGTYPE_p_std__setT_SdfLayerHandle_t layers)
Parameters
Type Name Description
SWIGTYPE_p_std__setT_SdfLayerHandle_t layers
Returns
Type Description
Boolean

ReloadLayers(SWIGTYPE_p_std__setT_SdfLayerHandle_t, Boolean)

Declaration
public bool ReloadLayers(SWIGTYPE_p_std__setT_SdfLayerHandle_t layers, bool force)
Parameters
Type Name Description
SWIGTYPE_p_std__setT_SdfLayerHandle_t layers
Boolean force
Returns
Type Description
Boolean

RemoveFromMutedLayers(String)

Declaration
public void RemoveFromMutedLayers(string mutedPath)
Parameters
Type Name Description
String mutedPath

RemoveFromRootPrimOrder(TfToken)

Declaration
public void RemoveFromRootPrimOrder(TfToken name)
Parameters
Type Name Description
TfToken name

RemoveFromRootPrimOrderByIndex(Int32)

Declaration
public void RemoveFromRootPrimOrderByIndex(int index)
Parameters
Type Name Description
Int32 index

RemoveInertSceneDescription()

Declaration
public void RemoveInertSceneDescription()

RemovePrimIfInert(SdfPrimSpecHandle)

Declaration
public void RemovePrimIfInert(SdfPrimSpecHandle prim)
Parameters
Type Name Description
SdfPrimSpecHandle prim

RemovePropertyIfHasOnlyRequiredFields(SdfPropertySpecHandle)

Declaration
public void RemovePropertyIfHasOnlyRequiredFields(SdfPropertySpecHandle prop)
Parameters
Type Name Description
SdfPropertySpecHandle prop

RemoveRootPrim(SdfPrimSpecHandle)

Declaration
public void RemoveRootPrim(SdfPrimSpecHandle prim)
Parameters
Type Name Description
SdfPrimSpecHandle prim

RemoveSubLayerPath(Int32)

Declaration
public void RemoveSubLayerPath(int index)
Parameters
Type Name Description
Int32 index

Save()

Declaration
public bool Save()
Returns
Type Description
Boolean

Save(Boolean)

Declaration
public bool Save(bool force)
Parameters
Type Name Description
Boolean force
Returns
Type Description
Boolean

ScheduleRemoveIfInert(SdfSpec)

Declaration
public void ScheduleRemoveIfInert(SdfSpec spec)
Parameters
Type Name Description
SdfSpec spec

SetColorConfiguration(SdfAssetPath)

Declaration
public void SetColorConfiguration(SdfAssetPath colorConfiguration)
Parameters
Type Name Description
SdfAssetPath colorConfiguration

SetColorManagementSystem(TfToken)

Declaration
public void SetColorManagementSystem(TfToken cms)
Parameters
Type Name Description
TfToken cms

SetComment(String)

Declaration
public void SetComment(string comment)
Parameters
Type Name Description
String comment

SetCustomLayerData(VtDictionary)

Declaration
public void SetCustomLayerData(VtDictionary value)
Parameters
Type Name Description
VtDictionary value

SetDefaultPrim(TfToken)

Declaration
public void SetDefaultPrim(TfToken name)
Parameters
Type Name Description
TfToken name

SetDocumentation(String)

Declaration
public void SetDocumentation(string documentation)
Parameters
Type Name Description
String documentation

SetEndTimeCode(Double)

Declaration
public void SetEndTimeCode(double endTimeCode)
Parameters
Type Name Description
Double endTimeCode

SetField(SdfPath, TfToken, SWIGTYPE_p_SdfAbstractDataConstValue)

Declaration
public void SetField(SdfPath path, TfToken fieldName, SWIGTYPE_p_SdfAbstractDataConstValue value)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
SWIGTYPE_p_SdfAbstractDataConstValue value

SetField(SdfPath, TfToken, VtValue)

Declaration
public void SetField(SdfPath path, TfToken fieldName, VtValue value)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
VtValue value

SetFieldDictValueByKey(SdfPath, TfToken, TfToken, SWIGTYPE_p_SdfAbstractDataConstValue)

Declaration
public void SetFieldDictValueByKey(SdfPath path, TfToken fieldName, TfToken keyPath, SWIGTYPE_p_SdfAbstractDataConstValue value)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
TfToken keyPath
SWIGTYPE_p_SdfAbstractDataConstValue value

SetFieldDictValueByKey(SdfPath, TfToken, TfToken, VtValue)

Declaration
public void SetFieldDictValueByKey(SdfPath path, TfToken fieldName, TfToken keyPath, VtValue value)
Parameters
Type Name Description
SdfPath path
TfToken fieldName
TfToken keyPath
VtValue value

SetFramePrecision(Int32)

Declaration
public void SetFramePrecision(int framePrecision)
Parameters
Type Name Description
Int32 framePrecision

SetFramesPerSecond(Double)

Declaration
public void SetFramesPerSecond(double framesPerSecond)
Parameters
Type Name Description
Double framesPerSecond

SetHasOwnedSubLayers(Boolean)

Declaration
public void SetHasOwnedSubLayers(bool arg0)
Parameters
Type Name Description
Boolean arg0

SetIdentifier(String)

Declaration
public void SetIdentifier(string identifier)
Parameters
Type Name Description
String identifier

SetMuted(Boolean)

Declaration
public void SetMuted(bool muted)
Parameters
Type Name Description
Boolean muted

SetOwner(String)

Declaration
public void SetOwner(string owner)
Parameters
Type Name Description
String owner

SetPermissionToEdit(Boolean)

Declaration
public void SetPermissionToEdit(bool allow)
Parameters
Type Name Description
Boolean allow

SetPermissionToSave(Boolean)

Declaration
public void SetPermissionToSave(bool allow)
Parameters
Type Name Description
Boolean allow

SetRootPrimOrder(TfTokenVector)

Declaration
public void SetRootPrimOrder(TfTokenVector names)
Parameters
Type Name Description
TfTokenVector names

SetRootPrims(SdfPrimSpecHandleVector)

Declaration
public void SetRootPrims(SdfPrimSpecHandleVector rootPrims)
Parameters
Type Name Description
SdfPrimSpecHandleVector rootPrims

SetSessionOwner(String)

Declaration
public void SetSessionOwner(string owner)
Parameters
Type Name Description
String owner

SetStartTimeCode(Double)

Declaration
public void SetStartTimeCode(double startTimecode)
Parameters
Type Name Description
Double startTimecode

SetStateDelegate(SWIGTYPE_p_TfDeclarePtrsT_SdfLayerStateDelegateBase_t__RefPtr)

Declaration
public void SetStateDelegate(SWIGTYPE_p_TfDeclarePtrsT_SdfLayerStateDelegateBase_t__RefPtr arg0)
Parameters
Type Name Description
SWIGTYPE_p_TfDeclarePtrsT_SdfLayerStateDelegateBase_t__RefPtr arg0

SetSubLayerOffset(SdfLayerOffset, Int32)

Declaration
public void SetSubLayerOffset(SdfLayerOffset offset, int index)
Parameters
Type Name Description
SdfLayerOffset offset
Int32 index

SetSubLayerPaths(StdStringVector)

Declaration
public void SetSubLayerPaths(StdStringVector newPaths)
Parameters
Type Name Description
StdStringVector newPaths

SetTimeCodesPerSecond(Double)

Declaration
public void SetTimeCodesPerSecond(double timeCodesPerSecond)
Parameters
Type Name Description
Double timeCodesPerSecond

SetTimeSample(SdfPath, Double, SWIGTYPE_p_SdfAbstractDataConstValue)

Declaration
public void SetTimeSample(SdfPath path, double time, SWIGTYPE_p_SdfAbstractDataConstValue value)
Parameters
Type Name Description
SdfPath path
Double time
SWIGTYPE_p_SdfAbstractDataConstValue value

SetTimeSample(SdfPath, Double, VtValue)

Declaration
public void SetTimeSample(SdfPath path, double time, VtValue value)
Parameters
Type Name Description
SdfPath path
Double time
VtValue value

SplitIdentifier(String, SWIGTYPE_p_std__string, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t)

Declaration
public bool SplitIdentifier(string identifier, SWIGTYPE_p_std__string layerPath, SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t arguments)
Parameters
Type Name Description
String identifier
SWIGTYPE_p_std__string layerPath
SWIGTYPE_p_std__mapT_std__string_std__string_std__lessT_std__string_t_t arguments
Returns
Type Description
Boolean

TransferContent(SdfLayerHandle)

Declaration
public void TransferContent(SdfLayerHandle layer)
Parameters
Type Name Description
SdfLayerHandle layer

UpdateAssetInfo()

Declaration
public void UpdateAssetInfo()

UpdateAssetInfo(String)

Declaration
public void UpdateAssetInfo(string fileVersion)
Parameters
Type Name Description
String fileVersion

UpdateExternalReference(String)

Declaration
public bool UpdateExternalReference(string oldAssetPath)
Parameters
Type Name Description
String oldAssetPath
Returns
Type Description
Boolean

UpdateExternalReference(String, String)

Declaration
public bool UpdateExternalReference(string oldAssetPath, string newAssetPath)
Parameters
Type Name Description
String oldAssetPath
String newAssetPath
Returns
Type Description
Boolean

WriteDataFile(String)

Declaration
public bool WriteDataFile(string filename)
Parameters
Type Name Description
String filename
Returns
Type Description
Boolean