-= Cloth cleanup =-
[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 * This struct contains all the global data required to run a simulation.
39 * At the time of this writing, this structure contains data appropriate
40 * to run a simulation as described in Deformation Constraints in a
41 * Mass-Spring Model to Describe Rigid Cloth Behavior by Xavier Provot.
42 *
43 * I've tried to keep similar, if not exact names for the variables as
44 * are presented in the paper.  Where I've changed the concept slightly,
45 * as in stepsPerFrame comapred to the time step in the paper, I've used
46 * variables with different names to minimize confusion.
47 **/
48 typedef struct SimulationSettings
49 {
50         short   vgroup_mass;    /* optional vertexgroup name for assigning weight.*/
51         short   vgroup_struct;  /* vertex group for scaling structural stiffness */
52         float   mingoal;        /* see SB */
53         int     preroll;        /* How many frames of simulation to do before we start. */
54         float   Cdis;           /* Mechanical damping of springs.               */
55         float   Cvi;            /* Viscous/fluid damping.                       */
56         int     stepsPerFrame;  /* Number of time steps per frame.              */
57         float   gravity [3];    /* Gravity/external force vector.               */
58         float   ufluid [3];     /* Velocity vector of the fluid.                */
59         float   dt;             /* This is the duration of our time step, computed.     */
60         float   mass;           /* The mass of the entire cloth.                */
61         float   structural;     /* Structural spring stiffness.                 */
62         float   shear;          /* Shear spring stiffness.                      */
63         float   bending;        /* Flexion spring stiffness.                    */
64         float   sim_time;
65         int     flags;          /* flags, see CSIMSETT_FLAGS enum above.        */
66         short   solver_type;    /* which solver should be used?         txold   */
67         short   vgroup_bend;    /* vertex group for scaling bending stiffness */
68         float   maxgoal;        /* see SB */
69         float   eff_force_scale;/* Scaling of effector forces (see softbody_calc_forces).*/
70         float   eff_wind_scale; /* Scaling of effector wind (see softbody_calc_forces). */
71         float   sim_time_old;
72         struct  LinkNode *cache; /* UNUSED atm */
73         float   defgoal;
74         int     goalfrict;
75         float   goalspring;
76         int     maxspringlen;   /* in percent!; if tearing enabled, a spring will get cut */
77         int     lastframe;      /* frame on which simulation stops */
78         int     firstframe;     /* frame on which simulation starts */
79         int     lastcachedframe;
80         int     editedframe;    /* which frame is in buffer */
81         int     autoprotect;    /* starting from this frame, cache gets protected  */
82         float   max_bend;       /* max bending scaling value, min is "bending" */
83         float   max_struct;     /* max structural scaling value, min is "structural" */
84         float   max_shear;      /* max shear scaling value, UNUSED */
85         int     firstcachedframe;
86         int pad;
87 }
88 SimulationSettings;
89
90
91 typedef struct CollisionSettings
92 {
93         float   epsilon;                /* The radius of a particle in the cloth.               */
94         float   self_friction;          /* Fiction/damping with self contact.                   */
95         float   friction;               /* Friction/damping applied on contact with other object.*/
96         short   collision_type;         /* which collision system is used.                      */
97         short   loop_count;             /* How many iterations for the collision loop.          */
98         struct  LinkNode *collision_list;       /* e.g. pointer to temp memory for collisions */
99         int     flags;                  /* collision flags defined in BKE_cloth.h */
100         float   avg_spring_len;         /* for selfcollision */
101 }
102 CollisionSettings;
103
104
105 /**
106 * This structure describes a cloth object against which the
107 * simulation can run.
108 *
109 * The m and n members of this structure represent the assumed
110 * rectangular ordered grid for which the original paper is written.
111 * At some point they need to disappear and we need to determine out
112 * own connectivity of the mesh based on the actual edges in the mesh.
113 *
114 **/
115 typedef struct Cloth
116 {
117         struct ClothVertex      *verts;                 /* The vertices that represent this cloth. */
118         struct  LinkNode        *springs;               /* The springs connecting the mesh. */
119         unsigned int            numverts;               /* The number of verts == m * n. */
120         unsigned int            numsprings;             /* The count of springs. */
121         unsigned int            numfaces;
122         unsigned char           old_solver_type;        /* unused, only 1 solver here */
123         unsigned char           pad2;
124         short                   pad3;
125         struct BVH              *tree;                  /* collision tree for this cloth object */
126         struct MFace            *mfaces;
127         struct Implicit_Data    *implicit;              /* our implicit solver connects to this pointer */
128 }
129 Cloth;
130
131 #endif