Merged changes in the trunk up to revision 42116.
[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 #include "DNA_modifier_types.h"
36
37 struct Object;
38 struct Scene;
39 struct Effect;
40 struct ListBase;
41 struct Particle;
42 struct Group;
43 struct RNG;
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_effect(struct Effect *eff);
113 void free_effects(struct ListBase *lb);
114 struct Effect *copy_effect(struct Effect *eff);
115 void copy_effects(struct ListBase *lbn, struct ListBase *lb);
116 void deselectall_eff(struct Object *ob);
117
118 struct PartEff *give_parteff(struct Object *ob);
119
120
121 void                    free_partdeflect(struct PartDeflect *pd);
122 struct ListBase *pdInitEffectors(struct Scene *scene, struct Object *ob_src, struct ParticleSystem *psys_src, struct EffectorWeights *weights);
123 void                    pdEndEffectors(struct ListBase **effectors);
124 void                    pdDoEffectors(struct ListBase *effectors, struct ListBase *colliders, struct EffectorWeights *weights, struct EffectedPoint *point, float *force, float *impulse);
125
126 void pd_point_from_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, struct EffectedPoint *point);
127 void pd_point_from_loc(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
128 void pd_point_from_soft(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
129
130 /* needed for boids */
131 float effector_falloff(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, struct EffectorWeights *weights);
132 int closest_point_on_surface(SurfaceModifierData *surmd, const float co[3], float surface_co[3], float surface_nor[3], float surface_vel[3]);
133 int get_effector_data(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, int real_velocity);
134
135 /* required for particle_system.c */
136 //void do_physical_effector(struct EffectorData *eff, struct EffectorPoint *point, float *total_force);
137 //float effector_falloff(struct EffectorData *eff, struct EffectorPoint *point, struct EffectorWeights *weights);
138
139 /* EffectedPoint->flag */
140 #define PE_WIND_AS_SPEED                1
141 #define PE_DYNAMIC_ROTATION             2
142 #define PE_USE_NORMAL_DATA              4
143
144 /* EffectorData->flag */
145 #define PE_VELOCITY_TO_IMPULSE  1
146
147
148 #endif
149