Blender V5.3
ED_keyframes_edit.hh File Reference
#include "BLI_array.hh"
#include "BLI_enum_flags.hh"
#include "BLI_math_vector_types.hh"
#include "ED_anim_api.hh"
#include "DNA_curve_types.h"
#include "DNA_listBase.h"

Go to the source code of this file.

Classes

struct  blender::KeyframeEdit_LassoData
struct  blender::KeyframeEdit_CircleData
struct  blender::CfraElem
struct  blender::KeyframeEditData
struct  blender::KeyframeEditCD_Remap
struct  blender::FCurveSegment
struct  blender::KeyframePasteContext

Namespaces

namespace  blender
 BMesh Iterators.

Typedefs

Function Pointer Typedefs
using blender::FcuEditFunc = void (*)(FCurve &fcu)
using blender::KeyframeEditFunc = short (*)(KeyframeEditData *ked, BezTriple *bezt)

Enumerations

Tool Flags

Common macros and defines.

enum  blender::eEditKeyframes_Validate {
  blender::BEZT_OK_FRAME = 1 , blender::BEZT_OK_FRAMERANGE , blender::BEZT_OK_SELECTED , blender::BEZT_OK_SELECTED_KEY ,
  blender::BEZT_OK_VALUE , blender::BEZT_OK_VALUERANGE , blender::BEZT_OK_REGION , blender::BEZT_OK_REGION_LASSO ,
  blender::BEZT_OK_REGION_CIRCLE , blender::BEZT_OK_CHANNEL_LASSO , blender::BEZT_OK_CHANNEL_CIRCLE
}
Tool Modes
enum  blender::eEditKeyframes_Select {
  blender::SELECT_REPLACE = (1 << 0) , blender::SELECT_ADD = (1 << 1) , blender::SELECT_SUBTRACT = (1 << 2) , blender::SELECT_INVERT = (1 << 3) ,
  blender::SELECT_EXTEND_RANGE = (1 << 4)
}
enum  blender::eEditKeyframes_SelMap { blender::SELMAP_MORE = 0 , blender::SELMAP_LESS }
enum  blender::eEditKeyframes_Snap {
  blender::SNAP_KEYS_CURFRAME = 1 , blender::SNAP_KEYS_NEARFRAME , blender::SNAP_KEYS_NEARSEC , blender::SNAP_KEYS_NEARMARKER ,
  blender::SNAP_KEYS_HORIZONTAL , blender::SNAP_KEYS_VALUE , blender::SNAP_KEYS_TIME
}
enum  blender::eEditKeyframes_Equalize { blender::EQUALIZE_HANDLES_LEFT = (1 << 0) , blender::EQUALIZE_HANDLES_RIGHT = (1 << 1) , blender::EQUALIZE_HANDLES_BOTH = (EQUALIZE_HANDLES_LEFT | EQUALIZE_HANDLES_RIGHT) }
enum  blender::eEditKeyframes_Mirror {
  blender::MIRROR_KEYS_CURFRAME = 1 , blender::MIRROR_KEYS_YAXIS , blender::MIRROR_KEYS_XAXIS , blender::MIRROR_KEYS_MARKER ,
  blender::MIRROR_KEYS_VALUE , blender::MIRROR_KEYS_TIME
}
Defines for 'OK' polls + KeyframeEditData Flags

Non-destructive editing API, implemented in keyframes_edit.cc.

enum  blender::eKeyframeVertOk {
  blender::KEYFRAME_NONE = 0 , blender::KEYFRAME_OK_KEY = (1 << 0) , blender::KEYFRAME_OK_H1 = (1 << 1) , blender::KEYFRAME_OK_H2 = (1 << 2) ,
  blender::KEYFRAME_OK_ALL = (KEYFRAME_OK_KEY | KEYFRAME_OK_H1 | KEYFRAME_OK_H2)
}
enum  blender::eKeyframeIterFlags {
  blender::KEYFRAME_ITER_INCL_HANDLES = (1 << 0) , blender::KED_F1_NLA_UNMAP = (1 << 1) , blender::KED_F2_NLA_UNMAP = (1 << 2) , blender::KEYFRAME_ITER_HANDLES_DEFAULT_INVISIBLE = (1 << 3) ,
  blender::KEYFRAME_ITER_HANDLES_INVISIBLE = (1 << 4)
}
Custom Data Type Defines
enum  blender::eKeyPasteOffset { blender::KEYFRAME_PASTE_OFFSET_CFRA_START , blender::KEYFRAME_PASTE_OFFSET_CFRA_END , blender::KEYFRAME_PASTE_OFFSET_CFRA_RELATIVE , blender::KEYFRAME_PASTE_OFFSET_NONE }
enum  blender::eKeyPasteValueOffset {
  blender::KEYFRAME_PASTE_VALUE_OFFSET_LEFT_KEY , blender::KEYFRAME_PASTE_VALUE_OFFSET_RIGHT_KEY , blender::KEYFRAME_PASTE_VALUE_OFFSET_CFRA , blender::KEYFRAME_PASTE_VALUE_OFFSET_CURSOR ,
  blender::KEYFRAME_PASTE_VALUE_OFFSET_NONE
}
enum  blender::eKeyMergeMode { blender::KEYFRAME_PASTE_MERGE_MIX , blender::KEYFRAME_PASTE_MERGE_OVER , blender::KEYFRAME_PASTE_MERGE_OVER_RANGE , blender::KEYFRAME_PASTE_MERGE_OVER_RANGE_ALL }
enum  blender::eKeyPasteError { blender::KEYFRAME_PASTE_OK , blender::KEYFRAME_PASTE_NOTHING_TO_PASTE , blender::KEYFRAME_PASTE_NOWHERE_TO_PASTE }
Destructive Editing API

Implemented in keyframes_general.cc.

enum class  blender::FCurveSegmentAnchor { blender::LEFT , blender::RIGHT }
enum  blender::tShearDirection { blender::SHEAR_FROM_LEFT = 1 , blender::SHEAR_FROM_RIGHT }

Functions

short blender::ANIM_fcurve_keyframes_loop (KeyframeEditData *ked, FCurve *fcu, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
void blender::ANIM_fcurve_equalize_keyframes_loop (FCurve *fcu, const eEditKeyframes_Equalize mode, const float handle_length, const bool flatten)
short blender::ANIM_animchannel_keyframes_loop (KeyframeEditData *ked, bDopeSheet *ads, bAnimListElem *ale, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb)
void blender::ANIM_animdata_keyframe_callback (bAnimContext *ac, eAnimFilter_Flags filter, KeyframeEditFunc callback_fn)
void blender::ANIM_editkeyframes_refresh (bAnimContext *ac)
KeyframeEditFunc blender::ANIM_editkeyframes_mirror (short mode)
KeyframeEditFunc blender::ANIM_editkeyframes_handles (short mode)
KeyframeEditFunc blender::ANIM_editkeyframes_ipo (short mode)
KeyframeEditFunc blender::ANIM_editkeyframes_buildselmap (short mode)
short blender::bezt_selmap_flush (KeyframeEditData *ked, BezTriple *bezt)
short blender::bezt_calc_average (KeyframeEditData *ked, BezTriple *bezt)
short blender::bezt_to_cfraelem (KeyframeEditData *ked, BezTriple *bezt)
void blender::bezt_remap_times (KeyframeEditData *ked, BezTriple *bezt)
BezTriple Callback Getters
KeyframeEditFunc blender::ANIM_editkeyframes_ok (short mode)
KeyframeEditFunc blender::ANIM_editkeyframes_snap (short mode)
KeyframeEditFunc blender::ANIM_editkeyframes_select (const eEditKeyframes_Select selectmode)
KeyframeEditFunc blender::ANIM_editkeyframes_keytype (const eBezTriple_KeyframeType keyframe_type)
KeyframeEditFunc blender::ANIM_editkeyframes_easing (short mode)
1.5-D Region Testing Utilities (Lasso/Circle Select)
bool blender::keyframe_region_lasso_test (const KeyframeEdit_LassoData *data_lasso, const float xy[2])
bool blender::keyframe_region_circle_test (const KeyframeEdit_CircleData *data_circle, const float xy[2])
Duplicate Keys
bool blender::duplicate_fcurve_keys (FCurve *fcu)
Various Tools
float blender::get_default_rna_value (const FCurve *fcu, PropertyRNA *prop, PointerRNA *ptr)
ListBaseT< FCurveSegment > blender::find_fcurve_segments (FCurve *fcu)
void blender::clean_fcurve (bAnimListElem *ale, float thresh, bool cleardefault, const bool only_selected_keys)
void blender::blend_to_neighbor_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float factor)
void blender::breakdown_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float factor)
void blender::scale_average_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float factor)
void blender::push_pull_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float factor)
void blender::scale_from_fcurve_segment_neighbor (FCurve *fcu, FCurveSegment *segment, const float factor, const FCurveSegmentAnchor anchor)
void blender::ED_ANIM_get_1d_gauss_kernel (const float sigma, const int kernel_size, double *r_kernel)
ButterworthCoefficients * blender::ED_anim_allocate_butterworth_coefficients (const int filter_order)
void blender::ED_anim_free_butterworth_coefficients (ButterworthCoefficients *bw_coeff)
void blender::ED_anim_calculate_butterworth_coefficients (const float cutoff_frequency, const float sampling_frequency, ButterworthCoefficients *bw_coeff)
void blender::butterworth_smooth_fcurve_segment (FCurve *fcu, FCurveSegment *segment, float *samples, const int sample_count, const float factor, const int blend_in_out, const int sample_rate, ButterworthCoefficients *bw_coeff)
void blender::smooth_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float *original_values, float *samples, const int sample_count, const float factor, const int kernel_size, const double *kernel)
void blender::ease_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float factor, const float width)
void blender::shear_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float factor, tShearDirection direction)
void blender::blend_offset_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float factor)
void blender::blend_to_ease_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float factor)
void blender::time_offset_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float frame_offset)
bool blender::match_slope_fcurve_segment (FCurve *fcu, FCurveSegment *segment, const float factor)
void blender::blend_to_default_fcurve (PointerRNA *id_ptr, FCurve *fcu, const float factor)
FCurve Decimate
bool blender::decimate_fcurve (bAnimListElem *ale, float remove_ratio, float error_sq_max)
FCurve Smooth
void blender::smooth_fcurve (FCurve *fcu)
Copy/Paste Tools
  • The copy/paste buffer currently stores a set of temporary F-Curves containing only the keyframes that were selected in each of the original F-Curves.
  • All pasted frames are offset by the same amount. This is calculated as the difference in the times of the current frame and the first keyframe (i.e. the earliest one in all channels).
  • The earliest frame is calculated per copy operation.
void blender::ANIM_fcurves_copybuf_reset ()
void blender::ANIM_fcurves_copybuf_free ()
bool blender::copy_animedit_keys (bAnimContext *ac, ListBaseT< bAnimListElem > *anim_data)
eKeyPasteError blender::paste_animedit_keys (bAnimContext *ac, ListBaseT< bAnimListElem > *anim_data, const KeyframePasteContext &paste_context)