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
path: root/source
diff options
context:
space:
mode:
authorSebastian Parborg <darkdefende@gmail.com>2020-10-20 13:34:04 +0300
committerSebastian Parborg <darkdefende@gmail.com>2020-10-20 14:04:02 +0300
commit0105f146bb40bd609ccbda3d3f6aeb8e14ad3f9e (patch)
tree5043903cae4b645edc83b3e12a1d55fe8dd6cb86 /source
parent580fe9f5f88079c8ba32f32d5b6404d3fd47133c (diff)
Cleanup: General comment style clean up of graph_edit.c and fcurve.c
No functional changes. Reviewed By: Sybren A. Stüvel Differential Revision: http://developer.blender.org/D7850
Diffstat (limited to 'source')
-rw-r--r--source/blender/blenkernel/intern/fcurve.c394
-rw-r--r--source/blender/editors/space_graph/graph_edit.c810
2 files changed, 601 insertions, 603 deletions
diff --git a/source/blender/blenkernel/intern/fcurve.c b/source/blender/blenkernel/intern/fcurve.c
index 2287170c29d..fafcbaec10f 100644
--- a/source/blender/blenkernel/intern/fcurve.c
+++ b/source/blender/blenkernel/intern/fcurve.c
@@ -82,41 +82,41 @@ void BKE_fcurve_free(FCurve *fcu)
return;
}
- /* free curve data */
+ /* Free curve data. */
MEM_SAFE_FREE(fcu->bezt);
MEM_SAFE_FREE(fcu->fpt);
- /* free RNA-path, as this were allocated when getting the path string */
+ /* Free RNA-path, as this were allocated when getting the path string. */
MEM_SAFE_FREE(fcu->rna_path);
- /* free extra data - i.e. modifiers, and driver */
+ /* Free extra data - i.e. modifiers, and driver. */
fcurve_free_driver(fcu);
free_fmodifiers(&fcu->modifiers);
- /* free f-curve itself */
+ /* Free the f-curve itself. */
MEM_freeN(fcu);
}
-/* Frees a list of F-Curves */
+/* Frees a list of F-Curves. */
void BKE_fcurves_free(ListBase *list)
{
FCurve *fcu, *fcn;
- /* sanity check */
+ /* Sanity check. */
if (list == NULL) {
return;
}
- /* free data - no need to call remlink before freeing each curve,
+ /* Free data - no need to call remlink before freeing each curve,
* as we store reference to next, and freeing only touches the curve
- * it's given
+ * it's given.
*/
for (fcu = list->first; fcu; fcu = fcn) {
fcn = fcu->next;
BKE_fcurve_free(fcu);
}
- /* clear pointers just in case */
+ /* Clear pointers just in case. */
BLI_listbase_clear(list);
}
@@ -126,53 +126,53 @@ void BKE_fcurves_free(ListBase *list)
/** \name F-Curve Data Copy
* \{ */
-/* duplicate an F-Curve */
+/* Duplicate a F-Curve. */
FCurve *BKE_fcurve_copy(const FCurve *fcu)
{
FCurve *fcu_d;
- /* sanity check */
+ /* Sanity check. */
if (fcu == NULL) {
return NULL;
}
- /* make a copy */
+ /* Make a copy. */
fcu_d = MEM_dupallocN(fcu);
fcu_d->next = fcu_d->prev = NULL;
fcu_d->grp = NULL;
- /* copy curve data */
+ /* Copy curve data. */
fcu_d->bezt = MEM_dupallocN(fcu_d->bezt);
fcu_d->fpt = MEM_dupallocN(fcu_d->fpt);
- /* copy rna-path */
+ /* Copy rna-path. */
fcu_d->rna_path = MEM_dupallocN(fcu_d->rna_path);
- /* copy driver */
+ /* Copy driver. */
fcu_d->driver = fcurve_copy_driver(fcu_d->driver);
- /* copy modifiers */
+ /* Copy modifiers. */
copy_fmodifiers(&fcu_d->modifiers, &fcu->modifiers);
- /* return new data */
+ /* Return new data. */
return fcu_d;
}
-/* duplicate a list of F-Curves */
+/* Duplicate a list of F-Curves. */
void BKE_fcurves_copy(ListBase *dst, ListBase *src)
{
FCurve *dfcu, *sfcu;
- /* sanity checks */
+ /* Sanity checks. */
if (ELEM(NULL, dst, src)) {
return;
}
- /* clear destination list first */
+ /* Clear destination list first. */
BLI_listbase_clear(dst);
- /* copy one-by-one */
+ /* Copy one-by-one. */
for (sfcu = src->first; sfcu; sfcu = sfcu->next) {
dfcu = BKE_fcurve_copy(sfcu);
BLI_addtail(dst, dfcu);
@@ -213,15 +213,15 @@ void BKE_fcurve_foreach_id(FCurve *fcu, LibraryForeachIDData *data)
/* ----------------- Finding F-Curves -------------------------- */
-/* high level function to get an fcurve from C without having the rna */
+/* High level function to get an fcurve from C without having the RNA. */
FCurve *id_data_find_fcurve(
ID *id, void *data, StructRNA *type, const char *prop_name, int index, bool *r_driven)
{
- /* anim vars */
+ /* Anim vars */
AnimData *adt = BKE_animdata_from_id(id);
FCurve *fcu = NULL;
- /* rna vars */
+ /* Rna vars */
PointerRNA ptr;
PropertyRNA *prop;
char *path;
@@ -230,7 +230,7 @@ FCurve *id_data_find_fcurve(
*r_driven = false;
}
- /* only use the current action ??? */
+ /* Only use the current action ??? */
if (ELEM(NULL, adt, adt->action)) {
return NULL;
}
@@ -246,12 +246,12 @@ FCurve *id_data_find_fcurve(
return NULL;
}
- /* animation takes priority over drivers */
+ /* Animation takes priority over drivers. */
if (adt->action && adt->action->curves.first) {
fcu = BKE_fcurve_find(&adt->action->curves, path, index);
}
- /* if not animated, check if driven */
+ /* If not animated, check if driven. */
if (fcu == NULL && adt->drivers.first) {
fcu = BKE_fcurve_find(&adt->drivers, path, index);
if (fcu && r_driven) {
@@ -271,45 +271,43 @@ FCurve *BKE_fcurve_find(ListBase *list, const char rna_path[], const int array_i
{
FCurve *fcu;
- /* sanity checks */
+ /* Sanity checks. */
if (ELEM(NULL, list, rna_path) || (array_index < 0)) {
return NULL;
}
- /* check paths of curves, then array indices... */
+ /* Check paths of curves, then array indices... */
for (fcu = list->first; fcu; fcu = fcu->next) {
- /* simple string-compare (this assumes that they have the same root...) */
+ /* Simple string-compare (this assumes that they have the same root...) */
if (fcu->rna_path && STREQ(fcu->rna_path, rna_path)) {
- /* now check indices */
+ /* Now check indices. */
if (fcu->array_index == array_index) {
return fcu;
}
}
}
- /* return */
return NULL;
}
-/* quick way to loop over all fcurves of a given 'path' */
+/* Quick way to loop over all fcurves of a given 'path'. */
FCurve *BKE_fcurve_iter_step(FCurve *fcu_iter, const char rna_path[])
{
FCurve *fcu;
- /* sanity checks */
+ /* Sanity checks. */
if (ELEM(NULL, fcu_iter, rna_path)) {
return NULL;
}
- /* check paths of curves, then array indices... */
+ /* Check paths of curves, then array indices... */
for (fcu = fcu_iter; fcu; fcu = fcu->next) {
- /* simple string-compare (this assumes that they have the same root...) */
+ /* Simple string-compare (this assumes that they have the same root...) */
if (fcu->rna_path && STREQ(fcu->rna_path, rna_path)) {
return fcu;
}
}
- /* return */
return NULL;
}
@@ -330,7 +328,7 @@ int BKE_fcurves_filter(ListBase *dst, ListBase *src, const char *dataPrefix, con
FCurve *fcu;
int matches = 0;
- /* sanity checks */
+ /* Sanity checks. */
if (ELEM(NULL, dst, src, dataPrefix, dataName)) {
return 0;
}
@@ -338,9 +336,9 @@ int BKE_fcurves_filter(ListBase *dst, ListBase *src, const char *dataPrefix, con
return 0;
}
- /* search each F-Curve one by one */
+ /* Search each F-Curve one by one. */
for (fcu = src->first; fcu; fcu = fcu->next) {
- /* check if quoted string matches the path */
+ /* Check if quoted string matches the path. */
if (fcu->rna_path == NULL || !strstr(fcu->rna_path, dataPrefix)) {
continue;
}
@@ -350,7 +348,7 @@ int BKE_fcurves_filter(ListBase *dst, ListBase *src, const char *dataPrefix, con
continue;
}
- /* check if the quoted name matches the required name */
+ /* Check if the quoted name matches the required name. */
if (STREQ(quotedName, dataName)) {
LinkData *ld = MEM_callocN(sizeof(LinkData), __func__);
@@ -360,10 +358,10 @@ int BKE_fcurves_filter(ListBase *dst, ListBase *src, const char *dataPrefix, con
matches++;
}
- /* always free the quoted string, since it needs freeing */
+ /* Always free the quoted string, since it needs freeing. */
MEM_freeN(quotedName);
}
- /* return the number of matches */
+ /* Return the number of matches. */
return matches;
}
@@ -415,7 +413,7 @@ FCurve *BKE_fcurve_find_by_rna_context_ui(bContext *C,
return fcu;
}
- /* there must be some RNA-pointer + property combon */
+ /* There must be some RNA-pointer + property combo. */
if (prop && tptr.owner_id && RNA_property_animateable(&tptr, prop)) {
AnimData *adt = BKE_animdata_from_id(tptr.owner_id);
int step = (
@@ -429,14 +427,14 @@ FCurve *BKE_fcurve_find_by_rna_context_ui(bContext *C,
step--;
}
- /* Standard F-Curve - Animation (Action) or Drivers */
+ /* Standard F-Curve - Animation (Action) or Drivers. */
while (adt && step--) {
if ((adt->action == NULL || adt->action->curves.first == NULL) &&
(adt->drivers.first == NULL)) {
continue;
}
- /* XXX this function call can become a performance bottleneck */
+ /* XXX This function call can become a performance bottleneck. */
if (step) {
path = RNA_path_from_ID_to_property(&tptr, prop);
}
@@ -444,8 +442,8 @@ FCurve *BKE_fcurve_find_by_rna_context_ui(bContext *C,
continue;
}
- /* XXX: the logic here is duplicated with a function up above
- * animation takes priority over drivers. */
+ /* XXX: The logic here is duplicated with a function up above. */
+ /* animation takes priority over drivers. */
if (adt->action && adt->action->curves.first) {
fcu = BKE_fcurve_find(&adt->action->curves, path, rnaindex);
@@ -454,7 +452,7 @@ FCurve *BKE_fcurve_find_by_rna_context_ui(bContext *C,
}
}
- /* if not animated, check if driven */
+ /* If not animated, check if driven. */
if (!fcu && (adt->drivers.first)) {
fcu = BKE_fcurve_find(&adt->drivers, path, rnaindex);
@@ -508,19 +506,19 @@ static int BKE_fcurve_bezt_binarysearch_index_ex(
int start = 0, end = arraylen;
int loopbreaker = 0, maxloop = arraylen * 2;
- /* initialize replace-flag first */
+ /* Initialize replace-flag first. */
*r_replace = false;
- /* sneaky optimizations (don't go through searching process if...):
- * - keyframe to be added is to be added out of current bounds
- * - keyframe to be added would replace one of the existing ones on bounds
+ /* Sneaky optimizations (don't go through searching process if...):
+ * - Keyframe to be added is to be added out of current bounds.
+ * - Keyframe to be added would replace one of the existing ones on bounds.
*/
if ((arraylen <= 0) || (array == NULL)) {
CLOG_WARN(&LOG, "encountered invalid array");
return 0;
}
- /* check whether to add before/after/on */
+ /* Check whether to add before/after/on. */
float framenum;
/* 'First' Keyframe (when only one keyframe, this case is used) */
@@ -543,24 +541,24 @@ static int BKE_fcurve_bezt_binarysearch_index_ex(
return arraylen;
}
- /* most of the time, this loop is just to find where to put it
- * 'loopbreaker' is just here to prevent infinite loops
+ /* Most of the time, this loop is just to find where to put it
+ * 'loopbreaker' is just here to prevent infinite loops.
*/
for (loopbreaker = 0; (start <= end) && (loopbreaker < maxloop); loopbreaker++) {
- /* compute and get midpoint */
+ /* Compute and get midpoint. */
/* We calculate the midpoint this way to avoid int overflows... */
int mid = start + ((end - start) / 2);
float midfra = array[mid].vec[1][0];
- /* check if exactly equal to midpoint */
+ /* Check if exactly equal to midpoint. */
if (IS_EQT(frame, midfra, threshold)) {
*r_replace = true;
return mid;
}
- /* repeat in upper/lower half */
+ /* Repeat in upper/lower half. */
if (frame > midfra) {
start = mid + 1;
}
@@ -569,11 +567,11 @@ static int BKE_fcurve_bezt_binarysearch_index_ex(
}
}
- /* print error if loop-limit exceeded */
+ /* Print error if loop-limit exceeded. */
if (loopbreaker == (maxloop - 1)) {
CLOG_ERROR(&LOG, "search taking too long");
- /* include debug info */
+ /* Include debug info. */
CLOG_ERROR(&LOG,
"\tround = %d: start = %d, end = %d, arraylen = %d",
loopbreaker,
@@ -582,7 +580,7 @@ static int BKE_fcurve_bezt_binarysearch_index_ex(
arraylen);
}
- /* not found, so return where to place it */
+ /* Not found, so return where to place it. */
return start;
}
@@ -594,14 +592,14 @@ int BKE_fcurve_bezt_binarysearch_index(BezTriple array[],
int arraylen,
bool *r_replace)
{
- /* this is just a wrapper which uses the default threshold */
+ /* This is just a wrapper which uses the default threshold. */
return BKE_fcurve_bezt_binarysearch_index_ex(
array, frame, arraylen, BEZT_BINARYSEARCH_THRESH, r_replace);
}
/* ...................................... */
-/* helper for calc_fcurve_* functions -> find first and last BezTriple to be used */
+/* Helper for calc_fcurve_* functions -> find first and last BezTriple to be used. */
static short get_fcurve_end_keyframes(FCurve *fcu,
BezTriple **first,
BezTriple **last,
@@ -609,20 +607,20 @@ static short get_fcurve_end_keyframes(FCurve *fcu,
{
bool found = false;
- /* init outputs */
+ /* Init outputs. */
*first = NULL;
*last = NULL;
- /* sanity checks */
+ /* Sanity checks. */
if (fcu->bezt == NULL) {
return found;
}
- /* only include selected items? */
+ /* Only include selected items? */
if (do_sel_only) {
BezTriple *bezt;
- /* find first selected */
+ /* Find first selected. */
bezt = fcu->bezt;
for (int i = 0; i < fcu->totvert; bezt++, i++) {
if (BEZT_ISSEL_ANY(bezt)) {
@@ -632,7 +630,7 @@ static short get_fcurve_end_keyframes(FCurve *fcu,
}
}
- /* find last selected */
+ /* Find last selected. */
bezt = ARRAY_LAST_ITEM(fcu->bezt, BezTriple, fcu->totvert);
for (int i = 0; i < fcu->totvert; bezt--, i++) {
if (BEZT_ISSEL_ANY(bezt)) {
@@ -643,7 +641,7 @@ static short get_fcurve_end_keyframes(FCurve *fcu,
}
}
else {
- /* just full array */
+ /* Use the whole array. */
*first = fcu->bezt;
*last = ARRAY_LAST_ITEM(fcu->bezt, BezTriple, fcu->totvert);
found = true;
@@ -652,7 +650,7 @@ static short get_fcurve_end_keyframes(FCurve *fcu,
return found;
}
-/* Calculate the extents of F-Curve's data */
+/* Calculate the extents of F-Curve's data. */
bool BKE_fcurve_calc_bounds(FCurve *fcu,
float *xmin,
float *xmax,
@@ -670,7 +668,7 @@ bool BKE_fcurve_calc_bounds(FCurve *fcu,
BezTriple *bezt_first = NULL, *bezt_last = NULL;
if (xmin || xmax) {
- /* get endpoint keyframes */
+ /* Get endpoint keyframes. */
foundvert = get_fcurve_end_keyframes(fcu, &bezt_first, &bezt_last, do_sel_only);
if (bezt_first) {
@@ -687,19 +685,19 @@ bool BKE_fcurve_calc_bounds(FCurve *fcu,
}
}
- /* only loop over keyframes to find extents for values if needed */
+ /* Only loop over keyframes to find extents for values if needed. */
if (ymin || ymax) {
BezTriple *bezt, *prevbezt = NULL;
int i;
for (bezt = fcu->bezt, i = 0; i < fcu->totvert; prevbezt = bezt, bezt++, i++) {
if ((do_sel_only == false) || BEZT_ISSEL_ANY(bezt)) {
- /* keyframe itself */
+ /* Keyframe itself. */
yminv = min_ff(yminv, bezt->vec[1][1]);
ymaxv = max_ff(ymaxv, bezt->vec[1][1]);
if (include_handles) {
- /* left handle - only if applicable
+ /* Left handle - only if applicable.
* NOTE: for the very first keyframe,
* the left handle actually has no bearings on anything. */
if (prevbezt && (prevbezt->ipo == BEZT_IPO_BEZ)) {
@@ -707,7 +705,7 @@ bool BKE_fcurve_calc_bounds(FCurve *fcu,
ymaxv = max_ff(ymaxv, bezt->vec[0][1]);
}
- /* right handle - only if applicable */
+ /* Right handle - only if applicable. */
if (bezt->ipo == BEZT_IPO_BEZ) {
yminv = min_ff(yminv, bezt->vec[2][1]);
ymaxv = max_ff(ymaxv, bezt->vec[2][1]);
@@ -720,13 +718,13 @@ bool BKE_fcurve_calc_bounds(FCurve *fcu,
}
}
else if (fcu->fpt) {
- /* frame range can be directly calculated from end verts */
+ /* Frame range can be directly calculated from end verts. */
if (xmin || xmax) {
xminv = min_ff(xminv, fcu->fpt[0].vec[0]);
xmaxv = max_ff(xmaxv, fcu->fpt[fcu->totvert - 1].vec[0]);
}
- /* only loop over keyframes to find extents for values if needed */
+ /* Only loop over keyframes to find extents for values if needed. */
if (ymin || ymax) {
FPoint *fpt;
int i;
@@ -783,7 +781,7 @@ bool BKE_fcurve_calc_bounds(FCurve *fcu,
return foundvert;
}
-/* Calculate the extents of F-Curve's keyframes */
+/* Calculate the extents of F-Curve's keyframes. */
bool BKE_fcurve_calc_range(
FCurve *fcu, float *start, float *end, const bool do_sel_only, const bool do_min_length)
{
@@ -794,7 +792,7 @@ bool BKE_fcurve_calc_range(
if (fcu->bezt) {
BezTriple *bezt_first = NULL, *bezt_last = NULL;
- /* get endpoint keyframes */
+ /* Get endpoint keyframes. */
get_fcurve_end_keyframes(fcu, &bezt_first, &bezt_last, do_sel_only);
if (bezt_first) {
@@ -819,7 +817,7 @@ bool BKE_fcurve_calc_range(
}
if (do_min_length) {
- /* minimum length is 1 frame */
+ /* Minimum length is 1 frame. */
if (min == max) {
max += 1.0f;
}
@@ -883,37 +881,37 @@ int BKE_fcurve_active_keyframe_index(const FCurve *fcu)
*/
bool BKE_fcurve_are_keyframes_usable(FCurve *fcu)
{
- /* F-Curve must exist */
+ /* F-Curve must exist. */
if (fcu == NULL) {
return false;
}
- /* F-Curve must not have samples - samples are mutually exclusive of keyframes */
+ /* F-Curve must not have samples - samples are mutually exclusive of keyframes. */
if (fcu->fpt) {
return false;
}
- /* if it has modifiers, none of these should "drastically" alter the curve */
+ /* If it has modifiers, none of these should "drastically" alter the curve. */
if (fcu->modifiers.first) {
FModifier *fcm;
- /* check modifiers from last to first, as last will be more influential */
- /* TODO: optionally, only check modifier if it is the active one... */
+ /* Check modifiers from last to first, as last will be more influential. */
+ /* TODO: optionally, only check modifier if it is the active one... (Joshua Leung 2010) */
for (fcm = fcu->modifiers.last; fcm; fcm = fcm->prev) {
- /* ignore if muted/disabled */
+ /* Ignore if muted/disabled. */
if (fcm->flag & (FMODIFIER_FLAG_DISABLED | FMODIFIER_FLAG_MUTED)) {
continue;
}
- /* type checks */
+ /* Type checks. */
switch (fcm->type) {
- /* clearly harmless - do nothing */
+ /* Clearly harmless - do nothing. */
case FMODIFIER_TYPE_CYCLES:
case FMODIFIER_TYPE_STEPPED:
case FMODIFIER_TYPE_NOISE:
break;
- /* sometimes harmful - depending on whether they're "additive" or not */
+ /* Sometimes harmful - depending on whether they're "additive" or not. */
case FMODIFIER_TYPE_GENERATOR: {
FMod_Generator *data = (FMod_Generator *)fcm->data;
@@ -930,14 +928,14 @@ bool BKE_fcurve_are_keyframes_usable(FCurve *fcu)
}
break;
}
- /* always harmful - cannot allow */
+ /* Always harmful - cannot allow. */
default:
return false;
}
}
}
- /* keyframes are usable */
+ /* Keyframes are usable. */
return true;
}
@@ -947,7 +945,7 @@ bool BKE_fcurve_is_protected(FCurve *fcu)
}
/* Can keyframes be added to F-Curve?
- * Keyframes can only be added if they are already visible
+ * Keyframes can only be added if they are already visible.
*/
bool BKE_fcurve_is_keyframable(FCurve *fcu)
{
@@ -956,12 +954,12 @@ bool BKE_fcurve_is_keyframable(FCurve *fcu)
return false;
}
- /* F-Curve must currently be editable too */
+ /* F-Curve must currently be editable too. */
if (BKE_fcurve_is_protected(fcu)) {
return false;
}
- /* F-Curve is keyframable */
+ /* F-Curve is keyframable. */
return true;
}
@@ -971,26 +969,26 @@ bool BKE_fcurve_is_keyframable(FCurve *fcu)
/** \name Keyframe Column Tools
* \{ */
-/* add a BezTriple to a column */
+/* Add a BezTriple to a column. */
static void UNUSED_FUNCTION(bezt_add_to_cfra_elem)(ListBase *lb, BezTriple *bezt)
{
CfraElem *ce, *cen;
for (ce = lb->first; ce; ce = ce->next) {
- /* double key? */
+ /* Double key? */
if (IS_EQT(ce->cfra, bezt->vec[1][0], BEZT_BINARYSEARCH_THRESH)) {
if (bezt->f2 & SELECT) {
ce->sel = bezt->f2;
}
return;
}
- /* should key be inserted before this column? */
+ /* Should key be inserted before this column? */
if (ce->cfra > bezt->vec[1][0]) {
break;
}
}
- /* create a new column */
+ /* Create a new column */
cen = MEM_callocN(sizeof(CfraElem), "add_to_cfra_elem");
if (ce) {
BLI_insertlinkbefore(lb, ce, cen);
@@ -1019,7 +1017,7 @@ static void UNUSED_FUNCTION(bezt_add_to_cfra_elem)(ListBase *lb, BezTriple *bezt
*/
float fcurve_samplingcb_evalcurve(FCurve *fcu, void *UNUSED(data), float evaltime)
{
- /* assume any interference from drivers on the curve is intended... */
+ /* Assume any interference from drivers on the curve is intended... */
return evaluate_fcurve(fcu, evaltime);
}
@@ -1031,8 +1029,8 @@ void fcurve_store_samples(FCurve *fcu, void *data, int start, int end, FcuSample
FPoint *fpt, *new_fpt;
int cfra;
- /* sanity checks */
- /* TODO: make these tests report errors using reports not CLOG's */
+ /* Sanity checks. */
+ /* TODO: make these tests report errors using reports not CLOG's (Joshua Leung 2009) */
if (ELEM(NULL, fcu, sample_cb)) {
CLOG_ERROR(&LOG, "No F-Curve with F-Curve Modifiers to Bake");
return;
@@ -1042,16 +1040,16 @@ void fcurve_store_samples(FCurve *fcu, void *data, int start, int end, FcuSample
return;
}
- /* set up sample data */
+ /* Set up sample data. */
fpt = new_fpt = MEM_callocN(sizeof(FPoint) * (end - start + 1), "FPoint Samples");
- /* use the sampling callback at 1-frame intervals from start to end frames */
+ /* Use the sampling callback at 1-frame intervals from start to end frames. */
for (cfra = start; cfra <= end; cfra++, fpt++) {
fpt->vec[0] = (float)cfra;
fpt->vec[1] = sample_cb(fcu, data, (float)cfra);
}
- /* free any existing sample/keyframe data on curve */
+ /* Free any existing sample/keyframe data on curve. */
if (fcu->bezt) {
MEM_freeN(fcu->bezt);
}
@@ -1059,7 +1057,7 @@ void fcurve_store_samples(FCurve *fcu, void *data, int start, int end, FcuSample
MEM_freeN(fcu->fpt);
}
- /* store the samples */
+ /* Store the samples. */
fcu->bezt = NULL;
fcu->fpt = new_fpt;
fcu->totvert = end - start + 1;
@@ -1068,7 +1066,7 @@ void fcurve_store_samples(FCurve *fcu, void *data, int start, int end, FcuSample
/* ***************************** F-Curve Sanity ********************************* */
/* The functions here are used in various parts of Blender, usually after some editing
* of keyframe data has occurred. They ensure that keyframe data is properly ordered and
- * that the handles are correctly
+ * that the handles are correct.
*/
/* Checks if the F-Curve has a Cycles modifier, and returns the type of the cycle behavior. */
@@ -1148,28 +1146,28 @@ void calchandles_fcurve_ex(FCurve *fcu, eBezTriple_Flag handle_sel_flag)
int a = fcu->totvert;
/* Error checking:
- * - need at least two points
- * - need bezier keys
- * - only bezier-interpolation has handles (for now)
+ * - Need at least two points.
+ * - Need bezier keys.
+ * - Only bezier-interpolation has handles (for now).
*/
if (ELEM(NULL, fcu, fcu->bezt) || (a < 2) /*|| ELEM(fcu->ipo, BEZT_IPO_CONST, BEZT_IPO_LIN)*/) {
return;
}
- /* if the first modifier is Cycles, smooth the curve through the cycle */
+ /* If the first modifier is Cycles, smooth the curve through the cycle. */
BezTriple *first = &fcu->bezt[0], *last = &fcu->bezt[fcu->totvert - 1];
BezTriple tmp;
bool cycle = BKE_fcurve_is_cyclic(fcu) && BEZT_IS_AUTOH(first) && BEZT_IS_AUTOH(last);
- /* get initial pointers */
+ /* Get initial pointers. */
bezt = fcu->bezt;
prev = cycle_offset_triple(cycle, &tmp, &fcu->bezt[fcu->totvert - 2], last, first);
next = (bezt + 1);
- /* loop over all beztriples, adjusting handles */
+ /* Loop over all beztriples, adjusting handles. */
while (a--) {
- /* clamp timing of handles to be on either side of beztriple */
+ /* Clamp timing of handles to be on either side of beztriple. */
if (bezt->vec[0][0] > bezt->vec[1][0]) {
bezt->vec[0][0] = bezt->vec[1][0];
}
@@ -1177,28 +1175,28 @@ void calchandles_fcurve_ex(FCurve *fcu, eBezTriple_Flag handle_sel_flag)
bezt->vec[2][0] = bezt->vec[1][0];
}
- /* calculate auto-handles */
+ /* Calculate auto-handles. */
BKE_nurb_handle_calc_ex(bezt, prev, next, handle_sel_flag, true, fcu->auto_smoothing);
- /* for automatic ease in and out */
+ /* For automatic ease in and out. */
if (BEZT_IS_AUTOH(bezt) && !cycle) {
- /* only do this on first or last beztriple */
+ /* Only do this on first or last beztriple. */
if ((a == 0) || (a == fcu->totvert - 1)) {
- /* set both handles to have same horizontal value as keyframe */
+ /* Set both handles to have same horizontal value as keyframe. */
if (fcu->extend == FCURVE_EXTRAPOLATE_CONSTANT) {
bezt->vec[0][1] = bezt->vec[2][1] = bezt->vec[1][1];
- /* remember that these keyframes are special, they don't need to be adjusted */
+ /* Remember that these keyframes are special, they don't need to be adjusted. */
bezt->f5 = HD_AUTOTYPE_SPECIAL;
}
}
}
- /* avoid total smoothing failure on duplicate keyframes (can happen during grab) */
+ /* Avoid total smoothing failure on duplicate keyframes (can happen during grab). */
if (prev && prev->vec[1][0] >= bezt->vec[1][0]) {
prev->f5 = bezt->f5 = HD_AUTOTYPE_SPECIAL;
}
- /* advance pointers for next iteration */
+ /* Advance pointers for next iteration. */
prev = bezt;
if (a == 1) {
@@ -1211,14 +1209,14 @@ void calchandles_fcurve_ex(FCurve *fcu, eBezTriple_Flag handle_sel_flag)
bezt++;
}
- /* if cyclic extrapolation and Auto Clamp has triggered, ensure it is symmetric */
+ /* If cyclic extrapolation and Auto Clamp has triggered, ensure it is symmetric. */
if (cycle && (first->f5 != HD_AUTOTYPE_NORMAL || last->f5 != HD_AUTOTYPE_NORMAL)) {
first->vec[0][1] = first->vec[2][1] = first->vec[1][1];
last->vec[0][1] = last->vec[2][1] = last->vec[1][1];
first->f5 = last->f5 = HD_AUTOTYPE_SPECIAL;
}
- /* do a second pass for auto handle: compute the handle to have 0 acceleration step */
+ /* Do a second pass for auto handle: compute the handle to have 0 acceleration step. */
if (fcu->auto_smoothing != FCURVE_SMOOTH_NONE) {
BKE_nurb_handle_smooth_fcurve(fcu->bezt, fcu->totvert, cycle);
}
@@ -1251,17 +1249,17 @@ void testhandles_fcurve(FCurve *fcu, eBezTriple_Flag sel_flag, const bool use_ha
BezTriple *bezt;
unsigned int a;
- /* only beztriples have handles (bpoints don't though) */
+ /* Only beztriples have handles (bpoints don't though). */
if (ELEM(NULL, fcu, fcu->bezt)) {
return;
}
- /* loop over beztriples */
+ /* Loop over beztriples. */
for (a = 0, bezt = fcu->bezt; a < fcu->totvert; a++, bezt++) {
BKE_nurb_bezt_handle_test(bezt, sel_flag, use_handle, false);
}
- /* recalculate handles */
+ /* Recalculate handles. */
calchandles_fcurve_ex(fcu, sel_flag);
}
@@ -1274,20 +1272,20 @@ void sort_time_fcurve(FCurve *fcu)
return;
}
- /* keep adjusting order of beztriples until nothing moves (bubble-sort) */
+ /* Keep adjusting order of beztriples until nothing moves (bubble-sort). */
BezTriple *bezt;
uint a;
bool ok = true;
while (ok) {
ok = 0;
- /* currently, will only be needed when there are beztriples */
+ /* Currently, will only be needed when there are beztriples. */
- /* loop over ALL points to adjust position in array and recalculate handles */
+ /* Loop over ALL points to adjust position in array and recalculate handles. */
for (a = 0, bezt = fcu->bezt; a < fcu->totvert; a++, bezt++) {
- /* check if thee's a next beztriple which we could try to swap with current */
+ /* Check if thee's a next beztriple which we could try to swap with current. */
if (a < (fcu->totvert - 1)) {
- /* swap if one is after the other (and indicate that order has changed) */
+ /* Swap if one is after the other (and indicate that order has changed). */
if (bezt->vec[1][0] > (bezt + 1)->vec[1][0]) {
SWAP(BezTriple, *bezt, *(bezt + 1));
ok = 1;
@@ -1297,34 +1295,34 @@ void sort_time_fcurve(FCurve *fcu)
}
for (a = 0, bezt = fcu->bezt; a < fcu->totvert; a++, bezt++) {
- /* if either one of both of the points exceeds crosses over the keyframe time... */
+ /* If either one of both of the points exceeds crosses over the keyframe time... */
if ((bezt->vec[0][0] > bezt->vec[1][0]) && (bezt->vec[2][0] < bezt->vec[1][0])) {
- /* swap handles if they have switched sides for some reason */
+ /* Swap handles if they have switched sides for some reason. */
swap_v2_v2(bezt->vec[0], bezt->vec[2]);
}
else {
- /* clamp handles */
+ /* Clamp handles. */
CLAMP_MAX(bezt->vec[0][0], bezt->vec[1][0]);
CLAMP_MIN(bezt->vec[2][0], bezt->vec[1][0]);
}
}
}
-/* This function tests if any BezTriples are out of order, thus requiring a sort */
+/* This function tests if any BezTriples are out of order, thus requiring a sort. */
bool test_time_fcurve(FCurve *fcu)
{
unsigned int a;
- /* sanity checks */
+ /* Sanity checks. */
if (fcu == NULL) {
return false;
}
- /* currently, only need to test beztriples */
+ /* Currently, only need to test beztriples. */
if (fcu->bezt) {
BezTriple *bezt;
- /* loop through all BezTriples, stopping when one exceeds the one after it */
+ /* Loop through all BezTriples, stopping when one exceeds the one after it. */
for (a = 0, bezt = fcu->bezt; a < (fcu->totvert - 1); a++, bezt++) {
if (bezt->vec[1][0] > (bezt + 1)->vec[1][0]) {
return true;
@@ -1334,7 +1332,7 @@ bool test_time_fcurve(FCurve *fcu)
else if (fcu->fpt) {
FPoint *fpt;
- /* loop through all FPoints, stopping when one exceeds the one after it */
+ /* Loop through all FPoints, stopping when one exceeds the one after it. */
for (a = 0, fpt = fcu->fpt; a < (fcu->totvert - 1); a++, fpt++) {
if (fpt->vec[0] > (fpt + 1)->vec[0]) {
return true;
@@ -1342,7 +1340,7 @@ bool test_time_fcurve(FCurve *fcu)
}
}
- /* none need any swapping */
+ /* None need any swapping. */
return false;
}
@@ -1371,9 +1369,9 @@ void BKE_fcurve_correct_bezpart(const float v1[2], float v2[2], float v3[2], con
h2[1] = v4[1] - v3[1];
/* Calculate distances:
- * - len = span of time between keyframes
- * - len1 = length of handle of start key
- * - len2 = length of handle of end key
+ * - len = Span of time between keyframes.
+ * - len1 = Length of handle of start key.
+ * - len2 = Length of handle of end key.
*/
len = v4[0] - v1[0];
len1 = fabsf(h1[0]);
@@ -1468,7 +1466,7 @@ static int solve_cubic(double c0, double c1, double c2, double c3, float *o)
c = c0;
if (a != 0.0) {
- /* discriminant */
+ /* Discriminant */
p = b * b - 4 * a * c;
if (p > 0) {
@@ -1647,7 +1645,7 @@ static float fcurve_eval_keyframes_extrapolate(
return endpoint_bezt->vec[1][1] - (fac * dx);
}
- /* Use the gradient of the second handle (later) of neighbor to calculate the gradient and thus
+ /* Use the gradient of the second handle (later) of neighbour to calculate the gradient and thus
* the value of the curve at evaluation time. */
int handle = direction_to_neighbor > 0 ? 0 : 2;
float dx = endpoint_bezt->vec[1][0] - evaltime;
@@ -1668,14 +1666,14 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
BezTriple *bezt, *prevbezt;
unsigned int a;
- /* evaltime occurs somewhere in the middle of the curve */
+ /* Evaltime occurs somewhere in the middle of the curve. */
bool exact = false;
/* Use binary search to find appropriate keyframes...
*
* The threshold here has the following constraints:
* - 0.001 is too coarse:
- * We get artifacts with 2cm driver movements at 1BU = 1m (see T40332)
+ * We get artifacts with 2cm driver movements at 1BU = 1m (see T40332).
*
* - 0.00001 is too fine:
* Weird errors, like selecting the wrong keyframe range (see T39207), occur.
@@ -1685,19 +1683,19 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
bezt = bezts + a;
if (exact) {
- /* index returned must be interpreted differently when it sits on top of an existing keyframe
- * - that keyframe is the start of the segment we need (see action_bug_2.blend in T39207)
+ /* Index returned must be interpreted differently when it sits on top of an existing keyframe
+ * - That keyframe is the start of the segment we need (see action_bug_2.blend in T39207).
*/
return bezt->vec[1][1];
}
- /* index returned refers to the keyframe that the eval-time occurs *before*
- * - hence, that keyframe marks the start of the segment we're dealing with
+ /* Index returned refers to the keyframe that the eval-time occurs *before*
+ * - hence, that keyframe marks the start of the segment we're dealing with.
*/
prevbezt = (a > 0) ? (bezt - 1) : bezt;
/* Use if the key is directly on the frame, in rare cases this is needed else we get 0.0 instead.
- * XXX: consult T39207 for examples of files where failure of these checks can cause issues */
+ * XXX: consult T39207 for examples of files where failure of these checks can cause issues. */
if (fabsf(bezt->vec[1][0] - evaltime) < eps) {
return bezt->vec[1][1];
}
@@ -1721,25 +1719,25 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
const float amplitude = prevbezt->amplitude;
const float period = prevbezt->period;
- /* value depends on interpolation mode */
+ /* Value depends on interpolation mode. */
if ((prevbezt->ipo == BEZT_IPO_CONST) || (fcu->flag & FCURVE_DISCRETE_VALUES) ||
(duration == 0)) {
- /* constant (evaltime not relevant, so no interpolation needed) */
+ /* Constant (evaltime not relevant, so no interpolation needed). */
return prevbezt->vec[1][1];
}
switch (prevbezt->ipo) {
- /* interpolation ...................................... */
+ /* Interpolation ...................................... */
case BEZT_IPO_BEZ: {
float v1[2], v2[2], v3[2], v4[2], opl[32];
- /* bezier interpolation */
- /* (v1, v2) are the first keyframe and its 2nd handle */
+ /* Bezier interpolation. */
+ /* (v1, v2) are the first keyframe and its 2nd handle. */
v1[0] = prevbezt->vec[1][0];
v1[1] = prevbezt->vec[1][1];
v2[0] = prevbezt->vec[2][0];
v2[1] = prevbezt->vec[2][1];
- /* (v3, v4) are the last keyframe's 1st handle + the last keyframe */
+ /* (v3, v4) are the last keyframe's 1st handle + the last keyframe. */
v3[0] = bezt->vec[0][0];
v3[1] = bezt->vec[0][1];
v4[0] = bezt->vec[1][0];
@@ -1748,14 +1746,14 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
if (fabsf(v1[1] - v4[1]) < FLT_EPSILON && fabsf(v2[1] - v3[1]) < FLT_EPSILON &&
fabsf(v3[1] - v4[1]) < FLT_EPSILON) {
/* Optimization: If all the handles are flat/at the same values,
- * the value is simply the shared value (see T40372 -> F91346)
+ * the value is simply the shared value (see T40372 -> F91346).
*/
return v1[1];
}
- /* adjust handles so that they don't overlap (forming a loop) */
+ /* Adjust handles so that they don't overlap (forming a loop). */
BKE_fcurve_correct_bezpart(v1, v2, v3, v4);
- /* try to get a value for this position - if failure, try another set of points */
+ /* Try to get a value for this position - if failure, try another set of points. */
if (!findzero(evaltime, v1[0], v2[0], v3[0], v4[0], opl)) {
if (G.debug & G_DEBUG) {
printf(" ERROR: findzero() failed at %f with %f %f %f %f\n",
@@ -1772,10 +1770,10 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
return opl[0];
}
case BEZT_IPO_LIN:
- /* linear - simply linearly interpolate between values of the two keyframes */
+ /* Linear - simply linearly interpolate between values of the two keyframes. */
return BLI_easing_linear_ease(time, begin, change, duration);
- /* easing ............................................ */
+ /* Easing ............................................ */
case BEZT_IPO_BACK:
switch (prevbezt->easing) {
case BEZT_IPO_EASE_IN:
@@ -1785,7 +1783,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_back_ease_in_out(time, begin, change, duration, prevbezt->back);
- default: /* default/auto: same as ease out */
+ default: /* Default/Auto: same as ease out. */
return BLI_easing_back_ease_out(time, begin, change, duration, prevbezt->back);
}
break;
@@ -1799,7 +1797,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_bounce_ease_in_out(time, begin, change, duration);
- default: /* default/auto: same as ease out */
+ default: /* Default/Auto: same as ease out. */
return BLI_easing_bounce_ease_out(time, begin, change, duration);
}
break;
@@ -1813,7 +1811,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_circ_ease_in_out(time, begin, change, duration);
- default: /* default/auto: same as ease in */
+ default: /* Default/Auto: same as ease in. */
return BLI_easing_circ_ease_in(time, begin, change, duration);
}
break;
@@ -1827,7 +1825,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_cubic_ease_in_out(time, begin, change, duration);
- default: /* default/auto: same as ease in */
+ default: /* Default/Auto: same as ease in. */
return BLI_easing_cubic_ease_in(time, begin, change, duration);
}
break;
@@ -1841,7 +1839,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_elastic_ease_in_out(time, begin, change, duration, amplitude, period);
- default: /* default/auto: same as ease out */
+ default: /* Default/Auto: same as ease out. */
return BLI_easing_elastic_ease_out(time, begin, change, duration, amplitude, period);
}
break;
@@ -1855,7 +1853,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_expo_ease_in_out(time, begin, change, duration);
- default: /* default/auto: same as ease in */
+ default: /* Default/Auto: same as ease in. */
return BLI_easing_expo_ease_in(time, begin, change, duration);
}
break;
@@ -1869,7 +1867,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_quad_ease_in_out(time, begin, change, duration);
- default: /* default/auto: same as ease in */
+ default: /* Default/Auto: same as ease in. */
return BLI_easing_quad_ease_in(time, begin, change, duration);
}
break;
@@ -1883,7 +1881,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_quart_ease_in_out(time, begin, change, duration);
- default: /* default/auto: same as ease in */
+ default: /* Default/Auto: same as ease in. */
return BLI_easing_quart_ease_in(time, begin, change, duration);
}
break;
@@ -1897,7 +1895,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_quint_ease_in_out(time, begin, change, duration);
- default: /* default/auto: same as ease in */
+ default: /* Default/Auto: same as ease in. */
return BLI_easing_quint_ease_in(time, begin, change, duration);
}
break;
@@ -1911,7 +1909,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
case BEZT_IPO_EASE_IN_OUT:
return BLI_easing_sine_ease_in_out(time, begin, change, duration);
- default: /* default/auto: same as ease in */
+ default: /* Default/Auto: same as ease in. */
return BLI_easing_sine_ease_in(time, begin, change, duration);
}
break;
@@ -1923,7 +1921,7 @@ static float fcurve_eval_keyframes_interpolate(FCurve *fcu, BezTriple *bezts, fl
return 0.0f;
}
-/* Calculate F-Curve value for 'evaltime' using BezTriple keyframes */
+/* Calculate F-Curve value for 'evaltime' using BezTriple keyframes. */
static float fcurve_eval_keyframes(FCurve *fcu, BezTriple *bezts, float evaltime)
{
if (evaltime <= bezts->vec[1][0]) {
@@ -1938,32 +1936,32 @@ static float fcurve_eval_keyframes(FCurve *fcu, BezTriple *bezts, float evaltime
return fcurve_eval_keyframes_interpolate(fcu, bezts, evaltime);
}
-/* Calculate F-Curve value for 'evaltime' using FPoint samples */
+/* Calculate F-Curve value for 'evaltime' using FPoint samples. */
static float fcurve_eval_samples(FCurve *fcu, FPoint *fpts, float evaltime)
{
FPoint *prevfpt, *lastfpt, *fpt;
float cvalue = 0.0f;
- /* get pointers */
+ /* Get pointers. */
prevfpt = fpts;
lastfpt = prevfpt + fcu->totvert - 1;
- /* evaluation time at or past endpoints? */
+ /* Evaluation time at or past endpoints? */
if (prevfpt->vec[0] >= evaltime) {
- /* before or on first sample, so just extend value */
+ /* Before or on first sample, so just extend value. */
cvalue = prevfpt->vec[1];
}
else if (lastfpt->vec[0] <= evaltime) {
- /* after or on last sample, so just extend value */
+ /* After or on last sample, so just extend value. */
cvalue = lastfpt->vec[1];
}
else {
float t = fabsf(evaltime - floorf(evaltime));
- /* find the one on the right frame (assume that these are spaced on 1-frame intervals) */
+ /* Find the one on the right frame (assume that these are spaced on 1-frame intervals). */
fpt = prevfpt + ((int)evaltime - (int)prevfpt->vec[0]);
- /* if not exactly on the frame, perform linear interpolation with the next one */
+ /* If not exactly on the frame, perform linear interpolation with the next one. */
if ((t != 0.0f) && (t < 1.0f)) {
cvalue = interpf(fpt->vec[1], (fpt + 1)->vec[1], 1.0f - t);
}
@@ -1972,7 +1970,6 @@ static float fcurve_eval_samples(FCurve *fcu, FPoint *fpts, float evaltime)
}
}
- /* return value */
return cvalue;
}
@@ -1983,13 +1980,13 @@ static float fcurve_eval_samples(FCurve *fcu, FPoint *fpts, float evaltime)
* \{ */
/* Evaluate and return the value of the given F-Curve at the specified frame ("evaltime")
- * Note: this is also used for drivers
+ * Note: this is also used for drivers.
*/
static float evaluate_fcurve_ex(FCurve *fcu, float evaltime, float cvalue)
{
float devaltime;
- /* evaluate modifiers which modify time to evaluate the base curve at */
+ /* Evaluate modifiers which modify time to evaluate the base curve at. */
FModifiersStackStorage storage;
storage.modifier_count = BLI_listbase_count(&fcu->modifiers);
storage.size_per_modifier = evaluate_fmodifiers_storage_size_per_modifier(&fcu->modifiers);
@@ -1997,9 +1994,9 @@ static float evaluate_fcurve_ex(FCurve *fcu, float evaltime, float cvalue)
devaltime = evaluate_time_fmodifiers(&storage, &fcu->modifiers, fcu, cvalue, evaltime);
- /* evaluate curve-data
+ /* Evaluate curve-data
* - 'devaltime' instead of 'evaltime', as this is the time that the last time-modifying
- * F-Curve modifier on the stack requested the curve to be evaluated at
+ * F-Curve modifier on the stack requested the curve to be evaluated at.
*/
if (fcu->bezt) {
cvalue = fcurve_eval_keyframes(fcu, fcu->bezt, devaltime);
@@ -2008,17 +2005,16 @@ static float evaluate_fcurve_ex(FCurve *fcu, float evaltime, float cvalue)
cvalue = fcurve_eval_samples(fcu, fcu->fpt, devaltime);
}
- /* evaluate modifiers */
+ /* Evaluate modifiers. */
evaluate_value_fmodifiers(&storage, &fcu->modifiers, fcu, &cvalue, devaltime);
- /* if curve can only have integral values, perform truncation (i.e. drop the decimal part)
- * here so that the curve can be sampled correctly
+ /* If curve can only have integral values, perform truncation (i.e. drop the decimal part)
+ * here so that the curve can be sampled correctly.
*/
if (fcu->flag & FCURVE_INT_VALUES) {
cvalue = floorf(cvalue + 0.5f);
}
- /* return evaluated value */
return cvalue;
}
@@ -2050,19 +2046,19 @@ float evaluate_fcurve_driver(PathResolvedRNA *anim_rna,
* evaluate it to find value to use as "evaltime" since drivers essentially act as alternative
* input (i.e. in place of 'time') for F-Curves. */
if (fcu->driver) {
- /* evaltime now serves as input for the curve */
+ /* Evaltime now serves as input for the curve. */
evaltime = evaluate_driver(anim_rna, fcu->driver, driver_orig, anim_eval_context);
- /* only do a default 1-1 mapping if it's unlikely that anything else will set a value... */
+ /* Only do a default 1-1 mapping if it's unlikely that anything else will set a value... */
if (fcu->totvert == 0) {
FModifier *fcm;
bool do_linear = true;
- /* out-of-range F-Modifiers will block, as will those which just plain overwrite the values
+ /* Out-of-range F-Modifiers will block, as will those which just plain overwrite the values
* XXX: additive is a bit more dicey; it really depends then if things are in range or not...
*/
for (fcm = fcu->modifiers.first; fcm; fcm = fcm->next) {
- /* if there are range-restrictions, we must definitely block T36950. */
+ /* If there are range-restrictions, we must definitely block T36950. */
if ((fcm->flag & FMODIFIER_FLAG_RANGERESTRICT) == 0 ||
((fcm->sfra <= evaltime) && (fcm->efra >= evaltime))) {
/* Within range: here it probably doesn't matter,
@@ -2075,7 +2071,7 @@ float evaluate_fcurve_driver(PathResolvedRNA *anim_rna,
}
}
- /* only copy over results if none of the modifiers disagreed with this */
+ /* Only copy over results if none of the modifiers disagreed with this. */
if (do_linear) {
cvalue = evaltime;
}
@@ -2092,19 +2088,19 @@ bool BKE_fcurve_is_empty(FCurve *fcu)
!list_has_suitable_fmodifier(&fcu->modifiers, 0, FMI_TYPE_GENERATE_CURVE);
}
-/* Calculate the value of the given F-Curve at the given frame, and set its curval */
+/* Calculate the value of the given F-Curve at the given frame, and set its curval. */
float calculate_fcurve(PathResolvedRNA *anim_rna,
FCurve *fcu,
const AnimationEvalContext *anim_eval_context)
{
- /* only calculate + set curval (overriding the existing value) if curve has
+ /* Only calculate + set curval (overriding the existing value) if curve has
* any data which warrants this...
*/
if (BKE_fcurve_is_empty(fcu)) {
return 0.0f;
}
- /* calculate and set curval (evaluates driver too if necessary) */
+ /* Calculate and set curval (evaluates driver too if necessary). */
float curval;
if (fcu->driver) {
curval = evaluate_fcurve_driver(anim_rna, fcu, fcu->driver, anim_eval_context);
@@ -2112,7 +2108,7 @@ float calculate_fcurve(PathResolvedRNA *anim_rna,
else {
curval = evaluate_fcurve(fcu, anim_eval_context->eval_time);
}
- fcu->curval = curval; /* debug display only, not thread safe! */
+ fcu->curval = curval; /* Debug display only, not thread safe! */
return curval;
}
diff --git a/source/blender/editors/space_graph/graph_edit.c b/source/blender/editors/space_graph/graph_edit.c
index c9b26674351..b25a275a0ab 100644
--- a/source/blender/editors/space_graph/graph_edit.c
+++ b/source/blender/editors/space_graph/graph_edit.c
@@ -75,8 +75,8 @@
/* *************************** Calculate Range ************************** */
-/* Get the min/max keyframes*/
-/* note: it should return total boundbox, filter for selection only can be argument... */
+/* Get the min/max keyframes. */
+/* Note: it should return total boundbox, filter for selection only can be argument... */
void get_graph_keyframe_extents(bAnimContext *ac,
float *xmin,
float *xmax,
@@ -92,7 +92,7 @@ void get_graph_keyframe_extents(bAnimContext *ac,
bAnimListElem *ale;
int filter;
- /* get data to filter, from Dopesheet */
+ /* Get data to filter, from Dopesheet. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_NODUPLIS);
if (sipo->flag & SIPO_SELCUVERTSONLY) {
filter |= ANIMFILTER_SEL;
@@ -100,7 +100,7 @@ void get_graph_keyframe_extents(bAnimContext *ac,
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* set large values initial values that will be easy to override */
+ /* Set large values initial values that will be easy to override. */
if (xmin) {
*xmin = 999999999.0f;
}
@@ -114,36 +114,37 @@ void get_graph_keyframe_extents(bAnimContext *ac,
*ymax = -999999999.0f;
}
- /* check if any channels to set range with */
+ /* Check if any channels to set range with. */
if (anim_data.first) {
bool foundBounds = false;
- /* go through channels, finding max extents */
+ /* Go through channels, finding max extents. */
for (ale = anim_data.first; ale; ale = ale->next) {
AnimData *adt = ANIM_nla_mapping_get(ac, ale);
FCurve *fcu = (FCurve *)ale->key_data;
float txmin, txmax, tymin, tymax;
float unitFac, offset;
- /* get range */
+ /* Get range. */
if (BKE_fcurve_calc_bounds(
fcu, &txmin, &txmax, &tymin, &tymax, do_sel_only, include_handles)) {
short mapping_flag = ANIM_get_normalization_flags(ac);
- /* apply NLA scaling */
+ /* Apply NLA scaling. */
if (adt) {
txmin = BKE_nla_tweakedit_remap(adt, txmin, NLATIME_CONVERT_MAP);
txmax = BKE_nla_tweakedit_remap(adt, txmax, NLATIME_CONVERT_MAP);
}
- /* apply unit corrections */
+ /* Apply unit corrections. */
unitFac = ANIM_unit_mapping_get_factor(ac->scene, ale->id, fcu, mapping_flag, &offset);
tymin += offset;
tymax += offset;
tymin *= unitFac;
tymax *= unitFac;
- /* try to set cur using these values, if they're more extreme than previously set values */
+ /* Try to set cur using these values, if they're more extreme than previously set values.
+ */
if ((xmin) && (txmin < *xmin)) {
*xmin = txmin;
}
@@ -161,7 +162,7 @@ void get_graph_keyframe_extents(bAnimContext *ac,
}
}
- /* ensure that the extents are not too extreme that view implodes...*/
+ /* Ensure that the extents are not too extreme that view implodes...*/
if (foundBounds) {
if ((xmin && xmax) && (fabsf(*xmax - *xmin) < 0.001f)) {
*xmin -= 0.0005f;
@@ -187,11 +188,11 @@ void get_graph_keyframe_extents(bAnimContext *ac,
}
}
- /* free memory */
+ /* Free memory. */
ANIM_animdata_freelist(&anim_data);
}
else {
- /* set default range */
+ /* Set default range. */
if (ac->scene) {
if (xmin) {
*xmin = (float)PSFRA;
@@ -226,7 +227,7 @@ static int graphkeys_previewrange_exec(bContext *C, wmOperator *UNUSED(op))
Scene *scene;
float min, max;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
@@ -236,14 +237,14 @@ static int graphkeys_previewrange_exec(bContext *C, wmOperator *UNUSED(op))
scene = ac.scene;
- /* set the range directly */
+ /* Set the range directly. */
get_graph_keyframe_extents(&ac, &min, &max, NULL, NULL, false, false);
scene->r.flag |= SCER_PRV_RANGE;
scene->r.psfra = round_fl_to_int(min);
scene->r.pefra = round_fl_to_int(max);
- /* set notifier that things have changed */
- /* XXX err... there's nothing for frame ranges yet, but this should do fine too */
+ /* Set notifier that things have changed. */
+ // XXX Err... there's nothing for frame ranges yet, but this should do fine too.
WM_event_add_notifier(C, NC_SCENE | ND_FRAME, ac.scene);
return OPERATOR_FINISHED;
@@ -251,17 +252,17 @@ static int graphkeys_previewrange_exec(bContext *C, wmOperator *UNUSED(op))
void GRAPH_OT_previewrange_set(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Auto-Set Preview Range";
ot->idname = "GRAPH_OT_previewrange_set";
ot->description = "Automatically set Preview Range based on range of keyframes";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_previewrange_exec;
/* XXX: unchecked poll to get fsamples working too, but makes modifier damage trickier. */
ot->poll = ED_operator_graphedit_active;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}
@@ -275,12 +276,12 @@ static int graphkeys_viewall(bContext *C,
bAnimContext ac;
rctf cur_new;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* set the horizontal range, with an extra offset so that the extreme keys will be in view */
+ /* Set the horizontal range, with an extra offset so that the extreme keys will be in view. */
get_graph_keyframe_extents(&ac,
&cur_new.xmin,
&cur_new.xmax,
@@ -310,7 +311,7 @@ static int graphkeys_viewall_exec(bContext *C, wmOperator *op)
const bool include_handles = RNA_boolean_get(op->ptr, "include_handles");
const int smooth_viewtx = WM_operator_smooth_viewtx_get(op);
- /* whole range */
+ /* Whole range */
return graphkeys_viewall(C, false, include_handles, smooth_viewtx);
}
@@ -319,7 +320,7 @@ static int graphkeys_view_selected_exec(bContext *C, wmOperator *op)
const bool include_handles = RNA_boolean_get(op->ptr, "include_handles");
const int smooth_viewtx = WM_operator_smooth_viewtx_get(op);
- /* only selected */
+ /* Only selected. */
return graphkeys_viewall(C, true, include_handles, smooth_viewtx);
}
@@ -327,20 +328,20 @@ static int graphkeys_view_selected_exec(bContext *C, wmOperator *op)
void GRAPH_OT_view_all(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Frame All";
ot->idname = "GRAPH_OT_view_all";
ot->description = "Reset viewable area to show full keyframe range";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_viewall_exec;
- /* XXX: unchecked poll to get fsamples working too, but makes modifier damage trickier... */
+ /* XXX: Unchecked poll to get fsamples working too, but makes modifier damage trickier... */
ot->poll = ED_operator_graphedit_active;
- /* flags */
+ /* Flags */
ot->flag = 0;
- /* props */
+ /* Props */
ot->prop = RNA_def_boolean(ot->srna,
"include_handles",
true,
@@ -350,20 +351,20 @@ void GRAPH_OT_view_all(wmOperatorType *ot)
void GRAPH_OT_view_selected(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Frame Selected";
ot->idname = "GRAPH_OT_view_selected";
ot->description = "Reset viewable area to show selected keyframe range";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_view_selected_exec;
- /* XXX: unchecked poll to get fsamples working too, but makes modifier damage trickier... */
+ /* XXX: Unchecked poll to get fsamples working too, but makes modifier damage trickier... */
ot->poll = ED_operator_graphedit_active;
- /* flags */
+ /* Flags */
ot->flag = 0;
- /* props */
+ /* Props */
ot->prop = RNA_def_boolean(ot->srna,
"include_handles",
true,
@@ -382,25 +383,25 @@ static int graphkeys_view_frame_exec(bContext *C, wmOperator *op)
void GRAPH_OT_view_frame(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Go to Current Frame";
ot->idname = "GRAPH_OT_view_frame";
ot->description = "Move the view to the current frame";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_view_frame_exec;
ot->poll = ED_operator_graphedit_active;
- /* flags */
+ /* Flags */
ot->flag = 0;
}
/* ******************** Create Ghost-Curves Operator *********************** */
/* This operator samples the data of the selected F-Curves to F-Points, storing them
- * as 'ghost curves' in the active Graph Editor
+ * as 'ghost curves' in the active Graph Editor.
*/
-/* Bake each F-Curve into a set of samples, and store as a ghost curve */
+/* Bake each F-Curve into a set of samples, and store as a ghost curve. */
static void create_ghost_curves(bAnimContext *ac, int start, int end)
{
SpaceGraph *sipo = (SpaceGraph *)ac->sl;
@@ -408,21 +409,21 @@ static void create_ghost_curves(bAnimContext *ac, int start, int end)
bAnimListElem *ale;
int filter;
- /* free existing ghost curves */
+ /* Free existing ghost curves. */
BKE_fcurves_free(&sipo->runtime.ghost_curves);
- /* sanity check */
+ /* Sanity check. */
if (start >= end) {
printf("Error: Frame range for Ghost F-Curve creation is inappropriate\n");
return;
}
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_SEL |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* loop through filtered data and add keys between selected keyframes on every frame */
+ /* Loop through filtered data and add keys between selected keyframes on every frame . */
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->key_data;
FCurve *gcu = BKE_fcurve_create();
@@ -433,19 +434,19 @@ static void create_ghost_curves(bAnimContext *ac, int start, int end)
int cfra;
short mapping_flag = ANIM_get_normalization_flags(ac);
- /* disable driver so that it don't muck up the sampling process */
+ /* Disable driver so that it don't muck up the sampling process. */
fcu->driver = NULL;
- /* calculate unit-mapping factor */
+ /* Calculate unit-mapping factor. */
unitFac = ANIM_unit_mapping_get_factor(ac->scene, ale->id, fcu, mapping_flag, &offset);
- /* create samples, but store them in a new curve
- * - we cannot use fcurve_store_samples() as that will only overwrite the original curve
+ /* Create samples, but store them in a new curve
+ * - we cannot use fcurve_store_samples() as that will only overwrite the original curve.
*/
gcu->fpt = fpt = MEM_callocN(sizeof(FPoint) * (end - start + 1), "Ghost FPoint Samples");
gcu->totvert = end - start + 1;
- /* use the sampling callback at 1-frame intervals from start to end frames */
+ /* Use the sampling callback at 1-frame intervals from start to end frames. */
for (cfra = start; cfra <= end; cfra++, fpt++) {
float cfrae = BKE_nla_tweakedit_remap(adt, cfra, NLATIME_CONVERT_UNMAP);
@@ -453,21 +454,21 @@ static void create_ghost_curves(bAnimContext *ac, int start, int end)
fpt->vec[1] = (fcurve_samplingcb_evalcurve(fcu, NULL, cfrae) + offset) * unitFac;
}
- /* set color of ghost curve
- * - make the color slightly darker
+ /* Set color of ghost curve
+ * - make the color slightly darker.
*/
gcu->color[0] = fcu->color[0] - 0.07f;
gcu->color[1] = fcu->color[1] - 0.07f;
gcu->color[2] = fcu->color[2] - 0.07f;
- /* store new ghost curve */
+ /* Store new ghost curve. */
BLI_addtail(&sipo->runtime.ghost_curves, gcu);
- /* restore driver */
+ /* Restore driver. */
fcu->driver = driver;
}
- /* admin and redraws */
+ /* Admin and redraws. */
ANIM_animdata_freelist(&anim_data);
}
@@ -479,7 +480,7 @@ static int graphkeys_create_ghostcurves_exec(bContext *C, wmOperator *UNUSED(op)
View2D *v2d;
int start, end;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
@@ -490,10 +491,10 @@ static int graphkeys_create_ghostcurves_exec(bContext *C, wmOperator *UNUSED(op)
start = (int)v2d->cur.xmin;
end = (int)v2d->cur.xmax;
- /* bake selected curves into a ghost curve */
+ /* Bake selected curves into a ghost curve. */
create_ghost_curves(&ac, start, end);
- /* update this editor only */
+ /* Update this editor only. */
ED_area_tag_redraw(CTX_wm_area(C));
return OPERATOR_FINISHED;
@@ -501,17 +502,17 @@ static int graphkeys_create_ghostcurves_exec(bContext *C, wmOperator *UNUSED(op)
void GRAPH_OT_ghost_curves_create(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Create Ghost Curves";
ot->idname = "GRAPH_OT_ghost_curves_create";
ot->description =
"Create snapshot (Ghosts) of selected F-Curves as background aid for active Graph Editor";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_create_ghostcurves_exec;
ot->poll = graphop_visible_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
/* TODO: add props for start/end frames */
@@ -525,20 +526,20 @@ static int graphkeys_clear_ghostcurves_exec(bContext *C, wmOperator *UNUSED(op))
bAnimContext ac;
SpaceGraph *sipo;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
sipo = (SpaceGraph *)ac.sl;
- /* if no ghost curves, don't do anything */
+ /* If no ghost curves, don't do anything. */
if (BLI_listbase_is_empty(&sipo->runtime.ghost_curves)) {
return OPERATOR_CANCELLED;
}
- /* free ghost curves */
+ /* Free ghost curves. */
BKE_fcurves_free(&sipo->runtime.ghost_curves);
- /* update this editor only */
+ /* Update this editor only. */
ED_area_tag_redraw(CTX_wm_area(C));
return OPERATOR_FINISHED;
@@ -546,16 +547,16 @@ static int graphkeys_clear_ghostcurves_exec(bContext *C, wmOperator *UNUSED(op))
void GRAPH_OT_ghost_curves_clear(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Clear Ghost Curves";
ot->idname = "GRAPH_OT_ghost_curves_clear";
ot->description = "Clear F-Curve snapshots (Ghosts) for active Graph Editor";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_clear_ghostcurves_exec;
ot->poll = ED_operator_graphedit_active;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}
@@ -564,7 +565,7 @@ void GRAPH_OT_ghost_curves_clear(wmOperatorType *ot)
/* ******************** Insert Keyframes Operator ************************* */
-/* Mode defines for insert keyframes tool */
+/* Mode defines for insert keyframes tool. */
typedef enum eGraphKeys_InsertKey_Types {
GRAPHKEYS_INSERTKEY_ALL = (1 << 0),
GRAPHKEYS_INSERTKEY_SEL = (1 << 1),
@@ -572,7 +573,7 @@ typedef enum eGraphKeys_InsertKey_Types {
GRAPHKEYS_INSERTKEY_ACTIVE = (1 << 3),
} eGraphKeys_InsertKey_Types;
-/* RNA mode types for insert keyframes tool */
+/* RNA mode types for insert keyframes tool. */
static const EnumPropertyItem prop_graphkeys_insertkey_types[] = {
{GRAPHKEYS_INSERTKEY_ALL,
"ALL",
@@ -597,7 +598,7 @@ static const EnumPropertyItem prop_graphkeys_insertkey_types[] = {
{0, NULL, 0, NULL, NULL},
};
-/* this function is responsible for snapping keyframes to frame-times */
+/* This function is responsible for snapping keyframes to frame-times. */
static void insert_graph_keys(bAnimContext *ac, eGraphKeys_InsertKey_Types mode)
{
ListBase anim_data = {NULL, NULL};
@@ -612,7 +613,7 @@ static void insert_graph_keys(bAnimContext *ac, eGraphKeys_InsertKey_Types mode)
ToolSettings *ts = scene->toolsettings;
eInsertKeyFlags flag = 0;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
if (mode & GRAPHKEYS_INSERTKEY_SEL) {
@@ -642,7 +643,7 @@ static void insert_graph_keys(bAnimContext *ac, eGraphKeys_InsertKey_Types mode)
/* Init key-framing flag. */
flag = ANIM_get_keyframing_flags(scene, true);
- /* insert keyframes */
+ /* Insert keyframes. */
if (mode & GRAPHKEYS_INSERTKEY_CURSOR) {
for (ale = anim_data.first; ale; ale = ale->next) {
AnimData *adt = ANIM_nla_mapping_get(ac, ale);
@@ -666,7 +667,7 @@ static void insert_graph_keys(bAnimContext *ac, eGraphKeys_InsertKey_Types mode)
x = (float)CFRA;
}
- /* normalise units of cursor's value */
+ /* Normalise units of cursor's value. */
if (sipo) {
y = (sipo->cursorVal / unit_scale) - offset;
}
@@ -674,7 +675,7 @@ static void insert_graph_keys(bAnimContext *ac, eGraphKeys_InsertKey_Types mode)
y = 0.0f;
}
- /* insert keyframe directly into the F-Curve */
+ /* Insert keyframe directly into the F-Curve. */
insert_vert_fcurve(fcu, x, y, ts->keyframe_type, 0);
ale->update |= ANIM_UPDATE_DEFAULT;
@@ -693,7 +694,7 @@ static void insert_graph_keys(bAnimContext *ac, eGraphKeys_InsertKey_Types mode)
* - ale->owner != NULL:
* If this is set, then the path may not be resolvable from the ID alone,
* so it's easier for now to just read the F-Curve directly.
- * (TODO: add the full-blown PointerRNA relative parsing case here...)
+ * (TODO: add the full-blown PointerRNA relative parsing case here... (Joshua Leung 2015))
* - fcu->driver != NULL:
* If this is set, then it's a driver. If we don't check for this, we'd end
* up adding the keyframes on a new F-Curve in the action data instead.
@@ -714,7 +715,7 @@ static void insert_graph_keys(bAnimContext *ac, eGraphKeys_InsertKey_Types mode)
else {
AnimData *adt = ANIM_nla_mapping_get(ac, ale);
- /* adjust current frame for NLA-mapping */
+ /* Adjust current frame for NLA-mapping. */
float cfra = (float)CFRA;
if ((sipo) && (sipo->mode == SIPO_MODE_DRIVERS)) {
cfra = sipo->cursorTime;
@@ -744,18 +745,18 @@ static int graphkeys_insertkey_exec(bContext *C, wmOperator *op)
bAnimContext ac;
eGraphKeys_InsertKey_Types mode;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* which channels to affect? */
+ /* Which channels to affect?. */
mode = RNA_enum_get(op->ptr, "type");
- /* insert keyframes */
+ /* Insert keyframes. */
insert_graph_keys(&ac, mode);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_ADDED, NULL);
return OPERATOR_FINISHED;
@@ -763,20 +764,20 @@ static int graphkeys_insertkey_exec(bContext *C, wmOperator *op)
void GRAPH_OT_keyframe_insert(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Insert Keyframes";
ot->idname = "GRAPH_OT_keyframe_insert";
ot->description = "Insert keyframes for the specified channels";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_menu_invoke;
ot->exec = graphkeys_insertkey_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* id-props */
+ /* Id-props */
ot->prop = RNA_def_enum(ot->srna, "type", prop_graphkeys_insertkey_types, 0, "Type", "");
}
@@ -790,12 +791,12 @@ static int graphkeys_click_insert_exec(bContext *C, wmOperator *op)
FCurve *fcu;
float frame, val;
- /* get animation context */
+ /* Get animation context. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* get active F-Curve 'anim-list-element' */
+ /* Get active F-Curve 'anim-list-element'. */
ale = get_active_fcurve_channel(&ac);
if (ELEM(NULL, ale, ale->data)) {
if (ale) {
@@ -805,7 +806,7 @@ static int graphkeys_click_insert_exec(bContext *C, wmOperator *op)
}
fcu = ale->data;
- /* when there are F-Modifiers on the curve, only allow adding
+ /* When there are F-Modifiers on the curve, only allow adding
* keyframes if these will be visible after doing so...
*/
if (BKE_fcurve_is_keyframable(fcu)) {
@@ -815,7 +816,7 @@ static int graphkeys_click_insert_exec(bContext *C, wmOperator *op)
short mapping_flag = ANIM_get_normalization_flags(&ac);
float scale, offset;
- /* preserve selection? */
+ /* Preserve selection? */
if (RNA_boolean_get(op->ptr, "extend") == false) {
/* Deselect all keyframes first,
* so that we can immediately start manipulating the newly added one(s)
@@ -823,21 +824,21 @@ static int graphkeys_click_insert_exec(bContext *C, wmOperator *op)
deselect_graph_keys(&ac, false, SELECT_SUBTRACT, false);
}
- /* get frame and value from props */
+ /* Get frame and value from props. */
frame = RNA_float_get(op->ptr, "frame");
val = RNA_float_get(op->ptr, "value");
- /* apply inverse NLA-mapping to frame to get correct time in un-scaled action */
+ /* Apply inverse NLA-mapping to frame to get correct time in un-scaled action. */
adt = ANIM_nla_mapping_get(&ac, ale);
frame = BKE_nla_tweakedit_remap(adt, frame, NLATIME_CONVERT_UNMAP);
- /* apply inverse unit-mapping to value to get correct value for F-Curves */
+ /* Apply inverse unit-mapping to value to get correct value for F-Curves. */
scale = ANIM_unit_mapping_get_factor(
ac.scene, ale->id, fcu, mapping_flag | ANIM_UNITCONV_RESTORE, &offset);
val = val * scale - offset;
- /* insert keyframe on the specified frame + value */
+ /* Insert keyframe on the specified frame + value. */
insert_vert_fcurve(fcu, frame, val, ts->keyframe_type, 0);
ale->update |= ANIM_UPDATE_DEPS;
@@ -848,7 +849,7 @@ static int graphkeys_click_insert_exec(bContext *C, wmOperator *op)
ANIM_animdata_update(&ac, &anim_data);
}
else {
- /* warn about why this can't happen */
+ /* Warn about why this can't happen. */
if (fcu->fpt) {
BKE_report(op->reports, RPT_ERROR, "Keyframes cannot be added to sampled F-Curves");
}
@@ -860,13 +861,13 @@ static int graphkeys_click_insert_exec(bContext *C, wmOperator *op)
}
}
- /* free temp data */
+ /* Free temp data. */
MEM_freeN(ale);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
- /* done */
+ /* Done */
return OPERATOR_FINISHED;
}
@@ -878,12 +879,12 @@ static int graphkeys_click_insert_invoke(bContext *C, wmOperator *op, const wmEv
int mval[2];
float x, y;
- /* get animation context */
+ /* Get animation context. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* store mouse coordinates in View2D space, into the operator's properties */
+ /* Store mouse coordinates in View2D space, into the operator's properties. */
region = ac.region;
v2d = &region->v2d;
@@ -895,26 +896,26 @@ static int graphkeys_click_insert_invoke(bContext *C, wmOperator *op, const wmEv
RNA_float_set(op->ptr, "frame", x);
RNA_float_set(op->ptr, "value", y);
- /* run exec now */
+ /* Run exec now. */
return graphkeys_click_insert_exec(C, op);
}
void GRAPH_OT_click_insert(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Click-Insert Keyframes";
ot->idname = "GRAPH_OT_click_insert";
ot->description = "Insert new keyframe at the cursor position for the active F-Curve";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = graphkeys_click_insert_invoke;
ot->exec = graphkeys_click_insert_exec;
ot->poll = graphop_active_fcurve_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* properties */
+ /* Properties */
RNA_def_float(ot->srna,
"frame",
1.0f,
@@ -942,12 +943,12 @@ static short copy_graph_keys(bAnimContext *ac)
ListBase anim_data = {NULL, NULL};
int filter, ok = 0;
- /* clear buffer first */
+ /* Clear buffer first. */
ANIM_fcurves_copybuf_free();
- /* filter data
+ /* Filter data
* - First time we try to filter more strictly, allowing only selected channels
- * to allow copying animation between channels
+ * to allow copying animation between channels.
*/
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_NODUPLIS);
@@ -955,10 +956,10 @@ static short copy_graph_keys(bAnimContext *ac)
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
}
- /* copy keyframes */
+ /* Copy keyframes. */
ok = copy_animedit_keys(ac, &anim_data);
- /* clean up */
+ /* Clean up. */
ANIM_animdata_freelist(&anim_data);
return ok;
@@ -972,7 +973,7 @@ static short paste_graph_keys(bAnimContext *ac,
ListBase anim_data = {NULL, NULL};
int filter, ok = 0;
- /* filter data
+ /* Filter data
* - First time we try to filter more strictly, allowing only selected channels
* to allow copying animation between channels
* - Second time, we loosen things up if nothing was found the first time, allowing
@@ -985,10 +986,10 @@ static short paste_graph_keys(bAnimContext *ac,
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
}
- /* paste keyframes */
+ /* Paste keyframes. */
ok = paste_animedit_keys(ac, &anim_data, offset_mode, merge_mode, flip);
- /* clean up */
+ /* Clean up. */
ANIM_animdata_freelist(&anim_data);
return ok;
@@ -1000,33 +1001,33 @@ static int graphkeys_copy_exec(bContext *C, wmOperator *op)
{
bAnimContext ac;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* copy keyframes */
+ /* Copy keyframes. */
if (copy_graph_keys(&ac)) {
BKE_report(op->reports, RPT_ERROR, "No keyframes copied to keyframes copy/paste buffer");
return OPERATOR_CANCELLED;
}
- /* just return - no operator needed here (no changes) */
+ /* Just return - no operator needed here (no changes). */
return OPERATOR_FINISHED;
}
void GRAPH_OT_copy(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Copy Keyframes";
ot->idname = "GRAPH_OT_copy";
ot->description = "Copy selected keyframes to the copy/paste buffer";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_copy_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}
@@ -1038,20 +1039,20 @@ static int graphkeys_paste_exec(bContext *C, wmOperator *op)
const eKeyMergeMode merge_mode = RNA_enum_get(op->ptr, "merge");
const bool flipped = RNA_boolean_get(op->ptr, "flipped");
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* ac.reports by default will be the global reports list, which won't show warnings */
+ /* Ac.reports by default will be the global reports list, which won't show warnings. */
ac.reports = op->reports;
- /* paste keyframes - non-zero return means an error occurred while trying to paste */
+ /* Paste keyframes - non-zero return means an error occurred while trying to paste. */
if (paste_graph_keys(&ac, offset_mode, merge_mode, flipped)) {
return OPERATOR_CANCELLED;
}
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -1061,23 +1062,23 @@ void GRAPH_OT_paste(wmOperatorType *ot)
{
PropertyRNA *prop;
- /* identifiers */
+ /* Identifiers */
ot->name = "Paste Keyframes";
ot->idname = "GRAPH_OT_paste";
ot->description =
"Paste keyframes from copy/paste buffer for the selected channels, starting on the current "
"frame";
- /* api callbacks */
+ /* API callbacks */
// ot->invoke = WM_operator_props_popup; /* better wait for graph redo panel */
ot->exec = graphkeys_paste_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* props */
+ /* Props */
RNA_def_enum(ot->srna,
"offset",
rna_enum_keyframe_paste_offset_items,
@@ -1103,12 +1104,12 @@ static void duplicate_graph_keys(bAnimContext *ac)
bAnimListElem *ale;
int filter;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* loop through filtered data and delete selected keys */
+ /* Loop through filtered data and delete selected keys. */
for (ale = anim_data.first; ale; ale = ale->next) {
duplicate_fcurve_keys((FCurve *)ale->key_data);
@@ -1125,15 +1126,15 @@ static int graphkeys_duplicate_exec(bContext *C, wmOperator *UNUSED(op))
{
bAnimContext ac;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* duplicate keyframes */
+ /* Duplicate keyframes. */
duplicate_graph_keys(&ac);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_ADDED, NULL);
return OPERATOR_FINISHED;
@@ -1141,19 +1142,19 @@ static int graphkeys_duplicate_exec(bContext *C, wmOperator *UNUSED(op))
void GRAPH_OT_duplicate(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Duplicate Keyframes";
ot->idname = "GRAPH_OT_duplicate";
ot->description = "Make a copy of all selected keyframes";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_duplicate_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* to give to transform */
+ /* To give to transform. */
RNA_def_enum(ot->srna, "mode", rna_enum_transform_mode_types, TFM_TRANSLATION, "Mode", "");
}
@@ -1166,18 +1167,18 @@ static bool delete_graph_keys(bAnimContext *ac)
int filter;
bool changed_final = false;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* loop through filtered data and delete selected keys */
+ /* Loop through filtered data and delete selected keys. */
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->key_data;
AnimData *adt = ale->adt;
bool changed;
- /* delete selected keyframes only */
+ /* Delete selected keyframes only. */
changed = delete_fcurve_keys(fcu);
if (changed) {
@@ -1185,7 +1186,7 @@ static bool delete_graph_keys(bAnimContext *ac)
changed_final = true;
}
- /* Only delete curve too if it won't be doing anything anymore */
+ /* Only delete curve too if it won't be doing anything anymore. */
if (BKE_fcurve_is_empty(fcu)) {
ANIM_fcurve_delete_from_animdata(ac, adt, fcu);
ale->key_data = NULL;
@@ -1204,17 +1205,17 @@ static int graphkeys_delete_exec(bContext *C, wmOperator *UNUSED(op))
{
bAnimContext ac;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* delete keyframes */
+ /* Delete keyframes. */
if (!delete_graph_keys(&ac)) {
return OPERATOR_CANCELLED;
}
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_REMOVED, NULL);
return OPERATOR_FINISHED;
@@ -1222,17 +1223,17 @@ static int graphkeys_delete_exec(bContext *C, wmOperator *UNUSED(op))
void GRAPH_OT_delete(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Delete Keyframes";
ot->idname = "GRAPH_OT_delete";
ot->description = "Remove all selected keyframes";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_operator_confirm;
ot->exec = graphkeys_delete_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}
@@ -1244,12 +1245,12 @@ static void clean_graph_keys(bAnimContext *ac, float thresh, bool clean_chan)
bAnimListElem *ale;
int filter;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_SEL | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* loop through filtered data and clean curves */
+ /* Loop through filtered data and clean curves. */
for (ale = anim_data.first; ale; ale = ale->next) {
clean_fcurve(ac, ale, thresh, clean_chan);
@@ -1268,18 +1269,18 @@ static int graphkeys_clean_exec(bContext *C, wmOperator *op)
float thresh;
bool clean_chan;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* get cleaning threshold */
+ /* Get cleaning threshold. */
thresh = RNA_float_get(op->ptr, "threshold");
clean_chan = RNA_boolean_get(op->ptr, "channels");
- /* clean keyframes */
+ /* Clean keyframes. */
clean_graph_keys(&ac, thresh, clean_chan);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -1287,20 +1288,20 @@ static int graphkeys_clean_exec(bContext *C, wmOperator *op)
void GRAPH_OT_clean(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Clean Keyframes";
ot->idname = "GRAPH_OT_clean";
ot->description = "Simplify F-Curves by removing closely spaced keyframes";
- /* api callbacks */
+ /* API callbacks */
// ot->invoke = ???; /* XXX we need that number popup for this! */
ot->exec = graphkeys_clean_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* properties */
+ /* Properties */
ot->prop = RNA_def_float(
ot->srna, "threshold", 0.001f, 0.0f, FLT_MAX, "Threshold", "", 0.0f, 1000.0f);
RNA_def_boolean(ot->srna, "channels", false, "Channels", "");
@@ -1314,12 +1315,12 @@ static void decimate_graph_keys(bAnimContext *ac, float remove_ratio, float erro
bAnimListElem *ale;
int filter;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_SEL | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* loop through filtered data and clean curves */
+ /* Loop through filtered data and clean curves. */
for (ale = anim_data.first; ale; ale = ale->next) {
if (!decimate_fcurve(ale, remove_ratio, error_sq_max)) {
/* The selection contains unsupported keyframe types! */
@@ -1371,7 +1372,7 @@ static void decimate_reset_bezts(tDecimateGraphOp *dgo)
bAnimContext *ac = &dgo->ac;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_SEL | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
@@ -1381,7 +1382,7 @@ static void decimate_reset_bezts(tDecimateGraphOp *dgo)
FCurve *fcu = (FCurve *)ale->key_data;
if (fcu->bezt == NULL) {
- /* This curve is baked, skip it */
+ /* This curve is baked, skip it. */
continue;
}
@@ -1428,7 +1429,7 @@ static void decimate_exit(bContext *C, wmOperator *op)
WM_cursor_modal_restore(win);
ED_area_status_text(area, NULL);
- /* cleanup */
+ /* Cleanup. */
op->customdata = NULL;
}
@@ -1502,7 +1503,7 @@ static int graphkeys_decimate_invoke(bContext *C, wmOperator *op, const wmEvent
int filter;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_SEL | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
@@ -1512,7 +1513,7 @@ static int graphkeys_decimate_invoke(bContext *C, wmOperator *op, const wmEvent
FCurve *fcu = (FCurve *)ale->key_data;
if (fcu->bezt == NULL) {
- /* This curve is baked, skip it */
+ /* This curve is baked, skip it. */
continue;
}
@@ -1559,7 +1560,7 @@ static void graphkeys_decimate_modal_update(bContext *C, wmOperator *op)
/* Reset keyframe data (so we get back to the original state). */
decimate_reset_bezts(dgo);
- /* apply... */
+ /* Apply... */
float remove_ratio = RNA_property_float_get(op->ptr, dgo->percentage_prop);
/* We don't want to limit the decimation to a certain error margin. */
const float error_sq_max = FLT_MAX;
@@ -1578,7 +1579,7 @@ static int graphkeys_decimate_modal(bContext *C, wmOperator *op, const wmEvent *
const bool has_numinput = hasNumInput(&dgo->num);
switch (event->type) {
- case LEFTMOUSE: /* confirm */
+ case LEFTMOUSE: /* Confirm */
case EVT_RETKEY:
case EVT_PADENTER: {
if (event->val == KM_PRESS) {
@@ -1589,7 +1590,7 @@ static int graphkeys_decimate_modal(bContext *C, wmOperator *op, const wmEvent *
break;
}
- case EVT_ESCKEY: /* cancel */
+ case EVT_ESCKEY: /* Cancel */
case RIGHTMOUSE: {
if (event->val == KM_PRESS) {
decimate_reset_bezts(dgo);
@@ -1604,7 +1605,7 @@ static int graphkeys_decimate_modal(bContext *C, wmOperator *op, const wmEvent *
}
/* Percentage Change... */
- case MOUSEMOVE: /* calculate new position */
+ case MOUSEMOVE: /* Calculate new position. */
{
if (has_numinput == false) {
/* Update percentage based on position of mouse. */
@@ -1634,8 +1635,8 @@ static int graphkeys_decimate_modal(bContext *C, wmOperator *op, const wmEvent *
break;
}
- /* unhandled event - maybe it was some view manip? */
- /* allow to pass through */
+ /* Unhandled event - maybe it was some view manip? */
+ /* Allow to pass through. */
return OPERATOR_RUNNING_MODAL | OPERATOR_PASS_THROUGH;
}
}
@@ -1647,7 +1648,7 @@ static int graphkeys_decimate_exec(bContext *C, wmOperator *op)
{
bAnimContext ac;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
@@ -1677,7 +1678,7 @@ static int graphkeys_decimate_exec(bContext *C, wmOperator *op)
decimate_graph_keys(&ac, remove_ratio, error_sq_max);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -1734,13 +1735,13 @@ static const EnumPropertyItem decimate_mode_items[] = {
void GRAPH_OT_decimate(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Decimate Keyframes";
ot->idname = "GRAPH_OT_decimate";
ot->description =
"Decimate F-Curves by removing keyframes that influence the curve shape the least";
- /* api callbacks */
+ /* API callbacks */
ot->poll_property = graphkeys_decimate_poll_property;
ot->get_description = graphkeys_decimate_desc;
ot->invoke = graphkeys_decimate_invoke;
@@ -1748,10 +1749,10 @@ void GRAPH_OT_decimate(wmOperatorType *ot)
ot->exec = graphkeys_decimate_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* properties */
+ /* Properties */
RNA_def_enum(ot->srna,
"mode",
decimate_mode_items,
@@ -1782,30 +1783,30 @@ void GRAPH_OT_decimate(wmOperatorType *ot)
/* ******************** Bake F-Curve Operator *********************** */
/* This operator bakes the data of the selected F-Curves to F-Points */
-/* Bake each F-Curve into a set of samples */
+/* Bake each F-Curve into a set of samples. */
static void bake_graph_curves(bAnimContext *ac, int start, int end)
{
ListBase anim_data = {NULL, NULL};
bAnimListElem *ale;
int filter;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_SEL |
ANIMFILTER_FOREDIT | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* loop through filtered data and add keys between selected keyframes on every frame */
+ /* Loop through filtered data and add keys between selected keyframes on every frame. */
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->key_data;
ChannelDriver *driver = fcu->driver;
- /* disable driver so that it don't muck up the sampling process */
+ /* Disable driver so that it don't muck up the sampling process. */
fcu->driver = NULL;
- /* create samples */
+ /* Create samples. */
fcurve_store_samples(fcu, NULL, start, end, fcurve_samplingcb_evalcurve);
- /* restore driver */
+ /* Restore driver. */
fcu->driver = driver;
ale->update |= ANIM_UPDATE_DEPS;
@@ -1823,21 +1824,21 @@ static int graphkeys_bake_exec(bContext *C, wmOperator *UNUSED(op))
Scene *scene = NULL;
int start, end;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* for now, init start/end from preview-range extents */
- /* TODO: add properties for this */
+ /* For now, init start/end from preview-range extents. */
+ /* TODO: add properties for this. (Joshua Leung 2009) */
scene = ac.scene;
start = PSFRA;
end = PEFRA;
- /* bake keyframes */
+ /* Bake keyframes. */
bake_graph_curves(&ac, start, end);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
/* NOTE: some distinction between order/number of keyframes and type should be made? */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
@@ -1846,20 +1847,20 @@ static int graphkeys_bake_exec(bContext *C, wmOperator *UNUSED(op))
void GRAPH_OT_bake(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Bake Curve";
ot->idname = "GRAPH_OT_bake";
ot->description = "Bake selected F-Curves to a set of sampled points defining a similar curve";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_operator_confirm; /* FIXME */
ot->exec = graphkeys_bake_exec;
ot->poll = graphop_selected_fcurve_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* TODO: add props for start/end frames */
+ /* TODO: add props for start/end frames (Joshua Leung 2009) */
}
#ifdef WITH_AUDASPACE
@@ -1870,7 +1871,7 @@ void GRAPH_OT_bake(wmOperatorType *ot)
/* ------------------- */
/* Custom data storage passed to the F-Sample-ing function,
- * which provides the necessary info for baking the sound
+ * which provides the necessary info for baking the sound.
*/
typedef struct tSoundBakeInfo {
float *samples;
@@ -1881,7 +1882,7 @@ typedef struct tSoundBakeInfo {
/* ------------------- */
/* Sampling callback used to determine the value from the sound to
- * save in the F-Curve at the specified frame
+ * save in the F-Curve at the specified frame.
*/
static float fcurve_samplingcb_sound(FCurve *UNUSED(fcu), void *data, float evaltime)
{
@@ -1910,7 +1911,7 @@ static int graphkeys_sound_bake_exec(bContext *C, wmOperator *op)
char path[FILE_MAX];
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
@@ -1922,9 +1923,9 @@ static int graphkeys_sound_bake_exec(bContext *C, wmOperator *op)
return OPERATOR_CANCELLED;
}
- scene = ac.scene; /* current scene */
+ scene = ac.scene; /* Current scene. */
- /* store necessary data for the baking steps */
+ /* Store necessary data for the baking steps. */
sbi.samples = AUD_readSoundBuffer(path,
RNA_float_get(op->ptr, "low"),
RNA_float_get(op->ptr, "high"),
@@ -1943,33 +1944,33 @@ static int graphkeys_sound_bake_exec(bContext *C, wmOperator *op)
return OPERATOR_CANCELLED;
}
- /* determine extents of the baking */
+ /* Determine extents of the baking. */
sbi.cfra = start = CFRA;
end = CFRA + sbi.length - 1;
- /* filter anim channels */
+ /* Filter anim channels. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_SEL |
ANIMFILTER_FOREDIT | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
- /* loop through all selected F-Curves, replacing its data with the sound samples */
+ /* Loop through all selected F-Curves, replacing its data with the sound samples. */
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->key_data;
- /* sample the sound */
+ /* Sample the sound. */
fcurve_store_samples(fcu, &sbi, start, end, fcurve_samplingcb_sound);
ale->update |= ANIM_UPDATE_DEFAULT;
}
- /* free sample data */
+ /* Free sample data. */
free(sbi.samples);
- /* validate keyframes after editing */
+ /* Validate keyframes after editing. */
ANIM_animdata_update(&ac, &anim_data);
ANIM_animdata_freelist(&anim_data);
- /* set notifier that 'keyframes' have changed */
+ /* Set notifier that 'keyframes' have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -1990,7 +1991,7 @@ static int graphkeys_sound_bake_invoke(bContext *C, wmOperator *op, const wmEven
{
bAnimContext ac;
- /* verify editor data */
+ /* Verify editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
@@ -2000,20 +2001,20 @@ static int graphkeys_sound_bake_invoke(bContext *C, wmOperator *op, const wmEven
void GRAPH_OT_sound_bake(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Bake Sound to F-Curves";
ot->idname = "GRAPH_OT_sound_bake";
ot->description = "Bakes a sound wave to selected F-Curves";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = graphkeys_sound_bake_invoke;
ot->exec = graphkeys_sound_bake_exec;
ot->poll = graphop_selected_fcurve_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* properties */
+ /* Properties */
WM_operator_properties_filesel(ot,
FILE_TYPE_FOLDER | FILE_TYPE_SOUND | FILE_TYPE_MOVIE,
FILE_SPECIAL,
@@ -2103,7 +2104,7 @@ void GRAPH_OT_sound_bake(wmOperatorType *ot)
* of selected keyframes. It is useful for creating keyframes for tweaking overlap.
*/
-/* Evaluates the curves between each selected keyframe on each frame, and keys the value */
+/* Evaluates the curves between each selected keyframe on each frame, and keys the value. */
static void sample_graph_keys(bAnimContext *ac)
{
ListBase anim_data = {NULL, NULL};
@@ -2115,7 +2116,7 @@ static void sample_graph_keys(bAnimContext *ac)
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* loop through filtered data and add keys between selected keyframes on every frame */
+ /* Loop through filtered data and add keys between selected keyframes on every frame. */
for (ale = anim_data.first; ale; ale = ale->next) {
sample_fcurve((FCurve *)ale->key_data);
@@ -2132,15 +2133,15 @@ static int graphkeys_sample_exec(bContext *C, wmOperator *UNUSED(op))
{
bAnimContext ac;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* sample keyframes */
+ /* Sample keyframes. */
sample_graph_keys(&ac);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -2148,16 +2149,16 @@ static int graphkeys_sample_exec(bContext *C, wmOperator *UNUSED(op))
void GRAPH_OT_sample(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Sample Keyframes";
ot->idname = "GRAPH_OT_sample";
ot->description = "Add keyframes on every frame between the selected keyframes";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_sample_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}
@@ -2166,11 +2167,11 @@ void GRAPH_OT_sample(wmOperatorType *ot)
/* ******************** Set Extrapolation-Type Operator *********************** */
-/* defines for make/clear cyclic extrapolation tools */
+/* Defines for make/clear cyclic extrapolation tools. */
#define MAKE_CYCLIC_EXPO -1
#define CLEAR_CYCLIC_EXPO -2
-/* defines for set extrapolation-type for selected keyframes tool */
+/* Defines for set extrapolation-type for selected keyframes tool. */
static const EnumPropertyItem prop_graphkeys_expo_types[] = {
{FCURVE_EXTRAPOLATE_CONSTANT,
"CONSTANT",
@@ -2196,41 +2197,42 @@ static const EnumPropertyItem prop_graphkeys_expo_types[] = {
{0, NULL, 0, NULL, NULL},
};
-/* this function is responsible for setting extrapolation mode for keyframes */
+/* This function is responsible for setting extrapolation mode for keyframes. */
static void setexpo_graph_keys(bAnimContext *ac, short mode)
{
ListBase anim_data = {NULL, NULL};
bAnimListElem *ale;
int filter;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_SEL |
ANIMFILTER_FOREDIT | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* loop through setting mode per F-Curve */
+ /* Loop through setting mode per F-Curve. */
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->data;
if (mode >= 0) {
- /* just set mode setting */
+ /* Just set mode setting. */
fcu->extend = mode;
ale->update |= ANIM_UPDATE_HANDLES;
}
else {
- /* shortcuts for managing Cycles F-Modifiers to make it easier to toggle cyclic animation
- * without having to go through FModifier UI in Graph Editor to do so
+ /* Shortcuts for managing Cycles F-Modifiers to make it easier to toggle cyclic animation
+ * without having to go through FModifier UI in Graph Editor to do so.
*/
if (mode == MAKE_CYCLIC_EXPO) {
- /* only add if one doesn't exist */
+ /* Only add if one doesn't exist. */
if (list_has_suitable_fmodifier(&fcu->modifiers, FMODIFIER_TYPE_CYCLES, -1) == 0) {
- /* TODO: add some more preset versions which set different extrapolation options? */
+ /* TODO: add some more preset versions which set different extrapolation options?
+ * (Joshua Leung 2011) */
add_fmodifier(&fcu->modifiers, FMODIFIER_TYPE_CYCLES, fcu);
}
}
else if (mode == CLEAR_CYCLIC_EXPO) {
- /* remove all the modifiers fitting this description */
+ /* Remove all the modifiers fitting this description. */
FModifier *fcm, *fcn = NULL;
for (fcm = fcu->modifiers.first; fcm; fcm = fcn) {
@@ -2257,18 +2259,18 @@ static int graphkeys_expo_exec(bContext *C, wmOperator *op)
bAnimContext ac;
short mode;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* get handle setting mode */
+ /* Get handle setting mode. */
mode = RNA_enum_get(op->ptr, "type");
- /* set handle type */
+ /* Set handle type. */
setexpo_graph_keys(&ac, mode);
- /* set notifier that keyframe properties have changed */
+ /* Set notifier that keyframe properties have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
return OPERATOR_FINISHED;
@@ -2276,26 +2278,26 @@ static int graphkeys_expo_exec(bContext *C, wmOperator *op)
void GRAPH_OT_extrapolation_type(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Set Keyframe Extrapolation";
ot->idname = "GRAPH_OT_extrapolation_type";
ot->description = "Set extrapolation mode for selected F-Curves";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_menu_invoke;
ot->exec = graphkeys_expo_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* id-props */
+ /* Id-props */
ot->prop = RNA_def_enum(ot->srna, "type", prop_graphkeys_expo_types, 0, "Type", "");
}
/* ******************** Set Interpolation-Type Operator *********************** */
-/* this function is responsible for setting interpolation mode for keyframes */
+/* This function is responsible for setting interpolation mode for keyframes. */
static void setipo_graph_keys(bAnimContext *ac, short mode)
{
ListBase anim_data = {NULL, NULL};
@@ -2303,7 +2305,7 @@ static void setipo_graph_keys(bAnimContext *ac, short mode)
int filter;
KeyframeEditFunc set_cb = ANIM_editkeyframes_ipo(mode);
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
@@ -2329,18 +2331,18 @@ static int graphkeys_ipo_exec(bContext *C, wmOperator *op)
bAnimContext ac;
short mode;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* get handle setting mode */
+ /* Get handle setting mode. */
mode = RNA_enum_get(op->ptr, "type");
- /* set handle type */
+ /* Set handle type. */
setipo_graph_keys(&ac, mode);
- /* set notifier that keyframe properties have changed */
+ /* Set notifier that keyframe properties have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
return OPERATOR_FINISHED;
@@ -2348,21 +2350,21 @@ static int graphkeys_ipo_exec(bContext *C, wmOperator *op)
void GRAPH_OT_interpolation_type(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Set Keyframe Interpolation";
ot->idname = "GRAPH_OT_interpolation_type";
ot->description =
"Set interpolation mode for the F-Curve segments starting from the selected keyframes";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_menu_invoke;
ot->exec = graphkeys_ipo_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* id-props */
+ /* Id-props */
ot->prop = RNA_def_enum(
ot->srna, "type", rna_enum_beztriple_interpolation_mode_items, 0, "Type", "");
}
@@ -2376,7 +2378,7 @@ static void seteasing_graph_keys(bAnimContext *ac, short mode)
int filter;
KeyframeEditFunc set_cb = ANIM_editkeyframes_easing(mode);
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
@@ -2400,18 +2402,18 @@ static int graphkeys_easing_exec(bContext *C, wmOperator *op)
bAnimContext ac;
short mode;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* get handle setting mode */
+ /* Get handle setting mode. */
mode = RNA_enum_get(op->ptr, "type");
- /* set handle type */
+ /* Set handle type. */
seteasing_graph_keys(&ac, mode);
- /* set notifier that keyframe properties have changed */
+ /* Set notifier that keyframe properties have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
return OPERATOR_FINISHED;
@@ -2419,28 +2421,28 @@ static int graphkeys_easing_exec(bContext *C, wmOperator *op)
void GRAPH_OT_easing_type(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Set Keyframe Easing Type";
ot->idname = "GRAPH_OT_easing_type";
ot->description =
"Set easing type for the F-Curve segments starting from the selected keyframes";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_menu_invoke;
ot->exec = graphkeys_easing_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* id-props */
+ /* Id-props */
ot->prop = RNA_def_enum(
ot->srna, "type", rna_enum_beztriple_interpolation_easing_items, 0, "Type", "");
}
/* ******************** Set Handle-Type Operator *********************** */
-/* this function is responsible for setting handle-type of selected keyframes */
+/* This function is responsible for setting handle-type of selected keyframes. */
static void sethandles_graph_keys(bAnimContext *ac, short mode)
{
ListBase anim_data = {NULL, NULL};
@@ -2450,7 +2452,7 @@ static void sethandles_graph_keys(bAnimContext *ac, short mode)
KeyframeEditFunc edit_cb = ANIM_editkeyframes_handles(mode);
KeyframeEditFunc sel_cb = ANIM_editkeyframes_ok(BEZT_OK_SELECTED);
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
@@ -2462,9 +2464,9 @@ static void sethandles_graph_keys(bAnimContext *ac, short mode)
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->key_data;
- /* any selected keyframes for editing? */
+ /* Any selected keyframes for editing? */
if (ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, sel_cb, NULL)) {
- /* change type of selected handles */
+ /* Change type of selected handles. */
ANIM_fcurve_keyframes_loop(NULL, fcu, NULL, edit_cb, calchandles_fcurve);
ale->update |= ANIM_UPDATE_DEFAULT;
@@ -2481,18 +2483,18 @@ static int graphkeys_handletype_exec(bContext *C, wmOperator *op)
bAnimContext ac;
short mode;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* get handle setting mode */
+ /* Get handle setting mode. */
mode = RNA_enum_get(op->ptr, "type");
- /* set handle type */
+ /* Set handle type. */
sethandles_graph_keys(&ac, mode);
- /* set notifier that keyframe properties have changed */
+ /* Set notifier that keyframe properties have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME_PROP, NULL);
return OPERATOR_FINISHED;
@@ -2500,20 +2502,20 @@ static int graphkeys_handletype_exec(bContext *C, wmOperator *op)
void GRAPH_OT_handle_type(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Set Keyframe Handle Type";
ot->idname = "GRAPH_OT_handle_type";
ot->description = "Set type of handle for selected keyframes";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_menu_invoke;
ot->exec = graphkeys_handletype_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* id-props */
+ /* Id-props */
ot->prop = RNA_def_enum(ot->srna, "type", rna_enum_keyframe_handle_type_items, 0, "Type", "");
}
@@ -2527,15 +2529,15 @@ void GRAPH_OT_handle_type(wmOperatorType *ot)
* of values to -180 degrees to 180 degrees.
*/
-/* set of three euler-rotation F-Curves */
+/* Set of three euler-rotation F-Curves. */
typedef struct tEulerFilter {
struct tEulerFilter *next, *prev;
/** ID-block which owns the channels */
ID *id;
- /** 3 Pointers to F-Curves */
+ /** 3 Pointers to F-Curves. */
FCurve *(fcurves[3]);
- /** Pointer to one of the RNA Path's used by one of the F-Curves */
+ /** Pointer to one of the RNA Path's used by one of the F-Curves. */
const char *rna_path;
} tEulerFilter;
@@ -2551,19 +2553,19 @@ static int graphkeys_euler_filter_exec(bContext *C, wmOperator *op)
tEulerFilter *euf = NULL;
int groups = 0, failed = 0;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
/* The process is done in two passes:
* 1) Sets of three related rotation curves are identified from the selected channels,
- * and are stored as a single 'operation unit' for the next step
+ * and are stored as a single 'operation unit' for the next step.
* 2) Each set of three F-Curves is processed for each keyframe, with the values being
- * processed as necessary
+ * processed as necessary.
*/
- /* step 1: extract only the rotation f-curves */
+ /* Step 1: extract only the rotation f-curves. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_SEL | ANIMFILTER_CURVE_VISIBLE |
ANIMFILTER_FOREDIT | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
@@ -2571,9 +2573,9 @@ static int graphkeys_euler_filter_exec(bContext *C, wmOperator *op)
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->data;
- /* check if this is an appropriate F-Curve
- * - only rotation curves
- * - for pchan curves, make sure we're only using the euler curves
+ /* Check if this is an appropriate F-Curve
+ * - Only rotation curves.
+ * - For pchan curves, make sure we're only using the euler curves.
*/
if (strstr(fcu->rna_path, "rotation_euler") == NULL) {
continue;
@@ -2588,22 +2590,22 @@ static int graphkeys_euler_filter_exec(bContext *C, wmOperator *op)
continue;
}
- /* optimization: assume that xyz curves will always be stored consecutively,
+ /* Optimization: assume that xyz curves will always be stored consecutively,
* so if the paths or the ID's don't match up, then a curve needs to be added
- * to a new group
+ * to a new group.
*/
if ((euf) && (euf->id == ale->id) && (STREQ(euf->rna_path, fcu->rna_path))) {
- /* this should be fine to add to the existing group then */
+ /* This should be fine to add to the existing group then. */
euf->fcurves[fcu->array_index] = fcu;
}
else {
- /* just add to a new block */
+ /* Just add to a new block. */
euf = MEM_callocN(sizeof(tEulerFilter), "tEulerFilter");
BLI_addtail(&eulers, euf);
groups++;
euf->id = ale->id;
- /* this should be safe, since we're only using it for a short time */
+ /* This should be safe, since we're only using it for a short time. */
euf->rna_path = fcu->rna_path;
euf->fcurves[fcu->array_index] = fcu;
}
@@ -2617,17 +2619,17 @@ static int graphkeys_euler_filter_exec(bContext *C, wmOperator *op)
return OPERATOR_CANCELLED;
}
- /* step 2: go through each set of curves, processing the values at each keyframe
- * - it is assumed that there must be a full set of keyframes at each keyframe position
+ /* Step 2: go through each set of curves, processing the values at each keyframe.
+ * - It is assumed that there must be a full set of keyframes at each keyframe position.
*/
for (euf = eulers.first; euf; euf = euf->next) {
int f;
- /* sanity check: ensure that there are enough F-Curves to work on in this group */
+ /* Sanity check: ensure that there are enough F-Curves to work on in this group. */
/* TODO: also enforce assumption that there be a full set of keyframes
- * at each position by ensuring that totvert counts are same? */
+ * at each position by ensuring that totvert counts are same? (Joshua Leung 2011) */
if (ELEM(NULL, euf->fcurves[0], euf->fcurves[1], euf->fcurves[2])) {
- /* report which components are missing */
+ /* Report which components are missing. */
BKE_reportf(op->reports,
RPT_WARNING,
"Missing %s%s%s component(s) of euler rotation for ID='%s' and RNA-Path='%s'",
@@ -2637,7 +2639,7 @@ static int graphkeys_euler_filter_exec(bContext *C, wmOperator *op)
euf->id->name,
euf->rna_path);
- /* keep track of number of failed sets, and carry on to next group */
+ /* Keep track of number of failed sets, and carry on to next group. */
failed++;
continue;
}
@@ -2651,20 +2653,20 @@ static int graphkeys_euler_filter_exec(bContext *C, wmOperator *op)
BezTriple *bezt, *prev;
uint i;
- /* skip if not enough vets to do a decent analysis of... */
+ /* Skip if not enough vets to do a decent analysis of.... */
if (fcu->totvert <= 2) {
continue;
}
- /* prev follows bezt, bezt = "current" point to be fixed */
- /* our method depends on determining a "difference" from the previous vert */
+ /* Prev follows bezt, bezt = "current" point to be fixed. */
+ /* Our method depends on determining a "difference" from the previous vert. */
for (i = 1, prev = fcu->bezt, bezt = fcu->bezt + 1; i < fcu->totvert; i++, prev = bezt++) {
const float sign = (prev->vec[1][1] > bezt->vec[1][1]) ? 1.0f : -1.0f;
/* > 180 degree flip? */
if ((sign * (prev->vec[1][1] - bezt->vec[1][1])) >= (float)M_PI) {
/* 360 degrees to add/subtract frame value until difference
- * is acceptably small that there's no more flip */
+ * is acceptably small that there's no more flip. */
const float fac = sign * 2.0f * (float)M_PI;
while ((sign * (prev->vec[1][1] - bezt->vec[1][1])) >= (float)M_PI) {
@@ -2681,7 +2683,7 @@ static int graphkeys_euler_filter_exec(bContext *C, wmOperator *op)
ANIM_animdata_update(&ac, &anim_data);
ANIM_animdata_freelist(&anim_data);
- /* updates + finishing warnings */
+ /* Updates + finishing warnings. */
if (failed == groups) {
BKE_report(
op->reports,
@@ -2701,16 +2703,16 @@ static int graphkeys_euler_filter_exec(bContext *C, wmOperator *op)
"consecutive XYZ order and selected");
}
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
- /* done at last */
+ /* Done at last. */
return OPERATOR_FINISHED;
}
void GRAPH_OT_euler_filter(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Euler Discontinuity Filter";
ot->idname = "GRAPH_OT_euler_filter";
ot->description =
@@ -2718,11 +2720,11 @@ void GRAPH_OT_euler_filter(wmOperatorType *ot)
"Euler Rotation F-Curves arising from rotation "
"values being clipped when baking physics";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_euler_filter_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}
@@ -2730,7 +2732,7 @@ void GRAPH_OT_euler_filter(wmOperatorType *ot)
static bool graphkeys_framejump_poll(bContext *C)
{
- /* prevent changes during render */
+ /* Prevent changes during render. */
if (G.is_rendering) {
return false;
}
@@ -2745,10 +2747,10 @@ static KeyframeEditData sum_selected_keyframes(bAnimContext *ac)
int filter;
KeyframeEditData ked;
- /* init edit data */
+ /* Init edit data. */
memset(&ked, 0, sizeof(KeyframeEditData));
- /* loop over action data, averaging values */
+ /* Loop over action data, averaging values. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
@@ -2782,12 +2784,12 @@ static KeyframeEditData sum_selected_keyframes(bAnimContext *ac)
return ked;
}
-/* snap current-frame indicator to 'average time' of selected keyframe */
+/* Snap current-frame indicator to 'average time' of selected keyframe. */
static int graphkeys_framejump_exec(bContext *C, wmOperator *UNUSED(op))
{
bAnimContext ac;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
@@ -2801,11 +2803,11 @@ static int graphkeys_framejump_exec(bContext *C, wmOperator *UNUSED(op))
return OPERATOR_FINISHED;
}
- /* set the new current frame and cursor values, based on the average time and value */
+ /* Set the new current frame and cursor values, based on the average time and value. */
SpaceGraph *sipo = (SpaceGraph *)ac.sl;
Scene *scene = ac.scene;
- /* take the average values, rounding to the nearest int as necessary for int results */
+ /* Take the average values, rounding to the nearest int as necessary for int results. */
if (sipo->mode == SIPO_MODE_DRIVERS) {
/* Drivers Mode - Affects cursor (float) */
sipo->cursorTime = sum_time / (float)num_keyframes;
@@ -2817,7 +2819,7 @@ static int graphkeys_framejump_exec(bContext *C, wmOperator *UNUSED(op))
}
sipo->cursorVal = sum_value / (float)num_keyframes;
- /* set notifier that things have changed */
+ /* Set notifier that things have changed. */
WM_event_add_notifier(C, NC_SCENE | ND_FRAME, ac.scene);
return OPERATOR_FINISHED;
@@ -2825,16 +2827,16 @@ static int graphkeys_framejump_exec(bContext *C, wmOperator *UNUSED(op))
void GRAPH_OT_frame_jump(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Jump to Keyframes";
ot->idname = "GRAPH_OT_frame_jump";
ot->description = "Place the cursor on the midpoint of selected keyframes";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_framejump_exec;
ot->poll = graphkeys_framejump_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}
@@ -2880,7 +2882,7 @@ void GRAPH_OT_snap_cursor_value(wmOperatorType *ot)
/* ******************** Snap Keyframes Operator *********************** */
-/* defines for snap keyframes tool */
+/* Defines for snap keyframes tool. */
static const EnumPropertyItem prop_graphkeys_snap_types[] = {
{GRAPHKEYS_SNAP_CFRA,
"CFRA",
@@ -2916,7 +2918,7 @@ static const EnumPropertyItem prop_graphkeys_snap_types[] = {
{0, NULL, 0, NULL, NULL},
};
-/* this function is responsible for snapping keyframes to frame-times */
+/* This function is responsible for snapping keyframes to frame-times. */
static void snap_graph_keys(bAnimContext *ac, short mode)
{
ListBase anim_data = {NULL, NULL};
@@ -2928,12 +2930,12 @@ static void snap_graph_keys(bAnimContext *ac, short mode)
KeyframeEditFunc edit_cb;
float cursor_value = 0.0f;
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* init custom data for iterating over keyframes */
+ /* Init custom data for iterating over keyframes. */
memset(&ked, 0, sizeof(KeyframeEditData));
ked.scene = ac->scene;
if (mode == GRAPHKEYS_SNAP_NEAREST_MARKER) {
@@ -2953,14 +2955,14 @@ static void snap_graph_keys(bAnimContext *ac, short mode)
}
}
- /* get beztriple editing callbacks */
+ /* Get beztriple editing callbacks. */
edit_cb = ANIM_editkeyframes_snap(mode);
- /* snap keyframes */
+ /* Snap keyframes. */
for (ale = anim_data.first; ale; ale = ale->next) {
AnimData *adt = ANIM_nla_mapping_get(ac, ale);
- /* normalise cursor value (for normalised F-Curves display) */
+ /* Normalise cursor value (for normalised F-Curves display). */
if (mode == GRAPHKEYS_SNAP_VALUE) {
short mapping_flag = ANIM_get_normalization_flags(ac);
float offset;
@@ -2970,7 +2972,7 @@ static void snap_graph_keys(bAnimContext *ac, short mode)
ked.f1 = (cursor_value / unit_scale) - offset;
}
- /* perform snapping */
+ /* Perform snapping. */
if (adt) {
ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 0);
ANIM_fcurve_keyframes_loop(&ked, ale->key_data, NULL, edit_cb, calchandles_fcurve);
@@ -2994,18 +2996,18 @@ static int graphkeys_snap_exec(bContext *C, wmOperator *op)
bAnimContext ac;
short mode;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* get snapping mode */
+ /* Get snapping mode. */
mode = RNA_enum_get(op->ptr, "type");
- /* snap keyframes */
+ /* Snap keyframes. */
snap_graph_keys(&ac, mode);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -3013,26 +3015,26 @@ static int graphkeys_snap_exec(bContext *C, wmOperator *op)
void GRAPH_OT_snap(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Snap Keys";
ot->idname = "GRAPH_OT_snap";
ot->description = "Snap selected keyframes to the chosen times/values";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_menu_invoke;
ot->exec = graphkeys_snap_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* id-props */
+ /* Id-props */
ot->prop = RNA_def_enum(ot->srna, "type", prop_graphkeys_snap_types, 0, "Type", "");
}
/* ******************** Mirror Keyframes Operator *********************** */
-/* defines for mirror keyframes tool */
+/* Defines for mirror keyframes tool. */
static const EnumPropertyItem prop_graphkeys_mirror_types[] = {
{GRAPHKEYS_MIRROR_CFRA,
"CFRA",
@@ -3063,7 +3065,7 @@ static const EnumPropertyItem prop_graphkeys_mirror_types[] = {
{0, NULL, 0, NULL, NULL},
};
-/* this function is responsible for mirroring keyframes */
+/* This function is responsible for mirroring keyframes. */
static void mirror_graph_keys(bAnimContext *ac, short mode)
{
ListBase anim_data = {NULL, NULL};
@@ -3075,18 +3077,18 @@ static void mirror_graph_keys(bAnimContext *ac, short mode)
KeyframeEditFunc edit_cb;
float cursor_value = 0.0f;
- /* init custom data for looping over keyframes */
+ /* Init custom data for looping over keyframes. */
memset(&ked, 0, sizeof(KeyframeEditData));
ked.scene = ac->scene;
- /* store mode-specific custom data... */
+ /* Store mode-specific custom data... */
if (mode == GRAPHKEYS_MIRROR_MARKER) {
TimeMarker *marker = NULL;
- /* find first selected marker */
+ /* Find first selected marker. */
marker = ED_markers_get_first_selected(ac->markers);
- /* store marker's time (if available) */
+ /* Store marker's time (if available). */
if (marker) {
ked.f1 = (float)marker->frame;
}
@@ -3107,19 +3109,19 @@ static void mirror_graph_keys(bAnimContext *ac, short mode)
}
}
- /* get beztriple editing callbacks */
+ /* Get beztriple editing callbacks. */
edit_cb = ANIM_editkeyframes_mirror(mode);
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(ac, &anim_data, filter, ac->data, ac->datatype);
- /* mirror keyframes */
+ /* Mirror keyframes. */
for (ale = anim_data.first; ale; ale = ale->next) {
AnimData *adt = ANIM_nla_mapping_get(ac, ale);
- /* apply unit corrections */
+ /* Apply unit corrections. */
if (mode == GRAPHKEYS_MIRROR_VALUE) {
short mapping_flag = ANIM_get_normalization_flags(ac);
float offset;
@@ -3129,7 +3131,7 @@ static void mirror_graph_keys(bAnimContext *ac, short mode)
ked.f1 = (cursor_value + offset) * unit_scale;
}
- /* perform actual mirroring */
+ /* Perform actual mirroring. */
if (adt) {
ANIM_nla_mapping_apply_fcurve(adt, ale->key_data, 0, 0);
ANIM_fcurve_keyframes_loop(&ked, ale->key_data, NULL, edit_cb, calchandles_fcurve);
@@ -3153,18 +3155,18 @@ static int graphkeys_mirror_exec(bContext *C, wmOperator *op)
bAnimContext ac;
short mode;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* get mirroring mode */
+ /* Get mirroring mode. */
mode = RNA_enum_get(op->ptr, "type");
- /* mirror keyframes */
+ /* Mirror keyframes. */
mirror_graph_keys(&ac, mode);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -3172,20 +3174,20 @@ static int graphkeys_mirror_exec(bContext *C, wmOperator *op)
void GRAPH_OT_mirror(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Mirror Keys";
ot->idname = "GRAPH_OT_mirror";
ot->description = "Flip selected keyframes over the selected mirror line";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_menu_invoke;
ot->exec = graphkeys_mirror_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* id-props */
+ /* Id-props */
ot->prop = RNA_def_enum(ot->srna, "type", prop_graphkeys_mirror_types, 0, "Type", "");
}
@@ -3198,17 +3200,17 @@ static int graphkeys_smooth_exec(bContext *C, wmOperator *UNUSED(op))
bAnimListElem *ale;
int filter;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
- /* smooth keyframes */
+ /* Smooth keyframes. */
for (ale = anim_data.first; ale; ale = ale->next) {
/* For now, we can only smooth by flattening handles AND smoothing curve values.
* Perhaps the mode argument could be removed, as that functionality is offered through
@@ -3222,7 +3224,7 @@ static int graphkeys_smooth_exec(bContext *C, wmOperator *UNUSED(op))
ANIM_animdata_update(&ac, &anim_data);
ANIM_animdata_freelist(&anim_data);
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -3230,16 +3232,16 @@ static int graphkeys_smooth_exec(bContext *C, wmOperator *UNUSED(op))
void GRAPH_OT_smooth(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Smooth Keys";
ot->idname = "GRAPH_OT_smooth";
ot->description = "Apply weighted moving means to make selected F-Curves less bumpy";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graphkeys_smooth_exec;
ot->poll = graphop_editable_keyframes_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}
@@ -3261,12 +3263,12 @@ static const EnumPropertyItem *graph_fmodifier_itemf(bContext *C,
return rna_enum_fmodifier_type_items;
}
- /* start from 1 to skip the 'Invalid' modifier type */
+ /* Start from 1 to skip the 'Invalid' modifier type. */
for (i = 1; i < FMODIFIER_NUM_TYPES; i++) {
const FModifierTypeInfo *fmi = get_fmodifier_typeinfo(i);
int index;
- /* check if modifier is valid for this context */
+ /* Check if modifier is valid for this context. */
if (fmi == NULL) {
continue;
}
@@ -3291,15 +3293,15 @@ static int graph_fmodifier_add_exec(bContext *C, wmOperator *op)
int filter;
short type;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* get type of modifier to add */
+ /* Get type of modifier to add. */
type = RNA_enum_get(op->ptr, "type");
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_FOREDIT | ANIMFILTER_NODUPLIS);
if (RNA_boolean_get(op->ptr, "only_active")) {
/* FIXME: enforce in this case only a single channel to get handled? */
@@ -3310,12 +3312,12 @@ static int graph_fmodifier_add_exec(bContext *C, wmOperator *op)
}
ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
- /* add f-modifier to each curve */
+ /* Add f-modifier to each curve. */
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->data;
FModifier *fcm;
- /* add F-Modifier of specified type to active F-Curve, and make it the active one */
+ /* Add F-Modifier of specified type to active F-Curve, and make it the active one. */
fcm = add_fmodifier(&fcu->modifiers, type, fcu);
if (fcm) {
set_active_fmodifier(&fcu->modifiers, fcm);
@@ -3331,7 +3333,7 @@ static int graph_fmodifier_add_exec(bContext *C, wmOperator *op)
ANIM_animdata_update(&ac, &anim_data);
ANIM_animdata_freelist(&anim_data);
- /* set notifier that things have changed */
+ /* Set notifier that things have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -3341,20 +3343,20 @@ void GRAPH_OT_fmodifier_add(wmOperatorType *ot)
{
PropertyRNA *prop;
- /* identifiers */
+ /* Identifiers */
ot->name = "Add F-Curve Modifier";
ot->idname = "GRAPH_OT_fmodifier_add";
ot->description = "Add F-Modifier to the active/selected F-Curves";
- /* api callbacks */
+ /* API callbacks */
ot->invoke = WM_menu_invoke;
ot->exec = graph_fmodifier_add_exec;
ot->poll = graphop_selected_fcurve_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* id-props */
+ /* Id-props */
prop = RNA_def_enum(ot->srna, "type", rna_enum_fmodifier_type_items, 0, "Type", "");
RNA_def_property_translation_context(prop, BLT_I18NCONTEXT_ID_ACTION);
RNA_def_enum_funcs(prop, graph_fmodifier_itemf);
@@ -3372,29 +3374,29 @@ static int graph_fmodifier_copy_exec(bContext *C, wmOperator *op)
bAnimListElem *ale;
bool ok = false;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* clear buffer first */
+ /* Clear buffer first. */
ANIM_fmodifiers_copybuf_free();
- /* get the active F-Curve */
+ /* Get the active F-Curve. */
ale = get_active_fcurve_channel(&ac);
- /* if this exists, call the copy F-Modifiers API function */
+ /* If this exists, call the copy F-Modifiers API function. */
if (ale && ale->data) {
FCurve *fcu = (FCurve *)ale->data;
- /* TODO: when 'active' vs 'all' boolean is added, change last param! */
+ /* TODO: When 'active' vs 'all' boolean is added, change last param! (Joshua Leung 2010) */
ok = ANIM_fmodifiers_copy_to_buf(&fcu->modifiers, 0);
- /* free temp data now */
+ /* Free temp data now. */
MEM_freeN(ale);
}
- /* successful or not? */
+ /* Successful or not? */
if (ok == 0) {
BKE_report(op->reports, RPT_ERROR, "No F-Modifiers available to be copied");
return OPERATOR_CANCELLED;
@@ -3404,19 +3406,19 @@ static int graph_fmodifier_copy_exec(bContext *C, wmOperator *op)
void GRAPH_OT_fmodifier_copy(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Copy F-Modifiers";
ot->idname = "GRAPH_OT_fmodifier_copy";
ot->description = "Copy the F-Modifier(s) of the active F-Curve";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graph_fmodifier_copy_exec;
ot->poll = graphop_active_fcurve_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* id-props */
+ /* Id-props */
#if 0
ot->prop = RNA_def_boolean(ot->srna,
"all",
@@ -3439,14 +3441,14 @@ static int graph_fmodifier_paste_exec(bContext *C, wmOperator *op)
const bool replace = RNA_boolean_get(op->ptr, "replace");
bool ok = false;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* filter data */
+ /* Filter data. */
if (RNA_boolean_get(op->ptr, "only_active")) {
- /* This should be the default (for buttons) - Just paste to the active FCurve */
+ /* This should be the default (for buttons) - Just paste to the active FCurve. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_ACTIVE | ANIMFILTER_FOREDIT |
ANIMFILTER_NODUPLIS);
}
@@ -3459,7 +3461,7 @@ static int graph_fmodifier_paste_exec(bContext *C, wmOperator *op)
ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
- /* paste modifiers */
+ /* Paste modifiers. */
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->data;
int tot;
@@ -3477,9 +3479,9 @@ static int graph_fmodifier_paste_exec(bContext *C, wmOperator *op)
}
ANIM_animdata_freelist(&anim_data);
- /* successful or not? */
+ /* Successful or not?. */
if (ok) {
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_EDITED, NULL);
return OPERATOR_FINISHED;
@@ -3491,19 +3493,19 @@ static int graph_fmodifier_paste_exec(bContext *C, wmOperator *op)
void GRAPH_OT_fmodifier_paste(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Paste F-Modifiers";
ot->idname = "GRAPH_OT_fmodifier_paste";
ot->description = "Add copied F-Modifiers to the selected F-Curves";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graph_fmodifier_paste_exec;
ot->poll = graphop_active_fcurve_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* properties */
+ /* Properties */
RNA_def_boolean(
ot->srna, "only_active", true, "Only Active", "Only paste F-Modifiers on active F-Curve");
RNA_def_boolean(
@@ -3525,14 +3527,14 @@ static int graph_driver_vars_copy_exec(bContext *C, wmOperator *op)
PointerRNA ptr = CTX_data_pointer_get_type(C, "active_editable_fcurve", &RNA_FCurve);
- /* if this exists, call the copy driver vars API function */
+ /* If this exists, call the copy driver vars API function. */
FCurve *fcu = ptr.data;
if (fcu) {
ok = ANIM_driver_vars_copy(op->reports, fcu);
}
- /* successful or not? */
+ /* Successful or not?. */
if (ok) {
return OPERATOR_FINISHED;
}
@@ -3541,16 +3543,16 @@ static int graph_driver_vars_copy_exec(bContext *C, wmOperator *op)
void GRAPH_OT_driver_variables_copy(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Copy Driver Variables";
ot->idname = "GRAPH_OT_driver_variables_copy";
ot->description = "Copy the driver variables of the active driver";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graph_driver_vars_copy_exec;
ot->poll = graphop_active_editable_fcurve_ctx_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}
@@ -3563,19 +3565,19 @@ static int graph_driver_vars_paste_exec(bContext *C, wmOperator *op)
PointerRNA ptr = CTX_data_pointer_get_type(C, "active_editable_fcurve", &RNA_FCurve);
- /* if this exists, call the paste driver vars API function */
+ /* If this exists, call the paste driver vars API function. */
FCurve *fcu = ptr.data;
if (fcu) {
ok = ANIM_driver_vars_paste(op->reports, fcu, replace);
}
- /* successful or not? */
+ /* Successful or not?. */
if (ok) {
- /* rebuild depsgraph, now that there are extra deps here */
+ /* Rebuild depsgraph, now that there are extra deps here. */
DEG_relations_tag_update(CTX_data_main(C));
- /* set notifier that keyframes have changed */
+ /* Set notifier that keyframes have changed. */
WM_event_add_notifier(C, NC_SCENE | ND_FRAME, CTX_data_scene(C));
return OPERATOR_FINISHED;
@@ -3585,19 +3587,19 @@ static int graph_driver_vars_paste_exec(bContext *C, wmOperator *op)
void GRAPH_OT_driver_variables_paste(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Paste Driver Variables";
ot->idname = "GRAPH_OT_driver_variables_paste";
ot->description = "Add copied driver variables to the active driver";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graph_driver_vars_paste_exec;
ot->poll = graphop_active_editable_fcurve_ctx_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
- /* properties */
+ /* Properties */
RNA_def_boolean(ot->srna,
"replace",
false,
@@ -3617,18 +3619,18 @@ static int graph_driver_delete_invalid_exec(bContext *C, wmOperator *op)
bool ok = false;
uint deleted = 0;
- /* get editor data */
+ /* Get editor data. */
if (ANIM_animdata_get_context(C, &ac) == 0) {
return OPERATOR_CANCELLED;
}
- /* NOTE: we might need a scene update to evaluate the driver flags */
+ /* NOTE: We might need a scene update to evaluate the driver flags. */
- /* filter data */
+ /* Filter data. */
filter = (ANIMFILTER_DATA_VISIBLE | ANIMFILTER_CURVE_VISIBLE | ANIMFILTER_NODUPLIS);
ANIM_animdata_filter(&ac, &anim_data, filter, ac.data, ac.datatype);
- /* find invalid drivers */
+ /* Find invalid drivers. */
for (ale = anim_data.first; ale; ale = ale->next) {
FCurve *fcu = (FCurve *)ale->data;
if (ELEM(NULL, fcu, fcu->driver)) {
@@ -3645,11 +3647,11 @@ static int graph_driver_delete_invalid_exec(bContext *C, wmOperator *op)
deleted += 1;
}
- /* cleanup */
+ /* Cleanup. */
ANIM_animdata_freelist(&anim_data);
if (deleted > 0) {
- /* notify the world of any changes */
+ /* Notify the world of any changes. */
DEG_relations_tag_update(CTX_data_main(C));
WM_event_add_notifier(C, NC_ANIMATION | ND_KEYFRAME | NA_REMOVED, NULL);
WM_reportf(RPT_INFO, "Deleted %u drivers", deleted);
@@ -3658,7 +3660,7 @@ static int graph_driver_delete_invalid_exec(bContext *C, wmOperator *op)
WM_report(RPT_INFO, "No drivers deleted");
}
- /* successful or not? */
+ /* Successful or not?*/
if (!ok) {
return OPERATOR_CANCELLED;
}
@@ -3671,26 +3673,26 @@ static bool graph_driver_delete_invalid_poll(bContext *C)
bAnimContext ac;
ScrArea *area = CTX_wm_area(C);
- /* firstly, check if in Graph Editor */
+ /* Firstly, check if in Graph Editor. */
if ((area == NULL) || (area->spacetype != SPACE_GRAPH)) {
return false;
}
- /* try to init Anim-Context stuff ourselves and check */
+ /* Try to init Anim-Context stuff ourselves and check. */
return ANIM_animdata_get_context(C, &ac) != 0;
}
void GRAPH_OT_driver_delete_invalid(wmOperatorType *ot)
{
- /* identifiers */
+ /* Identifiers */
ot->name = "Delete Invalid Drivers";
ot->idname = "GRAPH_OT_driver_delete_invalid";
ot->description = "Delete all visible drivers considered invalid";
- /* api callbacks */
+ /* API callbacks */
ot->exec = graph_driver_delete_invalid_exec;
ot->poll = graph_driver_delete_invalid_poll;
- /* flags */
+ /* Flags */
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
}