Final merge of HEAD (bf-blender) into the orange branch.
[blender.git] / source / blender / makesdna / DNA_action_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): Original design: Reevan McKay
24  * Contributor(s): Full recode, Ton Roosendaal, Crete 2005
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29
30 #ifndef DNA_ACTION_TYPES_H
31 #define DNA_ACTION_TYPES_H
32
33 #include "DNA_listBase.h"
34 #include "DNA_ID.h"
35 #include "DNA_view2d_types.h"
36
37 struct SpaceLink;
38 struct ListBase;
39 struct Object;
40
41 /* PoseChannel stores the results of Actions (ipos) and transform information 
42    with respect to the restposition of Armature bones */
43
44 typedef struct bPoseChannel {
45         struct bPoseChannel     *next, *prev;
46         ListBase                        constraints;
47         char                            name[32];       /* Channels need longer names than normal blender objects */
48         
49         short                           flag;           /* dynamic, for detecting transform changes */
50         short                           constflag;  /* for quick detecting which constraints affect this channel */
51         short                           ikflag;         /* settings for IK bones */
52         short                           pathlen;        /* for drawing paths, the amount of frames */
53         short                           protectflag;/* protect channels from being transformed */
54         short                           pad, pad1, pad2;
55         
56         struct Bone                     *bone;          /* set on read file or rebuild pose */
57         struct bPoseChannel *parent;    /* set on read file or rebuild pose */
58         struct bPoseChannel *child;             /* set on read file or rebuild pose, the 'ik' child, for b-bones */
59         struct ListBase          iktree;                /* only while evaluating pose */
60         void                            *b_bone_mats;   /* only while deform, stores precalculated b_bone deform mats */
61         
62         float           loc[3];                         /* written in by actions or transform */
63         float           size[3];
64         float           quat[4];
65         
66         float           chan_mat[4][4];         /* matrix result of loc/quat/size , and where we put deform in, see next line */
67         float           pose_mat[4][4];         /* constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat */
68         
69         float           pose_head[3];           /* actually pose_mat[3] */
70         float           pose_tail[3];           /* also used for drawing help lines... */
71         
72         float           limitmin[3], limitmax[3];       /* DOF constraint */
73         float           stiffness[3];                           /* DOF stiffness */
74         float           ikstretch;
75         
76         float           *path;                          /* totpath x 3 x float */
77         struct Object *custom;                  /* draws custom object instead of this channel */
78         
79 } bPoseChannel;
80
81
82 typedef struct bPose{
83         ListBase                        chanbase;
84         int flag;
85         float stride_offset[3];
86 } bPose;
87
88 typedef struct bActionChannel {
89         struct bActionChannel   *next, *prev;
90         struct Ipo                              *ipo;
91         ListBase                                constraintChannels;
92         int             flag;
93         char    name[32];               /* Channel name */
94         int             reserved1;
95
96 } bActionChannel;
97
98 typedef struct bAction {
99         ID                              id;
100         ListBase                chanbase;       /* Channels in this action */
101 } bAction;
102
103 typedef struct SpaceAction {
104         struct SpaceLink *next, *prev;
105         int spacetype;
106         float blockscale;
107         struct ScrArea *area;
108
109         short blockhandler[8];
110
111         View2D v2d;     
112         bAction         *action;
113         int     flag;
114         short pin, actnr, lock, pad;
115         float timeslide;
116 } SpaceAction;
117
118 /* Action Channel flags */
119 #define ACHAN_SELECTED  0x00000001
120 #define ACHAN_HILIGHTED 0x00000002
121 #define ACHAN_HIDDEN    0x00000004
122 #define ACHAN_MOVED     0x80000000
123
124 /* SpaceAction flag */
125 #define SACTION_MOVING  1
126
127 /* Pose->flag */
128 #define POSE_RECALC             1
129 #define POSE_LOCKED             2
130 #define POSE_DO_UNLOCK  4
131
132 /* PoseChannel (transform) flags */
133 enum    {
134         POSE_LOC                =       0x0001,
135         POSE_ROT                =       0x0002,
136         POSE_SIZE               =       0x0004,
137         POSE_IK_MAT             =       0x0008,
138         POSE_UNUSED2    =       0x0010,
139         POSE_UNUSED3    =       0x0020,
140         POSE_UNUSED4    =       0x0040,
141         POSE_UNUSED5    =       0x0080,
142         POSE_HAS_IK             =       0x0100,
143         POSE_CHAIN              =       0x0200,
144         POSE_DONE               =   0x0400,
145         POSE_KEY                =       0x1000,
146         POSE_STRIDE             =       0x2000
147 };
148
149 /* PoseChannel constflag (constraint detection) */
150 #define PCHAN_HAS_IK            1
151 #define PCHAN_HAS_CONST         2
152         /* only used for drawing Posemode, not stored in channel */
153 #define PCHAN_HAS_ACTION        4
154 #define PCHAN_HAS_TARGET        8
155         /* only for drawing Posemode too */
156 #define PCHAN_HAS_STRIDE        16
157
158 /* PoseChannel->ikflag */
159 #define         BONE_IK_NO_XDOF 1
160 #define         BONE_IK_NO_YDOF 2
161 #define         BONE_IK_NO_ZDOF 4
162
163 #define         BONE_IK_XLIMIT  8
164 #define         BONE_IK_YLIMIT  16
165 #define         BONE_IK_ZLIMIT  32
166
167
168 #endif
169