USD.References

Description

A class that represents a UsdReferences object from the OpenUSD API.

Methods

add Adds a reference to the list of references.
clear Removes all references from the list of references.
remove Removes a specific reference from the list of references.
set Sets the current list of references to the given list of assets.

Details

Do no remove, this fixes the anchor on doc.flexsim.com

USD.References.add()

int add( USD.Reference reference )

Parameters

reference The USD.Reference to add to the list.

Returns

int 1 if the method was successful; otherwise, 0.

Description

Adds a reference to the list of references.

Do no remove, this fixes the anchor on doc.flexsim.com

USD.References.clear()

int clear( )

Returns

int 1 if the method was successful; otherwise, 0.

Description

Removes all references from the list of references.

Do no remove, this fixes the anchor on doc.flexsim.com

USD.References.remove()

int remove( string primPath , string assetPath = "" )

Parameters

primPath The prim path of the reference to remove.
assetPath The asset path of the reference to remove.

Returns

int 1 if the method was successful; otherwise, 0.

Description

Removes a specific reference from the list of references.

Do no remove, this fixes the anchor on doc.flexsim.com

USD.References.set()

int set( Array primPaths )

Parameters

primPaths An Array of prim paths as strings.

Returns

int 1 if the method was successful; otherwise, 0.

Description

Sets the current list of references to the given list of assets.

Given an Array of strings of prim paths, it will clear the current list of references, create a USD.Reference for each of the prim paths, and then set the list to the list of USD.References created. If the Array contains anything that isn't a string, it will throw an exception.