diff options
author | Hans Goudey <h.goudey@me.com> | 2021-12-13 03:03:30 +0300 |
---|---|---|
committer | Hans Goudey <h.goudey@me.com> | 2021-12-13 03:03:30 +0300 |
commit | 03015a9b222e29e894fe7ce0da059094a8fee9ce (patch) | |
tree | 9a636752c53161a345e430fc29808f8dd57bfa5b /source/blender/blenkernel/BKE_spline.hh | |
parent | 92237f11eba44d77dce4582b77f5a293b93d8675 (diff) |
Cleanup/docs: Add comment to spline lookup factor method
Diffstat (limited to 'source/blender/blenkernel/BKE_spline.hh')
-rw-r--r-- | source/blender/blenkernel/BKE_spline.hh | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/source/blender/blenkernel/BKE_spline.hh b/source/blender/blenkernel/BKE_spline.hh index 4d3009a4cc6..2073ec065fa 100644 --- a/source/blender/blenkernel/BKE_spline.hh +++ b/source/blender/blenkernel/BKE_spline.hh @@ -196,9 +196,16 @@ class Spline { */ float factor; }; + /** + * Find the position on the evaluated spline at the given portion of the total length. + * The return value is the indices of the two neighboring points at that location and the + * factor between them, which can be used to look up any attribute on the evaluated points. + * \note This does not support extrapolation. + */ LookupResult lookup_evaluated_factor(const float factor) const; /** - * \note This does not support extrapolation currently. + * The same as #lookup_evaluated_factor, but looks up a length directly instead of + * a portion of the total. */ LookupResult lookup_evaluated_length(const float length) const; |