Merge branch 'blender2.7' of git.blender.org:blender
[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
112 struct PartDeflect *BKE_partdeflect_new(int type);
113 struct PartDeflect *BKE_partdeflect_copy(const struct PartDeflect *pd_src);
114 void                BKE_partdeflect_free(struct PartDeflect *pd);
115
116 struct ListBase *BKE_effector_relations_create(
117         struct Depsgraph *depsgraph,
118         struct ViewLayer *view_layer,
119         struct Collection *collection);
120 void BKE_effector_relations_free(struct ListBase *lb);
121
122 struct ListBase *BKE_effectors_create(
123         struct Depsgraph *depsgraph,
124         struct Object *ob_src,
125         struct ParticleSystem *psys_src,
126         struct EffectorWeights *weights);
127 void BKE_effectors_apply(
128         struct ListBase *effectors,
129         struct ListBase *colliders,
130         struct EffectorWeights *weights,
131         struct EffectedPoint *point,
132         float *force,
133         float *impulse);
134 void BKE_effectors_free(struct ListBase *lb);
135
136 void pd_point_from_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, struct EffectedPoint *point);
137 void pd_point_from_loc(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
138 void pd_point_from_soft(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
139
140 /* needed for boids */
141 float effector_falloff(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, struct EffectorWeights *weights);
142 int closest_point_on_surface(SurfaceModifierData *surmd, const float co[3], float surface_co[3], float surface_nor[3], float surface_vel[3]);
143 int get_effector_data(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, int real_velocity);
144
145 /* required for particle_system.c */
146 //void do_physical_effector(struct EffectorData *eff, struct EffectorPoint *point, float *total_force);
147 //float effector_falloff(struct EffectorData *eff, struct EffectorPoint *point, struct EffectorWeights *weights);
148
149 /* EffectedPoint->flag */
150 #define PE_WIND_AS_SPEED        1
151 #define PE_DYNAMIC_ROTATION     2
152 #define PE_USE_NORMAL_DATA      4
153
154 /* EffectorData->flag */
155 #define PE_VELOCITY_TO_IMPULSE  1
156
157 /* ======== Simulation Debugging ======== */
158
159 #define SIM_DEBUG_HASH_BASE 5381
160
161 unsigned int BKE_sim_debug_data_hash(int i);
162 unsigned int BKE_sim_debug_data_hash_combine(unsigned int kx, unsigned int ky);
163
164 /* _VA_SIM_DEBUG_HASH#(i, ...): combined hash value of multiple integers */
165 /* internal helpers*/
166 #define _VA_SIM_DEBUG_HASH1(a) \
167        (BKE_sim_debug_data_hash(a))
168 #define _VA_SIM_DEBUG_HASH2(a, b) \
169        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH1(b)))
170 #define _VA_SIM_DEBUG_HASH3(a, b, c) \
171        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH2(b, c)))
172 #define _VA_SIM_DEBUG_HASH4(a, b, c, d) \
173        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH3(b, c, d)))
174 #define _VA_SIM_DEBUG_HASH5(a, b, c, d, e) \
175        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH4(b, c, d, e)))
176 #define _VA_SIM_DEBUG_HASH6(a, b, c, d, e, f) \
177        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH5(b, c, d, e, f)))
178 #define _VA_SIM_DEBUG_HASH7(a, b, c, d, e, f, g) \
179        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH6(b, c, d, e, f, g)))
180 #define _VA_SIM_DEBUG_HASH8(a, b, c, d, e, f, g, h) \
181        (BKE_sim_debug_data_hash_combine(BKE_sim_debug_data_hash(a), _VA_SIM_DEBUG_HASH7(b, c, d, e, f, g, h)))
182
183 #define SIM_DEBUG_HASH(...) VA_NARGS_CALL_OVERLOAD(_VA_SIM_DEBUG_HASH, __VA_ARGS__)
184
185 typedef struct SimDebugElement {
186         unsigned int category_hash;
187         unsigned int hash;
188
189         int type;
190         float color[3];
191
192         float v1[3], v2[3];
193         char str[64];
194 } SimDebugElement;
195
196 typedef enum eSimDebugElement_Type {
197         SIM_DEBUG_ELEM_DOT,
198         SIM_DEBUG_ELEM_CIRCLE,
199         SIM_DEBUG_ELEM_LINE,
200         SIM_DEBUG_ELEM_VECTOR,
201         SIM_DEBUG_ELEM_STRING,
202 } eSimDebugElement_Type;
203
204 typedef struct SimDebugData {
205         struct GHash *gh;
206 } SimDebugData;
207
208 extern SimDebugData *_sim_debug_data;
209
210 void BKE_sim_debug_data_set_enabled(bool enable);
211 bool BKE_sim_debug_data_get_enabled(void);
212 void BKE_sim_debug_data_free(void);
213
214 void BKE_sim_debug_data_add_element(int type, const float v1[3], const float v2[3], const char *str,
215                                     float r, float g, float b, const char *category, unsigned int hash);
216 void BKE_sim_debug_data_remove_element(unsigned int hash);
217
218 #define BKE_sim_debug_data_add_dot(p, r, g, b, category, ...) { \
219         const float v2[3] = { 0.0f, 0.0f, 0.0f }; \
220         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_DOT, p, v2, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
221 }
222
223 #define BKE_sim_debug_data_add_circle(p, radius, r, g, b, category, ...) { \
224         const float v2[3] = { radius, 0.0f, 0.0f }; \
225         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_CIRCLE, p, v2, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
226 }
227
228 #define BKE_sim_debug_data_add_line(p1, p2, r, g, b, category, ...) { \
229         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_LINE, p1, p2, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
230 }
231
232 #define BKE_sim_debug_data_add_vector(p, d, r, g, b, category, ...) { \
233         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_VECTOR, p, d, NULL, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
234 }
235
236 #define BKE_sim_debug_data_add_string(p, str, r, g, b, category, ...) { \
237         BKE_sim_debug_data_add_element(SIM_DEBUG_ELEM_STRING, p, NULL, str, r, g, b, category, SIM_DEBUG_HASH(__VA_ARGS__)); \
238 }
239
240 #define BKE_sim_debug_data_remove(...) \
241         BKE_sim_debug_data_remove_element(SIM_DEBUG_HASH(__VA_ARGS__))
242
243 void BKE_sim_debug_data_clear(void);
244 void BKE_sim_debug_data_clear_category(const char *category);
245
246 #endif