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