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