Cleanup: use doxy sections for graph_edit.c
This commit is contained in:
parent
9c5d67411a
commit
cdfe733e70
|
|
@ -72,7 +72,9 @@
|
|||
/* ************************************************************************** */
|
||||
/* INSERT DUPLICATE AND BAKE KEYFRAMES */
|
||||
|
||||
/* ******************** Insert Keyframes Operator ************************* */
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Insert Keyframes Operator
|
||||
* \{ */
|
||||
|
||||
/* Mode defines for insert keyframes tool. */
|
||||
typedef enum eGraphKeys_InsertKey_Types {
|
||||
|
|
@ -290,7 +292,11 @@ void GRAPH_OT_keyframe_insert(wmOperatorType *ot)
|
|||
ot->prop = RNA_def_enum(ot->srna, "type", prop_graphkeys_insertkey_types, 0, "Type", "");
|
||||
}
|
||||
|
||||
/* ******************** Click-Insert Keyframes Operator ************************* */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Click-Insert Keyframes Operator
|
||||
* \{ */
|
||||
|
||||
static int graphkeys_click_insert_exec(bContext *C, wmOperator *op)
|
||||
{
|
||||
|
|
@ -444,8 +450,13 @@ void GRAPH_OT_click_insert(wmOperatorType *ot)
|
|||
"Extend selection instead of deselecting everything first");
|
||||
}
|
||||
|
||||
/* ******************** Copy/Paste Keyframes Operator ************************* */
|
||||
/* NOTE: the backend code for this is shared with the dopesheet editor */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Copy/Paste Keyframes Operator
|
||||
*
|
||||
* \note the back-end code for this is shared with the dope-sheet editor.
|
||||
* \{ */
|
||||
|
||||
static short copy_graph_keys(bAnimContext *ac)
|
||||
{
|
||||
|
|
@ -605,7 +616,11 @@ void GRAPH_OT_paste(wmOperatorType *ot)
|
|||
RNA_def_property_flag(prop, PROP_SKIP_SAVE);
|
||||
}
|
||||
|
||||
/* ******************** Duplicate Keyframes Operator ************************* */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Duplicate Keyframes Operator
|
||||
* \{ */
|
||||
|
||||
static void duplicate_graph_keys(bAnimContext *ac)
|
||||
{
|
||||
|
|
@ -667,7 +682,11 @@ void GRAPH_OT_duplicate(wmOperatorType *ot)
|
|||
RNA_def_enum(ot->srna, "mode", rna_enum_transform_mode_types, TFM_TRANSLATION, "Mode", "");
|
||||
}
|
||||
|
||||
/* ******************** Delete Keyframes Operator ************************* */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Delete Keyframes Operator
|
||||
* \{ */
|
||||
|
||||
static bool delete_graph_keys(bAnimContext *ac)
|
||||
{
|
||||
|
|
@ -746,7 +765,11 @@ void GRAPH_OT_delete(wmOperatorType *ot)
|
|||
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
|
||||
}
|
||||
|
||||
/* ******************** Clean Keyframes Operator ************************* */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Clean Keyframes Operator
|
||||
* \{ */
|
||||
|
||||
static void clean_graph_keys(bAnimContext *ac, float thresh, bool clean_chan)
|
||||
{
|
||||
|
|
@ -816,8 +839,13 @@ void GRAPH_OT_clean(wmOperatorType *ot)
|
|||
RNA_def_boolean(ot->srna, "channels", false, "Channels", "");
|
||||
}
|
||||
|
||||
/* ******************** Bake F-Curve Operator *********************** */
|
||||
/* This operator bakes the data of the selected F-Curves to F-Points */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name 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. */
|
||||
static void bake_graph_curves(bAnimContext *ac, int start, int end)
|
||||
|
|
@ -899,8 +927,13 @@ void GRAPH_OT_bake(wmOperatorType *ot)
|
|||
/* TODO: add props for start/end frames (Joshua Leung 2009) */
|
||||
}
|
||||
|
||||
/* ******************** Un-Bake F-Curve Operator *********************** */
|
||||
/* This operator unbakes the data of the selected F-Points to F-Curves. */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Un-Bake F-Curve Operator
|
||||
*
|
||||
* This operator un-bakes the data of the selected F-Points to F-Curves.
|
||||
* \{ */
|
||||
|
||||
/* Un-Bake F-Points into F-Curves. */
|
||||
static void unbake_graph_curves(bAnimContext *ac, int start, int end)
|
||||
|
|
@ -970,8 +1003,13 @@ void GRAPH_OT_unbake(wmOperatorType *ot)
|
|||
|
||||
#ifdef WITH_AUDASPACE
|
||||
|
||||
/* ******************** Sound Bake F-Curve Operator *********************** */
|
||||
/* This operator bakes the given sound to the selected F-Curves */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Sound Bake F-Curve Operator
|
||||
*
|
||||
* This operator bakes the given sound to the selected F-Curves.
|
||||
* \{ */
|
||||
|
||||
/* ------------------- */
|
||||
|
||||
|
|
@ -1204,10 +1242,14 @@ void GRAPH_OT_sound_bake(wmOperatorType *ot)
|
|||
0.1);
|
||||
}
|
||||
|
||||
/* ******************** Sample Keyframes Operator *********************** */
|
||||
/* This operator 'bakes' the values of the curve into new keyframes between pairs
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Sample Keyframes Operator
|
||||
*
|
||||
* This operator 'bakes' the values of the curve into new keyframes between pairs
|
||||
* 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. */
|
||||
static void sample_graph_keys(bAnimContext *ac)
|
||||
|
|
@ -1267,10 +1309,14 @@ void GRAPH_OT_sample(wmOperatorType *ot)
|
|||
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/* ************************************************************************** */
|
||||
/* EXTRAPOLATION MODE AND KEYFRAME HANDLE SETTINGS */
|
||||
|
||||
/* ******************** Set Extrapolation-Type Operator *********************** */
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Set Extrapolation-Type Operator
|
||||
* \{ */
|
||||
|
||||
/* Defines for make/clear cyclic extrapolation tools. */
|
||||
#define MAKE_CYCLIC_EXPO -1
|
||||
|
|
@ -1400,7 +1446,11 @@ void GRAPH_OT_extrapolation_type(wmOperatorType *ot)
|
|||
ot->prop = RNA_def_enum(ot->srna, "type", prop_graphkeys_expo_types, 0, "Type", "");
|
||||
}
|
||||
|
||||
/* ******************** Set Interpolation-Type Operator *********************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Set Interpolation-Type Operator
|
||||
* \{ */
|
||||
|
||||
/* This function is responsible for setting interpolation mode for keyframes. */
|
||||
static void setipo_graph_keys(bAnimContext *ac, short mode)
|
||||
|
|
@ -1474,7 +1524,11 @@ void GRAPH_OT_interpolation_type(wmOperatorType *ot)
|
|||
ot->srna, "type", rna_enum_beztriple_interpolation_mode_items, 0, "Type", "");
|
||||
}
|
||||
|
||||
/* ******************** Set Easing Operator *********************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Set Easing Operator
|
||||
* \{ */
|
||||
|
||||
static void seteasing_graph_keys(bAnimContext *ac, short mode)
|
||||
{
|
||||
|
|
@ -1545,7 +1599,11 @@ void GRAPH_OT_easing_type(wmOperatorType *ot)
|
|||
ot->srna, "type", rna_enum_beztriple_interpolation_easing_items, 0, "Type", "");
|
||||
}
|
||||
|
||||
/* ******************** Set Handle-Type Operator *********************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Set Handle-Type Operator
|
||||
* \{ */
|
||||
|
||||
/* This function is responsible for setting handle-type of selected keyframes. */
|
||||
static void sethandles_graph_keys(bAnimContext *ac, short mode)
|
||||
|
|
@ -1624,15 +1682,19 @@ void GRAPH_OT_handle_type(wmOperatorType *ot)
|
|||
ot->prop = RNA_def_enum(ot->srna, "type", rna_enum_keyframe_handle_type_items, 0, "Type", "");
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/* ************************************************************************** */
|
||||
/* EULER FILTER */
|
||||
|
||||
/* ***************** 'Euler Filter' Operator **************************** */
|
||||
/* Euler filter tools (as seen in Maya), are necessary for working with 'baked'
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name 'Euler Filter' Operator
|
||||
*
|
||||
* Euler filter tools (as seen in Maya), are necessary for working with 'baked'
|
||||
* rotation curves (with Euler rotations). The main purpose of such tools is to
|
||||
* resolve any discontinuities that may arise in the curves due to the clamping
|
||||
* of values to -180 degrees to 180 degrees.
|
||||
*/
|
||||
* \{ */
|
||||
|
||||
/* Set of three euler-rotation F-Curves. */
|
||||
typedef struct tEulerFilter {
|
||||
|
|
@ -1955,10 +2017,14 @@ void GRAPH_OT_euler_filter(wmOperatorType *ot)
|
|||
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/* ************************************************************************** */
|
||||
/* SNAPPING */
|
||||
|
||||
/* ***************** Jump to Selected Frames Operator *********************** */
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Jump to Selected Frames Operator
|
||||
* \{ */
|
||||
|
||||
static bool graphkeys_framejump_poll(bContext *C)
|
||||
{
|
||||
|
|
@ -2110,7 +2176,11 @@ void GRAPH_OT_snap_cursor_value(wmOperatorType *ot)
|
|||
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
|
||||
}
|
||||
|
||||
/* ******************** Snap Keyframes Operator *********************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Snap Keyframes Operator
|
||||
* \{ */
|
||||
|
||||
/* Defines for snap keyframes tool. */
|
||||
static const EnumPropertyItem prop_graphkeys_snap_types[] = {
|
||||
|
|
@ -2262,7 +2332,11 @@ void GRAPH_OT_snap(wmOperatorType *ot)
|
|||
ot->prop = RNA_def_enum(ot->srna, "type", prop_graphkeys_snap_types, 0, "Type", "");
|
||||
}
|
||||
|
||||
/* ******************** Mirror Keyframes Operator *********************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Mirror Keyframes Operator
|
||||
* \{ */
|
||||
|
||||
/* Defines for mirror keyframes tool. */
|
||||
static const EnumPropertyItem prop_graphkeys_mirror_types[] = {
|
||||
|
|
@ -2421,7 +2495,11 @@ void GRAPH_OT_mirror(wmOperatorType *ot)
|
|||
ot->prop = RNA_def_enum(ot->srna, "type", prop_graphkeys_mirror_types, 0, "Type", "");
|
||||
}
|
||||
|
||||
/* ******************** Smooth Keyframes Operator *********************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Smooth Keyframes Operator
|
||||
* \{ */
|
||||
|
||||
static int graphkeys_smooth_exec(bContext *C, wmOperator *UNUSED(op))
|
||||
{
|
||||
|
|
@ -2475,10 +2553,14 @@ void GRAPH_OT_smooth(wmOperatorType *ot)
|
|||
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/* ************************************************************************** */
|
||||
/* F-CURVE MODIFIERS */
|
||||
|
||||
/* ******************** Add F-Modifier Operator *********************** */
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Add F-Modifier Operator
|
||||
* \{ */
|
||||
|
||||
static const EnumPropertyItem *graph_fmodifier_itemf(bContext *C,
|
||||
PointerRNA *UNUSED(ptr),
|
||||
|
|
@ -2596,7 +2678,11 @@ void GRAPH_OT_fmodifier_add(wmOperatorType *ot)
|
|||
ot->srna, "only_active", 1, "Only Active", "Only add F-Modifier to active F-Curve");
|
||||
}
|
||||
|
||||
/* ******************** Copy F-Modifiers Operator *********************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Copy F-Modifiers Operator
|
||||
* \{ */
|
||||
|
||||
static int graph_fmodifier_copy_exec(bContext *C, wmOperator *op)
|
||||
{
|
||||
|
|
@ -2658,7 +2744,11 @@ void GRAPH_OT_fmodifier_copy(wmOperatorType *ot)
|
|||
#endif
|
||||
}
|
||||
|
||||
/* ******************** Paste F-Modifiers Operator *********************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Paste F-Modifiers Operator
|
||||
* \{ */
|
||||
|
||||
static int graph_fmodifier_paste_exec(bContext *C, wmOperator *op)
|
||||
{
|
||||
|
|
@ -2746,10 +2836,14 @@ void GRAPH_OT_fmodifier_paste(wmOperatorType *ot)
|
|||
"Replace existing F-Modifiers, instead of just appending to the end of the existing list");
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
||||
/* ************************************************************************** */
|
||||
/* Drivers */
|
||||
|
||||
/* ******************** Copy Driver Vars Operator *********************** */
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Copy Driver Variables Operator
|
||||
* \{ */
|
||||
|
||||
static int graph_driver_vars_copy_exec(bContext *C, wmOperator *op)
|
||||
{
|
||||
|
|
@ -2786,7 +2880,11 @@ void GRAPH_OT_driver_variables_copy(wmOperatorType *ot)
|
|||
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
|
||||
}
|
||||
|
||||
/* ******************** Paste Driver Vars Operator *********************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Paste Driver Variables Operator
|
||||
* \{ */
|
||||
|
||||
static int graph_driver_vars_paste_exec(bContext *C, wmOperator *op)
|
||||
{
|
||||
|
|
@ -2838,7 +2936,11 @@ void GRAPH_OT_driver_variables_paste(wmOperatorType *ot)
|
|||
"existing list");
|
||||
}
|
||||
|
||||
/* ************************************************************************** */
|
||||
/** \} */
|
||||
|
||||
/* -------------------------------------------------------------------- */
|
||||
/** \name Delete Invalid Drivers Operator
|
||||
* \{ */
|
||||
|
||||
static int graph_driver_delete_invalid_exec(bContext *C, wmOperator *op)
|
||||
{
|
||||
|
|
@ -2926,3 +3028,5 @@ void GRAPH_OT_driver_delete_invalid(wmOperatorType *ot)
|
|||
/* Flags */
|
||||
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
|
||||
}
|
||||
|
||||
/** \} */
|
||||
|
|
|
|||
Loading…
Reference in New Issue