Added UI numeric access to bone radius (for envelopes), needed to accsess the other...
[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, layer;
80         short           ghostep, ghostsize;
81 }bArmature;
82
83 /* armature->flag */
84 /* dont use bit 7, was saved in files to disable stuff */
85
86 /* armature->flag */
87 #define         ARM_RESTPOS             0x001
88                         /* XRAY is here only for backwards converting */
89 #define         ARM_DRAWXRAY    0x002
90 #define         ARM_DRAWAXES    0x004
91 #define         ARM_DRAWNAMES   0x008
92 #define         ARM_POSEMODE    0x010
93 #define         ARM_EDITMODE    0x020
94 #define         ARM_DELAYDEFORM 0x040
95 #define         ARM_DONT_USE    0x080
96 #define         ARM_MIRROR_EDIT 0x100
97 #define         ARM_AUTO_IK             0x200
98
99 /* armature->drawtype */
100 #define         ARM_OCTA                0
101 #define         ARM_LINE                1
102 #define         ARM_B_BONE              2
103 #define         ARM_ENVELOPE    3
104
105 /* armature->deformflag */
106 #define         ARM_DEF_VGROUP          1
107 #define         ARM_DEF_ENVELOPE        2
108
109
110 /* bone->flag */
111 #define         BONE_SELECTED   1
112 #define         BONE_ROOTSEL    2
113 #define         BONE_TIPSEL             4
114                         /* Used instead of BONE_SELECTED during transform */
115 #define         BONE_TRANSFORM  8
116 #define         BONE_CONNECTED 16
117                         /* 32 used to be quatrot, was always set in files, do not reuse unless you clear it always */
118                         /* hidden Bones when drawing Posechannels */
119 #define         BONE_HIDDEN_P           64
120                         /* For detecting cyclic dependancies */
121 #define         BONE_DONE               128
122                         /* active is on mouse clicks only */
123 #define         BONE_ACTIVE             256
124                         /* No parent rotation or scale */
125 #define         BONE_HINGE              512
126                         /* hidden Bones when drawing Armature Editmode */
127 #define         BONE_HIDDEN_A           1024
128                         /* multiplies vgroup with envelope */
129 #define         BONE_MULT_VG_ENV        2048
130 #define         BONE_NO_DEFORM          4096
131
132
133 #endif