BKE_anim_data.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 <functional>
#include <optional>
 
#include "BLI_function_ref.hh"
 
struct AnimData;
struct BlendDataReader;
struct BlendWriter;
struct FCurve;
struct ID;
struct Library;
struct LibraryForeachIDData;
struct Main;
struct ReportList;
struct bAction;
 
/* ************************************* */
/* AnimData API */
 
struct OwnedAnimData {
  ID &owner_id;
  AnimData &adt;
};
 
bool id_type_can_have_animdata(short id_type);
bool id_can_have_animdata(const ID *id);
 
AnimData *BKE_animdata_from_id(const ID *id);
 
AnimData *BKE_animdata_ensure_id(ID *id);
 
bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act);
 
bool BKE_animdata_set_tmpact(ReportList *reports, ID *id, bAction *act);
 
bool BKE_animdata_action_editable(const AnimData *adt);
 
bool BKE_animdata_action_ensure_idroot(const ID *owner, bAction *action);
 
void BKE_animdata_free(ID *id, bool do_id_user);
 
bool BKE_animdata_id_is_animated(const ID *id);
 
void BKE_animdata_foreach_id(AnimData *adt, LibraryForeachIDData *data);
 
AnimData *BKE_animdata_copy(Main *bmain, AnimData *adt, int flag);
 
AnimData *BKE_animdata_copy_in_lib(Main *bmain,
                                   std::optional<Library *> owner_library,
                                   AnimData *adt,
                                   int flag);
 
bool BKE_animdata_copy_id(Main *bmain, ID *id_to, ID *id_from, int flag);
 
void BKE_animdata_copy_id_action(Main *bmain, ID *id);
 
void BKE_animdata_duplicate_id_action(Main *bmain, ID *id, uint duplicate_flags);
 
/* Merge copies of data from source AnimData block */
typedef enum eAnimData_MergeCopy_Modes {
  /* Keep destination action */
  ADT_MERGECOPY_KEEP_DST = 0,
 
  /* Use src action (make a new copy) */
  ADT_MERGECOPY_SRC_COPY = 1,
 
  /* Use src action (but just reference the existing version) */
  ADT_MERGECOPY_SRC_REF = 2,
} eAnimData_MergeCopy_Modes;
 
void BKE_animdata_merge_copy(
    Main *bmain, ID *dst_id, ID *src_id, eAnimData_MergeCopy_Modes action_mode, bool fix_drivers);
 
void BKE_animdata_blend_write(BlendWriter *writer, ID *id);
void BKE_animdata_blend_read_data(BlendDataReader *reader, ID *id);
 
void BKE_animdata_liboverride_post_process(ID *id);
 
/* ************************************* */
/* Batch AnimData API */
/* Loop over all datablocks applying callback */
void BKE_animdata_main_cb(struct Main *bmain, blender::FunctionRef<void(ID *, AnimData *)> func);
 
void BKE_fcurves_main_cb(struct Main *bmain, blender::FunctionRef<void(ID *, FCurve *)> func);
 
/* Look over all f-curves of a given ID. */
void BKE_fcurves_id_cb(struct ID *id, blender::FunctionRef<void(ID *, FCurve *)> func);
 
/* ************************************* */
/* TODO: overrides, remapping, and path-finding API's. */