doxygen: blenkernel under core as module.
[blender.git] / source / blender / blenkernel / BKE_boids.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 by Janne Karhu.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BKE_BOIDS_H
31 #define BKE_BOIDS_H
32
33 /** \file BKE_boids.h
34  *  \ingroup bke
35  *  \since 2009
36  *  \author Janne Karhu
37  */
38
39 #include "DNA_boid_types.h"
40
41 typedef struct BoidBrainData {
42         struct ParticleSimulationData *sim;
43         struct ParticleSettings *part;
44         float timestep, cfra, dfra;
45         float wanted_co[3], wanted_speed;
46
47         /* Goal stuff */
48         struct Object *goal_ob;
49         float goal_co[3];
50         float goal_nor[3];
51         float goal_priority;
52 } BoidBrainData;
53
54 void boids_precalc_rules(struct ParticleSettings *part, float cfra);
55 void boid_brain(BoidBrainData *bbd, int p, struct ParticleData *pa);
56 void boid_body(BoidBrainData *bbd, struct ParticleData *pa);
57 void boid_default_settings(BoidSettings *boids);
58 BoidRule *boid_new_rule(int type);
59 BoidState *boid_new_state(BoidSettings *boids);
60 BoidState *boid_duplicate_state(BoidSettings *boids, BoidState *state);
61 void boid_free_settings(BoidSettings *boids);
62 BoidSettings *boid_copy_settings(BoidSettings *boids);
63 BoidState *boid_get_current_state(BoidSettings *boids);
64 #endif