Adding GetAll method to the codegenTemplates for multiple-apply schemas

[robpieke]

Description of Change(s)

Adding GetAll method to the codegenTemplates for multiple-apply schemas, both for C++ and Python.

This should enable a workflow such as:

from pxr import Usd

stage = Usd.Stage.CreateInMemory()
prim = stage.DefinePrim('/test')

MyMultipleApplySchema.Apply(prim, 'banana')
MyMultipleApplySchema.Apply(prim, 'apple')
MyMultipleApplySchema.Apply(prim, 'pear')

for api in MyMultipleApplySchema.GetAll(prim):
  api.GetAwesomenessAttr().Set(1.0)

This has been tested by rerunning usdGenSchema in the USD codebase and comparing the results of UsdCollectionAPI.GetAll(prim) to UsdCollectionAPI.GetAllCollections(prim) and verifying the entries in the resulting lists are the same.

Fixes Issue(s)

#1772

Note

I might not yet be covered by a CLA, but that should be addressed shortly :)

[spiffmon]

@robpieke, could you please also rerun usdGenSchema in pxr/usd/usd to pick up the changes to UsdCollectionAPI, and also augment the doc for GetAllCollections() to to say that it is equivalent to GetAll()... and if SideFx is OK with updating some code eventually, maybe "\deprecate" GetAllCollections() ?

[robpieke]

@robpieke, could you please also rerun usdGenSchema in pxr/usd/usd to pick up the changes to UsdCollectionAPI, and also augment the doc for GetAllCollections() to to say that it is equivalent to GetAll()... and if SideFx is OK with updating some code eventually, maybe "\deprecate" GetAllCollections() ?

Done! Thanks for the speedy feedback!

[spiffmon]

@robpieke , AFAICT, Pixar has three internal uses of GetAllCollections() that we'll be on the hook to update, but otherwise the HUSD is the only other place I see it in use. And thanks for updating UsdPhysics - I forgot that has multi-apply schemas!

[robpieke]

the HUSD is the only other place I see it in use

@spiffmon Yeah, we have about ten usages split between C++ and Python that we'll swap over.

[jilliene]

Filed as internal issue #USD-7221

[robpieke]

Just checking to make sure this isn't waiting on me for anything :)

[spiffmon]

Hi @robpieke , no it's not. We have a backlog of internal and external issues/PR's we're working our way through, and just haven't even gotten to this one yet.

[crevilla]

Hi @robpieke
I was asked to review this pull request here at Pixar and I think we'd benefit from having more of the implementation of GetAll centralized as opposed to written explicitly into every multiple apply API schema.
In particular, it'd be useful to have a static protected function in UsdAPISchemaBase:
static TfTokenVector _GetMultipleApplyInstances(const UsdPrim &prim, const TfType &schemaType)
to return all the instance names matching the schema type for a prim so that the generated code only has to populate the vector of schema of objects from this list.
For the shared function's impelementation, the UsdSchemaRegistry has the static functions GetAPISchemaTypeName and GetTypeNameAndInstance to help get the type name of the schema and to parse type name and instance name from an applied schema string respectively.

[robpieke]

Hi @crevilla ... sorry it took so long to return to this, but I've taken a stab at centralising the logic as requested.

[sunyab]

This PR was just merged into the dev branch, not sure why this PR didn't auto close. Closing this out.