DNA_armature_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_userdef_types.h"
 
#include "BLI_utildefines.h"
 
#include "BLI_utildefines.h"
 
#ifdef __cplusplus
#  include "BLI_span.hh"
namespace blender::animrig {
class BoneColor;
}
#endif
 
struct AnimData;
struct BoneCollection;
 
/* The Armature system works on different transformation space levels:
 *
 * 1) Bone Space:     In the orientation of the parent bone, position relative
 *                    to the parent's tail. Same as Armature Space for bones
 *                    without parent.
 * 2) Armature Space: The bone's rest transform in Object space. This is the
 *                    multiplication of the bone space matrices of the bone and
 *                    all its ancestors.
 * 3) Pose Space:     The bone's posed transform in Object space. This is the
 *                    same space as Armature Space, except that it represents
 *                    the current bone transform instead of the rest pose.
 *                    See bPoseChannel::pose_mat
 * 4) Channel Space:  The bone's local transform relative to its rest transform.
 *                    See bPoseChannel::chan_mat
 */
 
typedef struct BoneColor {
  int8_t palette_index;
  uint8_t _pad0[7];
  ThemeWireColor custom;
#ifdef __cplusplus
  blender::animrig::BoneColor &wrap();
  const blender::animrig::BoneColor &wrap() const;
#endif
} BoneColor;
 
typedef struct Bone_Runtime {
  /* #BoneCollectionReference */
  ListBase collections;
} Bone_Runtime;
 
typedef struct Bone {
  struct Bone *next, *prev;
  IDProperty *prop;
  IDProperty *system_properties;
  void *_pad0;
  struct Bone *parent;
  ListBase childbase;
  char name[/*MAXBONENAME*/ 64];

  float roll;
  float head[3];
  float tail[3];
  float bone_mat[3][3];
 
  int flag;
  int8_t drawtype; /* eArmature_Drawtype */
  char _pad1[3];
  BoneColor color; /* MUST be named the same as in bPoseChannel and EditBone structs. */
 
  char inherit_scale_mode;
  char _pad[3];

  float arm_head[3];
  float arm_tail[3];
  float arm_mat[4][4];
  float arm_roll;

  float dist;
  float weight;
  float xwidth, length, zwidth;
  float rad_head, rad_tail;

  float roll1, roll2;
  float curve_in_x, curve_in_z;
  float curve_out_x, curve_out_z;
  float ease1, ease2;
  float scale_in_x DNA_DEPRECATED, scale_in_z DNA_DEPRECATED;
  float scale_out_x DNA_DEPRECATED, scale_out_z DNA_DEPRECATED;
  float scale_in[3], scale_out[3];

  float size[3];
  int layer;
  short segments;
  char bbone_mapping_mode;
  char _pad2[7];

  char bbone_prev_type;
  char bbone_next_type;
  int bbone_flag;
  short bbone_prev_flag;
  short bbone_next_flag;
  struct Bone *bbone_prev;
  struct Bone *bbone_next;
 
  /* Keep last. */
  Bone_Runtime runtime;
} Bone;
 
typedef struct bArmature_Runtime {
  int active_collection_index;
  uint8_t _pad0[4];
  struct BoneCollection *active_collection;
} bArmature_Runtime;
 
typedef struct bArmature {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_AR;
#endif
 
  ID id;
  struct AnimData *adt;
 
  ListBase bonebase;

  struct GHash *bonehash;
  void *_pad1;

  ListBase *edbo;
 
  /* active bones should work like active object where possible
   * - active and selection are unrelated
   * - active & hidden is not allowed
   * - from the user perspective active == last selected
   * - active should be ignored when not visible (hidden layer) */

  Bone *act_bone;
  struct EditBone *act_edbone;

  char needs_flush_to_id;
  char _pad0[3];
 
  int flag;
  int drawtype; /* eArmature_Drawtype */
 
  short deformflag;
  short pathflag;

  ListBase collections_legacy; /* BoneCollection. */
 
  struct BoneCollection **collection_array; /* Array of `collection_array_num` BoneCollections. */
  int collection_array_num;
  int collection_root_count;

  char active_collection_name[/*MAX_NAME*/ 64];

  unsigned int layer_used DNA_DEPRECATED;
  unsigned int layer DNA_DEPRECATED, layer_protected DNA_DEPRECATED;

  float axes_position;

  struct bArmature_Runtime runtime;
 
#ifdef __cplusplus
  /* Collection array access for convenient for-loop iteration. */
  blender::Span<const BoneCollection *> collections_span() const;
  blender::Span<BoneCollection *> collections_span();
 
  /* Span of all root collections. */
  blender::Span<const BoneCollection *> collections_roots() const;
  blender::Span<BoneCollection *> collections_roots();
 
  /* Return the span of children of the given bone collection. */
  blender::Span<const BoneCollection *> collection_children(const BoneCollection *parent) const;
  blender::Span<BoneCollection *> collection_children(BoneCollection *parent);
#endif
} bArmature;

typedef struct BoneCollection {
  struct BoneCollection *next, *prev;
 
  char name[/*MAX_NAME*/ 64];

  ListBase bones;

  uint8_t flags;
  uint8_t _pad0[7];
 
  /*
   * Hierarchy information. The Armature has an array of BoneCollection pointers. These are ordered
   * such that siblings are always stored in consecutive array elements.
   */
  int child_index;
  int child_count;

  struct IDProperty *prop;
  struct IDProperty *system_properties;
 
#ifdef __cplusplus
  bool is_visible() const;

  bool is_visible_ancestors() const;

  bool is_visible_with_ancestors() const;

  bool is_solo() const;
  bool is_expanded() const;
#endif
} BoneCollection;

typedef struct BoneCollectionMember {
  struct BoneCollectionMember *next, *prev;
  struct Bone *bone;
} BoneCollectionMember;

typedef struct BoneCollectionReference {
  struct BoneCollectionReference *next, *prev;
  struct BoneCollection *bcoll;
} BoneCollectionReference;
 
/* armature->flag */
/* don't use bit 7, was saved in files to disable stuff */
typedef enum eArmature_Flag {
  ARM_RESTPOS = (1 << 0),
  ARM_FLAG_UNUSED_1 = (1 << 1), /* cleared */
  ARM_DRAWAXES = (1 << 2),
  ARM_DRAWNAMES = (1 << 3),
  /* ARM_POSEMODE = (1 << 4), Deprecated. */
  ARM_DRAW_RELATION_FROM_HEAD = (1 << 5), /* Cleared in versioning of pre-2.80 files. */
  ARM_BCOLL_SOLO_ACTIVE = (1 << 6), /* Cleared in versioning of pre-2.80 files. */
  ARM_FLAG_UNUSED_7 = (1 << 7),     /* cleared */
  ARM_MIRROR_EDIT = (1 << 8),
  ARM_FLAG_UNUSED_9 = (1 << 9),
  ARM_NO_CUSTOM = (1 << 10),
  ARM_COL_CUSTOM = (1 << 11),
  ARM_FLAG_UNUSED_12 = (1 << 12), /* cleared */
  ARM_DS_EXPAND = (1 << 13),
  ARM_HAS_VIZ_DEPS = (1 << 14),
} eArmature_Flag;
 
/* armature->drawtype */
typedef enum eArmature_Drawtype {
  ARM_DRAW_TYPE_ARMATURE_DEFINED = -1, /* Use draw type from Armature (only used on Bones). */
  ARM_DRAW_TYPE_OCTA = 0,
  ARM_DRAW_TYPE_STICK = 1,
  ARM_DRAW_TYPE_B_BONE = 2,
  ARM_DRAW_TYPE_ENVELOPE = 3,
  ARM_DRAW_TYPE_WIRE = 4,
} eArmature_Drawtype;
 
/* armature->deformflag */
typedef enum eArmature_DeformFlag {
  ARM_DEF_VGROUP = (1 << 0),
  ARM_DEF_ENVELOPE = (1 << 1),
  ARM_DEF_QUATERNION = (1 << 2),
#ifdef DNA_DEPRECATED_ALLOW
  ARM_DEF_B_BONE_REST = (1 << 3), /* deprecated */
#endif
  ARM_DEF_INVERT_VGROUP = (1 << 4),
} eArmature_DeformFlag;
 
#ifdef DNA_DEPRECATED_ALLOW /* Old animation system (armature only viz). */
typedef enum eArmature_PathFlag {
  ARM_PATH_FNUMS = (1 << 0),
  ARM_PATH_KFRAS = (1 << 1),
  ARM_PATH_HEADS = (1 << 2),
  ARM_PATH_ACFRA = (1 << 3),
  ARM_PATH_KFNOS = (1 << 4),
} eArmature_PathFlag;
#endif
 
/* bone->flag */
typedef enum eBone_Flag {
  BONE_SELECTED = (1 << 0),
  BONE_ROOTSEL = (1 << 1),
  BONE_TIPSEL = (1 << 2),
  BONE_TRANSFORM = (1 << 3),
  BONE_CONNECTED = (1 << 4),
  /* 32 used to be quatrot, was always set in files, do not reuse unless you clear it always */
  BONE_HIDDEN_P = (1 << 6),
  BONE_DONE = (1 << 7),
  BONE_DRAW_ACTIVE = (1 << 8),
  BONE_HINGE = (1 << 9),
  BONE_HIDDEN_A = (1 << 10),
  BONE_MULT_VG_ENV = (1 << 11),
  BONE_NO_DEFORM = (1 << 12),
#ifdef DNA_DEPRECATED_ALLOW
  BONE_UNKEYED = (1 << 13),
  BONE_HINGE_CHILD_TRANSFORM = (1 << 14),
  BONE_NO_SCALE = (1 << 15),
#endif
  BONE_DRAWWIRE = (1 << 17),
  BONE_NO_CYCLICOFFSET = (1 << 18),
  BONE_EDITMODE_LOCKED = (1 << 19),
#ifdef DNA_DEPRECATED_ALLOW
  BONE_TRANSFORM_CHILD = (1 << 20),
#endif
  BONE_UNSELECTABLE = (1 << 21),
  BONE_NO_LOCAL_LOCATION = (1 << 22),
  BONE_RELATIVE_PARENTING = (1 << 23),
#ifdef DNA_DEPRECATED_ALLOW
  BONE_ADD_PARENT_END_ROLL = (1 << 24),
#endif
  BONE_TRANSFORM_MIRROR = (1 << 25),
  BONE_DRAW_LOCKED_WEIGHT = (1 << 26),
} eBone_Flag;
ENUM_OPERATORS(eBone_Flag, BONE_DRAW_LOCKED_WEIGHT)
 
/* bone->inherit_scale_mode */
typedef enum eBone_InheritScaleMode {
  /* Inherit all scale and shear. */
  BONE_INHERIT_SCALE_FULL = 0,
  /* Inherit scale, but remove final shear. */
  BONE_INHERIT_SCALE_FIX_SHEAR = 1,
  /* Inherit average scale. */
  BONE_INHERIT_SCALE_AVERAGE = 2,
  /* Inherit no scale or shear. */
  BONE_INHERIT_SCALE_NONE = 3,
  /* Inherit effects of shear on parent (same as old disabled Inherit Scale). */
  BONE_INHERIT_SCALE_NONE_LEGACY = 4,
  /* Inherit parent X scale as child X scale etc. */
  BONE_INHERIT_SCALE_ALIGNED = 5,
} eBone_InheritScaleMode;
 
/* bone->bbone_prev_type, bbone_next_type */
typedef enum eBone_BBoneHandleType {
  BBONE_HANDLE_AUTO = 0,     /* Default mode based on parents & children. */
  BBONE_HANDLE_ABSOLUTE = 1, /* Custom handle in absolute position mode. */
  BBONE_HANDLE_RELATIVE = 2, /* Custom handle in relative position mode. */
  BBONE_HANDLE_TANGENT = 3,  /* Custom handle in tangent mode (use direction, not location). */
} eBone_BBoneHandleType;
 
/* bone->bbone_mapping_mode */
typedef enum eBone_BBoneMappingMode {
  BBONE_MAPPING_STRAIGHT = 0, /* Default mode that ignores the rest pose curvature. */
  BBONE_MAPPING_CURVED = 1,   /* Mode that takes the rest pose curvature into account. */
} eBone_BBoneMappingMode;
 
/* bone->bbone_flag */
typedef enum eBone_BBoneFlag {
  BBONE_ADD_PARENT_END_ROLL = (1 << 0),
  BBONE_SCALE_EASING = (1 << 1),
} eBone_BBoneFlag;
 
/* bone->bbone_prev/next_flag */
typedef enum eBone_BBoneHandleFlag {
  BBONE_HANDLE_SCALE_X = (1 << 0),
  BBONE_HANDLE_SCALE_Y = (1 << 1),
  BBONE_HANDLE_SCALE_Z = (1 << 2),
  BBONE_HANDLE_SCALE_EASE = (1 << 3),
  BBONE_HANDLE_SCALE_ANY = BBONE_HANDLE_SCALE_X | BBONE_HANDLE_SCALE_Y | BBONE_HANDLE_SCALE_Z |
                           BBONE_HANDLE_SCALE_EASE,
} eBone_BBoneHandleFlag;
 
#define MAXBONENAME 64

typedef enum eBoneCollection_Flag {
  BONE_COLLECTION_VISIBLE = (1 << 0),    /* Visibility flag of this particular collection. */
  BONE_COLLECTION_SELECTABLE = (1 << 1), /* Intended to be implemented in the not-so-far future. */
  BONE_COLLECTION_OVERRIDE_LIBRARY_LOCAL = (1 << 2), /* Added by a local library override. */

  BONE_COLLECTION_ANCESTORS_VISIBLE = (1 << 3),

  BONE_COLLECTION_SOLO = (1 << 4),
 
  BONE_COLLECTION_EXPANDED = (1 << 5), /* Expanded in the tree view. */
} eBoneCollection_Flag;
ENUM_OPERATORS(eBoneCollection_Flag, BONE_COLLECTION_EXPANDED)
 
#ifdef __cplusplus
 
inline blender::animrig::BoneColor &BoneColor::wrap()
{
  return *reinterpret_cast<blender::animrig::BoneColor *>(this);
}
inline const blender::animrig::BoneColor &BoneColor::wrap() const
{
  return *reinterpret_cast<const blender::animrig::BoneColor *>(this);
}
#endif