ED_keyframes_keylist.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2009 Blender Authors, Joshua Leung. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "BLI_bounds_types.hh"
#include "BLI_math_vector_types.hh"
 
#include "DNA_curve_types.h"
 
#include "ANIM_action.hh"
 
struct AnimData;
struct CacheFile;
struct FCurve;
struct GreasePencil;
struct GreasePencilLayer;
struct GreasePencilLayerTreeGroup;
struct ListBase;
struct MaskLayer;
struct Object;
struct Scene;
struct Strip;
struct bAction;
struct bActionGroup;
struct bAnimContext;
struct bDopeSheet;
struct bGPDlayer;
struct bGPdata;
 
namespace blender::animrig {
class Action;
class Slot;
}  // namespace blender::animrig
 
/* ****************************** Base Structs ****************************** */
 
struct AnimKeylist;

struct ActKeyBlockInfo {
  short flag;
  short conflict;

  char sel;
};

struct ActKeyColumn {
  /* ListBase linkage */
  ActKeyColumn *next, *prev;
 
  /* sorting-tree linkage */
  ActKeyColumn *left, *right;
  ActKeyColumn *parent;
 
  /* keyframe info */
  eBezTriple_KeyframeType key_type;
  char handle_type;
  char extreme_type;
  short sel;
  float cfra;
 
  /* key-block info */
  ActKeyBlockInfo block;
 
  /* number of curves and keys in this column */
  short totcurve, totkey, totblock;
};

enum eActKeyBlock_Hold {
  ACTKEYBLOCK_FLAG_MOVING_HOLD = (1 << 0),
  ACTKEYBLOCK_FLAG_STATIC_HOLD = (1 << 1),
  ACTKEYBLOCK_FLAG_ANY_HOLD = (1 << 2),
  ACTKEYBLOCK_FLAG_NON_BEZIER = (1 << 3),
  ACTKEYBLOCK_FLAG_GPENCIL = (1 << 4),
};
 
/* *********************** Keyframe Drawing ****************************** */

enum eKeyframeShapeDrawOpts {
  /* only the border */
  KEYFRAME_SHAPE_FRAME = 0,
  /* only the inside filling */
  KEYFRAME_SHAPE_INSIDE,
  /* the whole thing */
  KEYFRAME_SHAPE_BOTH,
};

enum eKeyframeHandleDrawOpts {
  /* Don't draw */
  KEYFRAME_HANDLE_NONE = 0,
  /* Various marks in order of increasing display priority. */
  KEYFRAME_HANDLE_AUTO_CLAMP,
  KEYFRAME_HANDLE_AUTO,
  KEYFRAME_HANDLE_VECTOR,
  KEYFRAME_HANDLE_ALIGNED,
  KEYFRAME_HANDLE_FREE,
};

enum eKeyframeExtremeDrawOpts {
  KEYFRAME_EXTREME_NONE = 0,
  KEYFRAME_EXTREME_MIN = (1 << 0),
  KEYFRAME_EXTREME_MAX = (1 << 1),
  KEYFRAME_EXTREME_MIXED = (1 << 2),
  KEYFRAME_EXTREME_FLAT = (1 << 3),
};
 
/* ******************************* Methods ****************************** */
 
AnimKeylist *ED_keylist_create();
void ED_keylist_free(AnimKeylist *keylist);
void ED_keylist_prepare_for_direct_access(AnimKeylist *keylist);
const ActKeyColumn *ED_keylist_find_exact(const AnimKeylist *keylist, float cfra);
const ActKeyColumn *ED_keylist_find_next(const AnimKeylist *keylist, float cfra);
const ActKeyColumn *ED_keylist_find_prev(const AnimKeylist *keylist, float cfra);
const ActKeyColumn *ED_keylist_find_closest(const AnimKeylist *keylist, float cfra);
const ActKeyColumn *ED_keylist_find_any_between(const AnimKeylist *keylist,
                                                const blender::Bounds<float> frame_range);
bool ED_keylist_is_empty(const AnimKeylist *keylist);
const ListBase /*ActKeyColumn*/ *ED_keylist_listbase(const AnimKeylist *keylist);
bool ED_keylist_all_keys_frame_range(const AnimKeylist *keylist,
                                     blender::Bounds<float> *r_frame_range);
bool ED_keylist_selected_keys_frame_range(const AnimKeylist *keylist,
                                          blender::Bounds<float> *r_frame_range);
const ActKeyColumn *ED_keylist_array(const AnimKeylist *keylist);
int64_t ED_keylist_array_len(const AnimKeylist *keylist);
 
/* Key-data Generation --------------- */

void fcurve_to_keylist(AnimData *adt,
                       FCurve *fcu,
                       AnimKeylist *keylist,
                       int saction_flag,
                       blender::float2 range,
                       bool use_nla_remapping);
/* Action Group */
void action_group_to_keylist(AnimData *adt,
                             bActionGroup *agrp,
                             AnimKeylist *keylist,
                             int saction_flag,
                             blender::float2 range);
/* Action */

void action_to_keylist(AnimData *adt,
                       bAction *dna_action,
                       AnimKeylist *keylist,
                       int saction_flag,
                       blender::float2 range);
 
/* Object */
void ob_to_keylist(
    bDopeSheet *ads, Object *ob, AnimKeylist *keylist, int saction_flag, blender::float2 range);
/* Cache File */
void cachefile_to_keylist(bDopeSheet *ads,
                          CacheFile *cache_file,
                          AnimKeylist *keylist,
                          int saction_flag);
/* Scene */
void scene_to_keylist(
    bDopeSheet *ads, Scene *sce, AnimKeylist *keylist, int saction_flag, blender::float2 range);
/* DopeSheet Summary */
void summary_to_keylist(bAnimContext *ac,
                        AnimKeylist *keylist,
                        int saction_flag,
                        blender::float2 range);

void action_slot_summary_to_keylist(bAnimContext *ac,
                                    ID *animated_id,
                                    blender::animrig::Action &action,
                                    blender::animrig::slot_handle_t slot_handle,
                                    AnimKeylist *keylist,
                                    int /* eSAction_Flag */ saction_flag,
                                    blender::float2 range);
 
/* Grease Pencil datablock summary (Legacy) */
void gpencil_to_keylist(bDopeSheet *ads, bGPdata *gpd, AnimKeylist *keylist, bool active);
 
/* Grease Pencil Cels. */
void grease_pencil_cels_to_keylist(AnimData *adt,
                                   const GreasePencilLayer *gpl,
                                   AnimKeylist *keylist,
                                   int saction_flag);
 
/* Grease Pencil Layer Group. */
void grease_pencil_layer_group_to_keylist(AnimData *adt,
                                          const GreasePencilLayerTreeGroup *layer_group,
                                          AnimKeylist *keylist,
                                          const int saction_flag);
/* Grease Pencil Data-Block. */
void grease_pencil_data_block_to_keylist(AnimData *adt,
                                         const GreasePencil *grease_pencil,
                                         AnimKeylist *keylist,
                                         const int saction_flag,
                                         bool active_layer_only);
/* Grease Pencil Layer (Legacy) */
void gpl_to_keylist(bDopeSheet *ads, bGPDlayer *gpl, AnimKeylist *keylist);
 
/* Mask */
void mask_to_keylist(bDopeSheet *ads, MaskLayer *masklay, AnimKeylist *keylist);
 
/* Sequencer strip data. */
void sequencer_strip_to_keylist(const Strip &strip, AnimKeylist &keylist, Scene &scene);
 
/* ActKeyColumn API ---------------- */

bool actkeyblock_is_valid(const ActKeyColumn *ac);

int actkeyblock_get_valid_hold(const ActKeyColumn *ac);