Marge with trunk: svn merge -r 12050:12057 https://svn.blender.org/svnroot/bf-blender...
[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         int     flags;                  /* General flags per vertex.                    */
45         float   v [3];                  /* The velocity of the point.                   */
46         float   xconst [3];             /* constrained position         */
47         float   x [3];                  /* The current position of this vertice.        */
48         float   xold [3];               /* The previous position of this vertice.       */
49         float   tx [3]; 
50         float   txold [3];
51         float   tv[3];
52         float   mass;                   /* mass / weight of the vertex                  */
53         float   goal;                   /* goal, from SB                                */
54 } ClothVertex;
55
56
57 /**
58 * The definition of a spring.
59 */
60 typedef struct ClothSpring {
61         int     ij;             /* Pij from the paper, one end of the spring.   */
62         int     kl;             /* Pkl from the paper, one end of the spring.   */
63         float   restlen;        /* The original length of the spring.   */
64         int     matrix_index;   /* needed for implicit */
65         int     type;
66         int     flags;          /* defined in BKE_cloth.h, e.g. deactivated due to tearing */
67 } ClothSpring;
68
69
70
71 /**
72 * This struct contains all the global data required to run a simulation.
73 * At the time of this writing, this structure contains data appropriate
74 * to run a simulation as described in Deformation Constraints in a
75 * Mass-Spring Model to Describe Rigid Cloth Behavior by Xavier Provot.
76 *
77 * I've tried to keep similar, if not exact names for the variables as
78 * are presented in the paper.  Where I've changed the concept slightly,
79 * as in stepsPerFrame comapred to the time step in the paper, I've used
80 * variables with different names to minimize confusion.
81 **/
82 typedef struct SimulationSettings {
83         short   vgroup_mass;    /* optional vertexgroup name for assigning weight.      */
84         short   pad;
85         float   mingoal; /* see SB */
86         int     preroll;        /* How many frames of simulation to do before we start. */
87         float   Cdis;           /* Mechanical damping of springs.               */
88         float   Cvi;            /* Viscous/fluid damping.                       */
89         int     stepsPerFrame;  /* Number of time steps per frame.                      */
90         float   gravity [3];    /* Gravity/external force vector.                       */
91         float   ufluid [3];     /* Velocity vector of the fluid.                */
92         float   dt;             /* This is the duration of our time step, computed.             */
93         float   mass;           /* The mass of the entire cloth.                */
94         float   structural;     /* Structural spring stiffness.                 */
95         float   shear;          /* Shear spring stiffness.                      */
96         float   bending;        /* Flexion spring stiffness.                    */
97         float   sim_time;       
98         int     flags;          /* flags, see CSIMSETT_FLAGS enum above.        */
99         short   solver_type;    /* which solver should be used?                         */
100         short   pad2;
101         float   maxgoal; /* see SB */
102         float   eff_force_scale;/* Scaling of effector forces (see softbody_calc_forces).*/
103         float   eff_wind_scale; /* Scaling of effector wind (see softbody_calc_forces). */
104         float   sim_time_old;
105         struct  LinkNode *cache;
106         float   defgoal;
107         int     goalfrict;
108         float   goalspring;
109         int     maxspringlen;   /* in percent!; if tearing enabled, a spring will get cut */
110         int     lastframe;      /* frame on which simulation stops */
111         int     firstframe;     /* frame on which simulation starts */
112 } SimulationSettings;
113
114
115 typedef struct CollisionSettings {
116         float   epsilon;                /* The radius of a particle in the cloth.               */
117         float   self_friction;          /* Fiction/damping with self contact.                   */
118         float   friction;               /* Friction/damping applied on contact with other object.*/
119         short   collision_type;         /* which collision system is used.                      */
120         short   loop_count;             /* How many iterations for the collision loop.          */
121         void    *temp; /* e.g. pointer to temp memory for collisions */
122 } CollisionSettings;     
123
124
125 /**
126 * This structure describes a cloth object against which the
127 * simulation can run.
128 *
129 * The m and n members of this structure represent the assumed
130 * rectangular ordered grid for which the original paper is written.
131 * At some point they need to disappear and we need to determine out
132 * own connectivity of the mesh based on the actual edges in the mesh.
133 *
134 **/
135 typedef struct Cloth {
136         struct ClothVertex      *verts;                 /* The vertices that represent this cloth.       */  
137         struct ClothSpring      *springs;               /* The springs connecting the mesh.              */
138         unsigned int            numverts;               /* The number of verts == m * n.                 */
139         unsigned int            numsprings;             /* The count of springs.                        */
140         unsigned char           *facemarks;
141         char                    old_solver_type;        /* Needed to allow call to free if solver changes.       */
142         char                    old_collision_type;     /* Needed to allow call to free if collision changes.*/
143         short                   pad7;
144         unsigned int            numfaces;
145         int                     pad2;
146         int                     pad4;
147         void                    *tree;                  /* collision tree for this cloth object */
148         struct MFace            *mfaces;
149         void                    *implicit;              /* our implicit solver connects to this pointer */
150 } Cloth;
151
152 #endif