ANIM_bone_collections.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#ifndef __cplusplus
#  error This is a C++ header.
#endif
 
#include <stdbool.h>
 
#include "BLI_map.hh"
#include "BLI_math_bits.h"
 
#include "BKE_armature.hh"
 
#include "DNA_action_types.h"
#include "DNA_armature_types.h"
 
struct bArmature;
struct Bone;
struct BoneCollection;
struct bPoseChannel;
struct EditBone;
 
BoneCollection *ANIM_bonecoll_new(const char *name) ATTR_WARN_UNUSED_RESULT;
 
void ANIM_bonecoll_free(BoneCollection *bcoll, bool do_id_user_count = true);
 
void ANIM_armature_runtime_refresh(bArmature *armature);
 
void ANIM_armature_runtime_free(bArmature *armature);
 
BoneCollection *ANIM_armature_bonecoll_new(bArmature *armature,
                                           const char *name,
                                           int parent_index = -1);
 
BoneCollection *ANIM_armature_bonecoll_insert_copy_after(bArmature *armature_dst,
                                                         const bArmature *armature_src,
                                                         const BoneCollection *anchor_in_dst,
                                                         const BoneCollection *bcoll_to_copy);
 
void ANIM_armature_bonecoll_remove_from_index(bArmature *armature, const int index);
 
void ANIM_armature_bonecoll_remove(bArmature *armature, BoneCollection *bcoll);
 
void ANIM_armature_bonecoll_active_set(bArmature *armature, BoneCollection *bcoll);
 
void ANIM_armature_bonecoll_active_index_set(bArmature *armature, int bone_collection_index);
 
void ANIM_armature_bonecoll_active_name_set(bArmature *armature, const char *name);
 
void ANIM_armature_bonecoll_active_runtime_refresh(bArmature *armature);
 
bool ANIM_armature_bonecoll_is_editable(const bArmature *armature, const BoneCollection *bcoll);
 
bool ANIM_armature_bonecoll_move_to_index(bArmature *armature, int from_index, int to_index);
 
enum class MoveLocation {
  Before, /* Move to before the item at the given index. */
  After,  /* Move to after the item at the given index. */
};
 
int ANIM_armature_bonecoll_move_before_after_index(bArmature *armature,
                                                   int from_index,
                                                   int to_index,
                                                   MoveLocation before_after);
 
bool ANIM_armature_bonecoll_move(bArmature *armature, BoneCollection *bcoll, int step);
 
BoneCollection *ANIM_armature_bonecoll_get_by_name(bArmature *armature,
                                                   const char *name) ATTR_WARN_UNUSED_RESULT;
 
int ANIM_armature_bonecoll_get_index_by_name(bArmature *armature,
                                             const char *name) ATTR_WARN_UNUSED_RESULT;
 
void ANIM_armature_bonecoll_name_set(bArmature *armature, BoneCollection *bcoll, const char *name);
 
void ANIM_bonecoll_show(bArmature *armature, BoneCollection *bcoll);
 
void ANIM_bonecoll_hide(bArmature *armature, BoneCollection *bcoll);
 
void ANIM_armature_bonecoll_is_visible_set(bArmature *armature,
                                           BoneCollection *bcoll,
                                           bool is_visible);
 
void ANIM_armature_bonecoll_solo_set(bArmature *armature, BoneCollection *bcoll, bool is_solo);
 
void ANIM_armature_refresh_solo_active(bArmature *armature);
 
bool ANIM_armature_bonecoll_is_visible_effectively(const bArmature *armature,
                                                   const BoneCollection *bcoll);
 
void ANIM_armature_bonecoll_is_expanded_set(BoneCollection *bcoll, bool is_expanded);
 
bool ANIM_armature_bonecoll_assign(BoneCollection *bcoll, Bone *bone);
bool ANIM_armature_bonecoll_assign_editbone(BoneCollection *bcoll, EditBone *ebone);
bool ANIM_armature_bonecoll_assign_and_move(BoneCollection *bcoll, Bone *bone);
bool ANIM_armature_bonecoll_assign_and_move_editbone(BoneCollection *bcoll, EditBone *ebone);
bool ANIM_armature_bonecoll_unassign(BoneCollection *bcoll, Bone *bone);
bool ANIM_armature_bonecoll_unassign_editbone(BoneCollection *bcoll, EditBone *ebone);
void ANIM_armature_bonecoll_unassign_all(Bone *bone);
void ANIM_armature_bonecoll_unassign_all_editbone(EditBone *ebone);
 
/* Assign the edit bone to the armature's active collection. */
void ANIM_armature_bonecoll_assign_active(const bArmature *armature, EditBone *ebone);
 
bool ANIM_armature_bonecoll_contains_active_bone(const bArmature *armature,
                                                 const BoneCollection *bcoll);
 
void ANIM_armature_bonecoll_reconstruct(bArmature *armature);
 
/*
 * Armature/Bone Layer abstractions. These functions are intended as the sole
 * accessors for `bone->layer`, `armature->layer`, etc. to get a grip on which
 * queries & operations are performed.
 *
 * The functions are named "bonecoll" (short for "bone collection"), as that's
 * the soon-to-be-introduced replacement for armature layers. This API is the
 * first step towards replacement.
 */
 
bool ANIM_bone_in_visible_collection(const bArmature *armature, const Bone *bone);
 
inline bool ANIM_bone_is_visible(const bArmature *armature, const Bone *bone)
{
  const bool bone_itself_visible = (bone->flag & (BONE_HIDDEN_P | BONE_HIDDEN_PG)) == 0;
  return bone_itself_visible && ANIM_bone_in_visible_collection(armature, bone);
}
 
bool ANIM_bonecoll_is_visible_editbone(const bArmature *armature, const EditBone *ebone);
 
inline bool ANIM_bone_is_visible_editbone(const bArmature *armature, const EditBone *ebone)
{
  const bool bone_itself_visible = (ebone->flag & BONE_HIDDEN_A) == 0;
  return bone_itself_visible && ANIM_bonecoll_is_visible_editbone(armature, ebone);
}
 
inline bool ANIM_bonecoll_is_visible_pchan(const bArmature *armature, const bPoseChannel *pchan)
{
  return ANIM_bone_in_visible_collection(armature, pchan->bone);
}
 
inline bool ANIM_bonecoll_is_visible_actbone(const bArmature *armature)
{
  return ANIM_bone_in_visible_collection(armature, armature->act_bone);
}
 
void ANIM_armature_bonecoll_show_all(bArmature *armature);
void ANIM_armature_bonecoll_hide_all(bArmature *armature);
 
void ANIM_armature_bonecoll_show_from_bone(bArmature *armature, const Bone *bone);
void ANIM_armature_bonecoll_show_from_ebone(bArmature *armature, const EditBone *ebone);
void ANIM_armature_bonecoll_show_from_pchan(bArmature *armature, const bPoseChannel *pchan);
 
namespace blender::animrig {
 
int armature_bonecoll_find_index(const bArmature *armature, const ::BoneCollection *bcoll);
 
int armature_bonecoll_find_parent_index(const bArmature *armature, int bcoll_index);
 
int armature_bonecoll_child_number_find(const bArmature *armature, const ::BoneCollection *bcoll);
 
int armature_bonecoll_child_number_set(bArmature *armature,
                                       ::BoneCollection *bcoll,
                                       int new_child_number);
 
bool armature_bonecoll_is_root(const bArmature *armature, int bcoll_index);
 
bool armature_bonecoll_is_child_of(const bArmature *armature,
                                   int potential_parent_index,
                                   int potential_child_index);
 
bool armature_bonecoll_is_descendant_of(const bArmature *armature,
                                        int potential_parent_index,
                                        int potential_descendant_index);
 
bool bonecoll_has_children(const BoneCollection *bcoll);
 
void bonecolls_copy_expanded_flag(Span<BoneCollection *> bcolls_dest,
                                  Span<const BoneCollection *> bcolls_source);
 
int armature_bonecoll_move_to_parent(bArmature *armature,
                                     int from_bcoll_index,
                                     int to_child_num,
                                     int from_parent_index,
                                     int to_parent_index);
 
/* --------------------------------------------------------------------
 * The following functions are only used by edit-mode Armature undo:
 */
 
blender::Map<BoneCollection *, BoneCollection *> ANIM_bonecoll_array_copy_no_membership(
    BoneCollection ***bcoll_array_dst,
    int *bcoll_array_dst_num,
    BoneCollection **bcoll_array_src,
    int bcoll_array_src_num,
    bool do_id_user);
void ANIM_bonecoll_array_free(BoneCollection ***bcoll_array,
                              int *bcoll_array_num,
                              bool do_id_user);
 
}  // namespace blender::animrig