Class UsdClipsAPI

Inheritance

Object

UsdSchemaBase

UsdAPISchemaBase

UsdClipsAPI

Inherited Members

UsdSchemaBase.swigCMemOwn

UsdSchemaBase.IsConcrete()

UsdSchemaBase.IsTyped()

UsdSchemaBase.IsAPISchema()

UsdSchemaBase.IsAppliedAPISchema()

UsdSchemaBase.IsMultipleApplyAPISchema()

UsdSchemaBase.GetSchemaType()

UsdSchemaBase.GetPrim()

UsdSchemaBase.GetPath()

UsdSchemaBase.GetSchemaClassPrimDefinition()

UsdSchemaBase.Equals(UsdSchemaBase, UsdSchemaBase)

UsdSchemaBase.GetHashCode()

UsdSchemaBase.Equals(Object)

UsdSchemaBase._IsValid()

Object.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: pxr

Syntax

public class UsdClipsAPI : UsdAPISchemaBase, IDisposable

Constructors

UsdClipsAPI()

Declaration

public UsdClipsAPI()

UsdClipsAPI(UsdPrim)

Declaration

public UsdClipsAPI(UsdPrim prim)

Parameters

Type	Name	Description
UsdPrim	prim

UsdClipsAPI(UsdSchemaBase)

Declaration

public UsdClipsAPI(UsdSchemaBase schemaObj)

Parameters

Type	Name	Description
UsdSchemaBase	schemaObj

Methods

ComputeClipAssetPaths()

Declaration

public SdfAssetPathArray ComputeClipAssetPaths()

Returns

Type	Description
SdfAssetPathArray

ComputeClipAssetPaths(String)

Declaration

public SdfAssetPathArray ComputeClipAssetPaths(string clipSet)

Parameters

Type	Name	Description
String	clipSet

Returns

Type	Description
SdfAssetPathArray

Dispose()

Declaration

public override void Dispose()

Overrides

UsdAPISchemaBase.Dispose()

Finalize()

Declaration

protected void Finalize()

GenerateClipManifest()

Declaration

public SdfLayer GenerateClipManifest()

Returns

Type	Description
SdfLayer

GenerateClipManifest(Boolean)

Declaration

public SdfLayer GenerateClipManifest(bool writeBlocksForClipsWithMissingValues)

Parameters

Type	Name	Description
Boolean	writeBlocksForClipsWithMissingValues

Returns

Type	Description
SdfLayer

GenerateClipManifest(String)

Declaration

public SdfLayer GenerateClipManifest(string clipSet)

Parameters

Type	Name	Description
String	clipSet

Returns

Type	Description
SdfLayer

GenerateClipManifest(String, Boolean)

Declaration

public SdfLayer GenerateClipManifest(string clipSet, bool writeBlocksForClipsWithMissingValues)

Parameters

Type	Name	Description
String	clipSet
Boolean	writeBlocksForClipsWithMissingValues

Returns

Type	Description
SdfLayer

GenerateClipManifestFromLayers(SdfLayerHandleVector, SdfPath)

Declaration

public static SdfLayer GenerateClipManifestFromLayers(SdfLayerHandleVector clipLayers, SdfPath clipPrimPath)

Parameters

Type	Name	Description
SdfLayerHandleVector	clipLayers
SdfPath	clipPrimPath

Returns

Type	Description
SdfLayer

Get(UsdStageWeakPtr, SdfPath)

Declaration

public static UsdClipsAPI Get(UsdStageWeakPtr stage, SdfPath path)

Parameters

Type	Name	Description
UsdStageWeakPtr	stage
SdfPath	path

Returns

Type	Description
UsdClipsAPI

GetClipActive(VtVec2dArray)

Declaration

public bool GetClipActive(VtVec2dArray activeClips)

Parameters

Type	Name	Description
VtVec2dArray	activeClips

Returns

Type	Description
Boolean

GetClipActive(VtVec2dArray, String)

Declaration

public bool GetClipActive(VtVec2dArray activeClips, string clipSet)

Parameters

Type	Name	Description
VtVec2dArray	activeClips
String	clipSet

Returns

Type	Description
Boolean

GetClipAssetPaths(SdfAssetPathArray)

Declaration

public bool GetClipAssetPaths(SdfAssetPathArray assetPaths)

Parameters

Type	Name	Description
SdfAssetPathArray	assetPaths

Returns

Type	Description
Boolean

GetClipAssetPaths(SdfAssetPathArray, String)

Declaration

public bool GetClipAssetPaths(SdfAssetPathArray assetPaths, string clipSet)

Parameters

Type	Name	Description
SdfAssetPathArray	assetPaths
String	clipSet

Returns

Type	Description
Boolean

GetClipManifestAssetPath(SdfAssetPath)

Declaration

public bool GetClipManifestAssetPath(SdfAssetPath manifestAssetPath)

Parameters

Type	Name	Description
SdfAssetPath	manifestAssetPath

Returns

Type	Description
Boolean

GetClipManifestAssetPath(SdfAssetPath, String)

Declaration

public bool GetClipManifestAssetPath(SdfAssetPath manifestAssetPath, string clipSet)

Parameters

Type	Name	Description
SdfAssetPath	manifestAssetPath
String	clipSet

Returns

Type	Description
Boolean

GetClipPrimPath(out String)

Declaration

public bool GetClipPrimPath(out string primPath)

Parameters

Type	Name	Description
String	primPath

Returns

Type	Description
Boolean

GetClipPrimPath(out String, String)

Declaration

public bool GetClipPrimPath(out string primPath, string clipSet)

Parameters

Type	Name	Description
String	primPath
String	clipSet

Returns

Type	Description
Boolean

GetClips(VtDictionary)

Declaration

public bool GetClips(VtDictionary clips)

Parameters

Type	Name	Description
VtDictionary	clips

Returns

Type	Description
Boolean

GetClipSets(SdfStringListOp)

Declaration

public bool GetClipSets(SdfStringListOp clipSets)

Parameters

Type	Name	Description
SdfStringListOp	clipSets

Returns

Type	Description
Boolean

GetClipTemplateActiveOffset(ref Double)

Declaration

public bool GetClipTemplateActiveOffset(ref double clipTemplateActiveOffset)

Parameters

Type	Name	Description
Double	clipTemplateActiveOffset

Returns

Type	Description
Boolean

GetClipTemplateActiveOffset(ref Double, String)

Declaration

public bool GetClipTemplateActiveOffset(ref double clipTemplateActiveOffset, string clipSet)

Parameters

Type	Name	Description
Double	clipTemplateActiveOffset
String	clipSet

Returns

Type	Description
Boolean

GetClipTemplateAssetPath(out String)

Declaration

public bool GetClipTemplateAssetPath(out string clipTemplateAssetPath)

Parameters

Type	Name	Description
String	clipTemplateAssetPath

Returns

Type	Description
Boolean

GetClipTemplateAssetPath(out String, String)

Declaration

public bool GetClipTemplateAssetPath(out string clipTemplateAssetPath, string clipSet)

Parameters

Type	Name	Description
String	clipTemplateAssetPath
String	clipSet

Returns

Type	Description
Boolean

GetClipTemplateEndTime(ref Double)

Declaration

public bool GetClipTemplateEndTime(ref double clipTemplateEndTime)

Parameters

Type	Name	Description
Double	clipTemplateEndTime

Returns

Type	Description
Boolean

GetClipTemplateEndTime(ref Double, String)

Declaration

public bool GetClipTemplateEndTime(ref double clipTemplateEndTime, string clipSet)

Parameters

Type	Name	Description
Double	clipTemplateEndTime
String	clipSet

Returns

Type	Description
Boolean

GetClipTemplateStartTime(ref Double)

Declaration

public bool GetClipTemplateStartTime(ref double clipTemplateStartTime)

Parameters

Type	Name	Description
Double	clipTemplateStartTime

Returns

Type	Description
Boolean

GetClipTemplateStartTime(ref Double, String)

Declaration

public bool GetClipTemplateStartTime(ref double clipTemplateStartTime, string clipSet)

Parameters

Type	Name	Description
Double	clipTemplateStartTime
String	clipSet

Returns

Type	Description
Boolean

GetClipTemplateStride(ref Double)

Declaration

public bool GetClipTemplateStride(ref double clipTemplateStride)

Parameters

Type	Name	Description
Double	clipTemplateStride

Returns

Type	Description
Boolean

GetClipTemplateStride(ref Double, String)

Declaration

public bool GetClipTemplateStride(ref double clipTemplateStride, string clipSet)

Parameters

Type	Name	Description
Double	clipTemplateStride
String	clipSet

Returns

Type	Description
Boolean

GetClipTimes(VtVec2dArray)

Declaration

public bool GetClipTimes(VtVec2dArray clipTimes)

Parameters

Type	Name	Description
VtVec2dArray	clipTimes

Returns

Type	Description
Boolean

GetClipTimes(VtVec2dArray, String)

Declaration

public bool GetClipTimes(VtVec2dArray clipTimes, string clipSet)

Parameters

Type	Name	Description
VtVec2dArray	clipTimes
String	clipSet

Returns

Type	Description
Boolean

GetInterpolateMissingClipValues(SWIGTYPE_p_bool)

Declaration

public bool GetInterpolateMissingClipValues(SWIGTYPE_p_bool interpolate)

Parameters

Type	Name	Description
SWIGTYPE_p_bool	interpolate

Returns

Type	Description
Boolean

GetInterpolateMissingClipValues(SWIGTYPE_p_bool, String)

Declaration

public bool GetInterpolateMissingClipValues(SWIGTYPE_p_bool interpolate, string clipSet)

Parameters

Type	Name	Description
SWIGTYPE_p_bool	interpolate
String	clipSet

Returns

Type	Description
Boolean

GetSchemaAttributeNames()

Declaration

public static TfTokenVector GetSchemaAttributeNames()

Returns

Type	Description
TfTokenVector

GetSchemaAttributeNames(Boolean)

Declaration

public static TfTokenVector GetSchemaAttributeNames(bool includeInherited)

Parameters

Type	Name	Description
Boolean	includeInherited

Returns

Type	Description
TfTokenVector

SetClipActive(VtVec2dArray)

Declaration

public bool SetClipActive(VtVec2dArray activeClips)

Parameters

Type	Name	Description
VtVec2dArray	activeClips

Returns

Type	Description
Boolean

SetClipActive(VtVec2dArray, String)

Declaration

public bool SetClipActive(VtVec2dArray activeClips, string clipSet)

Parameters

Type	Name	Description
VtVec2dArray	activeClips
String	clipSet

Returns

Type	Description
Boolean

SetClipAssetPaths(SdfAssetPathArray)

Declaration

public bool SetClipAssetPaths(SdfAssetPathArray assetPaths)

Parameters

Type	Name	Description
SdfAssetPathArray	assetPaths

Returns

Type	Description
Boolean

SetClipAssetPaths(SdfAssetPathArray, String)

Declaration

public bool SetClipAssetPaths(SdfAssetPathArray assetPaths, string clipSet)

Parameters

Type	Name	Description
SdfAssetPathArray	assetPaths
String	clipSet

Returns

Type	Description
Boolean

SetClipManifestAssetPath(SdfAssetPath)

Declaration

public bool SetClipManifestAssetPath(SdfAssetPath manifestAssetPath)

Parameters

Type	Name	Description
SdfAssetPath	manifestAssetPath

Returns

Type	Description
Boolean

SetClipManifestAssetPath(SdfAssetPath, String)

Declaration

public bool SetClipManifestAssetPath(SdfAssetPath manifestAssetPath, string clipSet)

Parameters

Type	Name	Description
SdfAssetPath	manifestAssetPath
String	clipSet

Returns

Type	Description
Boolean

SetClipPrimPath(String)

Declaration

public bool SetClipPrimPath(string primPath)

Parameters

Type	Name	Description
String	primPath

Returns

Type	Description
Boolean

SetClipPrimPath(String, String)

Declaration

public bool SetClipPrimPath(string primPath, string clipSet)

Parameters

Type	Name	Description
String	primPath
String	clipSet

Returns

Type	Description
Boolean

SetClips(VtDictionary)

Declaration

public bool SetClips(VtDictionary clips)

Parameters

Type	Name	Description
VtDictionary	clips

Returns

Type	Description
Boolean

SetClipSets(SdfStringListOp)

Declaration

public bool SetClipSets(SdfStringListOp clipSets)

Parameters

Type	Name	Description
SdfStringListOp	clipSets

Returns

Type	Description
Boolean

SetClipTemplateActiveOffset(Double)

Declaration

public bool SetClipTemplateActiveOffset(double clipTemplateActiveOffset)

Parameters

Type	Name	Description
Double	clipTemplateActiveOffset

Returns

Type	Description
Boolean

SetClipTemplateActiveOffset(Double, String)

Declaration

public bool SetClipTemplateActiveOffset(double clipTemplateActiveOffset, string clipSet)

Parameters

Type	Name	Description
Double	clipTemplateActiveOffset
String	clipSet

Returns

Type	Description
Boolean

SetClipTemplateAssetPath(String)

Declaration

public bool SetClipTemplateAssetPath(string clipTemplateAssetPath)

Parameters

Type	Name	Description
String	clipTemplateAssetPath

Returns

Type	Description
Boolean

SetClipTemplateAssetPath(String, String)

Declaration

public bool SetClipTemplateAssetPath(string clipTemplateAssetPath, string clipSet)

Parameters

Type	Name	Description
String	clipTemplateAssetPath
String	clipSet

Returns

Type	Description
Boolean

SetClipTemplateEndTime(Double)

Declaration

public bool SetClipTemplateEndTime(double clipTemplateEndTime)

Parameters

Type	Name	Description
Double	clipTemplateEndTime

Returns

Type	Description
Boolean

SetClipTemplateEndTime(Double, String)

Declaration

public bool SetClipTemplateEndTime(double clipTemplateEndTime, string clipSet)

Parameters

Type	Name	Description
Double	clipTemplateEndTime
String	clipSet

Returns

Type	Description
Boolean

SetClipTemplateStartTime(Double)

Declaration

public bool SetClipTemplateStartTime(double clipTemplateStartTime)

Parameters

Type	Name	Description
Double	clipTemplateStartTime

Returns

Type	Description
Boolean

SetClipTemplateStartTime(Double, String)

Declaration

public bool SetClipTemplateStartTime(double clipTemplateStartTime, string clipSet)

Parameters

Type	Name	Description
Double	clipTemplateStartTime
String	clipSet

Returns

Type	Description
Boolean

SetClipTemplateStride(Double)

Declaration

public bool SetClipTemplateStride(double clipTemplateStride)

Parameters

Type	Name	Description
Double	clipTemplateStride

Returns

Type	Description
Boolean

SetClipTemplateStride(Double, String)

Declaration

public bool SetClipTemplateStride(double clipTemplateStride, string clipSet)

Parameters

Type	Name	Description
Double	clipTemplateStride
String	clipSet

Returns

Type	Description
Boolean

SetClipTimes(VtVec2dArray)

Declaration

public bool SetClipTimes(VtVec2dArray clipTimes)

Parameters

Type	Name	Description
VtVec2dArray	clipTimes

Returns

Type	Description
Boolean

SetClipTimes(VtVec2dArray, String)

Declaration

public bool SetClipTimes(VtVec2dArray clipTimes, string clipSet)

Parameters

Type	Name	Description
VtVec2dArray	clipTimes
String	clipSet

Returns

Type	Description
Boolean

SetInterpolateMissingClipValues(Boolean)

Declaration

public bool SetInterpolateMissingClipValues(bool interpolate)

Parameters

Type	Name	Description
Boolean	interpolate

Returns

Type	Description
Boolean

SetInterpolateMissingClipValues(Boolean, String)

Declaration

public bool SetInterpolateMissingClipValues(bool interpolate, string clipSet)

Parameters

Type	Name	Description
Boolean	interpolate
String	clipSet

Returns

Type	Description
Boolean