effa5e34a91e9495d8530a34b38302b0ab45e39b
[blender.git] / source / blender / makesdna / DNA_armature_types.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL 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.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * Contributor(s): Full recode, Ton Roosendaal, Crete 2005
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef DNA_ARMATURE_TYPES_H
29 #define DNA_ARMATURE_TYPES_H
30
31 #include "DNA_listBase.h"
32 #include "DNA_ID.h"
33
34 struct AnimData;
35
36 /* this system works on different transformation space levels;
37
38 1) Bone Space;          with each Bone having own (0,0,0) origin
39 2) Armature Space;  the rest position, in Object space, Bones Spaces are applied hierarchical
40 3) Pose Space;          the animation position, in Object space
41 4) World Space;         Object matrix applied to Pose or Armature space
42
43 */
44
45 typedef struct Bone {
46         struct Bone             *next, *prev;   /*      Next/prev elements within this list     */
47         IDProperty              *prop;                  /* User-Defined Properties on this Bone */
48         struct Bone             *parent;                /*      Parent (ik parent if appropriate flag is set            */
49         ListBase                childbase;              /*      Children        */
50         char                    name[32];               /*  Name of the bone - must be unique within the armature */
51
52         float                   roll;   /*  roll is input for editmode, length calculated */
53         float                   head[3];                
54         float                   tail[3];                /*      head/tail and roll in Bone Space        */
55         float                   bone_mat[3][3]; /*  rotation derived from head/tail/roll */
56         
57         int                             flag;
58         
59         float                   arm_head[3];            
60         float                   arm_tail[3];    /*      head/tail and roll in Armature Space (rest pos) */
61         float                   arm_mat[4][4];  /*  matrix: (bonemat(b)+head(b))*arm_mat(b-1), rest pos*/
62         
63         float                   dist, weight;                   /*  dist, weight: for non-deformgroup deforms */
64         float                   xwidth, length, zwidth; /*  width: for block bones. keep in this order, transform! */
65         float                   ease1, ease2;                   /*  length of bezier handles */
66         float                   rad_head, rad_tail;     /* radius for head/tail sphere, defining deform as well, parent->rad_tip overrides rad_head*/
67         
68         float                   size[3];                /*  patch for upward compat, UNUSED! */
69         int                             layer;                  /* layers that bone appears on */
70         short                   segments;               /*  for B-bones */
71         short                   pad[3];
72 } Bone;
73
74 typedef struct bArmature {
75         ID                      id;
76         struct AnimData *adt;
77         
78         ListBase        bonebase;
79         ListBase        chainbase;
80         ListBase        *edbo;                                  /* editbone listbase, we use pointer so we can check state */
81         
82         Bone            *act_bone;                              /* active bone (when not in editmode) */
83         void            *act_edbone;                    /* active editbone (in editmode) */
84
85         void            *sketch;                                /* sketch struct for etch-a-ton */
86         
87         int                     flag;
88         int                     drawtype;                       
89         short           deformflag; 
90         short           pathflag;
91         
92         int                     pad;
93         
94         unsigned int layer, layer_protected;            /* for buttons to work, both variables in this order together */
95         
96 // XXX depreceated... old animaton system (armature only viz) ---
97         short           ghostep, ghostsize;             /* number of frames to ghosts to show, and step between them  */
98         short           ghosttype, pathsize;            /* ghost drawing options and number of frames between points of path */
99         int                     ghostsf, ghostef;               /* start and end frames of ghost-drawing range */
100         int             pathsf, pathef;                 /* start and end frames of path-calculation range for all bones */
101         int                     pathbc, pathac;                 /* number of frames before/after current frame of path-calculation for all bones  */
102 // XXX end of depreceated code ---------------------------------- 
103 } bArmature;
104
105 /* armature->flag */
106 /* dont use bit 7, was saved in files to disable stuff */
107 typedef enum eArmature_Flag {
108         ARM_RESTPOS                     = (1<<0),
109         ARM_DRAWXRAY            = (1<<1),       /* XRAY is here only for backwards converting */
110         ARM_DRAWAXES            = (1<<2),
111         ARM_DRAWNAMES           = (1<<3), 
112         ARM_POSEMODE            = (1<<4), 
113         ARM_EDITMODE            = (1<<5), 
114         ARM_DELAYDEFORM         = (1<<6), 
115         ARM_DONT_USE            = (1<<7),
116         ARM_MIRROR_EDIT         = (1<<8),
117         ARM_AUTO_IK                     = (1<<9),
118         ARM_NO_CUSTOM           = (1<<10),      /* made option negative, for backwards compat */
119         ARM_COL_CUSTOM          = (1<<11),      /* draw custom colors  */
120         ARM_GHOST_ONLYSEL       = (1<<12),      /* when ghosting, only show selected bones (this should belong to ghostflag instead) */ // XXX depreceated
121         ARM_DS_EXPAND           = (1<<13)
122 } eArmature_Flag;
123
124 /* armature->drawtype */
125 typedef enum eArmature_Drawtype {
126         ARM_OCTA = 0,
127         ARM_LINE,
128         ARM_B_BONE,
129         ARM_ENVELOPE
130 } eArmature_Drawtype;
131
132 /* armature->deformflag */
133 typedef enum eArmature_DeformFlag {
134         ARM_DEF_VGROUP                  = (1<<0),
135         ARM_DEF_ENVELOPE                = (1<<1),
136         ARM_DEF_QUATERNION              = (1<<2),
137         ARM_DEF_B_BONE_REST             = (1<<3),       /* deprecated */
138         ARM_DEF_INVERT_VGROUP   = (1<<4)
139 } eArmature_DeformFlag;
140
141 /* armature->pathflag */
142 // XXX depreceated... old animation system (armature only viz)
143 typedef enum eArmature_PathFlag {
144         ARM_PATH_FNUMS          = (1<<0),
145         ARM_PATH_KFRAS          = (1<<1),
146         ARM_PATH_HEADS          = (1<<2),
147         ARM_PATH_ACFRA          = (1<<3),
148         ARM_PATH_KFNOS          = (1<<4)
149 } eArmature_PathFlag;
150
151 /* armature->ghosttype */
152 // XXX depreceated... old animation system (armature only viz)
153 typedef enum eArmature_GhostType {
154         ARM_GHOST_CUR = 0,
155         ARM_GHOST_RANGE,
156         ARM_GHOST_KEYS
157 } eArmature_GhostType;
158
159 /* bone->flag */
160 typedef enum eBone_Flag {
161         BONE_SELECTED                           = (1<<0),
162         BONE_ROOTSEL                            = (1<<1),
163         BONE_TIPSEL                                     = (1<<2),
164         BONE_TRANSFORM                          = (1<<3),       /* Used instead of BONE_SELECTED during transform */
165         BONE_CONNECTED                          = (1<<4),       /* when bone has a parent, connect head of bone to parent's tail*/
166         /* 32 used to be quatrot, was always set in files, do not reuse unless you clear it always */   
167         BONE_HIDDEN_P                           = (1<<6),       /* hidden Bones when drawing PoseChannels */    
168         BONE_DONE                                       = (1<<7),       /* For detecting cyclic dependancies */
169         BONE_DRAW_ACTIVE                        = (1<<8),       /* active is on mouse clicks only - deprecated, ONLY USE FOR DRAWING */
170         BONE_HINGE                                      = (1<<9),       /* No parent rotation or scale */
171         BONE_HIDDEN_A                           = (1<<10),      /* hidden Bones when drawing Armature Editmode */
172         BONE_MULT_VG_ENV                        = (1<<11),      /* multiplies vgroup with envelope */
173         BONE_NO_DEFORM                          = (1<<12),      /* bone doesn't deform geometry */
174         BONE_UNKEYED                            = (1<<13),      /* set to prevent destruction of its unkeyframed pose (after transform) */              
175         BONE_HINGE_CHILD_TRANSFORM      = (1<<14),      /* set to prevent hinge child bones from influencing the transform center */
176         BONE_NO_SCALE                           = (1<<15),      /* No parent scale */
177         BONE_HIDDEN_PG                          = (1<<16),      /* hidden bone when drawing PoseChannels (for ghost drawing) */
178         BONE_DRAWWIRE                           = (1<<17),      /* bone should be drawn as OB_WIRE, regardless of draw-types of view+armature */
179         BONE_NO_CYCLICOFFSET            = (1<<18),      /* when no parent, bone will not get cyclic offset */
180         BONE_EDITMODE_LOCKED            = (1<<19),      /* bone transforms are locked in EditMode */
181         BONE_TRANSFORM_CHILD            = (1<<20),      /* Indicates that a parent is also being transformed */
182         BONE_UNSELECTABLE                       = (1<<21),      /* bone cannot be selected */
183         BONE_NO_LOCAL_LOCATION          = (1<<22)       /* bone location is in armature space */
184 } eBone_Flag;
185
186 #endif