Blender  V3.3
Classes | Macros | Typedefs | Enumerations
DNA_armature_types.h File Reference
#include "DNA_ID.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"

Go to the source code of this file.

Classes

struct  Bone
 
struct  bArmature
 

Macros

#define MAXBONENAME   64
 

Typedefs

typedef struct Bone Bone
 
typedef struct bArmature bArmature
 
typedef enum eArmature_Flag eArmature_Flag
 
typedef enum eArmature_Drawtype eArmature_Drawtype
 
typedef enum eArmature_DeformFlag eArmature_DeformFlag
 
typedef enum eBone_Flag eBone_Flag
 
typedef enum eBone_InheritScaleMode eBone_InheritScaleMode
 
typedef enum eBone_BBoneHandleType eBone_BBoneHandleType
 
typedef enum eBone_BBoneFlag eBone_BBoneFlag
 
typedef enum eBone_BBoneHandleFlag eBone_BBoneHandleFlag
 

Enumerations

enum  eArmature_Flag {
  ARM_RESTPOS = (1 << 0) , ARM_FLAG_UNUSED_1 = (1 << 1) , ARM_DRAWAXES = (1 << 2) , ARM_DRAWNAMES = (1 << 3) ,
  ARM_POSEMODE = (1 << 4) , ARM_FLAG_UNUSED_5 = (1 << 5) , ARM_FLAG_UNUSED_6 = (1 << 6) , 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) , ARM_DS_EXPAND = (1 << 13) , ARM_HAS_VIZ_DEPS = (1 << 14)
}
 
enum  eArmature_Drawtype {
  ARM_OCTA = 0 , ARM_LINE = 1 , ARM_B_BONE = 2 , ARM_ENVELOPE = 3 ,
  ARM_WIRE = 4
}
 
enum  eArmature_DeformFlag { ARM_DEF_VGROUP = (1 << 0) , ARM_DEF_ENVELOPE = (1 << 1) , ARM_DEF_QUATERNION = (1 << 2) , ARM_DEF_INVERT_VGROUP = (1 << 4) }
 
enum  eBone_Flag {
  BONE_SELECTED = (1 << 0) , BONE_ROOTSEL = (1 << 1) , BONE_TIPSEL = (1 << 2) , BONE_TRANSFORM = (1 << 3) ,
  BONE_CONNECTED = (1 << 4) , 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) ,
  BONE_HINGE_CHILD_TRANSFORM = (1 << 14) , 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_TRANSFORM_MIRROR = (1 << 25) , BONE_DRAW_LOCKED_WEIGHT = (1 << 26)
}
 
enum  eBone_InheritScaleMode {
  BONE_INHERIT_SCALE_FULL = 0 , BONE_INHERIT_SCALE_FIX_SHEAR = 1 , BONE_INHERIT_SCALE_AVERAGE = 2 , BONE_INHERIT_SCALE_NONE = 3 ,
  BONE_INHERIT_SCALE_NONE_LEGACY = 4 , BONE_INHERIT_SCALE_ALIGNED = 5
}
 
enum  eBone_BBoneHandleType { BBONE_HANDLE_AUTO = 0 , BBONE_HANDLE_ABSOLUTE = 1 , BBONE_HANDLE_RELATIVE = 2 , BBONE_HANDLE_TANGENT = 3 }
 
enum  eBone_BBoneFlag { BBONE_ADD_PARENT_END_ROLL = (1 << 0) , BBONE_SCALE_EASING = (1 << 1) }
 
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
}
 

Macro Definition Documentation

◆ MAXBONENAME

#define MAXBONENAME   64

Definition at line 312 of file DNA_armature_types.h.

Typedef Documentation

◆ bArmature

typedef struct bArmature bArmature

◆ Bone

typedef struct Bone Bone

◆ eArmature_DeformFlag

◆ eArmature_Drawtype

◆ eArmature_Flag

◆ eBone_BBoneFlag

◆ eBone_BBoneHandleFlag

◆ eBone_BBoneHandleType

◆ eBone_Flag

typedef enum eBone_Flag eBone_Flag

◆ eBone_InheritScaleMode

Enumeration Type Documentation

◆ eArmature_DeformFlag

Enumerator
ARM_DEF_VGROUP 
ARM_DEF_ENVELOPE 
ARM_DEF_QUATERNION 
ARM_DEF_INVERT_VGROUP 

Definition at line 184 of file DNA_armature_types.h.

◆ eArmature_Drawtype

Enumerator
ARM_OCTA 
ARM_LINE 
ARM_B_BONE 
ARM_ENVELOPE 
ARM_WIRE 

Definition at line 175 of file DNA_armature_types.h.

◆ eArmature_Flag

Enumerator
ARM_RESTPOS 
ARM_FLAG_UNUSED_1 

XRAY is here only for backwards converting

ARM_DRAWAXES 
ARM_DRAWNAMES 
ARM_POSEMODE 
ARM_FLAG_UNUSED_5 
ARM_FLAG_UNUSED_6 
ARM_FLAG_UNUSED_7 
ARM_MIRROR_EDIT 
ARM_FLAG_UNUSED_9 
ARM_NO_CUSTOM 

Made option negative, for backwards compatibility.

ARM_COL_CUSTOM 

Draw custom colors.

ARM_FLAG_UNUSED_12 

When ghosting, only show selected bones (this should belong to ghostflag instead).

ARM_DS_EXPAND 

Dope-sheet channel is expanded

ARM_HAS_VIZ_DEPS 

Other objects are used for visualizing various states (hack for efficient updates).

Definition at line 150 of file DNA_armature_types.h.

◆ eBone_BBoneFlag

Enumerator
BBONE_ADD_PARENT_END_ROLL 

Add the parent Out roll to the In roll.

BBONE_SCALE_EASING 

Multiply B-Bone easing values with Scale Length.

Definition at line 290 of file DNA_armature_types.h.

◆ eBone_BBoneHandleFlag

Enumerator
BBONE_HANDLE_SCALE_X 

Use handle bone scaling for scale X.

BBONE_HANDLE_SCALE_Y 

Use handle bone scaling for scale Y (length).

BBONE_HANDLE_SCALE_Z 

Use handle bone scaling for scale Z.

BBONE_HANDLE_SCALE_EASE 

Use handle bone scaling for easing.

BBONE_HANDLE_SCALE_ANY 

Is handle scale required?

Definition at line 298 of file DNA_armature_types.h.

◆ eBone_BBoneHandleType

Enumerator
BBONE_HANDLE_AUTO 
BBONE_HANDLE_ABSOLUTE 
BBONE_HANDLE_RELATIVE 
BBONE_HANDLE_TANGENT 

Definition at line 282 of file DNA_armature_types.h.

◆ eBone_Flag

enum eBone_Flag
Enumerator
BONE_SELECTED 
BONE_ROOTSEL 
BONE_TIPSEL 
BONE_TRANSFORM 

Used instead of BONE_SELECTED during transform (clear before use)

BONE_CONNECTED 

When bone has a parent, connect head of bone to parent's tail.

BONE_HIDDEN_P 

hidden Bones when drawing PoseChannels

BONE_DONE 

For detecting cyclic dependencies

BONE_DRAW_ACTIVE 

active is on mouse clicks only - deprecated, ONLY USE FOR DRAWING

BONE_HINGE 

No parent rotation or scale

BONE_HIDDEN_A 

hidden Bones when drawing Armature Editmode

BONE_MULT_VG_ENV 

multiplies vgroup with envelope

BONE_NO_DEFORM 

bone doesn't deform geometry

BONE_HINGE_CHILD_TRANSFORM 

set to prevent hinge child bones from influencing the transform center

BONE_HIDDEN_PG 

hidden bone when drawing PoseChannels (for ghost drawing)

BONE_DRAWWIRE 

bone should be drawn as OB_WIRE, regardless of draw-types of view+armature

BONE_NO_CYCLICOFFSET 

when no parent, bone will not get cyclic offset

BONE_EDITMODE_LOCKED 

bone transforms are locked in EditMode

BONE_TRANSFORM_CHILD 

Indicates that a parent is also being transformed

BONE_UNSELECTABLE 

bone cannot be selected

BONE_NO_LOCAL_LOCATION 

bone location is in armature space

BONE_RELATIVE_PARENTING 

object child will use relative transform (like deform)

BONE_TRANSFORM_MIRROR 

this bone was transformed by the mirror function

BONE_DRAW_LOCKED_WEIGHT 

this bone is associated with a locked vertex group, ONLY USE FOR DRAWING

Definition at line 206 of file DNA_armature_types.h.

◆ eBone_InheritScaleMode

Enumerator
BONE_INHERIT_SCALE_FULL 
BONE_INHERIT_SCALE_FIX_SHEAR 
BONE_INHERIT_SCALE_AVERAGE 
BONE_INHERIT_SCALE_NONE 
BONE_INHERIT_SCALE_NONE_LEGACY 
BONE_INHERIT_SCALE_ALIGNED 

Definition at line 266 of file DNA_armature_types.h.