Cleanup: comment line length (editors)
[blender.git] / source / blender / makesdna / DNA_rigidbody_types.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) 2013 Blender Foundation
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Joshua Leung, Sergej Reich
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_rigidbody_types.h
29  *  \ingroup DNA
30  *  \brief Types and defines for representing Rigid Body entities
31  */
32
33 #ifndef __DNA_RIGIDBODY_TYPES_H__
34 #define __DNA_RIGIDBODY_TYPES_H__
35
36 #include "DNA_listBase.h"
37
38 struct Group;
39
40 struct EffectorWeights;
41
42 /* ******************************** */
43 /* RigidBody World */
44
45 /* RigidBodyWorld (rbw)
46  *
47  * Represents a "simulation scene" existing within the parent scene.
48  */
49 typedef struct RigidBodyWorld {
50         /* Sim World Settings ------------------------------------------------------------- */
51         struct EffectorWeights *effector_weights; /* effectors info */
52
53         struct Group *group;            /* Group containing objects to use for Rigid Bodies */
54         struct Object **objects;        /* Array to access group objects by index, only used at runtime */
55
56         struct Group *constraints;      /* Group containing objects to use for Rigid Body Constraints*/
57
58         int pad;
59         float ltime;                            /* last frame world was evaluated for (internal) */
60
61         /* cache */
62         struct PointCache *pointcache;
63         struct ListBase ptcaches;
64         int numbodies;              /* number of objects in rigid body group */
65
66         short steps_per_second;         /* number of simulation steps thaken per second */
67         short num_solver_iterations;/* number of constraint solver iterations made per simulation step */
68
69         int flag;                                       /* (eRigidBodyWorld_Flag) settings for this RigidBodyWorld */
70         float time_scale;                       /* used to speed up or slow down the simulation */
71
72         /* References to Physics Sim objects. Exist at runtime only ---------------------- */
73         void *physics_world;            /* Physics sim world (i.e. btDiscreteDynamicsWorld) */
74 } RigidBodyWorld;
75
76 /* Flags for RigidBodyWorld */
77 typedef enum eRigidBodyWorld_Flag {
78         /* should sim world be skipped when evaluating (user setting) */
79         RBW_FLAG_MUTED                          = (1 << 0),
80         /* sim data needs to be rebuilt */
81         RBW_FLAG_NEEDS_REBUILD          = (1 << 1),
82         /* usse split impulse when stepping the simulation */
83         RBW_FLAG_USE_SPLIT_IMPULSE      = (1 << 2)
84 } eRigidBodyWorld_Flag;
85
86 /* ******************************** */
87 /* RigidBody Object */
88
89 /* RigidBodyObject (rbo)
90  *
91  * Represents an object participating in a RigidBody sim.
92  * This is attached to each object that is currently
93  * participating in a sim.
94  */
95 typedef struct RigidBodyOb {
96         /* References to Physics Sim objects. Exist at runtime only */
97         void *physics_object;   /* Physics object representation (i.e. btRigidBody) */
98         void *physics_shape;    /* Collision shape used by physics sim (i.e. btCollisionShape) */
99
100         /* General Settings for this RigidBodyOb */
101         short type;                             /* (eRigidBodyOb_Type) role of RigidBody in sim  */
102         short shape;                    /* (eRigidBody_Shape) collision shape to use */
103
104         int flag;                               /* (eRigidBodyOb_Flag) */
105         int col_groups;                 /* Collision groups that determines which rigid bodies can collide with each other */
106         short mesh_source;              /* (eRigidBody_MeshSource) mesh source for mesh based collision shapes */
107         short pad;
108
109         /* Physics Parameters */
110         float mass;                             /* how much object 'weighs' (i.e. absolute 'amount of stuff' it holds) */
111
112         float friction;                 /* resistance of object to movement */
113         float restitution;              /* how 'bouncy' object is when it collides */
114
115         float margin;                   /* tolerance for detecting collisions */
116
117         float lin_damping;              /* damping for linear velocities */
118         float ang_damping;              /* damping for angular velocities */
119
120         float lin_sleep_thresh; /* deactivation threshold for linear velocities */
121         float ang_sleep_thresh; /* deactivation threshold for angular velocities */
122
123         float orn[4];                   /* rigid body orientation */
124         float pos[3];                   /* rigid body position */
125         float pad1;
126 } RigidBodyOb;
127
128
129 /* Participation types for RigidBodyOb */
130 typedef enum eRigidBodyOb_Type {
131         /* active geometry participant in simulation. is directly controlled by sim */
132         RBO_TYPE_ACTIVE = 0,
133         /* passive geometry participant in simulation. is directly controlled by animsys */
134         RBO_TYPE_PASSIVE
135 } eRigidBodyOb_Type;
136
137 /* Flags for RigidBodyOb */
138 typedef enum eRigidBodyOb_Flag {
139         /* rigidbody is kinematic (controlled by the animation system) */
140         RBO_FLAG_KINEMATIC                      = (1 << 0),
141         /* rigidbody needs to be validated (usually set after duplicating and not hooked up yet) */
142         RBO_FLAG_NEEDS_VALIDATE         = (1 << 1),
143         /* rigidbody shape needs refreshing (usually after exiting editmode) */
144         RBO_FLAG_NEEDS_RESHAPE          = (1 << 2),
145         /* rigidbody can be deactivated */
146         RBO_FLAG_USE_DEACTIVATION       = (1 << 3),
147         /* rigidbody is deactivated at the beginning of simulation */
148         RBO_FLAG_START_DEACTIVATED      = (1 << 4),
149         /* rigidbody is not dynamically simulated */
150         RBO_FLAG_DISABLED                       = (1 << 5),
151         /* collision margin is not embedded (only used by convex hull shapes for now) */
152         RBO_FLAG_USE_MARGIN                     = (1 << 6),
153         /* collision shape deforms during simulation (only for passive triangle mesh shapes) */
154         RBO_FLAG_USE_DEFORM                     = (1 << 7)
155 } eRigidBodyOb_Flag;
156
157 /* RigidBody Collision Shape */
158 typedef enum eRigidBody_Shape {
159                 /* simple box (i.e. bounding box) */
160         RB_SHAPE_BOX = 0,
161                 /* sphere */
162         RB_SHAPE_SPHERE,
163                 /* rounded "pill" shape (i.e. calcium tablets) */
164         RB_SHAPE_CAPSULE,
165                 /* cylinder (i.e. pringles can) */
166         RB_SHAPE_CYLINDER,
167                 /* cone (i.e. party hat) */
168         RB_SHAPE_CONE,
169
170                 /* convex hull (minimal shrinkwrap encompassing all verts) */
171         RB_SHAPE_CONVEXH,
172                 /* triangulated mesh */
173         RB_SHAPE_TRIMESH,
174
175                 /* concave mesh approximated using primitives */
176         //RB_SHAPE_COMPOUND,
177 } eRigidBody_Shape;
178
179 typedef enum eRigidBody_MeshSource {
180         /* base mesh */
181         RBO_MESH_BASE = 0,
182         /* only deformations */
183         RBO_MESH_DEFORM,
184         /* final derived mesh */
185         RBO_MESH_FINAL
186 } eRigidBody_MeshSource;
187
188 /* ******************************** */
189 /* RigidBody Constraint */
190
191 /* RigidBodyConstraint (rbc)
192  *
193  * Represents an constraint connecting two rigid bodies.
194  */
195 typedef struct RigidBodyCon {
196         struct Object *ob1;                     /* First object influenced by the constraint */
197         struct Object *ob2;                     /* Second object influenced by the constraint */
198
199         /* General Settings for this RigidBodyCon */
200         short type;                                     /* (eRigidBodyCon_Type) role of RigidBody in sim  */
201         short num_solver_iterations;/* number of constraint solver iterations made per simulation step */
202
203         int flag;                                       /* (eRigidBodyCon_Flag) */
204
205         float breaking_threshold;       /* breaking impulse threshold */
206         char spring_type;               /* spring implementation to use */
207         char pad[3];
208
209         /* limits */
210         /* translation limits */
211         float limit_lin_x_lower;
212         float limit_lin_x_upper;
213         float limit_lin_y_lower;
214         float limit_lin_y_upper;
215         float limit_lin_z_lower;
216         float limit_lin_z_upper;
217         /* rotation limits */
218         float limit_ang_x_lower;
219         float limit_ang_x_upper;
220         float limit_ang_y_lower;
221         float limit_ang_y_upper;
222         float limit_ang_z_lower;
223         float limit_ang_z_upper;
224
225         /* spring settings */
226         /* resistance to deformation */
227         float spring_stiffness_x;
228         float spring_stiffness_y;
229         float spring_stiffness_z;
230         float spring_stiffness_ang_x;
231         float spring_stiffness_ang_y;
232         float spring_stiffness_ang_z;
233         /* amount of velocity lost over time */
234         float spring_damping_x;
235         float spring_damping_y;
236         float spring_damping_z;
237         float spring_damping_ang_x;
238         float spring_damping_ang_y;
239         float spring_damping_ang_z;
240
241         /* motor settings */
242         float motor_lin_target_velocity;        /* linear velocity the motor tries to hold */
243         float motor_ang_target_velocity;        /* angular velocity the motor tries to hold */
244         float motor_lin_max_impulse;            /* maximum force used to reach linear target velocity */
245         float motor_ang_max_impulse;            /* maximum force used to reach angular target velocity */
246
247         /* References to Physics Sim object. Exist at runtime only */
248         void *physics_constraint;       /* Physics object representation (i.e. btTypedConstraint) */
249 } RigidBodyCon;
250
251
252 /* Participation types for RigidBodyOb */
253 typedef enum eRigidBodyCon_Type {
254         /** lets bodies rotate around a specified point */
255         RBC_TYPE_POINT = 0,
256         /** lets bodies rotate around a specified axis */
257         RBC_TYPE_HINGE,
258         /** simulates wheel suspension */
259         RBC_TYPE_HINGE2,
260         /** restricts movent to a specified axis */
261         RBC_TYPE_SLIDER,
262         /** lets object rotate within a cpecified cone */
263         RBC_TYPE_CONE_TWIST,
264         /** allows user to specify constraint axes */
265         RBC_TYPE_6DOF,
266         /** like 6DOF but has springs */
267         RBC_TYPE_6DOF_SPRING,
268         /** simulates a universal joint */
269         RBC_TYPE_UNIVERSAL,
270         /** glues two bodies together */
271         RBC_TYPE_FIXED,
272         /** similar to slider but also allows rotation around slider axis */
273         RBC_TYPE_PISTON,
274         /** Simplified spring constraint with only once axis that's
275          * automatically placed between the connected bodies */
276         RBC_TYPE_SPRING,
277         /** dirves bodies by applying linear and angular forces */
278         RBC_TYPE_MOTOR,
279 } eRigidBodyCon_Type;
280
281 /* Spring implementation type for RigidBodyOb */
282 typedef enum eRigidBodyCon_SpringType {
283         RBC_SPRING_TYPE1 = 0,   /* btGeneric6DofSpringConstraint */
284         RBC_SPRING_TYPE2,       /* btGeneric6DofSpring2Constraint */
285 } eRigidBodyCon_SpringType;
286
287 /* Flags for RigidBodyCon */
288 typedef enum eRigidBodyCon_Flag {
289         /* constraint influences rigid body motion */
290         RBC_FLAG_ENABLED                                        = (1 << 0),
291         /* constraint needs to be validated */
292         RBC_FLAG_NEEDS_VALIDATE                         = (1 << 1),
293         /* allow constrained bodies to collide */
294         RBC_FLAG_DISABLE_COLLISIONS                     = (1 << 2),
295         /* constraint can break */
296         RBC_FLAG_USE_BREAKING                           = (1 << 3),
297         /* constraint use custom number of constraint solver iterations */
298         RBC_FLAG_OVERRIDE_SOLVER_ITERATIONS     = (1 << 4),
299         /* limits */
300         RBC_FLAG_USE_LIMIT_LIN_X                        = (1 << 5),
301         RBC_FLAG_USE_LIMIT_LIN_Y                        = (1 << 6),
302         RBC_FLAG_USE_LIMIT_LIN_Z                        = (1 << 7),
303         RBC_FLAG_USE_LIMIT_ANG_X                        = (1 << 8),
304         RBC_FLAG_USE_LIMIT_ANG_Y                        = (1 << 9),
305         RBC_FLAG_USE_LIMIT_ANG_Z                        = (1 << 10),
306         /* springs */
307         RBC_FLAG_USE_SPRING_X                           = (1 << 11),
308         RBC_FLAG_USE_SPRING_Y                           = (1 << 12),
309         RBC_FLAG_USE_SPRING_Z                           = (1 << 13),
310         /* motors */
311         RBC_FLAG_USE_MOTOR_LIN                          = (1 << 14),
312         RBC_FLAG_USE_MOTOR_ANG                          = (1 << 15),
313         /* angular springs */
314         RBC_FLAG_USE_SPRING_ANG_X                       = (1 << 16),
315         RBC_FLAG_USE_SPRING_ANG_Y                       = (1 << 17),
316         RBC_FLAG_USE_SPRING_ANG_Z                       = (1 << 18)
317 } eRigidBodyCon_Flag;
318
319 /* ******************************** */
320
321 #endif /* __DNA_RIGIDBODY_TYPES_H__ */