ED_anim_api.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2008 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "BKE_nla.hh"
 
#include "BLI_sys_types.h"
#include "BLI_utildefines.h"
 
#include "DNA_screen_types.h"
#include "DNA_space_types.h"
 
#include <optional>
 
struct AnimData;
struct Depsgraph;
struct ID;
struct ListBase;
 
struct ARegion;
struct ARegionType;
struct FModifier;
struct Main;
struct NlaStrip;
struct NlaTrack;
struct PanelType;
struct ReportList;
struct ScrArea;
struct SpaceLink;
struct View2D;
struct ViewLayer;
struct rctf;
struct bContext;
struct wmKeyConfig;
 
struct Object;
struct Scene;
 
struct bDopeSheet;
 
struct FCurve;
struct FModifier;
struct bAction;
 
struct uiBlock;
 
struct PointerRNA;
struct PropertyRNA;
 
struct MPathTarget;
 
namespace blender::animrig {
class Action;
class Slot;
}  // namespace blender::animrig
 
/* ************************************************ */
/* ANIMATION CHANNEL FILTERING */
/* `anim_filter.cc` */
 
/* -------------------------------------------------------------------- */

enum eAnimCont_Types {
  ANIMCONT_NONE = 0,
  ANIMCONT_ACTION = 1,
  ANIMCONT_SHAPEKEY = 2,
  ANIMCONT_GPENCIL = 3,
  ANIMCONT_DOPESHEET = 4,
  ANIMCONT_FCURVES = 5,
  ANIMCONT_DRIVERS = 6,
  ANIMCONT_NLA = 7,
  ANIMCONT_CHANNEL = 8,
  ANIMCONT_MASK = 9,
  ANIMCONT_TIMELINE = 10,
};

struct bAnimContext {
  void *data;
  eAnimCont_Types datatype;

  eAnimEdit_Context dopesheet_mode;
  eGraphEdit_Mode grapheditor_mode;

  eSpace_Type spacetype;
  eRegion_Type regiontype;

  ScrArea *area;
  SpaceLink *sl;
  ARegion *region;

  bDopeSheet *ads;

  Main *bmain;
  Scene *scene;
  ViewLayer *view_layer;
  Depsgraph *depsgraph;
  Object *obact;
  ListBase *markers;

  ReportList *reports;
};

 
/* -------------------------------------------------------------------- */

enum eAnim_ChannelType {
  ANIMTYPE_NONE = 0,
  ANIMTYPE_ANIMDATA,
  ANIMTYPE_SPECIALDATA__UNUSED,
 
  ANIMTYPE_SUMMARY,
 
  ANIMTYPE_SCENE,
  ANIMTYPE_OBJECT,
  ANIMTYPE_GROUP,
  ANIMTYPE_FCURVE,
 
  ANIMTYPE_NLACONTROLS,
  ANIMTYPE_NLACURVE,
 
  ANIMTYPE_FILLACT_LAYERED, /* Layered Actions. */
  ANIMTYPE_ACTION_SLOT,
  ANIMTYPE_FILLACTD, /* Legacy Actions. */
  ANIMTYPE_FILLDRIVERS,
 
  ANIMTYPE_DSMAT,
  ANIMTYPE_DSLAM,
  ANIMTYPE_DSCAM,
  ANIMTYPE_DSCACHEFILE,
  ANIMTYPE_DSCUR,
  ANIMTYPE_DSSKEY,
  ANIMTYPE_DSWOR,
  ANIMTYPE_DSNTREE,
  ANIMTYPE_DSPART,
  ANIMTYPE_DSMBALL,
  ANIMTYPE_DSARM,
  ANIMTYPE_DSMESH,
  ANIMTYPE_DSTEX,
  ANIMTYPE_DSLAT,
  ANIMTYPE_DSLINESTYLE,
  ANIMTYPE_DSSPK,
  ANIMTYPE_DSGPENCIL,
  ANIMTYPE_DSMCLIP,
  ANIMTYPE_DSHAIR,
  ANIMTYPE_DSPOINTCLOUD,
  ANIMTYPE_DSVOLUME,
  ANIMTYPE_DSLIGHTPROBE,
 
  ANIMTYPE_SHAPEKEY,
 
  ANIMTYPE_GPLAYER,
 
  ANIMTYPE_GREASE_PENCIL_DATABLOCK,
  ANIMTYPE_GREASE_PENCIL_LAYER_GROUP,
  ANIMTYPE_GREASE_PENCIL_LAYER,
 
  ANIMTYPE_MASKDATABLOCK,
  ANIMTYPE_MASKLAYER,
 
  ANIMTYPE_NLATRACK,
  ANIMTYPE_NLAACTION,
 
  ANIMTYPE_PALETTE,
 
  /* always as last item, the total number of channel types... */
  ANIMTYPE_NUM_TYPES,
};

enum eAnim_KeyType {
  ALE_NONE = 0, /* no keyframe data */
  ALE_FCURVE,   /* F-Curve */
  ALE_GPFRAME,  /* Grease Pencil Frames (Legacy) */
  ALE_MASKLAY,  /* Mask */
  ALE_NLASTRIP, /* NLA Strips */
 
  ALE_ALL,            /* All channels summary */
  ALE_SCE,            /* Scene summary */
  ALE_OB,             /* Object summary */
  ALE_ACT,            /* Action summary (legacy). */
  ALE_GROUP,          /* Action Group summary (legacy). */
  ALE_ACTION_LAYERED, /* Action summary (layered). */
  ALE_ACTION_SLOT,    /* Action slot summary. */
 
  ALE_GREASE_PENCIL_CEL,   /* Grease Pencil Cels. */
  ALE_GREASE_PENCIL_DATA,  /* Grease Pencil Cels summary. */
  ALE_GREASE_PENCIL_GROUP, /* Grease Pencil Layer Groups. */
};

enum eAnim_Update_Flags {
  ANIM_UPDATE_DEPS = (1 << 0),
  ANIM_UPDATE_ORDER = (1 << 1),
  ANIM_UPDATE_HANDLES = (1 << 2),
};
ENUM_OPERATORS(eAnim_Update_Flags, ANIM_UPDATE_HANDLES);
 
/* used for most tools which change keyframes (flushed by ANIM_animdata_update) */
#define ANIM_UPDATE_DEFAULT (ANIM_UPDATE_DEPS | ANIM_UPDATE_ORDER | ANIM_UPDATE_HANDLES)
#define ANIM_UPDATE_DEFAULT_NOHANDLES (ANIM_UPDATE_DEFAULT & ~ANIM_UPDATE_HANDLES)

struct bAnimListElem {
  bAnimListElem *next, *prev;

  void *data;
  eAnim_ChannelType type;
  int flag;
  int index;
  int32_t slot_handle;

  eAnim_Update_Flags update;
  char tag;

  eAnim_KeyType datatype;
  void *key_data;

  ID *id;
  AnimData *adt;
  Main *bmain;

  ID *fcurve_owner_id;

  void *owner;
};

 
/* -------------------------------------------------------------------- */
 
/* filtering flags  - under what circumstances should a channel be returned */
enum eAnimFilter_Flags {
  ANIMFILTER_DATA_VISIBLE = (1 << 0),
  ANIMFILTER_LIST_VISIBLE = (1 << 1),
  ANIMFILTER_CURVE_VISIBLE = (1 << 2),

  ANIMFILTER_LIST_CHANNELS = (1 << 3),

  ANIMFILTER_ACTIVE = (1 << 4),
  ANIMFILTER_ACTGROUPED = (1 << 5),

  ANIMFILTER_SEL = (1 << 6),
  ANIMFILTER_UNSEL = (1 << 7),

  ANIMFILTER_FOREDIT = (1 << 8),
  ANIMFILTER_SELEDIT = (1 << 9),

  ANIMFILTER_ANIMDATA = (1 << 10),

  ANIMFILTER_NODUPLIS = (1 << 11),

  ANIMFILTER_FCURVESONLY = (1 << 12),

  ANIMFILTER_TMP_PEEK = (1 << 30),

  ANIMFILTER_TMP_IGNORE_ONLYSEL = (1u << 31),
 
};
ENUM_OPERATORS(eAnimFilter_Flags, ANIMFILTER_TMP_IGNORE_ONLYSEL);

 
/* -------------------------------------------------------------------- */
 
/* XXX check on all of these flags again. */
 
/* Dope-sheet only. */
/* 'Scene' channels */
#define SEL_SCEC(sce) (CHECK_TYPE_INLINE(sce, Scene *), ((sce->flag & SCE_DS_SELECTED)))
#define EXPANDED_SCEC(sce) (CHECK_TYPE_INLINE(sce, Scene *), ((sce->flag & SCE_DS_COLLAPSED) == 0))
/* 'Sub-Scene' channels (flags stored in Data block) */
#define FILTER_WOR_SCED(wo) (CHECK_TYPE_INLINE(wo, World *), (wo->flag & WO_DS_EXPAND))
#define FILTER_LS_SCED(linestyle) ((linestyle->flag & LS_DS_EXPAND))
/* 'Object' channels */
#define SEL_OBJC(base) (CHECK_TYPE_INLINE(base, Base *), ((base->flag & SELECT)))
#define EXPANDED_OBJC(ob) \
  (CHECK_TYPE_INLINE(ob, Object *), (((ob)->nlaflag & OB_ADS_COLLAPSED) == 0))
/* 'Sub-object' channels (flags stored in Data block) */
#define FILTER_SKE_OBJD(key) (CHECK_TYPE_INLINE(key, Key *), ((key->flag & KEY_DS_EXPAND)))
#define FILTER_MAT_OBJD(ma) (CHECK_TYPE_INLINE(ma, Material *), ((ma->flag & MA_DS_EXPAND)))
#define FILTER_LAM_OBJD(la) (CHECK_TYPE_INLINE(la, Light *), ((la->flag & LA_DS_EXPAND)))
#define FILTER_CAM_OBJD(ca) (CHECK_TYPE_INLINE(ca, Camera *), ((ca->flag & CAM_DS_EXPAND)))
#define FILTER_CACHEFILE_OBJD(cf) \
  (CHECK_TYPE_INLINE(cf, CacheFile *), (((cf)->flag & CACHEFILE_DS_EXPAND)))
#define FILTER_CUR_OBJD(cu) (CHECK_TYPE_INLINE(cu, Curve *), ((cu->flag & CU_DS_EXPAND)))
#define FILTER_PART_OBJD(part) \
  (CHECK_TYPE_INLINE(part, ParticleSettings *), (((part)->flag & PART_DS_EXPAND)))
#define FILTER_MBALL_OBJD(mb) (CHECK_TYPE_INLINE(mb, MetaBall *), ((mb->flag2 & MB_DS_EXPAND)))
#define FILTER_ARM_OBJD(arm) (CHECK_TYPE_INLINE(arm, bArmature *), ((arm->flag & ARM_DS_EXPAND)))
#define FILTER_MESH_OBJD(me) (CHECK_TYPE_INLINE(me, Mesh *), ((me->flag & ME_DS_EXPAND)))
#define FILTER_LATTICE_OBJD(lt) (CHECK_TYPE_INLINE(lt, Lattice *), ((lt->flag & LT_DS_EXPAND)))
#define FILTER_SPK_OBJD(spk) (CHECK_TYPE_INLINE(spk, Speaker *), ((spk->flag & SPK_DS_EXPAND)))
#define FILTER_CURVES_OBJD(ha) (CHECK_TYPE_INLINE(ha, Curves *), ((ha->flag & HA_DS_EXPAND)))
#define FILTER_POINTS_OBJD(pt) (CHECK_TYPE_INLINE(pt, PointCloud *), ((pt->flag & PT_DS_EXPAND)))
#define FILTER_VOLUME_OBJD(vo) (CHECK_TYPE_INLINE(vo, Volume *), ((vo->flag & VO_DS_EXPAND)))
#define FILTER_LIGHTPROBE_OBJD(probe) \
  (CHECK_TYPE_INLINE(probe, LightProbe *), ((probe->flag & LIGHTPROBE_DS_EXPAND)))
/* Variable use expanders */
#define FILTER_NTREE_DATA(ntree) \
  (CHECK_TYPE_INLINE(ntree, bNodeTree *), (((ntree)->flag & NTREE_DS_EXPAND)))
#define FILTER_TEX_DATA(tex) (CHECK_TYPE_INLINE(tex, Tex *), ((tex->flag & TEX_DS_EXPAND)))
 
/* 'Sub-object/Action' channels (flags stored in Action) */
#define SEL_ACTC(actc) ((actc->flag & ACT_SELECTED))
#define EXPANDED_ACTC(actc) ((actc->flag & ACT_COLLAPSED) == 0)
/* 'Sub-AnimData' channels */
#define EXPANDED_DRVD(adt) ((adt->flag & ADT_DRIVERS_COLLAPSED) == 0)
#define EXPANDED_ADT(adt) ((adt->flag & ADT_UI_EXPANDED) != 0)
 
/* Actions (also used for Dope-sheet). */
#define EDITABLE_AGRP(agrp) (((agrp)->flag & AGRP_PROTECTED) == 0)
#define EXPANDED_AGRP(ac, agrp) \
  (((!(ac) || ((ac)->spacetype != SPACE_GRAPH)) && ((agrp)->flag & AGRP_EXPANDED)) || \
   (((ac) && ((ac)->spacetype == SPACE_GRAPH)) && ((agrp)->flag & AGRP_EXPANDED_G)))
#define SEL_AGRP(agrp) (((agrp)->flag & AGRP_SELECTED) || ((agrp)->flag & AGRP_ACTIVE))
#define EDITABLE_FCU(fcu) (((fcu)->flag & FCURVE_PROTECTED) == 0)
#define SEL_FCU(fcu) ((fcu)->flag & FCURVE_SELECTED)
 
/* ShapeKey mode only */
#define EDITABLE_SHAPEKEY(kb) ((kb->flag & KEYBLOCK_LOCKED) == 0)
#define SEL_SHAPEKEY(kb) (kb->flag & KEYBLOCK_SEL)
 
/* Grease Pencil only */
#define EXPANDED_GPD(gpd) (gpd->flag & GP_DATA_EXPAND)
#define EDITABLE_GPL(gpl) ((gpl->flag & GP_LAYER_LOCKED) == 0)
#define SEL_GPL(gpl) (gpl->flag & GP_LAYER_SELECT)
 
/* Mask Only */
#define EXPANDED_MASK(mask) (mask->flag & MASK_ANIMF_EXPAND)
#define EDITABLE_MASK(masklay) ((masklay->flag & MASK_LAYERFLAG_LOCKED) == 0)
#define SEL_MASKLAY(masklay) (masklay->flag & SELECT)
 
/* NLA only */
#define SEL_NLT(nlt) (nlt->flag & NLATRACK_SELECTED)
#define EDITABLE_NLT(nlt) ((nlt->flag & NLATRACK_PROTECTED) == 0)
 
/* Movie clip only */
#define EXPANDED_MCLIP(clip) (clip->flag & MCLIP_DATA_EXPAND)
 
/* Palette only */
#define EXPANDED_PALETTE(palette) (palette->flag & PALETTE_DATA_EXPAND)
 
/* AnimData - NLA mostly... */
#define SEL_ANIMDATA(adt) (adt->flag & ADT_UI_SELECTED)

 
/* -------------------------------------------------------------------- */

#define NLATRACK_FIRST_TOP(ac) \
  (UI_view2d_scale_get_y(&(ac)->region->v2d) * -UI_TIME_SCRUB_MARGIN_Y - NLATRACK_SKIP)
#define NLATRACK_HEIGHT(snla) \
  (((snla) && ((snla)->flag & SNLA_NOSTRIPCURVES)) ? (0.8f * U.widget_unit) : \
                                                     (1.2f * U.widget_unit))
#define NLATRACK_SKIP (0.1f * U.widget_unit)
#define NLATRACK_STEP(snla) (NLATRACK_HEIGHT(snla) + NLATRACK_SKIP)
#define NLATRACK_TOT_HEIGHT(ac, item_amount) \
  (-NLATRACK_FIRST_TOP(ac) + NLATRACK_STEP(((SpaceNla *)(ac)->sl)) * (item_amount + 1))

#define NLATRACK_NAMEWIDTH (10 * U.widget_unit)

 
/* -------------------------------------------------------------------- */

size_t ANIM_animfilter_action_slot(bAnimContext *ac,
                                   ListBase * /* bAnimListElem */ anim_data,
                                   blender::animrig::Action &action,
                                   blender::animrig::Slot &slot,
                                   eAnimFilter_Flags filter_mode,
                                   ID *animated_id);

size_t ANIM_animdata_filter(bAnimContext *ac,
                            ListBase *anim_data,
                            eAnimFilter_Flags filter_mode,
                            void *data,
                            eAnimCont_Types datatype);

bool ANIM_animdata_get_context(const bContext *C, bAnimContext *ac);

bool ANIM_animdata_context_getdata(bAnimContext *ac);

void ANIM_animdata_update(bAnimContext *ac, ListBase *anim_data);
 
void ANIM_animdata_freelist(ListBase *anim_data);

bool ANIM_animdata_can_have_greasepencil(const eAnimCont_Types type);
 
/* ************************************************ */
/* ANIMATION CHANNELS LIST */
/* anim_channels_*.c */

 
/* -------------------------------------------------------------------- */

enum eAnimChannel_Role {
  ACHANNEL_ROLE_EXPANDER = -1,
  /* ACHANNEL_ROLE_SPECIAL = 0, */ /* UNUSED */
  ACHANNEL_ROLE_CHANNEL = 1,
};
 
/* flag-setting behavior */
enum eAnimChannels_SetFlag {
  ACHANNEL_SETFLAG_CLEAR = 0,
  ACHANNEL_SETFLAG_ADD = 1,
  ACHANNEL_SETFLAG_INVERT = 2,
  ACHANNEL_SETFLAG_TOGGLE = 3,
  ACHANNEL_SETFLAG_EXTEND_RANGE = 4,
};
 
/* types of settings for AnimChannels */
enum eAnimChannel_Settings {
  ACHANNEL_SETTING_SELECT = 0,
  ACHANNEL_SETTING_PROTECT = 1,
  ACHANNEL_SETTING_MUTE = 2,
  ACHANNEL_SETTING_EXPAND = 3,
  ACHANNEL_SETTING_VISIBLE = 4,
  ACHANNEL_SETTING_SOLO = 5,
  ACHANNEL_SETTING_PINNED = 6,
  ACHANNEL_SETTING_MOD_OFF = 7,
  ACHANNEL_SETTING_ALWAYS_VISIBLE = 8,
};

struct bAnimChannelType {
  /* -- Type data -- */
  /* name of the channel type, for debugging */
  const char *channel_type_name;
  /* "level" or role in hierarchy - for finding the active channel */
  eAnimChannel_Role channel_role;
 
  /* -- Drawing -- */
  void (*get_backdrop_color)(bAnimContext *ac, bAnimListElem *ale, float r_color[3]);

  bool (*get_channel_color)(const bAnimListElem *ale, uint8_t r_color[3]);

  void (*draw_backdrop)(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
  short (*get_indent_level)(bAnimContext *ac, bAnimListElem *ale);
  short (*get_offset)(bAnimContext *ac, bAnimListElem *ale);

  void (*name)(bAnimListElem *ale, char *name);
  bool (*name_prop)(bAnimListElem *ale, PointerRNA *r_ptr, PropertyRNA **r_prop);
  int (*icon)(bAnimListElem *ale);
 
  /* -- Settings -- */
  bool (*has_setting)(bAnimContext *ac, bAnimListElem *ale, eAnimChannel_Settings setting);
  int (*setting_flag)(bAnimContext *ac, eAnimChannel_Settings setting, bool *r_neg);
  void *(*setting_ptr)(bAnimListElem *ale, eAnimChannel_Settings setting, short *r_type);

  void (*setting_post_update)(Main &bmain,
                              const bAnimListElem &ale,
                              eAnimChannel_Settings setting);
};

/* -------------------------------------------------------------------- */
 
float ANIM_UI_get_keyframe_scale_factor();
float ANIM_UI_get_channel_height();
float ANIM_UI_get_channel_skip();
float ANIM_UI_get_first_channel_top(View2D *v2d);
float ANIM_UI_get_channel_step();
float ANIM_UI_get_channels_total_height(View2D *v2d, int item_count);
float ANIM_UI_get_channel_name_width();
float ANIM_UI_get_channel_button_width();

 
/* -------------------------------------------------------------------- */

const bAnimChannelType *ANIM_channel_get_typeinfo(const bAnimListElem *ale);

void ANIM_channel_debug_print_info(bAnimContext &ac, bAnimListElem *ale, short indent_level);

bAction *ANIM_channel_action_get(const bAnimListElem *ale);

void ANIM_channel_draw(
    bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc, size_t channel_index);
void ANIM_channel_draw_widgets(const bContext *C,
                               bAnimContext *ac,
                               bAnimListElem *ale,
                               uiBlock *block,
                               const rctf *rect,
                               size_t channel_index);

 
/* -------------------------------------------------------------------- */

short ANIM_channel_setting_get(bAnimContext *ac,
                               bAnimListElem *ale,
                               eAnimChannel_Settings setting);

void ANIM_channel_setting_set(bAnimContext *ac,
                              bAnimListElem *ale,
                              eAnimChannel_Settings setting,
                              eAnimChannels_SetFlag mode);

void ANIM_flush_setting_anim_channels(bAnimContext *ac,
                                      ListBase *anim_data,
                                      bAnimListElem *ale_setting,
                                      eAnimChannel_Settings setting,
                                      eAnimChannels_SetFlag mode);
 
void ANIM_frame_channel_y_extents(bContext *C, bAnimContext *ac);

void ANIM_anim_channels_select_set(bAnimContext *ac, eAnimChannels_SetFlag sel);

void ANIM_anim_channels_select_toggle(bAnimContext *ac);

void ANIM_set_active_channel(bAnimContext *ac,
                             void *data,
                             eAnimCont_Types datatype,
                             eAnimFilter_Flags filter,
                             void *channel_data,
                             eAnim_ChannelType channel_type);

bool ANIM_is_active_channel(bAnimListElem *ale);

void ANIM_deselect_keys_in_animation_editors(bContext *C);
 
/* ************************************************ */
/* DRAWING API */
/* `anim_draw.cc` */

 
/* -------------------------------------------------------------------- */
 
/* flags for Current Frame Drawing */
enum eAnimEditDraw_CurrentFrame {
  /* DRAWCFRA_PLAIN = 0, */ /* UNUSED */
  DRAWCFRA_UNIT_SECONDS = (1 << 0),
  DRAWCFRA_WIDE = (1 << 1),
};

void ANIM_draw_cfra(const bContext *C, View2D *v2d, short flag);

 
/* -------------------------------------------------------------------- */

void ANIM_draw_previewrange(const Scene *scene, View2D *v2d, int end_frame_width);

 
/* -------------------------------------------------------------------- */

void ANIM_draw_framerange(Scene *scene, View2D *v2d);

void ANIM_draw_action_framerange(
    AnimData *adt, bAction *action, View2D *v2d, float ymin, float ymax);
 
/* ************************************************* */
/* F-MODIFIER TOOLS */

 
/* -------------------------------------------------------------------- */
 
bool ANIM_nla_context_track_ptr(const bContext *C, PointerRNA *r_ptr);
bool ANIM_nla_context_strip_ptr(const bContext *C, PointerRNA *r_ptr);
 
NlaTrack *ANIM_nla_context_track(const bContext *C);
NlaStrip *ANIM_nla_context_strip(const bContext *C);
FCurve *ANIM_graph_context_fcurve(const bContext *C);

using PanelTypePollFn = bool (*)(const bContext *C, PanelType *pt);
using uiListPanelIDFromDataFunc = void (*)(void *data_link, char *r_idname);

void ANIM_fmodifier_panels(const bContext *C,
                           ID *owner_id,
                           ListBase *fmodifiers,
                           uiListPanelIDFromDataFunc panel_id_fn);
 
void ANIM_modifier_panels_register_graph_and_NLA(ARegionType *region_type,
                                                 const char *modifier_panel_prefix,
                                                 PanelTypePollFn poll_function);
void ANIM_modifier_panels_register_graph_only(ARegionType *region_type,
                                              const char *modifier_panel_prefix,
                                              PanelTypePollFn poll_function);

 
/* -------------------------------------------------------------------- */

void ANIM_fmodifiers_copybuf_free();

bool ANIM_fmodifiers_copy_to_buf(ListBase *modifiers, bool active);

bool ANIM_fmodifiers_paste_from_buf(ListBase *modifiers, bool replace, FCurve *curve);
 
/* ************************************************* */
/* ASSORTED TOOLS */

 
/* -------------------------------------------------------------------- */
 
/* `anim_ipo_utils.cc` */

std::optional<int> getname_anim_fcurve(char *name, ID *id, FCurve *fcu);

std::string getname_anim_fcurve_for_slot(Main &bmain,
                                         const blender::animrig::Slot &slot,
                                         FCurve &fcurve);

void getcolor_fcurve_rainbow(int cur, int tot, float out[3]);

 
/* -------------------------------------------------------------------- */

void nla_action_get_color(AnimData *adt, bAction *act, float color[4]);

 
/* -------------------------------------------------------------------- */
 
/* `anim_draw.cc` */

bool ANIM_nla_mapping_allowed(const bAnimListElem *ale);

float ANIM_nla_tweakedit_remap(bAnimListElem *ale, float cframe, eNlaTime_ConvertModes mode);

void ANIM_nla_mapping_apply_fcurve(AnimData *adt, FCurve *fcu, bool restore, bool only_keys);

void ANIM_nla_mapping_apply_if_needed_fcurve(bAnimListElem *ale,
                                             FCurve *fcu,
                                             bool restore,
                                             bool only_keys);
 
/* ..... */

void ED_nla_postop_refresh(bAnimContext *ac);

 
/* -------------------------------------------------------------------- */
 
/* `anim_draw.cc` */

enum eAnimUnitConv_Flags {
  ANIM_UNITCONV_NONE = 0,
  ANIM_UNITCONV_RESTORE = (1 << 0),
  ANIM_UNITCONV_ONLYKEYS = (1 << 1),
  ANIM_UNITCONV_ONLYSEL = (1 << 2),
  ANIM_UNITCONV_SELVERTS = (1 << 3),
  /* ANIM_UNITCONV_SKIPKNOTS = (1 << 4), */ /* UNUSED */
  ANIM_UNITCONV_NORMALIZE = (1 << 5),
  ANIM_UNITCONV_NORMALIZE_FREEZE = (1 << 6),
};

short ANIM_get_normalization_flags(SpaceLink *space_link);
float ANIM_unit_mapping_get_factor(Scene *scene, ID *id, FCurve *fcu, short flag, float *r_offset);

 
/* -------------------------------------------------------------------- */

#define ACHANNEL_SET_FLAG(channel, smode, sflag) \
  { \
    if (smode == ACHANNEL_SETFLAG_INVERT) { \
      (channel)->flag ^= (sflag); \
    } \
    else if (smode == ACHANNEL_SETFLAG_ADD) { \
      (channel)->flag |= (sflag); \
    } \
    else { \
      (channel)->flag &= ~(sflag); \
    } \
  } \
  ((void)0)

#define ACHANNEL_SET_FLAG_NEG(channel, smode, sflag) \
  { \
    if (smode == ACHANNEL_SETFLAG_INVERT) { \
      (channel)->flag ^= (sflag); \
    } \
    else if (smode == ACHANNEL_SETFLAG_ADD) { \
      (channel)->flag &= ~(sflag); \
    } \
    else { \
      (channel)->flag |= (sflag); \
    } \
  } \
  ((void)0)

 
/* `anim_deps.cc` */
 
/* -------------------------------------------------------------------- */

void ANIM_id_update(Main *bmain, ID *id);
void ANIM_list_elem_update(Main *bmain, Scene *scene, bAnimListElem *ale);
 
/* data -> channels syncing */

void ANIM_sync_animchannels_to_data(const bContext *C);
 
void ANIM_center_frame(bContext *C, int smooth_viewtx);

rctf ANIM_frame_range_view2d_add_xmargin(const View2D &view_2d, rctf view_rect);

 
/* -------------------------------------------------------------------- */
 
/* generic animation channels */
void ED_operatortypes_animchannels();
void ED_keymap_animchannels(wmKeyConfig *keyconf);
 
/* generic time editing */
void ED_operatortypes_anim();
void ED_keymap_anim(wmKeyConfig *keyconf);
 
/* space_graph */
void ED_operatormacros_graph();
/* space_action */
void ED_operatormacros_action();
/* space_nla */
void ED_operatormacros_nla();

 
/* -------------------------------------------------------------------- */
 
/* XXX: Should we be doing these here, or at all? */

AnimData *ED_actedit_animdata_from_context(const bContext *C, ID **r_adt_id_owner);
void ED_animedit_unlink_action(
    bContext *C, ID *id, AnimData *adt, bAction *act, ReportList *reports, bool force_delete);

void ED_drivers_editor_init(bContext *C, ScrArea *area);
 
/* ************************************************ */
 
enum eAnimvizCalcRange {
  ANIMVIZ_CALC_RANGE_CURRENT_FRAME,

  ANIMVIZ_CALC_RANGE_CHANGED,

  ANIMVIZ_CALC_RANGE_FULL,
};
 
Depsgraph *animviz_depsgraph_build(Main *bmain,
                                   Scene *scene,
                                   ViewLayer *view_layer,
                                   blender::Span<MPathTarget *> targets);
 
void animviz_calc_motionpaths(Depsgraph *depsgraph,
                              Main *bmain,
                              Scene *scene,
                              blender::MutableSpan<MPathTarget *> targets,
                              eAnimvizCalcRange range,
                              bool restore);

void animviz_motionpath_compute_range(Object *ob, Scene *scene);

void animviz_build_motionpath_targets(Object *ob, blender::Vector<MPathTarget *> &r_targets);

void animviz_free_motionpath_targets(blender::Vector<MPathTarget *> &targets);