ED_keyframing.hh

Go to the documentation of this file.

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

 
#pragma once
 
#include "DNA_anim_types.h"
#include "RNA_types.hh"
 
struct ID;
struct Main;
struct Scene;
 
struct KeyingSet;
 
struct AnimationEvalContext;
struct FCurve;
 
struct ReportList;
struct bContext;
 
struct EnumPropertyItem;
struct PointerRNA;
struct PropertyRNA;
 
namespace blender::animrig {
enum class ModifyKeyReturn;
enum class ModifyKeyMode;
}  // namespace blender::animrig
 
/* -------------------------------------------------------------------- */

void update_autoflags_fcurve(FCurve *fcu, bContext *C, ReportList *reports, PointerRNA *ptr);
 
/* -------- */

void ED_keyframes_add(FCurve *fcu, int num_keys_to_add);

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

int ANIM_scene_get_keyingset_index(Scene *scene, KeyingSet *keyingset);
 
void ANIM_keyingset_visit_for_search(
    const bContext *C,
    PointerRNA *ptr,
    PropertyRNA *prop,
    const char *edit_text,
    blender::FunctionRef<void(StringPropertySearchVisitParams)> visit_fn);
 
void ANIM_keyingset_visit_for_search_no_poll(
    const bContext *C,
    PointerRNA *ptr,
    PropertyRNA *prop,
    const char *edit_text,
    blender::FunctionRef<void(StringPropertySearchVisitParams)> visit_fn);

const EnumPropertyItem *ANIM_keying_sets_enum_itemf(bContext *C,
                                                    PointerRNA *ptr,
                                                    PropertyRNA *prop,
                                                    bool *r_free);

KeyingSet *ANIM_keyingset_get_from_enum_type(Scene *scene, int type);
KeyingSet *ANIM_keyingset_get_from_idname(Scene *scene, const char *idname);

bool ANIM_keyingset_context_ok_poll(bContext *C, KeyingSet *keyingset);

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

enum eCreateDriverFlags {
  CREATEDRIVER_WITH_DEFAULT_DVAR = (1 << 0),
  CREATEDRIVER_WITH_FMODIFIER = (1 << 1),
};

enum eCreateDriver_MappingTypes {
  CREATEDRIVER_MAPPING_1_N = 0,
  CREATEDRIVER_MAPPING_1_1 = 1,
  CREATEDRIVER_MAPPING_N_N = 2,

  CREATEDRIVER_MAPPING_NONE = 3,
  CREATEDRIVER_MAPPING_NONE_ALL = 4,
};

extern const EnumPropertyItem prop_driver_create_mapping_types[];
 
/* -------- */
 
enum eDriverFCurveCreationMode {
  DRIVER_FCURVE_LOOKUP_ONLY = 0,
  DRIVER_FCURVE_KEYFRAMES = 1,
  DRIVER_FCURVE_GENERATOR = 2,
  DRIVER_FCURVE_EMPTY = 3
};

FCurve *verify_driver_fcurve(ID *id,
                             const char rna_path[],
                             int array_index,
                             eDriverFCurveCreationMode creation_mode);
 
FCurve *alloc_driver_fcurve(const char rna_path[],
                            int array_index,
                            eDriverFCurveCreationMode creation_mode);
 
/* -------- */

int ANIM_add_driver_with_target(ReportList *reports,
                                ID *dst_id,
                                const char dst_path[],
                                int dst_index,
                                ID *src_id,
                                const char src_path[],
                                int src_index,
                                short flag,
                                int driver_type,
                                short mapping_type);
 
/* -------- */

int ANIM_add_driver(
    ReportList *reports, ID *id, const char rna_path[], int array_index, short flag, int type);

bool ANIM_remove_driver(ID *id, const char rna_path[], int array_index);
 
/* -------- */

void ANIM_drivers_copybuf_free();

void ANIM_driver_vars_copybuf_free();
 
/* -------- */

bool ANIM_driver_can_paste();

bool ANIM_copy_driver(
    ReportList *reports, ID *id, const char rna_path[], int array_index, short flag);

bool ANIM_paste_driver(
    ReportList *reports, ID *id, const char rna_path[], int array_index, short flag);
 
/* -------- */

bool ANIM_driver_vars_can_paste();

bool ANIM_driver_vars_copy(ReportList *reports, FCurve *fcu);

bool ANIM_driver_vars_paste(ReportList *reports, FCurve *fcu, bool replace);
 
/* -------- */

void ANIM_copy_as_driver(ID *target_id, const char *target_path, const char *var_name);

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

bool fcurve_is_changed(PointerRNA ptr,
                       PropertyRNA *prop,
                       FCurve *fcu,
                       const AnimationEvalContext *anim_eval_context);