Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_effect.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_EFFECT_H__
20 #define __BKE_EFFECT_H__
21
22 /** \file
23  * \ingroup bke
24  */
25
26 #include "DNA_modifier_types.h"
27
28 #include "BLI_utildefines.h"
29
30 struct Collection;
31 struct Depsgraph;
32 struct ListBase;
33 struct Object;
34 struct ParticleData;
35 struct ParticleKey;
36 struct ParticleSimulationData;
37 struct Scene;
38 struct ViewLayer;
39
40 struct EffectorWeights *BKE_effector_add_weights(struct Collection *collection);
41
42 /* Input to effector code */
43 typedef struct EffectedPoint {
44   float *loc;
45   float *vel;
46   float *ave; /* angular velocity for particles with dynamic rotation */
47   float *rot; /* rotation quaternion for particles with dynamic rotation */
48   float vel_to_frame;
49   float vel_to_sec;
50
51   /* only for particles */
52   float size, charge;
53
54   unsigned int flag;
55   int index;
56
57   struct ParticleSystem *psys; /* particle system the point belongs to */
58 } EffectedPoint;
59
60 typedef struct GuideEffectorData {
61   float vec_to_point[3];
62   float strength;
63 } GuideEffectorData;
64
65 typedef struct EffectorData {
66   /* Effector point */
67   float loc[3];
68   float nor[3];
69   float vel[3];
70
71   float vec_to_point[3];
72   float distance, falloff;
73
74   /* only for effector particles */
75   float size, charge;
76
77   /* only for vortex effector with surface falloff */
78   float nor2[3], vec_to_point2[3];
79
80   int *index; /* point index */
81 } EffectorData;
82
83 /* used for calculating the effector force */
84 typedef struct EffectorCache {
85   struct EffectorCache *next, *prev;
86
87   struct Depsgraph *depsgraph;
88   struct Scene *scene;
89   struct Object *ob;
90   struct ParticleSystem *psys;
91   struct SurfaceModifierData *surmd;
92
93   struct PartDeflect *pd;
94
95   /* precalculated for guides */
96   struct GuideEffectorData *guide_data;
97   float guide_loc[4], guide_dir[3], guide_radius;
98
99   float frame;
100   int flag;
101 } EffectorCache;
102
103 typedef struct EffectorRelation {
104   struct EffectorRelation *next, *prev;
105
106   struct Object *ob;
107   struct ParticleSystem *psys;
108   struct PartDeflect *pd;
109 } EffectorRelation;
110
111 struct PartDeflect *BKE_partdeflect_new(int type);
112 struct PartDeflect *BKE_partdeflect_copy(const struct PartDeflect *pd_src);
113 void BKE_partdeflect_free(struct PartDeflect *pd);
114
115 struct ListBase *BKE_effector_relations_create(struct Depsgraph *depsgraph,
116                                                struct ViewLayer *view_layer,
117                                                struct Collection *collection);
118 void BKE_effector_relations_free(struct ListBase *lb);
119
120 struct ListBase *BKE_effectors_create(struct Depsgraph *depsgraph,
121                                       struct Object *ob_src,
122                                       struct ParticleSystem *psys_src,
123                                       struct EffectorWeights *weights);
124 void BKE_effectors_apply(struct ListBase *effectors,
125                          struct ListBase *colliders,
126                          struct EffectorWeights *weights,
127                          struct EffectedPoint *point,
128                          float *force,
129                          float *impulse);
130 void BKE_effectors_free(struct ListBase *lb);
131
132 void pd_point_from_particle(struct ParticleSimulationData *sim,
133                             struct ParticleData *pa,
134                             struct ParticleKey *state,
135                             struct EffectedPoint *point);
136 void pd_point_from_loc(
137     struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
138 void pd_point_from_soft(
139     struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
140
141 /* needed for boids */
142 float effector_falloff(struct EffectorCache *eff,
143                        struct EffectorData *efd,
144                        struct EffectedPoint *point,
145                        struct EffectorWeights *weights);
146 int closest_point_on_surface(SurfaceModifierData *surmd,
147                              const float co[3],
148                              float surface_co[3],
149                              float surface_nor[3],
150                              float surface_vel[3]);
151 int get_effector_data(struct EffectorCache *eff,
152                       struct EffectorData *efd,
153                       struct EffectedPoint *point,
154                       int real_velocity);
155
156 /* required for particle_system.c */
157 //void do_physical_effector(struct EffectorData *eff, struct EffectorPoint *point, float *total_force);
158 //float effector_falloff(struct EffectorData *eff, struct EffectorPoint *point, struct EffectorWeights *weights);
159
160 /* EffectedPoint->flag */
161 #define PE_WIND_AS_SPEED 1
162 #define PE_DYNAMIC_ROTATION 2
163 #define PE_USE_NORMAL_DATA 4
164
165 /* EffectorData->flag */
166 #define PE_VELOCITY_TO_IMPULSE 1
167
168 /* ======== Simulation Debugging ======== */
169
170 #define SIM_DEBUG_HASH_BASE 5381
171
172 unsigned int BKE_sim_debug_data_hash(int i);
173 unsigned int BKE_sim_debug_data_hash_combine(unsigned int kx, unsigned int ky);
174
175 /* _VA_SIM_DEBUG_HASH#(i, ...): combined hash value of multiple integers */
176 /* internal helpers*/
177 #define _VA_SIM_DEBUG_HASH1(a) (BKE_sim_debug_data_hash(a))
178 #define _VA_SIM_DEBUG_HASH2(a, b) \
179   (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH1(b)))
180 #define _VA_SIM_DEBUG_HASH3(a, b, c) \
181   (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH2(b, c)))
182 #define _VA_SIM_DEBUG_HASH4(a, b, c, d) \
183   (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH3(b, c, d)))
184 #define _VA_SIM_DEBUG_HASH5(a, b, c, d, e) \
185   (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH4(b, c, d, e)))
186 #define _VA_SIM_DEBUG_HASH6(a, b, c, d, e, f) \
187   (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH5(b, c, d, e, f)))
188 #define _VA_SIM_DEBUG_HASH7(a, b, c, d, e, f, g) \
189   (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), \
190                                    _VA_SIM_DEBUG_HASH6(b, c, d, e, f, g)))
191 #define _VA_SIM_DEBUG_HASH8(a, b, c, d, e, f, g, h) \
192   (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), \
193                                    _VA_SIM_DEBUG_HASH7(b, c, d, e, f, g, h)))
194
195 #define SIM_DEBUG_HASH(...) VA_NARGS_CALL_OVERLOAD(_VA_SIM_DEBUG_HASH, __VA_ARGS__)
196
197 typedef struct SimDebugElement {
198   unsigned int category_hash;
199   unsigned int hash;
200
201   int type;
202   float color[3];
203
204   float v1[3], v2[3];
205   char str[64];
206 } SimDebugElement;
207
208 typedef enum eSimDebugElement_Type {
209   SIM_DEBUG_ELEM_DOT,
210   SIM_DEBUG_ELEM_CIRCLE,
211   SIM_DEBUG_ELEM_LINE,
212   SIM_DEBUG_ELEM_VECTOR,
213   SIM_DEBUG_ELEM_STRING,
214 } eSimDebugElement_Type;
215
216 typedef struct SimDebugData {
217   struct GHash *gh;
218 } SimDebugData;
219
220 extern SimDebugData *_sim_debug_data;
221
222 void BKE_sim_debug_data_set_enabled(bool enable);
223 bool BKE_sim_debug_data_get_enabled(void);
224 void BKE_sim_debug_data_free(void);
225
226 void BKE_sim_debug_data_add_element(int type,
227                                     const float v1[3],
228                                     const float v2[3],
229                                     const char *str,
230                                     float r,
231                                     float g,
232                                     float b,
233                                     const char *category,
234                                     unsigned int hash);
235 void BKE_sim_debug_data_remove_element(unsigned int hash);
236
237 #define BKE_sim_debug_data_add_dot(p, r, g, b, category, ...) \
238   { \
239     const float v2[3] = {0.0f, 0.0f, 0.0f}; \
240     BKE_sim_debug_data_add_element( \
241         SIM_DEBUG_ELEM_DOT, p, v2, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
242   }
243
244 #define BKE_sim_debug_data_add_circle(p, radius, r, g, b, category, ...) \
245   { \
246     const float v2[3] = {radius, 0.0f, 0.0f}; \
247     BKE_sim_debug_data_add_element( \
248         SIM_DEBUG_ELEM_CIRCLE, p, v2, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
249   }
250
251 #define BKE_sim_debug_data_add_line(p1, p2, r, g, b, category, ...) \
252   { \
253     BKE_sim_debug_data_add_element( \
254         SIM_DEBUG_ELEM_LINE, p1, p2, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
255   }
256
257 #define BKE_sim_debug_data_add_vector(p, d, r, g, b, category, ...) \
258   { \
259     BKE_sim_debug_data_add_element( \
260         SIM_DEBUG_ELEM_VECTOR, p, d, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
261   }
262
263 #define BKE_sim_debug_data_add_string(p, str, r, g, b, category, ...) \
264   { \
265     BKE_sim_debug_data_add_element( \
266         SIM_DEBUG_ELEM_STRING, p, NULL, str, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
267   }
268
269 #define BKE_sim_debug_data_remove(...) \
270   BKE_sim_debug_data_remove_element(SIM_DEBUG_HASH(__VA_ARGS__))
271
272 void BKE_sim_debug_data_clear(void);
273 void BKE_sim_debug_data_clear_category(const char *category);
274
275 #endif