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