DNA_armature_types.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 */
 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct AnimData;
 
/* this system works on different transformation space levels;
 *
 * 1) Bone Space;      with each Bone having own (0,0,0) origin
 * 2) Armature Space;  the rest position, in Object space, Bones Spaces are applied hierarchical
 * 3) Pose Space;      the animation position, in Object space
 * 4) World Space;     Object matrix applied to Pose or Armature space
 */
 
typedef struct Bone {
  struct Bone *next, *prev;
  IDProperty *prop;
  struct Bone *parent;
  ListBase childbase;
  char name[64];
 
  float roll;
  float head[3];
  float tail[3];
  float bone_mat[3][3];
 
  int flag;
 
  char inherit_scale_mode;
  char _pad[7];
 
  float arm_head[3];
  float arm_tail[3];
  float arm_mat[4][4];
  float arm_roll;
 
  float dist, weight;
  float xwidth, length, zwidth;
  float rad_head, rad_tail;
 
  float roll1, roll2;
  float curve_in_x, curve_in_y;
  float curve_out_x, curve_out_y;
  float ease1, ease2;
  float scale_in_x, scale_in_y;
  float scale_out_x, scale_out_y;
 
  float size[3];
  int layer;
  short segments;
 
  char bbone_prev_type;
  char bbone_next_type;
  struct Bone *bbone_prev;
  struct Bone *bbone_next;
} Bone;
 
typedef struct bArmature {
  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;
 
  short deformflag;
  short pathflag;
 
  unsigned int layer_used;
  unsigned int layer, layer_protected;
 
  float axes_position;
} bArmature;
 
/* 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),
  ARM_FLAG_UNUSED_5 = (1 << 5), /* cleared */
  ARM_FLAG_UNUSED_6 = (1 << 6), /* cleared */
  ARM_FLAG_UNUSED_7 = (1 << 7),
  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_OCTA = 0,
  ARM_LINE = 1,
  ARM_B_BONE = 2,
  ARM_ENVELOPE = 3,
  ARM_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;
 
/* armature->pathflag */
// XXX deprecated... old animation system (armature only viz)
#ifdef DNA_DEPRECATED_ALLOW
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),
#endif
  BONE_HINGE_CHILD_TRANSFORM = (1 << 14),
#ifdef DNA_DEPRECATED_ALLOW
  BONE_NO_SCALE = (1 << 15),
#endif
  BONE_HIDDEN_PG = (1 << 16),
  BONE_DRAWWIRE = (1 << 17),
  BONE_NO_CYCLICOFFSET = (1 << 18),
  BONE_EDITMODE_LOCKED = (1 << 19),
  BONE_TRANSFORM_CHILD = (1 << 20),
  BONE_UNSELECTABLE = (1 << 21),
  BONE_NO_LOCAL_LOCATION = (1 << 22),
  BONE_RELATIVE_PARENTING = (1 << 23),
  BONE_ADD_PARENT_END_ROLL = (1 << 24),
  BONE_TRANSFORM_MIRROR = (1 << 25),
  BONE_DRAW_LOCKED_WEIGHT = (1 << 26),
} eBone_Flag;
 
/* 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;
 
#define MAXBONENAME 64
 
#ifdef __cplusplus
}
#endif