Merge pull request #4904 from tellypresence/update-morph-documentation

Update morph mesh documentation now that gltf known to work

include/assimp/anim.h

@@ -198,7 +198,10 @@ struct aiMeshMorphKey {
     /** The time of this key */
     double mTime;
 
-    /** The values and weights at the time of this key */
+    /** The values and weights at the time of this key
+     *   - mValues: index of attachment mesh to apply weight at the same position in mWeights
+     *   - mWeights: weight to apply to the blend shape index at the same position in mValues
+     */
     unsigned int *mValues;
     double *mWeights;
 

include/assimp/mesh.h

@@ -737,13 +737,20 @@ struct aiMesh {
      **/
     C_STRUCT aiString mName;
 
-    /** The number of attachment meshes. Note! Currently only works with Collada loader. */
+    /** The number of attachment meshes.
+     *  Currently known to work with loaders:
+     *   - Collada
+     *   - gltf
+     */
     unsigned int mNumAnimMeshes;
 
     /** Attachment meshes for this mesh, for vertex-based animation.
      *  Attachment meshes carry replacement data for some of the
      *  mesh'es vertex components (usually positions, normals).
-     *  Note! Currently only works with Collada loader.*/
+     *  Currently known to work with loaders:
+     *   - Collada
+     *   - gltf
+     */
     C_STRUCT aiAnimMesh **mAnimMeshes;
 
     /**

port/PyAssimp/pyassimp/structs.py

@@ -748,13 +748,18 @@ class Mesh(Structure):
             #   - Vertex animations refer to meshes by their names.
             ("mName", String),
 
-            # The number of attachment meshes. Note! Currently only works with Collada loader.
+            # The number of attachment meshes. 
+            # Currently known to work with loaders:
+            #  - Collada
+            #  - gltf
             ("mNumAnimMeshes", c_uint),
 
             # Attachment meshes for this mesh, for vertex-based animation.
             # Attachment meshes carry replacement data for some of the
             # mesh'es vertex components (usually positions, normals).
-            # Note! Currently only works with Collada loader.
+            # Currently known to work with loaders:
+            #  - Collada
+            #  - gltf
             ("mAnimMeshes", POINTER(POINTER(AnimMesh))),
 
             # Method of morphing when animeshes are specified.