Blender V5.3
ED_keyframes_keylist.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2009 Blender Authors, Joshua Leung. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_bounds_types.hh"
13
14#include "DNA_curve_types.h"
15#include "DNA_listBase.h"
16
17#include "ANIM_action.hh"
18
19namespace blender {
20
21struct AnimData;
22struct CacheFile;
23struct FCurve;
24struct GreasePencil;
27struct MaskLayer;
28struct Object;
29struct Scene;
30struct Strip;
31struct bAction;
32struct bActionGroup;
33struct bAnimContext;
34struct bDopeSheet;
35struct bGPDlayer;
36struct bGPdata;
37
38namespace animrig {
39class Action;
40class Slot;
41} // namespace animrig
42
43/* ****************************** Base Structs ****************************** */
44
45struct AnimKeylist;
46
50 short flag;
52 short conflict;
53
55 char sel;
56};
57
60 /* ListBaseT linkage */
62
63 /* sorting-tree linkage */
68
69 /* keyframe info */
75 short sel;
76 float cfra;
77
78 /* key-block info */
80
81 /* number of curves and keys in this column */
83};
84
102
103/* *********************** Keyframe Drawing ****************************** */
104
107 /* only the border */
109 /* only the inside filling */
111 /* the whole thing */
113};
114
126
139
140/* ******************************* Methods ****************************** */
141
142AnimKeylist *ED_keylist_create();
143void ED_keylist_free(AnimKeylist *keylist);
144void ED_keylist_prepare_for_direct_access(AnimKeylist *keylist);
145const ActKeyColumn *ED_keylist_find_exact(const AnimKeylist *keylist, float cfra);
146const ActKeyColumn *ED_keylist_find_next(const AnimKeylist *keylist, float cfra);
147const ActKeyColumn *ED_keylist_find_prev(const AnimKeylist *keylist, float cfra);
148const ActKeyColumn *ED_keylist_find_closest(const AnimKeylist *keylist, float cfra);
149const ActKeyColumn *ED_keylist_find_any_between(const AnimKeylist *keylist,
150 const Bounds<float> frame_range);
151bool ED_keylist_is_empty(const AnimKeylist *keylist);
152const ListBaseT<ActKeyColumn> *ED_keylist_listbase(const AnimKeylist *keylist);
153bool ED_keylist_all_keys_frame_range(const AnimKeylist *keylist, Bounds<float> *r_frame_range);
158bool ED_keylist_selected_keys_frame_range(const AnimKeylist *keylist,
159 Bounds<float> *r_frame_range);
160const ActKeyColumn *ED_keylist_array(const AnimKeylist *keylist);
161int64_t ED_keylist_array_len(const AnimKeylist *keylist);
162
163/* Key-data Generation --------------- */
164
177void fcurve_to_keylist(AnimData *adt,
178 FCurve *fcu,
179 AnimKeylist *keylist,
180 int saction_flag,
181 float2 range,
182 bool use_nla_remapping);
183/* Action Group */
185 AnimData *adt, bActionGroup *agrp, AnimKeylist *keylist, int saction_flag, float2 range);
186/* Action */
187
203 AnimData *adt, bAction *dna_action, AnimKeylist *keylist, int saction_flag, float2 range);
204
205/* Object */
206void ob_to_keylist(
207 bDopeSheet *ads, Object *ob, AnimKeylist *keylist, int saction_flag, float2 range);
208/* Cache File */
209void cachefile_to_keylist(bDopeSheet *ads,
210 CacheFile *cache_file,
211 AnimKeylist *keylist,
212 int saction_flag);
213/* Scene */
215 bDopeSheet *ads, Scene *sce, AnimKeylist *keylist, int saction_flag, float2 range);
216/* DopeSheet Summary */
217void summary_to_keylist(bAnimContext *ac, AnimKeylist *keylist, int saction_flag, float2 range);
218
247void action_slot_summary_to_keylist(bAnimContext *ac,
248 ID *animated_id,
249 animrig::Action &action,
250 animrig::slot_handle_t slot_handle,
251 AnimKeylist *keylist,
252 int /* eSAction_Flag */ saction_flag,
253 float2 range);
254
255/* Grease Pencil datablock summary (Legacy) */
256void gpencil_to_keylist(bDopeSheet *ads, bGPdata *gpd, AnimKeylist *keylist, bool active);
257
258/* Grease Pencil Cels. */
259void grease_pencil_cels_to_keylist(AnimData *adt,
260 const GreasePencilLayer *gpl,
261 AnimKeylist *keylist,
262 int saction_flag);
263
264/* Grease Pencil Layer Group. */
265void grease_pencil_layer_group_to_keylist(AnimData *adt,
266 const GreasePencilLayerTreeGroup *layer_group,
267 AnimKeylist *keylist,
268 const int saction_flag);
269/* Grease Pencil Data-Block. */
270void grease_pencil_data_block_to_keylist(AnimData *adt,
271 const GreasePencil *grease_pencil,
272 AnimKeylist *keylist,
273 const int saction_flag,
274 bool active_layer_only);
275/* Grease Pencil Layer (Legacy) */
276void gpl_to_keylist(bDopeSheet *ads, bGPDlayer *gpl, AnimKeylist *keylist);
277
278/* Mask */
279void mask_to_keylist(bDopeSheet *ads, MaskLayer *masklay, AnimKeylist *keylist);
280
281/* Sequencer strip data. */
282void sequencer_strip_to_keylist(const Strip &strip, AnimKeylist &keylist, Scene &scene);
283
284/* ActKeyColumn API ---------------- */
285
287bool actkeyblock_is_valid(const ActKeyColumn *ac);
288
290int actkeyblock_get_valid_hold(const ActKeyColumn *ac);
291
292} // namespace blender
Functions and classes to work with Actions.
These structs are the foundation for all linked lists in the library system.
long long int int64_t
Definition scene.h:133
decltype(blender::ActionSlot::handle) slot_handle_t
BMesh Iterators.
void action_to_keylist(AnimData *adt, bAction *dna_action, AnimKeylist *keylist, const int saction_flag, float2 range)
void grease_pencil_cels_to_keylist(AnimData *, const GreasePencilLayer *gpl, AnimKeylist *keylist, int)
void gpl_to_keylist(bDopeSheet *, bGPDlayer *gpl, AnimKeylist *keylist)
bool actkeyblock_is_valid(const ActKeyColumn *ac)
void grease_pencil_layer_group_to_keylist(AnimData *adt, const GreasePencilLayerTreeGroup *layer_group, AnimKeylist *keylist, const int saction_flag)
bool ED_keylist_selected_keys_frame_range(const AnimKeylist *keylist, Bounds< float > *r_frame_range)
void sequencer_strip_to_keylist(const Strip &strip, AnimKeylist &keylist, Scene &scene)
const ActKeyColumn * ED_keylist_find_prev(const AnimKeylist *keylist, const float cfra)
void summary_to_keylist(bAnimContext *ac, AnimKeylist *keylist, const int saction_flag, float2 range)
bool ED_keylist_is_empty(const AnimKeylist *keylist)
const ActKeyColumn * ED_keylist_find_exact(const AnimKeylist *keylist, const float cfra)
const ActKeyColumn * ED_keylist_array(const AnimKeylist *keylist)
const ActKeyColumn * ED_keylist_find_next(const AnimKeylist *keylist, const float cfra)
void fcurve_to_keylist(AnimData *adt, FCurve *fcu, AnimKeylist *keylist, const int saction_flag, float2 range, const bool use_nla_remapping)
void gpencil_to_keylist(bDopeSheet *ads, bGPdata *gpd, AnimKeylist *keylist, const bool active)
void grease_pencil_data_block_to_keylist(AnimData *adt, const GreasePencil *grease_pencil, AnimKeylist *keylist, const int saction_flag, const bool active_layer_only)
void action_group_to_keylist(AnimData *adt, bActionGroup *agrp, AnimKeylist *keylist, const int saction_flag, float2 range)
void ED_keylist_prepare_for_direct_access(AnimKeylist *keylist)
void action_slot_summary_to_keylist(bAnimContext *ac, ID *animated_id, animrig::Action &action, const animrig::slot_handle_t slot_handle, AnimKeylist *keylist, const int saction_flag, float2 range)
AnimKeylist * ED_keylist_create()
int64_t ED_keylist_array_len(const AnimKeylist *keylist)
void ob_to_keylist(bDopeSheet *ads, Object *ob, AnimKeylist *keylist, const int saction_flag, float2 range)
const ActKeyColumn * ED_keylist_find_any_between(const AnimKeylist *keylist, const Bounds< float > frame_range)
void scene_to_keylist(bDopeSheet *ads, Scene *sce, AnimKeylist *keylist, const int saction_flag, float2 range)
void cachefile_to_keylist(bDopeSheet *ads, CacheFile *cache_file, AnimKeylist *keylist, const int saction_flag)
void mask_to_keylist(bDopeSheet *, MaskLayer *masklay, AnimKeylist *keylist)
void ED_keylist_free(AnimKeylist *keylist)
const ActKeyColumn * ED_keylist_find_closest(const AnimKeylist *keylist, const float cfra)
const ListBaseT< ActKeyColumn > * ED_keylist_listbase(const AnimKeylist *keylist)
bool ED_keylist_all_keys_frame_range(const AnimKeylist *keylist, Bounds< float > *r_frame_range)
int actkeyblock_get_valid_hold(const ActKeyColumn *ac)
eBezTriple_KeyframeType key_type