Improve UsdSkel docs #2697
Improve UsdSkel docs #2697
Conversation
- Fix UsdSkel docs code/usda samples. - Add more info to UsdSkel docs for clarity. Signed-off-by: mati-nvidia <mcodesal@nvidia.com>
|
|
||
| UsdSkelBindingAPI binding = UsdSkelBindingAPI::Apply(skel.GetPrim()); | ||
| binding.CreateSkeletonRel().SetTargets( | ||
| binding.CreateAnimationSourceRel().SetTargets( |
There was a problem hiding this comment.
I could be wrong, but I believe the repeated section of code down near line 1081 needs to be updated to use CreateAnimationSourceRel() instead of CreateSkeletonRel() as you did here (and similarly for the Python snippet). I'm working on merging this change in, so I'll update accordingly on my end.
There was a problem hiding this comment.
Good catch. I missed the fix in the breakdown section. I went ahead and updated it in a new commit along with another suggestion from Spiff on the AOUSD forum.
pxr/usd/usdSkel/doxygen/schemas.dox
Outdated
| } | ||
| def Skeleton "Skel" { | ||
| uniform token[] = ["A/B", "A"] | ||
| uniform token[] = ["A", "A/B"] |
There was a problem hiding this comment.
Updated to correctly list parent joints before child joints in the Skeleton. Switched the order in SkelAnimation too just to still show that the joint order can be different between the two prims.
| @@ -530,12 +536,51 @@ using the UsdSkelBindingAPI. The _jointIndices_ primvar provides an array giving | |||
| the joint index of an influence, while the _jointWeights_ primvar provides a | |||
| weight value corresponding to each of those indices. | |||
|
|
|||
| For example: | |||
There was a problem hiding this comment.
This was a missing example. I made it up based on the explanation paragraph below.
| @@ -12,7 +12,10 @@ def SkelRoot "Model" ( | |||
| prepend apiSchemas = ["SkelBindingAPI"] | |||
| ) | |||
| { | |||
| def Skeleton "Skel" { | |||
| def Skeleton "Skel" ( | |||
There was a problem hiding this comment.
Bug fix for new strict applied schemas.
| bool | ||
| WriteAnimatedSkel( | ||
| const UsdStagePtr& stage, | ||
| const SdfPath& skelPath, | ||
| const SdfPath& skelRootPath, |
There was a problem hiding this comment.
I think it'd be good to include SkelRoot in this example.
| @@ -218,19 +218,25 @@ as the authored _joints_ array. The effect of a skel animation prim may | |||
| also be directly nullified by either deactivating the primitive, or by blocking | |||
| the component attributes. | |||
|
|
|||
| \subsection UsdSkel_SkelAnimation_Blendshapes Skel Animation Schema: Blend Shape Animation | |||
There was a problem hiding this comment.
New subsection. Just better for scannability and linking.
|
Filed as internal issue #USD-8711 |
…n Skeleton and SkelAnimation.
Description of Change(s)
Fixes Issue(s)