kannonier8/blender
1
0
Fork 0
forked from bartvdbraak/blender
Code Pull Requests Activity

code cleanup: comment (almost) all members of KeyBlock & Key.

Browse Source
This commit is contained in:
Campbell Barton 2012-04-14 03:58:08 +00:00
parent 289f627f63
commit 969a079aeb
2 changed files with 49 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/blender/blenkernel/intern/key.c
View File

@ -326,7 +326,7 @@ void key_curve_tangent_weights(float t, float *data, int type)
t2 = t * t;
data[0] = -0.5f * t2 + t - 0.5f;
data[1] = 1.5f * t2 - 2.0f * t;
data[1] = 1.5f * t2 - t * 2.0f;
data[2] = -1.5f * t2 + t + 0.5f;
data[3] = 0.5f * t2;
}

61
source/blender/makesdna/DNA_key_types.h
View File

@ -41,18 +41,29 @@ struct Ipo;
typedef struct KeyBlock {
struct KeyBlock *next, *prev;
float pos;
float curval;
short type, pad1, relative, flag; /* relative == 0 means first key is reference */
int totelem, uid;
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.*/
void *data;
float *weights;
char name[64]; /* MAX_NAME */
char vgroup[64]; /* MAX_VGROUP_NAME */
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 chech 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) */
float *weights; /* store an aligned array of weights from 'vgroup' */
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 */
/* ranges, for RNA and UI only to clamp 'curval' */
float slidermin;
float slidermax;
} KeyBlock;
@ -60,48 +71,60 @@ 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;
/* 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;
float curval DNA_DEPRECATED;
int elemsize; /* size of each element in #KeyBlock.data, use for allocation and stride */
int pad;
ListBase block;
ListBase block; /* list of KeyBlock's */
struct Ipo *ipo DNA_DEPRECATED; /* old animation system, deprecated for 2.5 */
ID *from;
short type, totkey;
short slurph, flag;
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*/
/* can never be 0, this is used for detecting old data */
int uidgen; /* current free uid for keyblocks */
} Key;
/* **************** KEY ********************* */
/* key->type */
/* Key->type: KeyBlocks are interpreted as... */
enum {
/* Sequencial positions over time (using KeyBlock->pos and Key->ctime) */
KEY_NORMAL = 0,
/* States to blend between (default) */
KEY_RELATIVE = 1
};
/* key->flag */
/* Key->flag */
enum {
KEY_DS_EXPAND = 1
};
/* keyblock->type */
/* KeyBlock->type */
enum {
KEY_LINEAR = 0,
KEY_CARDINAL = 1,
KEY_BSPLINE = 2
};
/* keyblock->flag */
/* KeyBlock->flag */
enum {
KEYBLOCK_MUTE = (1 << 0),
KEYBLOCK_SEL = (1 << 1),