Effector calculations are now thread safe.
[blender.git] / source / blender / blenkernel / BKE_effect.h
1 /*
2  * $Id$ 
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef BKE_EFFECT_H
30 #define BKE_EFFECT_H
31
32 /** \file BKE_effect.h
33  *  \ingroup bke
34  *  \since March 2001
35  *  \author nzc
36  */
37 #include "DNA_modifier_types.h"
38
39 struct Object;
40 struct Scene;
41 struct Effect;
42 struct ListBase;
43 struct Particle;
44 struct Group;
45 struct RNG;
46 struct ParticleSimulationData;
47 struct ParticleData;
48 struct ParticleKey;
49
50 struct EffectorWeights *BKE_add_effector_weights(struct Group *group);
51 struct PartDeflect *object_add_collision_fields(int type);
52
53 /* Input to effector code */
54 typedef struct EffectedPoint {
55         float *loc;
56         float *vel;
57         float *ave;     /* angular velocity for particles with dynamic rotation */
58         float *rot; /* rotation quaternion for particles with dynamic rotation */
59         float vel_to_frame;
60         float vel_to_sec;
61
62         /* only for particles */
63         float size, charge;
64
65         unsigned int flag;
66         int index;
67
68         struct ParticleSystem *psys;    /* particle system the point belongs to */
69 } EffectedPoint;
70
71 typedef struct GuideEffectorData {
72         float vec_to_point[3];
73         float strength;
74 } GuideEffectorData;
75
76 typedef struct EffectorData {
77         /* Effector point */
78         float loc[3];
79         float nor[3];
80         float vel[3];
81
82         float vec_to_point[3];
83         float distance, falloff;
84
85         /* only for effector particles */
86         float size, charge;
87
88         /* only for vortex effector with surface falloff */
89         float nor2[3], vec_to_point2[3];
90
91         int *index;     /* point index */
92 } EffectorData;
93
94 /* used for calculating the effector force */
95 typedef struct EffectorCache {
96         struct EffectorCache *next, *prev;
97
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_effect(struct Effect *eff);
115 void free_effects(struct ListBase *lb);
116 struct Effect *copy_effect(struct Effect *eff);
117 void copy_effects(struct ListBase *lbn, struct ListBase *lb);
118 void deselectall_eff(struct Object *ob);
119
120 struct PartEff *give_parteff(struct Object *ob);
121
122
123 void                    free_partdeflect(struct PartDeflect *pd);
124 struct ListBase *pdInitEffectors(struct Scene *scene, struct Object *ob_src, struct ParticleSystem *psys_src, struct EffectorWeights *weights);
125 void                    pdEndEffectors(struct ListBase **effectors);
126 void                    pdDoEffectors(struct ListBase *effectors, struct ListBase *colliders, struct EffectorWeights *weights, struct EffectedPoint *point, float *force, float *impulse);
127
128 void pd_point_from_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, struct EffectedPoint *point);
129 void pd_point_from_loc(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
130 void pd_point_from_soft(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
131
132 /* needed for boids */
133 float effector_falloff(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, struct EffectorWeights *weights);
134 int closest_point_on_surface(struct SurfaceModifierData *surmd, float *co, float *surface_co, float *surface_nor, float *surface_vel);
135 int get_effector_data(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, int real_velocity);
136
137 /* required for particle_system.c */
138 //void do_physical_effector(struct EffectorData *eff, struct EffectorPoint *point, float *total_force);
139 //float effector_falloff(struct EffectorData *eff, struct EffectorPoint *point, struct EffectorWeights *weights);
140
141 /* EffectedPoint->flag */
142 #define PE_WIND_AS_SPEED                1
143 #define PE_DYNAMIC_ROTATION             2
144 #define PE_USE_NORMAL_DATA              4
145
146 /* EffectorData->flag */
147 #define PE_VELOCITY_TO_IMPULSE  1
148
149
150 #endif
151