Blender V5.3
ANIM_keyingsets.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2024 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
10
11#pragma once
12
13#include "RNA_types.hh"
14
15namespace blender {
16
17struct KeyingSet;
18struct ExtensionRNA;
19/* Forward declaration for this struct which is declared a bit later. */
20struct KeyingSetInfo;
21struct bContext;
22struct ID;
23struct Scene;
24struct PointerRNA;
25
26enum eInsertKeyFlags : short;
27
28/* Names for builtin keying sets so we don't confuse these with labels/text,
29 * defined in python script: `keyingsets_builtins.py`. */
30
31static constexpr const char *ANIM_KS_LOCATION_ID = "Location";
32static constexpr const char *ANIM_KS_ROTATION_ID = "Rotation";
33static constexpr const char *ANIM_KS_SCALING_ID = "Scaling";
34static constexpr const char *ANIM_KS_LOC_ROT_SCALE_ID = "LocRotScale";
35static constexpr const char *ANIM_KS_LOC_ROT_SCALE_CPROP_ID = "LocRotScaleCProp";
36static constexpr const char *ANIM_KS_AVAILABLE_ID = "Available";
37static constexpr const char *ANIM_KS_WHOLE_CHARACTER_ID = "WholeCharacter";
38static constexpr const char *ANIM_KS_WHOLE_CHARACTER_SELECTED_ID = "WholeCharacterSelected";
39
41using cbKeyingSet_Poll = bool (*)(KeyingSetInfo *ksi, bContext *C);
45using cbKeyingSet_Generate = void (*)(KeyingSetInfo *ksi,
46 bContext *C,
47 KeyingSet *ks,
48 PointerRNA *ptr);
49
53
54 /* info */
56 char idname[/*MAX_NAME*/ 64];
58 char name[/*MAX_NAME*/ 64];
60 char description[/*RNA_DYN_DESCR_MAX*/ 1024];
63
64 /* polling callbacks */
67
68 /* generate callbacks */
77
80};
81
82namespace animrig {
83
85enum class ModifyKeyMode {
86 INSERT = 0,
87 /* Not calling it just `DELETE` because that interferes with a macro on windows. */
89};
90
99
100/* -------------------------------------------------------------------- */
103
113
125 Vector<PointerRNA> *sources,
126 KeyingSet *keyingset,
127 ModifyKeyMode mode,
128 float cfra);
129
131
132/* -------------------------------------------------------------------- */
135
141KeyingSet *builtin_keyingset_get_named(const char name[]);
142
146KeyingSetInfo *keyingset_info_find_name(const char name[]);
147
151bool keyingset_find_id(KeyingSet *keyingset, ID *id);
152
156KeyingSet *get_keyingset_for_autokeying(const Scene *scene, const char *transformKSName);
157
162
164
165/* -------------------------------------------------------------------- */
168
173void keyingset_info_register(KeyingSetInfo *keyingset_info);
178void keyingset_info_unregister(Main *bmain, KeyingSetInfo *keyingset_info);
179
181
186 ID *id,
187 StructRNA *srna,
188 void *data);
190
192
193} // namespace animrig
194} // namespace blender
#define C
Definition RandGen.cpp:29
void relative_keyingset_add_source(Vector< PointerRNA > &sources, ID *id, StructRNA *srna, void *data)
KeyingSet * builtin_keyingset_get_named(const char name[])
KeyingSet * scene_get_active_keyingset(const Scene *scene)
KeyingSetInfo * keyingset_info_find_name(const char name[])
KeyingSet * get_keyingset_for_autokeying(const Scene *scene, const char *transformKSName)
ModifyKeyReturn validate_keyingset(bContext *C, Vector< PointerRNA > *sources, KeyingSet *keyingset)
void keyingset_info_register(KeyingSetInfo *keyingset_info)
void keyingset_info_unregister(Main *bmain, KeyingSetInfo *keyingset_info)
bool keyingset_find_id(KeyingSet *keyingset, ID *id)
int apply_keyingset(bContext *C, Vector< PointerRNA > *sources, KeyingSet *keyingset, ModifyKeyMode mode, float cfra)
BMesh Iterators.
static constexpr const char * ANIM_KS_SCALING_ID
void(*)(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks) cbKeyingSet_Iterator
static constexpr const char * ANIM_KS_LOCATION_ID
static constexpr const char * ANIM_KS_WHOLE_CHARACTER_SELECTED_ID
BMesh const char void * data
static constexpr const char * ANIM_KS_AVAILABLE_ID
static constexpr const char * ANIM_KS_ROTATION_ID
void(*)(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks, PointerRNA *ptr) cbKeyingSet_Generate
static constexpr const char * ANIM_KS_LOC_ROT_SCALE_ID
static constexpr const char * ANIM_KS_WHOLE_CHARACTER_ID
bool(*)(KeyingSetInfo *ksi, bContext *C) cbKeyingSet_Poll
static constexpr const char * ANIM_KS_LOC_ROT_SCALE_CPROP_ID
cbKeyingSet_Generate generate
cbKeyingSet_Iterator iter
eInsertKeyFlags keyingflag