Cleanup: sort forward declarations of enum & struct
[blender.git] / source / blender / blenkernel / BKE_effect.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_EFFECT_H__
28 #define __BKE_EFFECT_H__
29
30 /** \file BKE_effect.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 #include "DNA_modifier_types.h"
37
38 #include "BLI_utildefines.h"
39
40 struct Group;
41 struct ListBase;
42 struct Object;
43 struct ParticleData;
44 struct ParticleKey;
45 struct ParticleSimulationData;
46 struct Scene;
47
48 struct EffectorWeights *BKE_effector_add_weights(struct Group *group);
49
50 /* Input to effector code */
51 typedef struct EffectedPoint {
52         float *loc;
53         float *vel;
54         float *ave;  /* angular velocity for particles with dynamic rotation */
55         float *rot; /* rotation quaternion for particles with dynamic rotation */
56         float vel_to_frame;
57         float vel_to_sec;
58
59         /* only for particles */
60         float size, charge;
61
62         unsigned int flag;
63         int index;
64
65         struct ParticleSystem *psys;  /* particle system the point belongs to */
66 } EffectedPoint;
67
68 typedef struct GuideEffectorData {
69         float vec_to_point[3];
70         float strength;
71 } GuideEffectorData;
72
73 typedef struct EffectorData {
74         /* Effector point */
75         float loc[3];
76         float nor[3];
77         float vel[3];
78
79         float vec_to_point[3];
80         float distance, falloff;
81
82         /* only for effector particles */
83         float size, charge;
84
85         /* only for vortex effector with surface falloff */
86         float nor2[3], vec_to_point2[3];
87
88         int *index; /* point index */
89 } EffectorData;
90
91 /* used for calculating the effector force */
92 typedef struct EffectorCache {
93         struct EffectorCache *next, *prev;
94
95         struct Scene *scene;
96         struct Object *ob;
97         struct ParticleSystem *psys;
98         struct SurfaceModifierData *surmd;
99
100         struct PartDeflect *pd;
101
102         /* precalculated for guides */
103         struct GuideEffectorData *guide_data;
104         float guide_loc[4], guide_dir[3], guide_radius;
105         float velocity[3];
106
107         float frame;
108         int flag;
109 } EffectorCache;
110
111 struct PartDeflect *BKE_partdeflect_new(int type);
112 void                BKE_partdeflect_free(struct PartDeflect *pd);
113
114 struct ListBase *pdInitEffectors(struct Scene *scene, struct Object *ob_src, struct ParticleSystem *psys_src, struct EffectorWeights *weights, bool for_simulation);
115 void            pdEndEffectors(struct ListBase **effectors);
116 void            pdPrecalculateEffectors(struct ListBase *effectors);
117 void            pdDoEffectors(struct ListBase *effectors, struct ListBase *colliders, struct EffectorWeights *weights, struct EffectedPoint *point, float *force, float *impulse);
118
119 void pd_point_from_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, struct EffectedPoint *point);
120 void pd_point_from_loc(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
121 void pd_point_from_soft(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
122
123 /* needed for boids */
124 float effector_falloff(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, struct EffectorWeights *weights);
125 int closest_point_on_surface(SurfaceModifierData *surmd, const float co[3], float surface_co[3], float surface_nor[3], float surface_vel[3]);
126 int get_effector_data(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, int real_velocity);
127
128 /* required for particle_system.c */
129 //void do_physical_effector(struct EffectorData *eff, struct EffectorPoint *point, float *total_force);
130 //float effector_falloff(struct EffectorData *eff, struct EffectorPoint *point, struct EffectorWeights *weights);
131
132 /* EffectedPoint->flag */
133 #define PE_WIND_AS_SPEED        1
134 #define PE_DYNAMIC_ROTATION     2
135 #define PE_USE_NORMAL_DATA      4
136
137 /* EffectorData->flag */
138 #define PE_VELOCITY_TO_IMPULSE  1
139
140 /* ======== Simulation Debugging ======== */
141
142 #define SIM_DEBUG_HASH_BASE 5381
143
144 unsigned int BKE_sim_debug_data_hash(int i);
145 unsigned int BKE_sim_debug_data_hash_combine(unsigned int kx, unsigned int ky);
146
147 /* _VA_SIM_DEBUG_HASH#(i, ...): combined hash value of multiple integers */
148 /* internal helpers*/
149 #define _VA_SIM_DEBUG_HASH1(a) \
150        (BKE_sim_debug_data_hash(a))
151 #define _VA_SIM_DEBUG_HASH2(a, b) \
152        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH1(b)))
153 #define _VA_SIM_DEBUG_HASH3(a, b, c) \
154        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH2(b, c)))
155 #define _VA_SIM_DEBUG_HASH4(a, b, c, d) \
156        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH3(b, c, d)))
157 #define _VA_SIM_DEBUG_HASH5(a, b, c, d, e) \
158        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH4(b, c, d, e)))
159 #define _VA_SIM_DEBUG_HASH6(a, b, c, d, e, f) \
160        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH5(b, c, d, e, f)))
161 #define _VA_SIM_DEBUG_HASH7(a, b, c, d, e, f, g) \
162        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH6(b, c, d, e, f, g)))
163 #define _VA_SIM_DEBUG_HASH8(a, b, c, d, e, f, g, h) \
164        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH7(b, c, d, e, f, g, h)))
165
166 #define SIM_DEBUG_HASH(...) VA_NARGS_CALL_OVERLOAD(_VA_SIM_DEBUG_HASH, __VA_ARGS__)
167
168 typedef struct SimDebugElement {
169         unsigned int category_hash;
170         unsigned int hash;
171
172         int type;
173         float color[3];
174
175         float v1[3], v2[3];
176         char str[64];
177 } SimDebugElement;
178
179 typedef enum eSimDebugElement_Type {
180         SIM_DEBUG_ELEM_DOT,
181         SIM_DEBUG_ELEM_CIRCLE,
182         SIM_DEBUG_ELEM_LINE,
183         SIM_DEBUG_ELEM_VECTOR,
184         SIM_DEBUG_ELEM_STRING,
185 } eSimDebugElement_Type;
186
187 typedef struct SimDebugData {
188         struct GHash *gh;
189 } SimDebugData;
190
191 extern SimDebugData *_sim_debug_data;
192
193 void BKE_sim_debug_data_set_enabled(bool enable);
194 bool BKE_sim_debug_data_get_enabled(void);
195 void BKE_sim_debug_data_free(void);
196
197 void BKE_sim_debug_data_add_element(int type, const float v1[3], const float v2[3], const char *str,
198                                     float r, float g, float b, const char *category, unsigned int hash);
199 void BKE_sim_debug_data_remove_element(unsigned int hash);
200
201 #define BKE_sim_debug_data_add_dot(p, r, g, b, category, ...) { \
202         const float v2[3] = { 0.0f, 0.0f, 0.0f }; \
203         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_DOT, p, v2, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
204 }
205
206 #define BKE_sim_debug_data_add_circle(p, radius, r, g, b, category, ...) { \
207         const float v2[3] = { radius, 0.0f, 0.0f }; \
208         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_CIRCLE, p, v2, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
209 }
210
211 #define BKE_sim_debug_data_add_line(p1, p2, r, g, b, category, ...) { \
212         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_LINE, p1, p2, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
213 }
214
215 #define BKE_sim_debug_data_add_vector(p, d, r, g, b, category, ...) { \
216         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_VECTOR, p, d, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
217 }
218
219 #define BKE_sim_debug_data_add_string(p, str, r, g, b, category, ...) { \
220         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_STRING, p, NULL, str, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
221 }
222
223 #define BKE_sim_debug_data_remove(...) \
224         BKE_sim_debug_data_remove_element(SIM_DEBUG_HASH(__VA_ARGS__))
225
226 void BKE_sim_debug_data_clear(void);
227 void BKE_sim_debug_data_clear_category(const char *category);
228
229 #endif