1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
#ifndef __DNA_KEY_TYPES_H__
#define __DNA_KEY_TYPES_H__
/** \file DNA_key_types.h
* \ingroup DNA
*
* This file defines structures for Shape-Keys (not animation keyframes),
* attached to Mesh, Curve and Lattice Data. Even though Key's are ID blocks they
* aren't intended to be shared between multiple data blocks as with other ID types.
*/
#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_ID.h"
struct AnimData;
struct Ipo;
# /* These two things tell makesdna to ignore this struct */
#
typedef struct CompressedMeshVertex {
int vertex_index;
float co[3];
} CompressedMeshVertex;
typedef struct KeyBlock {
struct KeyBlock *next, *prev;
float pos; /* point in time (Key->type == KEY_NORMAL) only,
* for historic reasons this is relative to (Key->ctime / 100),
* so this value increments by 0.1f per frame. */
float curval; /* influence (typically [0 - 1] but can be more), (Key->type == KEY_RELATIVE) only.*/
short type; /* interpolation type (Key->type == KEY_NORMAL) only. */
short pad1;
short relative; /* relative == 0 means first key is reference, otherwise the index of Key->blocks */
short flag;
int totelem; /* total number if items in the keyblock (compare with mesh/curve verts to check we match) */
int uid; /* for meshes only, match the unique number with the customdata layer */
void *data; /* array of shape key values, size is (Key->elemsize * KeyBlock->totelem) */
char name[64]; /* MAX_NAME (unique name, user assigned) */
char vgroup[64]; /* MAX_VGROUP_NAME (optional vertex group), array gets allocated into 'weights' when set */
float mixval; /* animation-independent mix influence (Key->type == KEY_RELATIVE only) */
/* ranges, for RNA and UI only to clamp 'curval' and 'mixval' */
float slidermin;
float slidermax;
char pad[4];
} KeyBlock;
typedef struct ScratchKeyBlock {
/* array of values, size Key->elemsize * KeyBlock->totelem */
void *data;
/* where this scratch has come from, all other setting are read from there */
KeyBlock *origin;
} ScratchKeyBlock;
typedef struct Key {
ID id;
struct AnimData *adt; /* animation data (must be immediately after id for utilities to use it) */
/* commonly called 'Basis', (Key->type == KEY_RELATIVE) only.
* Looks like this is _always_ 'key->block.first',
* perhaps later on it could be defined as some other KeyBlock - campbell */
KeyBlock *refkey;
/* Runtime KeyBlock where the 'real' data editing happens. Gets committed to its origin. */
ScratchKeyBlock scratch;
/* this is not a regular string, although it is \0 terminated
* this is an array of (element_array_size, element_type) pairs
* (each one char) used for calculating shape key-blocks */
char elemstr[32];
int elemsize; /* size of each element in #KeyBlock.data, use for allocation and stride */
short pad;
short mix_mode; /* Key->type == KEY_RELATIVE only; defines whether the mix will be from the animation or
* from the temporary user values */
ListBase block; /* list of KeyBlock's */
struct Ipo *ipo DNA_DEPRECATED; /* old animation system, deprecated for 2.5 */
ID *from;
short type; /* absolute or relative shape key */
short totkey; /* (totkey == BLI_countlist(&key->block)) */
short slurph; /* quaint feature to delay moving points based on their order (Key->type == KEY_NORMAL) only */
short flag;
/* only used when (Key->type == KEY_NORMAL), this value is used as a time slider,
* rather then using the scenes time, this value can be animated to give greater control */
float ctime;
/* can never be 0, this is used for detecting old data */
int uidgen; /* current free uid for keyblocks */
} Key;
/* **************** KEY ********************* */
/* Key->type: KeyBlocks are interpreted as... */
enum {
/* Sequential positions over time (using KeyBlock->pos and Key->ctime) */
KEY_NORMAL = 0,
/* States to blend between (default) */
KEY_RELATIVE = 1
};
/* Key->mix_mode */
enum {
KEY_MIX_FROM_TEMPVALUES = 0,
KEY_MIX_FROM_ANIMDATA = 1,
};
/* Key->flag */
enum {
KEY_DS_EXPAND = 1 << 0,
/* File save only - if set, key's data is laid out as an array of CompressedMeshVertex structs (total totelem).
* Mesh only. Does not do anything useful at runtime */
KEY_COMPRESSED = 1 << 1,
};
/* Min squared distance between org vertex and skey one, to store the skey in file (compressed mode only). */
#define KEY_MIN_SQUARED_LEN 1e-6f
/* KeyBlock->type */
enum {
KEY_LINEAR = 0,
KEY_CARDINAL = 1,
KEY_BSPLINE = 2,
KEY_CATMULL_ROM = 3,
};
/* KeyBlock->flag */
enum {
KEYBLOCK_MUTE = (1 << 0),
KEYBLOCK_SEL = (1 << 1),
KEYBLOCK_LOCKED = (1 << 2)
};
#endif /* __DNA_KEY_TYPES_H__ */
|
