svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r21908:22075
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 /* this system works on different transformation space levels;
35
36 1) Bone Space;          with each Bone having own (0,0,0) origin
37 2) Armature Space;  the rest position, in Object space, Bones Spaces are applied hierarchical
38 3) Pose Space;          the animation position, in Object space
39 4) World Space;         Object matrix applied to Pose or Armature space
40
41 */
42
43 typedef struct Bone {
44         struct Bone             *next, *prev;   /*      Next/prev elements within this list     */
45         struct Bone             *parent;                /*      Parent (ik parent if appropriate flag is set            */
46         ListBase                childbase;              /*      Children        */
47         char                    name[32];               /*  Name of the bone - must be unique within the armature */
48
49         float                   roll;   /*  roll is input for editmode, length calculated */
50         float                   head[3];                
51         float                   tail[3];                /*      head/tail and roll in Bone Space        */
52         float                   bone_mat[3][3]; /*  rotation derived from head/tail/roll */
53         
54         int                             flag;
55         
56         float                   arm_head[3];            
57         float                   arm_tail[3];    /*      head/tail and roll in Armature Space (rest pos) */
58         float                   arm_mat[4][4];  /*  matrix: (bonemat(b)+head(b))*arm_mat(b-1), rest pos*/
59         
60         float                   dist, weight;                   /*  dist, weight: for non-deformgroup deforms */
61         float                   xwidth, length, zwidth; /*  width: for block bones. keep in this order, transform! */
62         float                   ease1, ease2;                   /*  length of bezier handles */
63         float                   rad_head, rad_tail;     /* radius for head/tail sphere, defining deform as well, parent->rad_tip overrides rad_head*/
64         
65         float                   size[3];                /*  patch for upward compat, UNUSED! */
66         short                   layer;
67         short                   segments;               /*  for B-bones */
68 } Bone;
69
70 typedef struct bArmature {
71         ID                      id;
72         ListBase        bonebase;
73         ListBase        chainbase;
74         ListBase        *edbo;                                  /* editbone listbase, we use pointer so we can check state */
75         
76         void            *sketch;                                /* sketch struct for etch-a-ton */
77         
78         int                     flag;
79         int                     drawtype;                       
80         short           deformflag; 
81         short           pathflag;
82         short           layer, layer_protected;         /* for buttons to work, both variables in this order together */
83         short           ghostep, ghostsize;             /* number of frames to ghosts to show, and step between them  */
84         short           ghosttype, pathsize;            /* ghost drawing options and number of frames between points of path */
85         int                     ghostsf, ghostef;               /* start and end frames of ghost-drawing range */
86         int             pathsf, pathef;                 /* start and end frames of path-calculation range for all bones */
87         int                     pathbc, pathac;                 /* number of frames before/after current frame of path-calculation for all bones  */
88 } bArmature;
89
90 /* armature->flag */
91 /* dont use bit 7, was saved in files to disable stuff */
92 typedef enum eArmature_Flag {
93         ARM_RESTPOS                     = (1<<0),
94         ARM_DRAWXRAY            = (1<<1),       /* XRAY is here only for backwards converting */
95         ARM_DRAWAXES            = (1<<2),
96         ARM_DRAWNAMES           = (1<<3), 
97         ARM_POSEMODE            = (1<<4), 
98         ARM_EDITMODE            = (1<<5), 
99         ARM_DELAYDEFORM         = (1<<6), 
100         ARM_DONT_USE            = (1<<7),
101         ARM_MIRROR_EDIT         = (1<<8),
102         ARM_AUTO_IK                     = (1<<9),
103         ARM_NO_CUSTOM           = (1<<10),      /* made option negative, for backwards compat */
104         ARM_COL_CUSTOM          = (1<<11),      /* draw custom colours  */
105         ARM_GHOST_ONLYSEL       = (1<<12)       /* when ghosting, only show selected bones (this should belong to ghostflag instead) */
106 } eArmature_Flag;
107
108 /* armature->drawtype */
109 typedef enum eArmature_Drawtype {
110         ARM_OCTA = 0,
111         ARM_LINE,
112         ARM_B_BONE,
113         ARM_ENVELOPE
114 } eArmature_Drawtype;
115
116 /* armature->deformflag */
117 typedef enum eArmature_DeformFlag {
118         ARM_DEF_VGROUP                  = (1<<0),
119         ARM_DEF_ENVELOPE                = (1<<1),
120         ARM_DEF_QUATERNION              = (1<<2),
121         ARM_DEF_B_BONE_REST             = (1<<3),
122         ARM_DEF_INVERT_VGROUP   = (1<<4)
123 } eArmature_DeformFlag;
124
125 /* armature->pathflag */
126 typedef enum eArmature_PathFlag {
127         ARM_PATH_FNUMS          = (1<<0),
128         ARM_PATH_KFRAS          = (1<<1),
129         ARM_PATH_HEADS          = (1<<2),
130         ARM_PATH_ACFRA          = (1<<3),
131         ARM_PATH_KFNOS          = (1<<4)
132 } eArmature_PathFlag;
133
134 /* armature->ghosttype */
135 typedef enum eArmature_GhostType {
136         ARM_GHOST_CUR = 0,
137         ARM_GHOST_RANGE,
138         ARM_GHOST_KEYS
139 } eArmature_GhostType;
140
141 /* bone->flag */
142 typedef enum eBone_Flag {
143         BONE_SELECTED                           = (1<<0),
144         BONE_ROOTSEL                            = (1<<1),
145         BONE_TIPSEL                                     = (1<<2),
146         BONE_TRANSFORM                          = (1<<3),       /* Used instead of BONE_SELECTED during transform */
147         BONE_CONNECTED                          = (1<<4),       /* when bone has a parent, connect head of bone to parent's tail*/
148         /* 32 used to be quatrot, was always set in files, do not reuse unless you clear it always */   
149         BONE_HIDDEN_P                           = (1<<6),       /* hidden Bones when drawing PoseChannels */    
150         BONE_DONE                                       = (1<<7),       /* For detecting cyclic dependancies */
151         BONE_ACTIVE                                     = (1<<8),       /* active is on mouse clicks only */
152         BONE_HINGE                                      = (1<<9),       /* No parent rotation or scale */
153         BONE_HIDDEN_A                           = (1<<10),      /* hidden Bones when drawing Armature Editmode */
154         BONE_MULT_VG_ENV                        = (1<<11),      /* multiplies vgroup with envelope */
155         BONE_NO_DEFORM                          = (1<<12),      /* bone doesn't deform geometry */
156         BONE_UNKEYED                            = (1<<13),      /* set to prevent destruction of its unkeyframed pose (after transform) */              
157         BONE_HINGE_CHILD_TRANSFORM      = (1<<14),      /* set to prevent hinge child bones from influencing the transform center */
158         BONE_NO_SCALE                           = (1<<15),      /* No parent scale */
159         BONE_HIDDEN_PG                          = (1<<16),      /* hidden bone when drawing PoseChannels (for ghost drawing) */
160         BONE_DRAWWIRE                           = (1<<17),      /* bone should be drawn as OB_WIRE, regardless of draw-types of view+armature */
161         BONE_NO_CYCLICOFFSET            = (1<<18),      /* when no parent, bone will not get cyclic offset */
162         BONE_EDITMODE_LOCKED            = (1<<19),      /* bone transforms are locked in EditMode */
163         BONE_TRANSFORM_CHILD            = (1<<20),      /* Indicates that a parent is also being transformed */
164         BONE_UNSELECTABLE                       = (1<<21),      /* bone cannot be selected */
165 } eBone_Flag;
166
167 #endif