Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2019-01-07 14:19:13 +0300
committerCampbell Barton <ideasman42@gmail.com>2019-01-07 16:43:00 +0300
commit5a43406e1bad973a8cb32702b4fdb588068a6dcd (patch)
treeb47ac75f429b586950dab5300669c373023efab8 /source/blender/makesdna/DNA_key_types.h
parent0215caeac2ad013fa03e2799049f5358d951ebfa (diff)
Cleanup: move DNA comments before struct members
Needed for clang-format in some cases, see: T53211
Diffstat (limited to 'source/blender/makesdna/DNA_key_types.h')
-rw-r--r--source/blender/makesdna/DNA_key_types.h75
1 files changed, 49 insertions, 26 deletions
diff --git a/source/blender/makesdna/DNA_key_types.h b/source/blender/makesdna/DNA_key_types.h
index fa58f8f8abd..740d8b274b4 100644
--- a/source/blender/makesdna/DNA_key_types.h
+++ b/source/blender/makesdna/DNA_key_types.h
@@ -45,25 +45,36 @@ struct Ipo;
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. */
+ /**
+ * 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 pos;
+ /** influence (typically [0 - 1] but can be more), (Key->type == KEY_RELATIVE) only.*/
+ float curval;
+
+ /** interpolation type (Key->type == KEY_NORMAL) only. */
+ short type;
short pad1;
- short relative; /* relative == 0 means first key is reference, otherwise the index of Key->blocks */
+ /** relative == 0 means first key is reference, otherwise the index of Key->blocks */
+ short relative;
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 */
+ /** total number if items in the keyblock (compare with mesh/curve verts to check we match) */
+ int totelem;
+ /** for meshes only, match the unique number with the customdata layer */
+ int uid;
- 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 */
+ /** array of shape key values, size is (Key->elemsize * KeyBlock->totelem) */
+ void *data;
+ /** MAX_NAME (unique name, user assigned) */
+ char name[64];
+ /** MAX_VGROUP_NAME (optional vertex group), array gets allocated into 'weights' when set */
+ char vgroup[64];
- /* ranges, for RNA and UI only to clamp 'curval' */
+ /** ranges, for RNA and UI only to clamp 'curval' */
float slidermin;
float slidermax;
@@ -72,36 +83,48 @@ typedef struct KeyBlock {
typedef struct Key {
ID id;
- struct AnimData *adt; /* animation data (must be immediately after id for utilities to use it) */
+ /** Animation data (must be immediately after id for utilities to use it). */
+ struct AnimData *adt;
- /* commonly called 'Basis', (Key->type == KEY_RELATIVE) only.
+ /**
+ * 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 */
+ * 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 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 */
+ * (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 */
+ /** Size of each element in #KeyBlock.data, use for allocation and stride. */
+ int elemsize;
int pad;
- ListBase block; /* list of KeyBlock's */
- struct Ipo *ipo DNA_DEPRECATED; /* old animation system, deprecated for 2.5 */
+ /** list of KeyBlock's */
+ ListBase block;
+ /** old animation system, deprecated for 2.5 */
+ struct Ipo *ipo DNA_DEPRECATED;
ID *from;
- int totkey; /* (totkey == BLI_listbase_count(&key->block)) */
+ /** (totkey == BLI_listbase_count(&key->block)) */
+ int totkey;
short flag;
- char type; /* absolute or relative shape key */
+ /** absolute or relative shape key */
+ char type;
char pad2;
- /* only used when (Key->type == KEY_NORMAL), this value is used as a time slider,
+ /** 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.
+ * current free uid for keyblocks
+ */
+ int uidgen;
} Key;
/* **************** KEY ********************* */