From ffc4c126f5416b04a01653e7a03451797b98aba4 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 7 Dec 2021 17:19:15 +1100 Subject: Cleanup: move public doc-strings into headers for 'blenkernel' - Added space below non doc-string comments to make it clear these aren't comments for the symbols directly below them. - Use doxy sections for some headers. - Minor improvements to doc-strings. Ref T92709 --- source/blender/blenkernel/BKE_mball.h | 42 +++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) (limited to 'source/blender/blenkernel/BKE_mball.h') diff --git a/source/blender/blenkernel/BKE_mball.h b/source/blender/blenkernel/BKE_mball.h index db4dca14535..895fe5a28f9 100644 --- a/source/blender/blenkernel/BKE_mball.h +++ b/source/blender/blenkernel/BKE_mball.h @@ -41,13 +41,45 @@ bool BKE_mball_is_any_selected(const struct MetaBall *mb); bool BKE_mball_is_any_selected_multi(struct Base **bases, int bases_len); bool BKE_mball_is_any_unselected(const struct MetaBall *mb); bool BKE_mball_is_basis_for(struct Object *ob1, struct Object *ob2); +/** + * Test, if \a ob is a basis meta-ball. + * + * It test last character of Object ID name. + * If last character is digit it return 0, else it return 1. + */ bool BKE_mball_is_basis(struct Object *ob); +/** + * This function finds the basis meta-ball. + * + * Basis meta-ball doesn't include any number at the end of + * its name. All meta-balls with same base of name can be + * blended. meta-balls with different basic name can't be blended. + * + * \warning #BKE_mball_is_basis() can fail on returned object, see function docs for details. + */ struct Object *BKE_mball_basis_find(struct Scene *scene, struct Object *ob); +/** + * Compute bounding box of all meta-elements / meta-ball. + * + * Bounding box is computed from polygonized surface. \a ob is + * basic meta-balls (with name `Meta` for example). All other meta-ball objects + * (with names `Meta.001`, `Meta.002`, etc) are included in this bounding-box. + */ void BKE_mball_texspace_calc(struct Object *ob); +/** + * Return or compute bounding-box for given meta-ball object. + */ struct BoundBox *BKE_mball_boundbox_get(struct Object *ob); float *BKE_mball_make_orco(struct Object *ob, struct ListBase *dispbase); +/** + * Copy some properties from object to other meta-ball object with same base name. + * + * When some properties (wire-size, threshold, update flags) of meta-ball are changed, then this + * properties are copied to all meta-balls in same "group" (meta-balls with same base name: + * `MBall`, `MBall.001`, `MBall.002`, etc). The most important is to copy properties to the base + * meta-ball, because this meta-ball influence polygonization of meta-balls. */ void BKE_mball_properties_copy(struct Scene *scene, struct Object *active_object); bool BKE_mball_minmax_ex(const struct MetaBall *mb, @@ -55,14 +87,24 @@ bool BKE_mball_minmax_ex(const struct MetaBall *mb, float max[3], const float obmat[4][4], const short flag); + +/* Basic vertex data functions. */ + bool BKE_mball_minmax(const struct MetaBall *mb, float min[3], float max[3]); bool BKE_mball_center_median(const struct MetaBall *mb, float r_cent[3]); bool BKE_mball_center_bounds(const struct MetaBall *mb, float r_cent[3]); void BKE_mball_transform(struct MetaBall *mb, const float mat[4][4], const bool do_props); void BKE_mball_translate(struct MetaBall *mb, const float offset[3]); +/** + * Most simple meta-element adding function. + * + * \note don't do context manipulation here (rna uses). + */ struct MetaElem *BKE_mball_element_add(struct MetaBall *mb, const int type); +/* *** select funcs *** */ + int BKE_mball_select_count(const struct MetaBall *mb); int BKE_mball_select_count_multi(struct Base **bases, int bases_len); bool BKE_mball_select_all(struct MetaBall *mb); -- cgit v1.2.3