diff options
Diffstat (limited to 'source/blender')
-rw-r--r-- | source/blender/makesdna/DNA_curve_types.h | 32 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_sequence_types.h | 15 |
2 files changed, 29 insertions, 18 deletions
diff --git a/source/blender/makesdna/DNA_curve_types.h b/source/blender/makesdna/DNA_curve_types.h index 56cf90d3d9d..284694f2b48 100644 --- a/source/blender/makesdna/DNA_curve_types.h +++ b/source/blender/makesdna/DNA_curve_types.h @@ -87,20 +87,22 @@ typedef struct BevPoint { short split_tag, dupe_tag; } BevPoint; -/* Keyframes on F-Curves (allows code reuse of Bezier eval code) and +/** + * Keyframes on F-Curves (allows code reuse of Bezier eval code) and * Points on Bezier Curves/Paths are generally BezTriples - */ -/* note: alfa location in struct is abused by Key system */ -/* vec in BezTriple looks like this: - * - vec[0][0]=x location of handle 1 - * - vec[0][1]=y location of handle 1 - * - vec[0][2]=z location of handle 1 (not used for FCurve Points(2d)) - * - vec[1][0]=x location of control point - * - vec[1][1]=y location of control point - * - vec[1][2]=z location of control point - * - vec[2][0]=x location of handle 2 - * - vec[2][1]=y location of handle 2 - * - vec[2][2]=z location of handle 2 (not used for FCurve Points(2d)) + * + * \note alfa location in struct is abused by Key system + * + * \note vec in BezTriple looks like this: + * - vec[0][0] = x location of handle 1 + * - vec[0][1] = y location of handle 1 + * - vec[0][2] = z location of handle 1 (not used for FCurve Points(2d)) + * - vec[1][0] = x location of control point + * - vec[1][1] = y location of control point + * - vec[1][2] = z location of control point + * - vec[2][0] = x location of handle 2 + * - vec[2][1] = y location of handle 2 + * - vec[2][2] = z location of handle 2 (not used for FCurve Points(2d)) */ typedef struct BezTriple { float vec[3][3]; @@ -119,6 +121,10 @@ typedef struct BPoint { float radius, pad; /* user-set radius per point for beveling etc */ } BPoint; +/** + * \note Nurb name is misleading, since it can be used for polygons too, + * also, it should be NURBS (Nurb isn't the singular of Nurbs). + */ typedef struct Nurb { struct Nurb *next, *prev; /* multiple nurbs per curve object are allowed */ short type; diff --git a/source/blender/makesdna/DNA_sequence_types.h b/source/blender/makesdna/DNA_sequence_types.h index e7ab6f66408..0835bb6b4c8 100644 --- a/source/blender/makesdna/DNA_sequence_types.h +++ b/source/blender/makesdna/DNA_sequence_types.h @@ -102,11 +102,16 @@ typedef struct Strip { StripColorBalance *color_balance; } Strip; -/* The sequence structure is the basic struct used by any strip. each of the strips uses a different sequence structure.*/ -/* WATCH IT: first part identical to ID (for use in ipo's) - * the commend above is historic, probably we can drop the ID compatibility, but take care making this change */ - -/* WATCH ITv2, this is really a 'Strip' in the UI!, name is highly confusing */ +/** + * The sequence structure is the basic struct used by any strip. + * each of the strips uses a different sequence structure. + * + * \warning The first part identical to ID (for use in ipo's) + * the commend above is historic, probably we can drop the ID compatibility, + * but take care making this change. + * + * \warning This is really a 'Strip' in the UI!, name is highly confusing. + */ typedef struct Sequence { struct Sequence *next, *prev; void *tmp; /* tmp var for copying, and tagging for linked selection */ |