diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-01-15 15:14:35 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-01-15 15:15:35 +0300 |
commit | 328a0f975be68404604ee2571c1d0c4cf828dfec (patch) | |
tree | 5a0a74b069108f122cad0b1b11829cfa9529abbe /source/blender/makesdna/DNA_constraint_types.h | |
parent | 39acbebe46ef90003201077867a394ebc60d540c (diff) |
Cleanup: comment line length (DNA)
Prevents clang-format wrapping text before comments.
Diffstat (limited to 'source/blender/makesdna/DNA_constraint_types.h')
-rw-r--r-- | source/blender/makesdna/DNA_constraint_types.h | 122 |
1 files changed, 78 insertions, 44 deletions
diff --git a/source/blender/makesdna/DNA_constraint_types.h b/source/blender/makesdna/DNA_constraint_types.h index e27f810b38b..a5bd0890200 100644 --- a/source/blender/makesdna/DNA_constraint_types.h +++ b/source/blender/makesdna/DNA_constraint_types.h @@ -121,15 +121,20 @@ typedef struct bConstraintTarget { /* bConstraintTarget -> flag */ typedef enum eConstraintTargetFlag { - CONSTRAINT_TAR_TEMP = (1<<0) /* temporary target-struct that needs to be freed after use */ + /** temporary target-struct that needs to be freed after use */ + CONSTRAINT_TAR_TEMP = (1<<0) } eConstraintTargetFlag; /* bConstraintTarget/bConstraintOb -> type */ typedef enum eConstraintObType { - CONSTRAINT_OBTYPE_OBJECT = 1, /* string is "" */ - CONSTRAINT_OBTYPE_BONE = 2, /* string is bone-name */ - CONSTRAINT_OBTYPE_VERT = 3, /* string is vertex-group name */ - CONSTRAINT_OBTYPE_CV = 4 /* string is vertex-group name - is not available until curves get vgroups */ + /** string is "" */ + CONSTRAINT_OBTYPE_OBJECT = 1, + /** string is bone-name */ + CONSTRAINT_OBTYPE_BONE = 2, + /** string is vertex-group name */ + CONSTRAINT_OBTYPE_VERT = 3, + /** string is vertex-group name - is not available until curves get vgroups */ + CONSTRAINT_OBTYPE_CV = 4 } eConstraintObType; @@ -201,8 +206,10 @@ typedef struct bKinematicConstraint { } bKinematicConstraint; typedef enum eConstraint_IK_Type { - CONSTRAINT_IK_COPYPOSE = 0, /* 'standard' IK constraint: match position and/or orientation of target */ - CONSTRAINT_IK_DISTANCE = 1 /* maintain distance with target */ + /** 'standard' IK constraint: match position and/or orientation of target */ + CONSTRAINT_IK_COPYPOSE = 0, + /** maintain distance with target */ + CONSTRAINT_IK_DISTANCE = 1 } eConstraint_IK_Type; @@ -606,37 +613,60 @@ typedef struct bTransformCacheConstraint { * broken as their correct value cannot be resolved */ typedef enum eBConstraint_Types { - CONSTRAINT_TYPE_NULL = 0, /* Invalid/legacy constraint */ - CONSTRAINT_TYPE_CHILDOF = 1, /* Unimplemented non longer :) - during constraints recode, Aligorith */ + /** Invalid/legacy constraint */ + CONSTRAINT_TYPE_NULL = 0, + /** Unimplemented non longer :) - during constraints recode, Aligorith */ + CONSTRAINT_TYPE_CHILDOF = 1, CONSTRAINT_TYPE_TRACKTO = 2, CONSTRAINT_TYPE_KINEMATIC = 3, CONSTRAINT_TYPE_FOLLOWPATH = 4, - CONSTRAINT_TYPE_ROTLIMIT = 5, /* Unimplemented no longer :) - Aligorith */ - CONSTRAINT_TYPE_LOCLIMIT = 6, /* Unimplemented no longer :) - Aligorith */ - CONSTRAINT_TYPE_SIZELIMIT = 7, /* Unimplemented no longer :) - Aligorith */ + /** Unimplemented no longer :) - Aligorith */ + CONSTRAINT_TYPE_ROTLIMIT = 5, + /** Unimplemented no longer :) - Aligorith */ + CONSTRAINT_TYPE_LOCLIMIT = 6, + /** Unimplemented no longer :) - Aligorith */ + CONSTRAINT_TYPE_SIZELIMIT = 7, CONSTRAINT_TYPE_ROTLIKE = 8, CONSTRAINT_TYPE_LOCLIKE = 9, CONSTRAINT_TYPE_SIZELIKE = 10, - CONSTRAINT_TYPE_PYTHON = 11, /* Unimplemented no longer :) - Aligorith. Scripts */ + /** Unimplemented no longer :) - Aligorith. Scripts */ + CONSTRAINT_TYPE_PYTHON = 11, CONSTRAINT_TYPE_ACTION = 12, - CONSTRAINT_TYPE_LOCKTRACK = 13, /* New Tracking constraint that locks an axis in place - theeth */ - CONSTRAINT_TYPE_DISTLIMIT = 14, /* limit distance */ - CONSTRAINT_TYPE_STRETCHTO = 15, /* claiming this to be mine :) is in tuhopuu bjornmose */ - CONSTRAINT_TYPE_MINMAX = 16, /* floor constraint */ + /** New Tracking constraint that locks an axis in place - theeth */ + CONSTRAINT_TYPE_LOCKTRACK = 13, + /** limit distance */ + CONSTRAINT_TYPE_DISTLIMIT = 14, + /** claiming this to be mine :) is in tuhopuu bjornmose */ + CONSTRAINT_TYPE_STRETCHTO = 15, + /** floor constraint */ + CONSTRAINT_TYPE_MINMAX = 16, /* CONSTRAINT_TYPE_DEPRECATED = 17 */ - CONSTRAINT_TYPE_CLAMPTO = 18, /* clampto constraint */ - CONSTRAINT_TYPE_TRANSFORM = 19, /* transformation (loc/rot/size -> loc/rot/size) constraint */ - CONSTRAINT_TYPE_SHRINKWRAP = 20, /* shrinkwrap (loc/rot) constraint */ - CONSTRAINT_TYPE_DAMPTRACK = 21, /* New Tracking constraint that minimizes twisting */ - CONSTRAINT_TYPE_SPLINEIK = 22, /* Spline-IK - Align 'n' bones to a curve */ - CONSTRAINT_TYPE_TRANSLIKE = 23, /* Copy transform matrix */ - CONSTRAINT_TYPE_SAMEVOL = 24, /* Maintain volume during scaling */ - CONSTRAINT_TYPE_PIVOT = 25, /* Pivot Constraint */ - CONSTRAINT_TYPE_FOLLOWTRACK = 26, /* Follow Track Constraint */ - CONSTRAINT_TYPE_CAMERASOLVER = 27, /* Camera Solver Constraint */ - CONSTRAINT_TYPE_OBJECTSOLVER = 28, /* Object Solver Constraint */ - CONSTRAINT_TYPE_TRANSFORM_CACHE = 29, /* Transform Cache Constraint */ - CONSTRAINT_TYPE_ARMATURE = 30, /* Armature Deform Constraint */ + /** clampto constraint */ + CONSTRAINT_TYPE_CLAMPTO = 18, + /** transformation (loc/rot/size -> loc/rot/size) constraint */ + CONSTRAINT_TYPE_TRANSFORM = 19, + /** shrinkwrap (loc/rot) constraint */ + CONSTRAINT_TYPE_SHRINKWRAP = 20, + /** New Tracking constraint that minimizes twisting */ + CONSTRAINT_TYPE_DAMPTRACK = 21, + /** Spline-IK - Align 'n' bones to a curve */ + CONSTRAINT_TYPE_SPLINEIK = 22, + /** Copy transform matrix */ + CONSTRAINT_TYPE_TRANSLIKE = 23, + /** Maintain volume during scaling */ + CONSTRAINT_TYPE_SAMEVOL = 24, + /** Pivot Constraint */ + CONSTRAINT_TYPE_PIVOT = 25, + /** Follow Track Constraint */ + CONSTRAINT_TYPE_FOLLOWTRACK = 26, + /** Camera Solver Constraint */ + CONSTRAINT_TYPE_CAMERASOLVER = 27, + /** Object Solver Constraint */ + CONSTRAINT_TYPE_OBJECTSOLVER = 28, + /** Transform Cache Constraint */ + CONSTRAINT_TYPE_TRANSFORM_CACHE = 29, + /** Armature Deform Constraint */ + CONSTRAINT_TYPE_ARMATURE = 30, /* NOTE: no constraints are allowed to be added after this */ NUM_CONSTRAINT_TYPES @@ -644,27 +674,28 @@ typedef enum eBConstraint_Types { /* bConstraint->flag */ /* flags 0x2 (1<<1) and 0x8 (1<<3) were used in past */ -/* flag 0x20 (1<<5) was used to indicate that a constraint was evaluated using a 'local' hack for posebones only */ +/* flag 0x20 (1<<5) was used to indicate that a constraint was evaluated + * using a 'local' hack for posebones only. */ typedef enum eBConstraint_Flags { - /* expand for UI */ + /* expand for UI */ CONSTRAINT_EXPAND = (1<<0), - /* pre-check for illegal object name or bone name */ + /* pre-check for illegal object name or bone name */ CONSTRAINT_DISABLE = (1<<2), - /* to indicate which Ipo should be shown, maybe for 3d access later too */ + /* to indicate which Ipo should be shown, maybe for 3d access later too */ CONSTRAINT_ACTIVE = (1<<4), - /* to indicate that the owner's space should only be changed into ownspace, but not out of it */ + /* to indicate that the owner's space should only be changed into ownspace, but not out of it */ CONSTRAINT_SPACEONCE = (1<<6), - /* influence ipo is on constraint itself, not in action channel */ + /* influence ipo is on constraint itself, not in action channel */ CONSTRAINT_OWN_IPO = (1<<7), - /* indicates that constraint was added locally (i.e. didn't come from the proxy-lib) */ + /* indicates that constraint was added locally (i.e. didn't come from the proxy-lib) */ CONSTRAINT_PROXY_LOCAL = (1<<8), - /* indicates that constraint is temporarily disabled (only used in GE) */ + /* indicates that constraint is temporarily disabled (only used in GE) */ CONSTRAINT_OFF = (1<<9), - /* use bbone curve shape when calculating headtail values (also used by dependency graph!) */ + /* use bbone curve shape when calculating headtail values (also used by dependency graph!) */ CONSTRAINT_BBONE_SHAPE = (1<<10), - /* That constraint has been inserted in local override (i.e. it can be fully edited!). */ + /* That constraint has been inserted in local override (i.e. it can be fully edited!). */ CONSTRAINT_STATICOVERRIDE_LOCAL = (1 << 11), - /* use full transformation (not just segment locations) - only set at runtime */ + /* use full transformation (not just segment locations) - only set at runtime */ CONSTRAINT_BBONE_SHAPE_FULL = (1 << 12), } eBConstraint_Flags; @@ -882,9 +913,12 @@ typedef enum eSplineIK_XZScaleModes { /* bArmatureConstraint -> flag */ typedef enum eArmature_Flags { - CONSTRAINT_ARMATURE_QUATERNION = (1<<0), /* use dual quaternion blending */ - CONSTRAINT_ARMATURE_ENVELOPE = (1<<1), /* use envelopes */ - CONSTRAINT_ARMATURE_CUR_LOCATION = (1<<2), /* use current bone location */ + /** use dual quaternion blending */ + CONSTRAINT_ARMATURE_QUATERNION = (1<<0), + /** use envelopes */ + CONSTRAINT_ARMATURE_ENVELOPE = (1<<1), + /** use current bone location */ + CONSTRAINT_ARMATURE_CUR_LOCATION = (1<<2), } eArmature_Flags; /* MinMax (floor) flags */ |