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.
69 lines
1.9 KiB
C
69 lines
1.9 KiB
C
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*
|
|
* Pose Backups can be created from the current pose, and later restored. The
|
|
* backup is restricted to those bones animated by a given Action, so that
|
|
* operations are as fast as possible.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include "BLI_listbase.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct PoseBackup;
|
|
|
|
/**
|
|
* Create a backup of those bones that are selected AND animated in the given action.
|
|
*
|
|
* The backup is owned by the caller, and should be freed with `BKE_pose_backup_free()`.
|
|
*/
|
|
struct PoseBackup *BKE_pose_backup_create_selected_bones(
|
|
const struct Object *ob, const struct bAction *action) ATTR_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* Create a backup of those bones that are animated in the given action.
|
|
*
|
|
* The backup is owned by the caller, and should be freed with `BKE_pose_backup_free()`.
|
|
*/
|
|
struct PoseBackup *BKE_pose_backup_create_all_bones(
|
|
const struct Object *ob, const struct bAction *action) ATTR_WARN_UNUSED_RESULT;
|
|
bool BKE_pose_backup_is_selection_relevant(const struct PoseBackup *pose_backup);
|
|
void BKE_pose_backup_restore(const struct PoseBackup *pbd);
|
|
void BKE_pose_backup_free(struct PoseBackup *pbd);
|
|
|
|
/**
|
|
* Create a backup of those bones that are animated in the given action.
|
|
*
|
|
* The backup is owned by the Object, and there can be only one backup at a time.
|
|
* It should be freed with `BKE_pose_backup_clear(ob)`.
|
|
*/
|
|
void BKE_pose_backup_create_on_object(struct Object *ob, const struct bAction *action);
|
|
|
|
/**
|
|
* Restore the pose backup owned by this OBject.
|
|
*
|
|
* \return true on success, false if there was no pose backup to restore.
|
|
*
|
|
* \see #BKE_pose_backup_create_on_object
|
|
*/
|
|
bool BKE_pose_backup_restore_on_object(struct Object *ob);
|
|
|
|
/**
|
|
* Free the pose backup that was stored on this object's runtime data.
|
|
*/
|
|
void BKE_pose_backup_clear(struct Object *ob);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|