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