Code comments add to collision interface
[blender.git] / source / blender / makesdna / DNA_cloth_types.h
1 /**
2 * $Id: DNA_cloth_types.h,v 1.1 2007/08/01 02:28:34 daniel Exp $
3 *
4 * ***** BEGIN GPL/BL DUAL 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. The Blender
10 * Foundation also sells licenses for use in proprietary software under
11 * the Blender License.  See http://www.blender.org/BL/ for information
12 * about this.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22 *
23 * The Original Code is Copyright (C) 2006 by NaN Holding BV.
24 * All rights reserved.
25 *
26 * The Original Code is: all of this file.
27 *
28 * Contributor(s): Daniel (Genscher), Todd Koeckeritz  (zaz)
29 *
30 * ***** END GPL/BL DUAL LICENSE BLOCK *****
31 */
32 #ifndef DNA_CLOTH_TYPES_H
33 #define DNA_CLOTH_TYPES_H
34
35 #include "DNA_listBase.h"
36
37
38 /**
39 * Pin and unpin frames are the frames on which the vertices stop moving.
40 * They will assume the position they had prior to pinFrame until unpinFrame
41 * is reached.
42 */
43 typedef struct ClothVertex
44 {
45         int     flags;          /* General flags per vertex.            */
46         float   v [3];          /* The velocity of the point.           */
47         float   xconst [3];     /* constrained position                 */
48         float   x [3];          /* The current position of this vertex. */
49         float   xold [3];       /* The previous position of this vertex.*/
50         float   tx [3];         /* temporary position */
51         float   txold [3];      /* temporary old position */
52         float   tv[3];          /* temporary "velocity", mostly used as tv = tx-txold */
53         float   mass;           /* mass / weight of the vertex          */
54         float   goal;           /* goal, from SB                        */
55         float   impulse[3];     /* used in collision.c */
56         unsigned int impulse_count; /* same as above */
57 }
58 ClothVertex;
59
60
61 /**
62 * The definition of a spring.
63 */
64 typedef struct ClothSpring
65 {
66         int     ij;             /* Pij from the paper, one end of the spring.   */
67         int     kl;             /* Pkl from the paper, one end of the spring.   */
68         float   restlen;        /* The original length of the spring.   */
69         int     matrix_index;   /* needed for implicit solver (fast lookup) */
70         int     type;           /* types defined in BKE_cloth.h ("springType") */
71         int     flags;          /* defined in BKE_cloth.h, e.g. deactivated due to tearing */
72         float dfdx[3][3];
73         float dfdv[3][3];
74         float f[3];
75 }
76 ClothSpring;
77
78
79
80 /**
81 * This struct contains all the global data required to run a simulation.
82 * At the time of this writing, this structure contains data appropriate
83 * to run a simulation as described in Deformation Constraints in a
84 * Mass-Spring Model to Describe Rigid Cloth Behavior by Xavier Provot.
85 *
86 * I've tried to keep similar, if not exact names for the variables as
87 * are presented in the paper.  Where I've changed the concept slightly,
88 * as in stepsPerFrame comapred to the time step in the paper, I've used
89 * variables with different names to minimize confusion.
90 **/
91 typedef struct SimulationSettings
92 {
93         short   vgroup_mass;    /* optional vertexgroup name for assigning weight.      */
94         short   pad;
95         float   mingoal;        /* see SB */
96         int     preroll;        /* How many frames of simulation to do before we start. */
97         float   Cdis;           /* Mechanical damping of springs.               */
98         float   Cvi;            /* Viscous/fluid damping.                       */
99         int     stepsPerFrame;  /* Number of time steps per frame.                      */
100         float   gravity [3];    /* Gravity/external force vector.                       */
101         float   ufluid [3];     /* Velocity vector of the fluid.                */
102         float   dt;             /* This is the duration of our time step, computed.             */
103         float   mass;           /* The mass of the entire cloth.                */
104         float   structural;     /* Structural spring stiffness.                 */
105         float   shear;          /* Shear spring stiffness.                      */
106         float   bending;        /* Flexion spring stiffness.                    */
107         float   sim_time;
108         int     flags;          /* flags, see CSIMSETT_FLAGS enum above.        */
109         short   solver_type;    /* which solver should be used?                         */
110         short   pad2;
111         float   maxgoal;        /* see SB */
112         float   eff_force_scale;/* Scaling of effector forces (see softbody_calc_forces).*/
113         float   eff_wind_scale; /* Scaling of effector wind (see softbody_calc_forces). */
114         float   sim_time_old;
115         struct  LinkNode *cache;
116         float   defgoal;
117         int     goalfrict;
118         float   goalspring;
119         int     maxspringlen;   /* in percent!; if tearing enabled, a spring will get cut */
120         int     lastframe;      /* frame on which simulation stops */
121         int     firstframe;     /* frame on which simulation starts */
122 }
123 SimulationSettings;
124
125
126 typedef struct CollisionSettings
127 {
128         float   epsilon;                /* The radius of a particle in the cloth.               */
129         float   self_friction;          /* Fiction/damping with self contact.                   */
130         float   friction;               /* Friction/damping applied on contact with other object.*/
131         short   collision_type;         /* which collision system is used.                      */
132         short   loop_count;             /* How many iterations for the collision loop.          */
133         int     flags;                  /* collision flags defined in BKE_cloth.h */
134         int     pad;
135 }
136 CollisionSettings;
137
138
139 /**
140 * This structure describes a cloth object against which the
141 * simulation can run.
142 *
143 * The m and n members of this structure represent the assumed
144 * rectangular ordered grid for which the original paper is written.
145 * At some point they need to disappear and we need to determine out
146 * own connectivity of the mesh based on the actual edges in the mesh.
147 *
148 **/
149 typedef struct Cloth
150 {
151         struct ClothVertex      *verts;                 /* The vertices that represent this cloth. */
152         struct  LinkNode        *springs;               /* The springs connecting the mesh. */
153         unsigned int            numverts;               /* The number of verts == m * n. */
154         unsigned int            numsprings;             /* The count of springs. */
155         unsigned int            numfaces;
156         unsigned char           old_solver_type;
157         unsigned char           pad2;
158         short                   pad3;
159         void                    *tree;                  /* collision tree for this cloth object */
160         struct MFace            *mfaces;
161         void                    *implicit;              /* our implicit solver connects to this pointer */
162 }
163 Cloth;
164
165 #endif