From df63d1f2704d65b542f055040bb753deb49c76d3 Mon Sep 17 00:00:00 2001 From: Nick Fisher Date: Mon, 20 Nov 2023 15:26:08 +0800 Subject: [PATCH] documentation --- ios/include/AssetManager.hpp | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/ios/include/AssetManager.hpp b/ios/include/AssetManager.hpp index 77c36bd3..0f6cdc9d 100644 --- a/ios/include/AssetManager.hpp +++ b/ios/include/AssetManager.hpp @@ -59,22 +59,22 @@ namespace polyvox void setMorphTargetWeights(EntityId entityId, const char *const entityName, const float *const weights, int count); /// @brief Set the local transform for the bone at boneIndex/skinIndex in the given entity. - /// @param entityId - /// @param entityName - /// @param skinIndex - /// @param boneName - /// @param transform - /// @return + /// @param entityId the parent entity + /// @param entityName the name of the mesh under entityId for which the bone will be set. + /// @param skinIndex the index of the joint skin. Currently only 0 is supported. + /// @param boneName the name of the bone + /// @param transform the 4x4 matrix representing the local transform for the bone + /// @return true if the transform was successfully set, false otherwise bool setBoneTransform(EntityId entityId, const char *entityName, int skinIndex, const char* boneName, math::mat4f transform); /// @brief Set frame data to animate the given bones/entities. - /// @param entity + /// @param entity the parent entity /// @param frameData frame data as quaternions - /// @param numFrames - /// @param boneName - /// @param meshName - /// @param numMeshTargets - /// @param frameLengthInMs + /// @param numFrames the number of frames + /// @param boneName the name of the bone to animate + /// @param meshName an array of mesh names under [entity] that should be animated + /// @param numMeshTargets the number of meshes under [meshName] + /// @param frameLengthInMs the length of each frame in ms /// @return bool addBoneAnimation( EntityId entity,