Class UsdCollectionAPI
Inheritance
UsdCollectionAPI
Namespace: pxr
Syntax
public class UsdCollectionAPI : UsdAPISchemaBase, IDisposable
Constructors
UsdCollectionAPI()
Declaration
public UsdCollectionAPI()
UsdCollectionAPI(UsdPrim)
Declaration
public UsdCollectionAPI(UsdPrim prim)
Parameters
UsdCollectionAPI(UsdPrim, TfToken)
Declaration
public UsdCollectionAPI(UsdPrim prim, TfToken name)
Parameters
UsdCollectionAPI(UsdSchemaBase, TfToken)
Declaration
public UsdCollectionAPI(UsdSchemaBase schemaObj, TfToken name)
Parameters
Methods
ApplyCollection(UsdPrim, TfToken)
Declaration
public static UsdCollectionAPI ApplyCollection(UsdPrim prim, TfToken name)
Parameters
Returns
ApplyCollection(UsdPrim, TfToken, TfToken)
Declaration
public static UsdCollectionAPI ApplyCollection(UsdPrim prim, TfToken name, TfToken expansionRule)
Parameters
Returns
BlockCollection()
Declaration
public bool BlockCollection()
Returns
ComputeIncludedObjects(SWIGTYPE_p_UsdCollectionMembershipQuery, UsdStageWeakPtr)
Declaration
public static UsdObjectVector ComputeIncludedObjects(SWIGTYPE_p_UsdCollectionMembershipQuery query, UsdStageWeakPtr stage)
Parameters
Returns
ComputeIncludedPaths(SWIGTYPE_p_UsdCollectionMembershipQuery, UsdStageWeakPtr)
Declaration
public static SWIGTYPE_p_std__setT_SdfPath_t ComputeIncludedPaths(SWIGTYPE_p_UsdCollectionMembershipQuery query, UsdStageWeakPtr stage)
Parameters
Returns
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
Returns
ComputeMembershipQuery()
Declaration
public SWIGTYPE_p_UsdCollectionMembershipQuery ComputeMembershipQuery()
Returns
ComputeMembershipQuery(SWIGTYPE_p_UsdCollectionMembershipQuery)
Declaration
public void ComputeMembershipQuery(SWIGTYPE_p_UsdCollectionMembershipQuery query)
Parameters
CreateExcludesRel()
Declaration
public UsdRelationship CreateExcludesRel()
Returns
CreateExpansionRuleAttr()
Declaration
public UsdAttribute CreateExpansionRuleAttr()
Returns
CreateExpansionRuleAttr(VtValue)
Declaration
public UsdAttribute CreateExpansionRuleAttr(VtValue defaultValue)
Parameters
| Type |
Name |
Description |
| VtValue |
defaultValue |
|
Returns
CreateExpansionRuleAttr(VtValue, Boolean)
Declaration
public UsdAttribute CreateExpansionRuleAttr(VtValue defaultValue, bool writeSparsely)
Parameters
Returns
CreateIncludeRootAttr()
Declaration
public UsdAttribute CreateIncludeRootAttr()
Returns
CreateIncludeRootAttr(VtValue)
Declaration
public UsdAttribute CreateIncludeRootAttr(VtValue defaultValue)
Parameters
| Type |
Name |
Description |
| VtValue |
defaultValue |
|
Returns
CreateIncludeRootAttr(VtValue, Boolean)
Declaration
public UsdAttribute CreateIncludeRootAttr(VtValue defaultValue, bool writeSparsely)
Parameters
Returns
CreateIncludesRel()
Declaration
public UsdRelationship CreateIncludesRel()
Returns
Dispose()
Declaration
public override void Dispose()
Overrides
ExcludePath(SdfPath)
Declaration
public bool ExcludePath(SdfPath pathToExclude)
Parameters
| Type |
Name |
Description |
| SdfPath |
pathToExclude |
|
Returns
Finalize()
Declaration
protected void Finalize()
Get(UsdPrim, TfToken)
Declaration
public static UsdCollectionAPI Get(UsdPrim prim, TfToken name)
Parameters
Returns
Get(UsdStageWeakPtr, SdfPath)
Declaration
public static UsdCollectionAPI Get(UsdStageWeakPtr stage, SdfPath path)
Parameters
Returns
GetAllCollections(UsdPrim)
Declaration
public static UsdCollectionAPIVector GetAllCollections(UsdPrim prim)
Parameters
Returns
GetCollection(UsdPrim, TfToken)
Declaration
public static UsdCollectionAPI GetCollection(UsdPrim prim, TfToken name)
Parameters
Returns
GetCollection(UsdStageWeakPtr, SdfPath)
Declaration
public static UsdCollectionAPI GetCollection(UsdStageWeakPtr stage, SdfPath collectionPath)
Parameters
Returns
GetCollectionPath()
Declaration
public SdfPath GetCollectionPath()
Returns
GetExcludesRel()
Declaration
public UsdRelationship GetExcludesRel()
Returns
GetExpansionRuleAttr()
Declaration
public UsdAttribute GetExpansionRuleAttr()
Returns
GetIncludeRootAttr()
Declaration
public UsdAttribute GetIncludeRootAttr()
Returns
GetIncludesRel()
Declaration
public UsdRelationship GetIncludesRel()
Returns
GetName()
Declaration
Returns
GetNamedCollectionPath(UsdPrim, TfToken)
Declaration
public static SdfPath GetNamedCollectionPath(UsdPrim prim, TfToken collectionName)
Parameters
Returns
GetSchemaAttributeNames()
Declaration
public static TfTokenVector GetSchemaAttributeNames()
Returns
GetSchemaAttributeNames(Boolean)
Declaration
public static TfTokenVector GetSchemaAttributeNames(bool includeInherited)
Parameters
| Type |
Name |
Description |
| Boolean |
includeInherited |
|
Returns
GetSchemaAttributeNames(Boolean, TfToken)
Declaration
public static TfTokenVector GetSchemaAttributeNames(bool includeInherited, TfToken instanceName)
Parameters
Returns
HasNoIncludedPaths()
Declaration
public bool HasNoIncludedPaths()
Returns
IncludePath(SdfPath)
Declaration
public bool IncludePath(SdfPath pathToInclude)
Parameters
| Type |
Name |
Description |
| SdfPath |
pathToInclude |
|
Returns
IsCollectionAPIPath(SdfPath, TfToken)
Declaration
public static bool IsCollectionAPIPath(SdfPath path, TfToken name)
Parameters
Returns
IsSchemaPropertyBaseName(TfToken)
Declaration
public static bool IsSchemaPropertyBaseName(TfToken baseName)
Parameters
| Type |
Name |
Description |
| TfToken |
baseName |
|
Returns
ResetCollection()
Declaration
public bool ResetCollection()
Returns
Validate(out String)
Declaration
public bool Validate(out string reason)
Parameters
| Type |
Name |
Description |
| String |
reason |
|
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.