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