Bugfixes:
[blender.git] / source / blender / makesdna / DNA_armature_types.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * Contributor(s): Full recode, Ton Roosendaal, Crete 2005
27  *
28  * ***** END GPL/BL DUAL LICENSE BLOCK *****
29  */
30
31 #ifndef DNA_ARMATURE_TYPES_H
32 #define DNA_ARMATURE_TYPES_H
33
34 #include "DNA_listBase.h"
35 #include "DNA_ID.h"
36
37 /* this system works on different transformation space levels;
38
39 1) Bone Space;          with each Bone having own (0,0,0) origin
40 2) Armature Space;  the rest position, in Object space, Bones Spaces are applied hierarchical
41 3) Pose Space;          the animation position, in Object space
42 4) World Space;         Object matrix applied to Pose or Armature space
43
44 */
45
46 typedef struct Bone {
47         struct Bone             *next, *prev;   /*      Next/prev elements within this list     */
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         short                   layer;
70         short                   segments;               /*  for B-bones */
71 } Bone;
72
73 typedef struct bArmature {
74         ID                      id;
75         ListBase        bonebase;
76         ListBase        chainbase;
77         int                     flag;
78         int                     drawtype;                       
79         short           deformflag; 
80         short           pathflag;
81         short           layer, layer_protected;         /* for buttons to work, both variables in this order together */
82         short           ghostep, ghostsize;             /* number of frames to ghosts to show, and step between them  */
83         short           ghosttype, pathsize;            /* ghost drawing options and number of frames between points of path */
84         int                     ghostsf, ghostef;               /* start and end frames of ghost-drawing range */
85         int             pathsf, pathef;                 /* start and end frames of path-calculation range for all bones */
86         int                     pathbc, pathac;                 /* number of frames before/after current frame of path-calculation for all bones  */
87 } bArmature;
88
89 /* armature->flag */
90 /* dont use bit 7, was saved in files to disable stuff */
91 typedef enum eArmature_Flag {
92         ARM_RESTPOS                     = (1<<0),
93         ARM_DRAWXRAY            = (1<<1),       /* XRAY is here only for backwards converting */
94         ARM_DRAWAXES            = (1<<2),
95         ARM_DRAWNAMES           = (1<<3), 
96         ARM_POSEMODE            = (1<<4), 
97         ARM_EDITMODE            = (1<<5), 
98         ARM_DELAYDEFORM         = (1<<6), 
99         ARM_DONT_USE            = (1<<7),
100         ARM_MIRROR_EDIT         = (1<<8),
101         ARM_AUTO_IK                     = (1<<9),
102         ARM_NO_CUSTOM           = (1<<10),      /* made option negative, for backwards compat */
103         ARM_COL_CUSTOM          = (1<<11),      /* draw custom colours  */
104         ARM_GHOST_ONLYSEL       = (1<<12)       /* when ghosting, only show selected bones (this should belong to ghostflag instead) */
105 } eArmature_Flag;
106
107 /* armature->drawtype */
108 typedef enum eArmature_Drawtype {
109         ARM_OCTA = 0,
110         ARM_LINE,
111         ARM_B_BONE,
112         ARM_ENVELOPE
113 } eArmature_Drawtype;
114
115 /* armature->deformflag */
116 typedef enum eArmature_DeformFlag {
117         ARM_DEF_VGROUP                  = (1<<0),
118         ARM_DEF_ENVELOPE                = (1<<1),
119         ARM_DEF_QUATERNION              = (1<<2),
120         ARM_DEF_B_BONE_REST             = (1<<3),
121         ARM_DEF_INVERT_VGROUP   = (1<<4)
122 } eArmature_DeformFlag;
123
124 /* armature->pathflag */
125 typedef enum eArmature_PathFlag {
126         ARM_PATH_FNUMS          = (1<<0),
127         ARM_PATH_KFRAS          = (1<<1),
128         ARM_PATH_HEADS          = (1<<2),
129         ARM_PATH_ACFRA          = (1<<3),
130         ARM_PATH_KFNOS          = (1<<4)
131 } eArmature_PathFlag;
132
133 /* armature->ghosttype */
134 typedef enum eArmature_GhostType {
135         ARM_GHOST_CUR = 0,
136         ARM_GHOST_RANGE,
137         ARM_GHOST_KEYS
138 } eArmature_GhostType;
139
140 /* bone->flag */
141 typedef enum eBone_Flag {
142         BONE_SELECTED                           = (1<<0),
143         BONE_ROOTSEL                            = (1<<1),
144         BONE_TIPSEL                                     = (1<<2),
145         BONE_TRANSFORM                          = (1<<3),       /* Used instead of BONE_SELECTED during transform */
146         BONE_CONNECTED                          = (1<<4),
147         /* 32 used to be quatrot, was always set in files, do not reuse unless you clear it always */   
148         BONE_HIDDEN_P                           = (1<<6),       /* hidden Bones when drawing PoseChannels */    
149         BONE_DONE                                       = (1<<7),       /* For detecting cyclic dependancies */
150         BONE_ACTIVE                                     = (1<<8),       /* active is on mouse clicks only */
151         BONE_HINGE                                      = (1<<9),       /* No parent rotation or scale */
152         BONE_HIDDEN_A                           = (1<<10),      /* hidden Bones when drawing Armature Editmode */
153         BONE_MULT_VG_ENV                        = (1<<11),      /* multiplies vgroup with envelope */
154         BONE_NO_DEFORM                          = (1<<12),
155         BONE_UNKEYED                            = (1<<13),      /* set to prevent destruction of its unkeyframed pose (after transform) */              
156         BONE_HINGE_CHILD_TRANSFORM      = (1<<14),      /* set to prevent hinge child bones from influencing the transform center */
157         BONE_NO_SCALE                           = (1<<15),      /* No parent scale */
158         BONE_HIDDEN_PG                          = (1<<16),      /* hidden bone when drawing PoseChannels (for ghost drawing) */
159         BONE_DRAWWIRE                           = (1<<17)       /* bone should be drawn as OB_WIRE, regardless of draw-types of view+armature */
160 } eBone_Flag;
161
162 #endif