Class UsdCollectionAPI

Inheritance

Object

UsdSchemaBase

UsdAPISchemaBase

UsdCollectionAPI

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 UsdCollectionAPI : UsdAPISchemaBase, IDisposable

Constructors

UsdCollectionAPI()

Declaration

public UsdCollectionAPI()

UsdCollectionAPI(UsdPrim)

Declaration

public UsdCollectionAPI(UsdPrim prim)

Parameters

Type	Name	Description
UsdPrim	prim

UsdCollectionAPI(UsdPrim, TfToken)

Declaration

public UsdCollectionAPI(UsdPrim prim, TfToken name)

Parameters

Type	Name	Description
UsdPrim	prim
TfToken	name

UsdCollectionAPI(UsdSchemaBase, TfToken)

Declaration

public UsdCollectionAPI(UsdSchemaBase schemaObj, TfToken name)

Parameters

Type	Name	Description
UsdSchemaBase	schemaObj
TfToken	name

Methods

ApplyCollection(UsdPrim, TfToken)

Declaration

public static UsdCollectionAPI ApplyCollection(UsdPrim prim, TfToken name)

Parameters

Type	Name	Description
UsdPrim	prim
TfToken	name

Returns

Type	Description
UsdCollectionAPI

ApplyCollection(UsdPrim, TfToken, TfToken)

Declaration

public static UsdCollectionAPI ApplyCollection(UsdPrim prim, TfToken name, TfToken expansionRule)

Parameters

Type	Name	Description
UsdPrim	prim
TfToken	name
TfToken	expansionRule

Returns

Type	Description
UsdCollectionAPI

BlockCollection()

Declaration

public bool BlockCollection()

Returns

Type	Description
Boolean

ComputeIncludedObjects(SWIGTYPE_p_UsdCollectionMembershipQuery, UsdStageWeakPtr)

Declaration

public static UsdObjectVector ComputeIncludedObjects(SWIGTYPE_p_UsdCollectionMembershipQuery query, UsdStageWeakPtr stage)

Parameters

Type	Name	Description
SWIGTYPE_p_UsdCollectionMembershipQuery	query
UsdStageWeakPtr	stage

Returns

Type	Description
UsdObjectVector

ComputeIncludedPaths(SWIGTYPE_p_UsdCollectionMembershipQuery, UsdStageWeakPtr)

Declaration

public static SWIGTYPE_p_std__setT_SdfPath_t ComputeIncludedPaths(SWIGTYPE_p_UsdCollectionMembershipQuery query, UsdStageWeakPtr stage)

Parameters

Type	Name	Description
SWIGTYPE_p_UsdCollectionMembershipQuery	query
UsdStageWeakPtr	stage

Returns

Type	Description
SWIGTYPE_p_std__setT_SdfPath_t

ComputeIncludedPaths(SWIGTYPE_p_UsdCollectionMembershipQuery, UsdStageWeakPtr, Usd_PrimFlagsPredicate)

Declaration

public static SWIGTYPE_p_std__setT_SdfPath_t ComputeIncludedPaths(SWIGTYPE_p_UsdCollectionMembershipQuery query, UsdStageWeakPtr stage, Usd_PrimFlagsPredicate pred)

Parameters

Type	Name	Description
SWIGTYPE_p_UsdCollectionMembershipQuery	query
UsdStageWeakPtr	stage
Usd_PrimFlagsPredicate	pred

Returns

Type	Description
SWIGTYPE_p_std__setT_SdfPath_t

ComputeMembershipQuery()

Declaration

public SWIGTYPE_p_UsdCollectionMembershipQuery ComputeMembershipQuery()

Returns

Type	Description
SWIGTYPE_p_UsdCollectionMembershipQuery

ComputeMembershipQuery(SWIGTYPE_p_UsdCollectionMembershipQuery)

Declaration

public void ComputeMembershipQuery(SWIGTYPE_p_UsdCollectionMembershipQuery query)

Parameters

Type	Name	Description
SWIGTYPE_p_UsdCollectionMembershipQuery	query

CreateExcludesRel()

Declaration

public UsdRelationship CreateExcludesRel()

Returns

Type	Description
UsdRelationship

CreateExpansionRuleAttr()

Declaration

public UsdAttribute CreateExpansionRuleAttr()

Returns

Type	Description
UsdAttribute

CreateExpansionRuleAttr(VtValue)

Declaration

public UsdAttribute CreateExpansionRuleAttr(VtValue defaultValue)

Parameters

Type	Name	Description
VtValue	defaultValue

Returns

Type	Description
UsdAttribute

CreateExpansionRuleAttr(VtValue, Boolean)

Declaration

public UsdAttribute CreateExpansionRuleAttr(VtValue defaultValue, bool writeSparsely)

Parameters

Type	Name	Description
VtValue	defaultValue
Boolean	writeSparsely

Returns

Type	Description
UsdAttribute

CreateIncludeRootAttr()

Declaration

public UsdAttribute CreateIncludeRootAttr()

Returns

Type	Description
UsdAttribute

CreateIncludeRootAttr(VtValue)

Declaration

public UsdAttribute CreateIncludeRootAttr(VtValue defaultValue)

Parameters

Type	Name	Description
VtValue	defaultValue

Returns

Type	Description
UsdAttribute

CreateIncludeRootAttr(VtValue, Boolean)

Declaration

public UsdAttribute CreateIncludeRootAttr(VtValue defaultValue, bool writeSparsely)

Parameters

Type	Name	Description
VtValue	defaultValue
Boolean	writeSparsely

Returns

Type	Description
UsdAttribute

CreateIncludesRel()

Declaration

public UsdRelationship CreateIncludesRel()

Returns

Type	Description
UsdRelationship

Dispose()

Declaration

public override void Dispose()

Overrides

UsdAPISchemaBase.Dispose()

ExcludePath(SdfPath)

Declaration

public bool ExcludePath(SdfPath pathToExclude)

Parameters

Type	Name	Description
SdfPath	pathToExclude

Returns

Type	Description
Boolean

Finalize()

Declaration

protected void Finalize()

Get(UsdPrim, TfToken)

Declaration

public static UsdCollectionAPI Get(UsdPrim prim, TfToken name)

Parameters

Type	Name	Description
UsdPrim	prim
TfToken	name

Returns

Type	Description
UsdCollectionAPI

Get(UsdStageWeakPtr, SdfPath)

Declaration

public static UsdCollectionAPI Get(UsdStageWeakPtr stage, SdfPath path)

Parameters

Type	Name	Description
UsdStageWeakPtr	stage
SdfPath	path

Returns

Type	Description
UsdCollectionAPI

GetAllCollections(UsdPrim)

Declaration

public static UsdCollectionAPIVector GetAllCollections(UsdPrim prim)

Parameters

Type	Name	Description
UsdPrim	prim

Returns

Type	Description
UsdCollectionAPIVector

GetCollection(UsdPrim, TfToken)

Declaration

public static UsdCollectionAPI GetCollection(UsdPrim prim, TfToken name)

Parameters

Type	Name	Description
UsdPrim	prim
TfToken	name

Returns

Type	Description
UsdCollectionAPI

GetCollection(UsdStageWeakPtr, SdfPath)

Declaration

public static UsdCollectionAPI GetCollection(UsdStageWeakPtr stage, SdfPath collectionPath)

Parameters

Type	Name	Description
UsdStageWeakPtr	stage
SdfPath	collectionPath

Returns

Type	Description
UsdCollectionAPI

GetCollectionPath()

Declaration

public SdfPath GetCollectionPath()

Returns

Type	Description
SdfPath

GetExcludesRel()

Declaration

public UsdRelationship GetExcludesRel()

Returns

Type	Description
UsdRelationship

GetExpansionRuleAttr()

Declaration

public UsdAttribute GetExpansionRuleAttr()

Returns

Type	Description
UsdAttribute

GetIncludeRootAttr()

Declaration

public UsdAttribute GetIncludeRootAttr()

Returns

Type	Description
UsdAttribute

GetIncludesRel()

Declaration

public UsdRelationship GetIncludesRel()

Returns

Type	Description
UsdRelationship

GetName()

Declaration

public TfToken GetName()

Returns

Type	Description
TfToken

GetNamedCollectionPath(UsdPrim, TfToken)

Declaration

public static SdfPath GetNamedCollectionPath(UsdPrim prim, TfToken collectionName)

Parameters

Type	Name	Description
UsdPrim	prim
TfToken	collectionName

Returns

Type	Description
SdfPath

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

GetSchemaAttributeNames(Boolean, TfToken)

Declaration

public static TfTokenVector GetSchemaAttributeNames(bool includeInherited, TfToken instanceName)

Parameters

Type	Name	Description
Boolean	includeInherited
TfToken	instanceName

Returns

Type	Description
TfTokenVector

HasNoIncludedPaths()

Declaration

public bool HasNoIncludedPaths()

Returns

Type	Description
Boolean

IncludePath(SdfPath)

Declaration

public bool IncludePath(SdfPath pathToInclude)

Parameters

Type	Name	Description
SdfPath	pathToInclude

Returns

Type	Description
Boolean

IsCollectionAPIPath(SdfPath, TfToken)

Declaration

public static bool IsCollectionAPIPath(SdfPath path, TfToken name)

Parameters

Type	Name	Description
SdfPath	path
TfToken	name

Returns

Type	Description
Boolean

IsSchemaPropertyBaseName(TfToken)

Declaration

public static bool IsSchemaPropertyBaseName(TfToken baseName)

Parameters

Type	Name	Description
TfToken	baseName

Returns

Type	Description
Boolean

ResetCollection()

Declaration

public bool ResetCollection()

Returns

Type	Description
Boolean

Validate(out String)

Declaration

public bool Validate(out string reason)

Parameters

Type	Name	Description
String	reason

Returns

Type	Description
Boolean