diff options
Diffstat (limited to 'source/blender/blenkernel/BKE_anim_path.h')
| -rw-r--r-- | source/blender/blenkernel/BKE_anim_path.h | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/source/blender/blenkernel/BKE_anim_path.h b/source/blender/blenkernel/BKE_anim_path.h index 9db63080fd9..6bc09eb35ed 100644 --- a/source/blender/blenkernel/BKE_anim_path.h +++ b/source/blender/blenkernel/BKE_anim_path.h @@ -35,12 +35,21 @@ struct Object; int BKE_anim_path_get_array_size(const struct CurveCache *curve_cache); float BKE_anim_path_get_length(const struct CurveCache *curve_cache); -/* This function populates the 'ob->runtime.curve_cache->anim_path_accum_length' data. +/** + * This function populates the 'ob->runtime.curve_cache->anim_path_accum_length' data. * You should never have to call this manually as it should already have been called by * 'BKE_displist_make_curveTypes'. Do not call this manually unless you know what you are doing. */ void BKE_anim_path_calc_data(struct Object *ob); +/** + * Calculate the deformation implied by the curve path at a given parametric position, + * and returns whether this operation succeeded. + * + * \param ctime: Time is normalized range <0-1>. + * + * \return success. + */ bool BKE_where_on_path(const struct Object *ob, float ctime, float r_vec[4], |