Cleanup: rename the curveInX etc bbone DNA fields to curve_in_x etc.
[blender.git] / source / blender / makesdna / DNA_armature_types.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup DNA
22  */
23
24 #ifndef __DNA_ARMATURE_TYPES_H__
25 #define __DNA_ARMATURE_TYPES_H__
26
27 #include "DNA_defs.h"
28 #include "DNA_listBase.h"
29 #include "DNA_ID.h"
30
31 struct AnimData;
32
33 /* this system works on different transformation space levels;
34  *
35  * 1) Bone Space;      with each Bone having own (0,0,0) origin
36  * 2) Armature Space;  the rest position, in Object space, Bones Spaces are applied hierarchical
37  * 3) Pose Space;      the animation position, in Object space
38  * 4) World Space;     Object matrix applied to Pose or Armature space
39  */
40
41 typedef struct Bone {
42   /**  Next/prev elements within this list. */
43   struct Bone *next, *prev;
44   /** User-Defined Properties on this Bone. */
45   IDProperty *prop;
46   /**  Parent (ik parent if appropriate flag is set. */
47   struct Bone *parent;
48   /**  Children   . */
49   ListBase childbase;
50   /**  Name of the bone - must be unique within the armature, MAXBONENAME. */
51   char name[64];
52
53   /**  roll is input for editmode, length calculated. */
54   float roll;
55   float head[3];
56   /**  head/tail and roll in Bone Space   . */
57   float tail[3];
58   /**  rotation derived from head/tail/roll. */
59   float bone_mat[3][3];
60
61   int flag;
62
63   float arm_head[3];
64   /**  head/tail in Armature Space (rest pos). */
65   float arm_tail[3];
66   /**  matrix: (bonemat(b)+head(b))*arm_mat(b-1), rest po.s*/
67   float arm_mat[4][4];
68   /** Roll in Armature Space (rest pos). */
69   float arm_roll;
70
71   /**  dist, weight: for non-deformgroup deforms. */
72   float dist, weight;
73   /**  width: for block bones. keep in this order, transform!. */
74   float xwidth, length, zwidth;
75   /** Radius for head/tail sphere, defining deform as well, parent->rad_tip overrides rad_head. */
76   float rad_head, rad_tail;
77
78   /** Curved bones settings - these define the "restpose" for a curved bone. */
79   float roll1, roll2;
80   float curve_in_x, curve_in_y;
81   float curve_out_x, curve_out_y;
82   /** Length of bezier handles. */
83   float ease1, ease2;
84   float scale_in_x, scale_in_y;
85   float scale_out_x, scale_out_y;
86
87   /**  patch for upward compat, UNUSED!. */
88   float size[3];
89   /** Layers that bone appears on. */
90   int layer;
91   /**  for B-bones. */
92   short segments;
93
94   /** Type of next/prev bone handles. */
95   char bbone_prev_type;
96   char bbone_next_type;
97   /** Next/prev bones to use as handle references when calculating bbones (optional). */
98   struct Bone *bbone_prev;
99   struct Bone *bbone_next;
100 } Bone;
101
102 typedef struct bArmature {
103   ID id;
104   struct AnimData *adt;
105
106   ListBase bonebase;
107   ListBase chainbase;
108   /** Editbone listbase, we use pointer so we can check state. */
109   ListBase *edbo;
110
111   /* active bones should work like active object where possible
112    * - active and selection are unrelated
113    * - active & hidden is not allowed
114    * - from the user perspective active == last selected
115    * - active should be ignored when not visible (hidden layer) */
116
117   /** Active bone. */
118   Bone *act_bone;
119   /** Active editbone (in editmode). */
120   struct EditBone *act_edbone;
121
122   int flag;
123   int drawtype;
124   /** How vertex deformation is handled in the ge. */
125   int gevertdeformer;
126   char _pad[4];
127   short deformflag;
128   short pathflag;
129
130   /** For UI, to show which layers are there. */
131   unsigned int layer_used;
132   /** For buttons to work, both variables in this order together. */
133   unsigned int layer, layer_protected;
134 } bArmature;
135
136 /* armature->flag */
137 /* don't use bit 7, was saved in files to disable stuff */
138 typedef enum eArmature_Flag {
139   ARM_RESTPOS = (1 << 0),
140   /** XRAY is here only for backwards converting */
141   ARM_FLAG_UNUSED_1 = (1 << 1), /* cleared */
142   ARM_DRAWAXES = (1 << 2),
143   ARM_DRAWNAMES = (1 << 3),
144   ARM_POSEMODE = (1 << 4),
145   ARM_FLAG_UNUSED_5 = (1 << 5), /* cleared */
146   ARM_DELAYDEFORM = (1 << 6),
147   ARM_FLAG_UNUSED_7 = (1 << 7), /* cleared */
148   ARM_MIRROR_EDIT = (1 << 8),
149   ARM_AUTO_IK = (1 << 9),
150   /** made option negative, for backwards compat */
151   ARM_NO_CUSTOM = (1 << 10),
152   /** draw custom colors  */
153   ARM_COL_CUSTOM = (1 << 11),
154   /** when ghosting, only show selected bones (this should belong to ghostflag instead) */
155   ARM_FLAG_UNUSED_12 = (1 << 12), /* cleared */
156   /** dopesheet channel is expanded */
157   ARM_DS_EXPAND = (1 << 13),
158   /** other objects are used for visualizing various states (hack for efficient updates) */
159   ARM_HAS_VIZ_DEPS = (1 << 14),
160 } eArmature_Flag;
161
162 /* armature->drawtype */
163 typedef enum eArmature_Drawtype {
164   ARM_OCTA = 0,
165   ARM_LINE = 1,
166   ARM_B_BONE = 2,
167   ARM_ENVELOPE = 3,
168   ARM_WIRE = 4,
169 } eArmature_Drawtype;
170
171 /* armature->gevertdeformer */
172 typedef enum eArmature_VertDeformer {
173   ARM_VDEF_BLENDER = 0,
174   ARM_VDEF_BGE_CPU = 1,
175 } eArmature_VertDeformer;
176
177 /* armature->deformflag */
178 typedef enum eArmature_DeformFlag {
179   ARM_DEF_VGROUP = (1 << 0),
180   ARM_DEF_ENVELOPE = (1 << 1),
181   ARM_DEF_QUATERNION = (1 << 2),
182 #ifdef DNA_DEPRECATED
183   ARM_DEF_B_BONE_REST = (1 << 3), /* deprecated */
184 #endif
185   ARM_DEF_INVERT_VGROUP = (1 << 4),
186 } eArmature_DeformFlag;
187
188 /* armature->pathflag */
189 // XXX deprecated... old animation system (armature only viz)
190 #ifdef DNA_DEPRECATED
191 typedef enum eArmature_PathFlag {
192   ARM_PATH_FNUMS = (1 << 0),
193   ARM_PATH_KFRAS = (1 << 1),
194   ARM_PATH_HEADS = (1 << 2),
195   ARM_PATH_ACFRA = (1 << 3),
196   ARM_PATH_KFNOS = (1 << 4),
197 } eArmature_PathFlag;
198 #endif
199
200 /* bone->flag */
201 typedef enum eBone_Flag {
202   BONE_SELECTED = (1 << 0),
203   BONE_ROOTSEL = (1 << 1),
204   BONE_TIPSEL = (1 << 2),
205   /** Used instead of BONE_SELECTED during transform (clear before use) */
206   BONE_TRANSFORM = (1 << 3),
207   /** when bone has a parent, connect head of bone to parent's tail*/
208   BONE_CONNECTED = (1 << 4),
209   /* 32 used to be quatrot, was always set in files, do not reuse unless you clear it always */
210   /** hidden Bones when drawing PoseChannels */
211   BONE_HIDDEN_P = (1 << 6),
212   /** For detecting cyclic dependencies */
213   BONE_DONE = (1 << 7),
214   /** active is on mouse clicks only - deprecated, ONLY USE FOR DRAWING */
215   BONE_DRAW_ACTIVE = (1 << 8),
216   /** No parent rotation or scale */
217   BONE_HINGE = (1 << 9),
218   /** hidden Bones when drawing Armature Editmode */
219   BONE_HIDDEN_A = (1 << 10),
220   /** multiplies vgroup with envelope */
221   BONE_MULT_VG_ENV = (1 << 11),
222   /** bone doesn't deform geometry */
223   BONE_NO_DEFORM = (1 << 12),
224   /** set to prevent destruction of its unkeyframed pose (after transform) */
225   BONE_UNKEYED = (1 << 13),
226   /** set to prevent hinge child bones from influencing the transform center */
227   BONE_HINGE_CHILD_TRANSFORM = (1 << 14),
228   /** No parent scale */
229   BONE_NO_SCALE = (1 << 15),
230   /** hidden bone when drawing PoseChannels (for ghost drawing) */
231   BONE_HIDDEN_PG = (1 << 16),
232   /** bone should be drawn as OB_WIRE, regardless of draw-types of view+armature */
233   BONE_DRAWWIRE = (1 << 17),
234   /** when no parent, bone will not get cyclic offset */
235   BONE_NO_CYCLICOFFSET = (1 << 18),
236   /** bone transforms are locked in EditMode */
237   BONE_EDITMODE_LOCKED = (1 << 19),
238   /** Indicates that a parent is also being transformed */
239   BONE_TRANSFORM_CHILD = (1 << 20),
240   /** bone cannot be selected */
241   BONE_UNSELECTABLE = (1 << 21),
242   /** bone location is in armature space */
243   BONE_NO_LOCAL_LOCATION = (1 << 22),
244   /** object child will use relative transform (like deform) */
245   BONE_RELATIVE_PARENTING = (1 << 23),
246   /** it will add the parent end roll to the inroll */
247   BONE_ADD_PARENT_END_ROLL = (1 << 24),
248
249 } eBone_Flag;
250
251 /* bone->bbone_prev_type, bbone_next_type */
252 typedef enum eBone_BBoneHandleType {
253   BBONE_HANDLE_AUTO = 0, /* Default mode based on parents & children. */
254   BBONE_HANDLE_ABSOLUTE, /* Custom handle in absolute position mode. */
255   BBONE_HANDLE_RELATIVE, /* Custom handle in relative position mode. */
256   BBONE_HANDLE_TANGENT,  /* Custom handle in tangent mode (use direction, not location). */
257 } eBone_BBoneHandleType;
258
259 #define MAXBONENAME 64
260
261 #endif