e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
143 lines
4.2 KiB
C
143 lines
4.2 KiB
C
/* SPDX-FileCopyrightText: 2009 Blender Authors, Joshua Leung. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*/
|
|
|
|
#include "BLI_sys_types.h" /* for bool */
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct AnimData;
|
|
struct BlendDataReader;
|
|
struct BlendExpander;
|
|
struct BlendLibReader;
|
|
struct BlendWriter;
|
|
struct ID;
|
|
struct LibraryForeachIDData;
|
|
struct Main;
|
|
struct ReportList;
|
|
struct bAction;
|
|
|
|
/* ************************************* */
|
|
/* AnimData API */
|
|
|
|
/**
|
|
* Check if the given ID-block can have AnimData.
|
|
*/
|
|
bool id_type_can_have_animdata(short id_type);
|
|
bool id_can_have_animdata(const struct ID *id);
|
|
|
|
/**
|
|
* Get #AnimData from the given ID-block.
|
|
*/
|
|
struct AnimData *BKE_animdata_from_id(const struct ID *id);
|
|
|
|
/**
|
|
* Ensure #AnimData exists in the given ID-block (when supported).
|
|
*/
|
|
struct AnimData *BKE_animdata_ensure_id(struct ID *id);
|
|
|
|
/**
|
|
* Set active action used by AnimData from the given ID-block.
|
|
*
|
|
* Called when user tries to change the active action of an #AnimData block
|
|
* (via RNA, Outliner, etc.)
|
|
*
|
|
* \param reports: Can be NULL.
|
|
* \param id: The owner of the animation data
|
|
* \param act: The Action to set, or NULL to clear.
|
|
*
|
|
* \return true when the action was successfully updated, false otherwise.
|
|
*/
|
|
bool BKE_animdata_set_action(struct ReportList *reports, struct ID *id, struct bAction *act);
|
|
|
|
/**
|
|
* Same as BKE_animdata_set_action(), except sets `tmpact` instead of `action`.
|
|
*/
|
|
bool BKE_animdata_set_tmpact(struct ReportList *reports, struct ID *id, struct bAction *act);
|
|
|
|
bool BKE_animdata_action_editable(const struct AnimData *adt);
|
|
|
|
/**
|
|
* Ensure that the action's idroot is set correctly given the ID type of the owner.
|
|
* Return true if it is, false if it was already set to an incompatible type.
|
|
*/
|
|
bool BKE_animdata_action_ensure_idroot(const struct ID *owner, struct bAction *action);
|
|
|
|
/**
|
|
* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer.
|
|
*/
|
|
void BKE_animdata_free(struct ID *id, bool do_id_user);
|
|
|
|
/**
|
|
* Return true if the ID-block has non-empty AnimData.
|
|
*/
|
|
bool BKE_animdata_id_is_animated(const struct ID *id);
|
|
|
|
/**
|
|
* Callback used by lib_query to walk over all ID usages
|
|
* (mimics `foreach_id` callback of #IDTypeInfo structure).
|
|
*/
|
|
void BKE_animdata_foreach_id(struct AnimData *adt, struct LibraryForeachIDData *data);
|
|
|
|
/**
|
|
* Make a copy of the given AnimData - to be used when copying data-blocks.
|
|
* \param flag: Control ID pointers management,
|
|
* see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_lib_id.h
|
|
* \return The copied animdata.
|
|
*/
|
|
struct AnimData *BKE_animdata_copy(struct Main *bmain, struct AnimData *adt, int flag);
|
|
|
|
/**
|
|
* \param flag: Control ID pointers management,
|
|
* see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_lib_id.h
|
|
* \return true is successfully copied.
|
|
*/
|
|
bool BKE_animdata_copy_id(struct Main *bmain, struct ID *id_to, struct ID *id_from, int flag);
|
|
|
|
/**
|
|
* Copy AnimData Actions.
|
|
*/
|
|
void BKE_animdata_copy_id_action(struct Main *bmain, struct ID *id);
|
|
|
|
void BKE_animdata_duplicate_id_action(struct Main *bmain, struct 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;
|
|
|
|
/**
|
|
* Merge copies of the data from the src AnimData into the destination AnimData.
|
|
*/
|
|
void BKE_animdata_merge_copy(struct Main *bmain,
|
|
struct ID *dst_id,
|
|
struct ID *src_id,
|
|
eAnimData_MergeCopy_Modes action_mode,
|
|
bool fix_drivers);
|
|
|
|
void BKE_animdata_blend_write(struct BlendWriter *writer, struct ID *id);
|
|
void BKE_animdata_blend_read_data(struct BlendDataReader *reader, struct ID *id);
|
|
void BKE_animdata_blend_read_lib(struct BlendLibReader *reader,
|
|
struct ID *id,
|
|
struct AnimData *adt);
|
|
void BKE_animdata_blend_read_expand(struct BlendExpander *expander, struct AnimData *adt);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|