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