4786fbe774
The only remaining code in source/blender that must be compiled as C is now datatoc generated code and the DNA defaults that use designated initializers. Pull Request: https://projects.blender.org/blender/blender/pulls/134469
65 lines
2.0 KiB
C
65 lines
2.0 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 "BKE_action.hh"
|
|
#include "BLI_listbase.h"
|
|
#include "BLI_span.hh"
|
|
|
|
struct PoseBackup;
|
|
struct Object;
|
|
|
|
/**
|
|
* 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(
|
|
blender::Span<Object *> objects, 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(
|
|
blender::Span<Object *> objects, 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);
|