doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_mball.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BKE_MBALL_H__
20 #define __BKE_MBALL_H__
21
22 /** \file
23  * \ingroup bke
24  */
25 struct BoundBox;
26 struct Depsgraph;
27 struct Main;
28 struct MetaBall;
29 struct MetaElem;
30 struct Object;
31 struct Scene;
32
33 void BKE_mball_free(struct MetaBall *mb);
34 void BKE_mball_init(struct MetaBall *mb);
35 struct MetaBall *BKE_mball_add(struct Main *bmain, const char *name);
36 void BKE_mball_copy_data(struct Main *bmain, struct MetaBall *mb_dst, const struct MetaBall *mb_src, const int flag);
37 struct MetaBall *BKE_mball_copy(struct Main *bmain, const struct MetaBall *mb);
38
39 void BKE_mball_make_local(struct Main *bmain, struct MetaBall *mb, const bool lib_local);
40
41 bool BKE_mball_is_any_selected(const struct MetaBall *mb);
42 bool BKE_mball_is_any_selected_multi(struct Object **objects, int objects_len);
43 bool BKE_mball_is_any_unselected(const struct MetaBall *mb);
44 bool BKE_mball_is_basis_for(struct Object *ob1, struct Object *ob2);
45 bool BKE_mball_is_basis(struct Object *ob);
46 struct Object *BKE_mball_basis_find(struct Scene *scene, struct Object *ob);
47
48 void BKE_mball_texspace_calc(struct Object *ob);
49 struct BoundBox *BKE_mball_boundbox_get(struct Object *ob);
50 float *BKE_mball_make_orco(struct Object *ob, struct ListBase *dispbase);
51
52 void BKE_mball_properties_copy(struct Scene *scene, struct Object *active_object);
53
54 bool BKE_mball_minmax_ex(
55         const struct MetaBall *mb, float min[3], float max[3],
56         const float obmat[4][4], const short flag);
57 bool BKE_mball_minmax(const struct MetaBall *mb, float min[3], float max[3]);
58 bool BKE_mball_center_median(const struct MetaBall *mb, float r_cent[3]);
59 bool BKE_mball_center_bounds(const struct MetaBall *mb, float r_cent[3]);
60 void BKE_mball_transform(struct MetaBall *mb, float mat[4][4], const bool do_props);
61 void BKE_mball_translate(struct MetaBall *mb, const float offset[3]);
62
63 struct MetaElem *BKE_mball_element_add(struct MetaBall *mb, const int type);
64
65 int BKE_mball_select_count(const struct MetaBall *mb);
66 int BKE_mball_select_count_multi(struct Object **objects, int objects_len);
67 void BKE_mball_select_all(struct MetaBall *mb);
68 void BKE_mball_select_all_multi(struct Object **objects, int objects_len);
69 void BKE_mball_deselect_all(struct MetaBall *mb);
70 void BKE_mball_deselect_all_multi(struct Object **objects, int objects_len);
71 void BKE_mball_select_swap(struct MetaBall *mb);
72 void BKE_mball_select_swap_multi(struct Object **objects, int objects_len);
73
74 /* **** Depsgraph evaluation **** */
75
76 struct Depsgraph;
77
78 /* Draw Cache */
79
80 enum {
81         BKE_MBALL_BATCH_DIRTY_ALL = 0,
82 };
83 void BKE_mball_batch_cache_dirty_tag(struct MetaBall *mb, int mode);
84 void BKE_mball_batch_cache_free(struct MetaBall *mb);
85
86 #endif