Cleanup: comment line length (editors)
[blender.git] / source / blender / makesdna / DNA_armature_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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): Full recode, Ton Roosendaal, Crete 2005
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file DNA_armature_types.h
27  *  \ingroup DNA
28  */
29
30 #ifndef __DNA_ARMATURE_TYPES_H__
31 #define __DNA_ARMATURE_TYPES_H__
32
33 #include "DNA_defs.h"
34 #include "DNA_listBase.h"
35 #include "DNA_ID.h"
36
37 struct AnimData;
38
39 /* this system works on different transformation space levels;
40  *
41  * 1) Bone Space;      with each Bone having own (0,0,0) origin
42  * 2) Armature Space;  the rest position, in Object space, Bones Spaces are applied hierarchical
43  * 3) Pose Space;      the animation position, in Object space
44  * 4) World Space;     Object matrix applied to Pose or Armature space
45  *
46  */
47
48 typedef struct Bone {
49         struct Bone *next, *prev;    /*  Next/prev elements within this list */
50         IDProperty  *prop;           /* User-Defined Properties on this Bone */
51         struct Bone *parent;         /*  Parent (ik parent if appropriate flag is set */
52         ListBase     childbase;      /*  Children    */
53         char         name[64];       /*  Name of the bone - must be unique within the armature, MAXBONENAME */
54
55         float        roll;           /*  roll is input for editmode, length calculated */
56         float        head[3];
57         float        tail[3];        /*  head/tail and roll in Bone Space    */
58         float        bone_mat[3][3]; /*  rotation derived from head/tail/roll */
59
60         int          flag;
61
62         float        arm_head[3];
63         float        arm_tail[3];    /*  head/tail in Armature Space (rest pos) */
64         float        arm_mat[4][4];  /*  matrix: (bonemat(b)+head(b))*arm_mat(b-1), rest pos*/
65         float        arm_roll;       /* roll in Armature Space (rest pos) */
66
67         float        dist, weight;           /*  dist, weight: for non-deformgroup deforms */
68         float        xwidth, length, zwidth; /*  width: for block bones. keep in this order, transform! */
69         float        rad_head, rad_tail;     /* radius for head/tail sphere, defining deform as well, parent->rad_tip overrides rad_head */
70
71         float        roll1, roll2;           /* curved bones settings - these define the "restpose" for a curved bone */
72         float            curveInX, curveInY;
73         float            curveOutX, curveOutY;
74         float        ease1, ease2;        /* length of bezier handles */
75         float            scaleIn, scaleOut;
76
77         float        size[3];        /*  patch for upward compat, UNUSED! */
78         int          layer;          /* layers that bone appears on */
79         short        segments;       /*  for B-bones */
80
81         short            pad1;
82
83 } Bone;
84
85 typedef struct bArmature {
86         ID          id;
87         struct AnimData *adt;
88
89         ListBase    bonebase;
90         ListBase    chainbase;
91         ListBase   *edbo;                   /* editbone listbase, we use pointer so we can check state */
92
93         /* active bones should work like active object where possible
94          * - active and selection are unrelated
95          * - active & hidden is not allowed
96          * - from the user perspective active == last selected
97          * - active should be ignored when not visible (hidden layer) */
98
99         Bone       *act_bone;               /* active bone */
100         struct EditBone *act_edbone;        /* active editbone (in editmode) */
101
102         void       *sketch;                 /* sketch struct for etch-a-ton */
103
104         int         flag;
105         int         drawtype;
106         int         gevertdeformer;         /* how vertex deformation is handled in the ge */
107         int         pad;
108         short       deformflag;
109         short       pathflag;
110
111         unsigned int layer_used;             /* for UI, to show which layers are there */
112         unsigned int layer, layer_protected; /* for buttons to work, both variables in this order together */
113
114 // XXX deprecated... old animation system (armature only viz) ---
115         short       ghostep, ghostsize;     /* number of frames to ghosts to show, and step between them  */
116         short       ghosttype, pathsize;        /* ghost drawing options and number of frames between points of path */
117         int         ghostsf, ghostef;       /* start and end frames of ghost-drawing range */
118         int         pathsf, pathef;         /* start and end frames of path-calculation range for all bones */
119         int         pathbc, pathac;         /* number of frames before/after current frame of path-calculation for all bones  */
120 // XXX end of deprecated code ----------------------------------
121 } bArmature;
122
123 /* armature->flag */
124 /* don't use bit 7, was saved in files to disable stuff */
125 typedef enum eArmature_Flag {
126         ARM_RESTPOS         = (1<<0),
127         /** XRAY is here only for backwards converting */
128         ARM_DRAWXRAY        = (1<<1),
129         ARM_DRAWAXES        = (1<<2),
130         ARM_DRAWNAMES       = (1<<3),
131         ARM_POSEMODE        = (1<<4),
132         ARM_EDITMODE        = (1<<5),
133         ARM_DELAYDEFORM     = (1<<6),
134         ARM_DONT_USE        = (1<<7),
135         ARM_MIRROR_EDIT     = (1<<8),
136         ARM_AUTO_IK         = (1<<9),
137         /** made option negative, for backwards compat */
138         ARM_NO_CUSTOM       = (1<<10),
139         /** draw custom colors  */
140         ARM_COL_CUSTOM      = (1<<11),
141         /** when ghosting, only show selected bones (this should belong to ghostflag instead) */
142         ARM_GHOST_ONLYSEL   = (1<<12), /* XXX deprecated */
143         /** dopesheet channel is expanded */
144         ARM_DS_EXPAND       = (1<<13),
145         /** other objects are used for visualizing various states (hack for efficient updates) */
146         ARM_HAS_VIZ_DEPS    = (1<<14),
147 } eArmature_Flag;
148
149 /* armature->drawtype */
150 typedef enum eArmature_Drawtype {
151         ARM_OCTA = 0,
152         ARM_LINE = 1,
153         ARM_B_BONE = 2,
154         ARM_ENVELOPE = 3,
155         ARM_WIRE = 4
156 } eArmature_Drawtype;
157
158 /* armature->gevertdeformer */
159 typedef enum eArmature_VertDeformer {
160         ARM_VDEF_BLENDER = 0,
161         ARM_VDEF_BGE_CPU = 1
162 } eArmature_VertDeformer;
163
164 /* armature->deformflag */
165 typedef enum eArmature_DeformFlag {
166         ARM_DEF_VGROUP                  = (1<<0),
167         ARM_DEF_ENVELOPE                = (1<<1),
168         ARM_DEF_QUATERNION              = (1<<2),
169 #ifdef DNA_DEPRECATED
170         ARM_DEF_B_BONE_REST             = (1<<3),       /* deprecated */
171 #endif
172         ARM_DEF_INVERT_VGROUP   = (1<<4)
173 } eArmature_DeformFlag;
174
175 /* armature->pathflag */
176 // XXX deprecated... old animation system (armature only viz)
177 #ifdef DNA_DEPRECATED
178 typedef enum eArmature_PathFlag {
179         ARM_PATH_FNUMS          = (1<<0),
180         ARM_PATH_KFRAS          = (1<<1),
181         ARM_PATH_HEADS          = (1<<2),
182         ARM_PATH_ACFRA          = (1<<3),
183         ARM_PATH_KFNOS          = (1<<4)
184 } eArmature_PathFlag;
185 #endif
186
187 /* armature->ghosttype */
188 // XXX deprecated... old animation system (armature only viz)
189 typedef enum eArmature_GhostType {
190         ARM_GHOST_CUR = 0,
191         ARM_GHOST_RANGE = 1,
192         ARM_GHOST_KEYS = 2
193 } eArmature_GhostType;
194
195 /* bone->flag */
196 typedef enum eBone_Flag {
197         BONE_SELECTED               = (1 << 0),
198         BONE_ROOTSEL                = (1 << 1),
199         BONE_TIPSEL                 = (1 << 2),
200         /** Used instead of BONE_SELECTED during transform (clear before use) */
201         BONE_TRANSFORM              = (1 << 3),
202         /** when bone has a parent, connect head of bone to parent's tail*/
203         BONE_CONNECTED              = (1 << 4),
204         /* 32 used to be quatrot, was always set in files, do not reuse unless you clear it always */
205         /** hidden Bones when drawing PoseChannels */
206         BONE_HIDDEN_P               = (1 << 6),
207         /** For detecting cyclic dependencies */
208         BONE_DONE                   = (1 << 7),
209         /** active is on mouse clicks only - deprecated, ONLY USE FOR DRAWING */
210         BONE_DRAW_ACTIVE            = (1 << 8),
211         /** No parent rotation or scale */
212         BONE_HINGE                  = (1 << 9),
213         /** hidden Bones when drawing Armature Editmode */
214         BONE_HIDDEN_A               = (1 << 10),
215         /** multiplies vgroup with envelope */
216         BONE_MULT_VG_ENV            = (1 << 11),
217         /** bone doesn't deform geometry */
218         BONE_NO_DEFORM              = (1 << 12),
219         /** set to prevent destruction of its unkeyframed pose (after transform) */
220         BONE_UNKEYED                = (1 << 13),
221         /** set to prevent hinge child bones from influencing the transform center */
222         BONE_HINGE_CHILD_TRANSFORM  = (1 << 14),
223         /** No parent scale */
224         BONE_NO_SCALE               = (1 << 15),
225         /** hidden bone when drawing PoseChannels (for ghost drawing) */
226         BONE_HIDDEN_PG              = (1 << 16),
227         /** bone should be drawn as OB_WIRE, regardless of draw-types of view+armature */
228         BONE_DRAWWIRE               = (1 << 17),
229         /** when no parent, bone will not get cyclic offset */
230         BONE_NO_CYCLICOFFSET        = (1 << 18),
231         /** bone transforms are locked in EditMode */
232         BONE_EDITMODE_LOCKED        = (1 << 19),
233         /** Indicates that a parent is also being transformed */
234         BONE_TRANSFORM_CHILD        = (1 << 20),
235         /** bone cannot be selected */
236         BONE_UNSELECTABLE           = (1 << 21),
237         /** bone location is in armature space */
238         BONE_NO_LOCAL_LOCATION      = (1 << 22),
239         /** object child will use relative transform (like deform) */
240         BONE_RELATIVE_PARENTING     = (1 << 23),
241         /** it will add the parent end roll to the inroll */
242         BONE_ADD_PARENT_END_ROLL    = (1 << 24)
243
244 } eBone_Flag;
245
246 #define MAXBONENAME 64
247
248 #endif