== Peach Feature Requests (Bone-Path Drawing) ==
[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
92 /* armature->flag */
93 #define         ARM_RESTPOS             0x001
94                         /* XRAY is here only for backwards converting */
95 #define         ARM_DRAWXRAY    0x002
96 #define         ARM_DRAWAXES    0x004
97 #define         ARM_DRAWNAMES   0x008
98 #define         ARM_POSEMODE    0x010
99 #define         ARM_EDITMODE    0x020
100 #define         ARM_DELAYDEFORM 0x040
101 #define         ARM_DONT_USE    0x080
102 #define         ARM_MIRROR_EDIT 0x100
103 #define         ARM_AUTO_IK             0x200
104                         /* made option negative, for backwards compat */
105 #define         ARM_NO_CUSTOM   0x400
106 #define         ARM_COL_CUSTOM  0x800
107
108 /* armature->drawtype */
109 #define         ARM_OCTA                0
110 #define         ARM_LINE                1
111 #define         ARM_B_BONE              2
112 #define         ARM_ENVELOPE    3
113
114 /* armature->deformflag */
115 #define         ARM_DEF_VGROUP          1
116 #define         ARM_DEF_ENVELOPE        2
117 #define         ARM_DEF_QUATERNION      4
118 #define         ARM_DEF_B_BONE_REST     8
119
120 /* armature->pathflag */
121 #define         ARM_PATH_FNUMS          (1<<0)
122 #define         ARM_PATH_KFRAS          (1<<1)
123 #define         ARM_PATH_HEADS          (1<<2)
124 #define         ARM_PATH_ACFRA          (1<<3)
125
126 /* armature->ghosttype */
127 #define         ARM_GHOST_CUR   0
128 #define         ARM_GHOST_RANGE 1
129
130 /* bone->flag */
131 #define         BONE_SELECTED   1
132 #define         BONE_ROOTSEL    2
133 #define         BONE_TIPSEL             4
134                         /* Used instead of BONE_SELECTED during transform */
135 #define         BONE_TRANSFORM  8
136 #define         BONE_CONNECTED 16
137                         /* 32 used to be quatrot, was always set in files, do not reuse unless you clear it always */
138                         /* hidden Bones when drawing Posechannels */
139 #define         BONE_HIDDEN_P           64
140                         /* For detecting cyclic dependancies */
141 #define         BONE_DONE               128
142                         /* active is on mouse clicks only */
143 #define         BONE_ACTIVE             256
144                         /* No parent rotation or scale */
145 #define         BONE_HINGE              512
146                         /* hidden Bones when drawing Armature Editmode */
147 #define         BONE_HIDDEN_A           1024
148                         /* multiplies vgroup with envelope */
149 #define         BONE_MULT_VG_ENV        2048
150 #define         BONE_NO_DEFORM          4096
151                         /* set to prevent destruction of its unkeyframed pose (after transform) */
152 #define         BONE_UNKEYED            8192
153                         /* set to prevent hinge child bones from influencing the transform center */
154 #define         BONE_HINGE_CHILD_TRANSFORM 16384
155                         /* No parent scale */
156 #define         BONE_NO_SCALE           (1<<15)
157
158 #endif