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