Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / editors / include / ED_particle.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) 2007 by Janne Karhu.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup editors
21  */
22
23 #ifndef __ED_PARTICLE_H__
24 #define __ED_PARTICLE_H__
25
26 struct Object;
27 struct PTCacheEdit;
28 struct ParticleEditSettings;
29 struct ParticleSystem;
30 struct Scene;
31 struct UndoType;
32 struct ViewLayer;
33 struct bContext;
34 struct rcti;
35
36 /* particle edit mode */
37 void PE_free_ptcache_edit(struct PTCacheEdit *edit);
38 int PE_start_edit(struct PTCacheEdit *edit);
39
40 /* access */
41 struct PTCacheEdit *PE_get_current_from_psys(struct ParticleSystem *psys);
42 struct PTCacheEdit *PE_get_current(struct Scene *scene, struct Object *ob);
43 struct PTCacheEdit *PE_create_current(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
44 void PE_current_changed(struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob);
45 int PE_minmax(struct Scene *scene, struct ViewLayer *view_layer, float min[3], float max[3]);
46 struct ParticleEditSettings *PE_settings(struct Scene *scene);
47
48 /* update calls */
49 void PE_hide_keys_time(struct Scene *scene, struct PTCacheEdit *edit, float cfra);
50 void PE_update_object(
51         struct Depsgraph *depsgraph, struct Scene *scene,
52         struct Object *ob, int useflag);
53
54 /* selection tools */
55 int PE_mouse_particles(struct bContext *C, const int mval[2], bool extend, bool deselect, bool toggle);
56 int PE_box_select(struct bContext *C, const struct rcti *rect, const int sel_op);
57 int PE_circle_select(struct bContext *C, int selecting, const int mval[2], float rad);
58 int PE_lasso_select(struct bContext *C, const int mcords[][2], const short moves, const int sel_op);
59 void PE_deselect_all_visible(struct PTCacheEdit *edit);
60
61 /* particle_edit_undo.c */
62 void ED_particle_undosys_type(struct UndoType *ut);
63
64 #endif /* __ED_PARTICLE_H__ */