ANIM_keyingsets.hh

Go to the documentation of this file.

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

 
#pragma once
 
#include "RNA_types.hh"
 
struct KeyingSet;
struct ExtensionRNA;
/* Forward declaration for this struct which is declared a bit later. */
struct KeyingSetInfo;
struct bContext;
struct ID;
struct Scene;
struct PointerRNA;
 
/* Names for builtin keying sets so we don't confuse these with labels/text,
 * defined in python script: `keyingsets_builtins.py`. */
 
static constexpr const char *ANIM_KS_LOCATION_ID = "Location";
static constexpr const char *ANIM_KS_ROTATION_ID = "Rotation";
static constexpr const char *ANIM_KS_SCALING_ID = "Scaling";
static constexpr const char *ANIM_KS_LOC_ROT_SCALE_ID = "LocRotScale";
static constexpr const char *ANIM_KS_LOC_ROT_SCALE_CPROP_ID = "LocRotScaleCProp";
static constexpr const char *ANIM_KS_AVAILABLE_ID = "Available";
static constexpr const char *ANIM_KS_WHOLE_CHARACTER_ID = "WholeCharacter";
static constexpr const char *ANIM_KS_WHOLE_CHARACTER_SELECTED_ID = "WholeCharacterSelected";

using cbKeyingSet_Poll = bool (*)(KeyingSetInfo *ksi, bContext *C);
using cbKeyingSet_Iterator = void (*)(KeyingSetInfo *ksi, bContext *C, KeyingSet *ks);
using cbKeyingSet_Generate = void (*)(KeyingSetInfo *ksi,
                                      bContext *C,
                                      KeyingSet *ks,
                                      PointerRNA *ptr);

struct KeyingSetInfo {
  KeyingSetInfo *next, *prev;
 
  /* info */
  char idname[/*MAX_NAME*/ 64];
  char name[/*MAX_NAME*/ 64];
  char description[/*RNA_DYN_DESCR_MAX*/ 1024];
  short keyingflag;
 
  /* polling callbacks */
  cbKeyingSet_Poll poll;
 
  /* generate callbacks */
  cbKeyingSet_Iterator iter;
  cbKeyingSet_Generate generate;

  ExtensionRNA rna_ext;
};
 
namespace blender::animrig {

enum class ModifyKeyMode {
  INSERT = 0,
  /* Not calling it just `DELETE` because that interferes with a macro on windows. */
  DELETE_KEY,
};

enum class ModifyKeyReturn {
  SUCCESS = 0,
  INVALID_CONTEXT = -1,
  MISSING_TYPEINFO = -2,
};
 
/* -------------------------------------------------------------------- */

ModifyKeyReturn validate_keyingset(bContext *C,
                                   blender::Vector<PointerRNA> *sources,
                                   KeyingSet *keyingset);

int apply_keyingset(bContext *C,
                    blender::Vector<PointerRNA> *sources,
                    KeyingSet *keyingset,
                    ModifyKeyMode mode,
                    float cfra);

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

KeyingSet *builtin_keyingset_get_named(const char name[]);

KeyingSetInfo *keyingset_info_find_name(const char name[]);

bool keyingset_find_id(KeyingSet *keyingset, ID *id);

KeyingSet *get_keyingset_for_autokeying(const Scene *scene, const char *transformKSName);

KeyingSet *scene_get_active_keyingset(const Scene *scene);

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

void keyingset_info_register(KeyingSetInfo *keyingset_info);
void keyingset_info_unregister(Main *bmain, KeyingSetInfo *keyingset_info);
 
void keyingset_infos_exit();

void relative_keyingset_add_source(blender::Vector<PointerRNA> &sources,
                                   ID *id,
                                   StructRNA *srna,
                                   void *data);
void relative_keyingset_add_source(blender::Vector<PointerRNA> &sources, ID *id);

 
}  // namespace blender::animrig