diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-01-14 08:15:33 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-01-14 08:20:55 +0300 |
commit | a1d73d03eb91be72b0f10ff4a9c6eb00f04b97c6 (patch) | |
tree | 3e8ebea3ccb39f93dec36145200169de8acf8556 /source/blender/blenkernel/BKE_constraint.h | |
parent | 63ee378fa96d1906adc8da3d318a73333f52b643 (diff) |
Cleanup: move comments above definitions
For clang-format not to wrap definitions.
Diffstat (limited to 'source/blender/blenkernel/BKE_constraint.h')
-rw-r--r-- | source/blender/blenkernel/BKE_constraint.h | 56 |
1 files changed, 34 insertions, 22 deletions
diff --git a/source/blender/blenkernel/BKE_constraint.h b/source/blender/blenkernel/BKE_constraint.h index bfcdcb68c4a..9e723b49b63 100644 --- a/source/blender/blenkernel/BKE_constraint.h +++ b/source/blender/blenkernel/BKE_constraint.h @@ -49,16 +49,24 @@ extern "C" { /* special struct for use in constraint evaluation */ typedef struct bConstraintOb { - struct Depsgraph *depsgraph;/* to get evaluated armature. */ - struct Scene *scene; /* for system time, part of deglobalization, code nicer later with local time (ton) */ - struct Object *ob; /* if pchan, then armature that it comes from, otherwise constraint owner */ - struct bPoseChannel *pchan; /* pose channel that owns the constraints being evaluated */ - - float matrix[4][4]; /* matrix where constraints are accumulated + solved */ - float startmat[4][4]; /* original matrix (before constraint solving) */ - - short type; /* type of owner */ - short rotOrder; /* rotation order for constraint owner (as defined in eEulerRotationOrders in BLI_math.h) */ + /** to get evaluated armature. */ + struct Depsgraph *depsgraph; + /** for system time, part of deglobalization, code nicer later with local time (ton) */ + struct Scene *scene; + /** if pchan, then armature that it comes from, otherwise constraint owner */ + struct Object *ob; + /** pose channel that owns the constraints being evaluated */ + struct bPoseChannel *pchan; + + /** matrix where constraints are accumulated + solved */ + float matrix[4][4]; + /** original matrix (before constraint solving) */ + float startmat[4][4]; + + /** type of owner */ + short type; + /** rotation order for constraint owner (as defined in eEulerRotationOrders in BLI_math.h) */ + short rotOrder; } bConstraintOb; /* ---------------------------------------------------------------------------- */ @@ -83,31 +91,35 @@ typedef void (*ConstraintIDFunc)(struct bConstraint *con, struct ID **idpoin, bo */ typedef struct bConstraintTypeInfo { /* admin/ident */ - short type; /* CONSTRAINT_TYPE_### */ - short size; /* size in bytes of the struct */ - char name[32]; /* name of constraint in interface */ - char structName[32]; /* name of struct for SDNA */ + /** CONSTRAINT_TYPE_### */ + short type; + /** size in bytes of the struct */ + short size; + /** name of constraint in interface */ + char name[32]; + /** name of struct for SDNA */ + char structName[32]; /* data management function pointers - special handling */ - /* free any data that is allocated separately (optional) */ + /** free any data that is allocated separately (optional) */ void (*free_data)(struct bConstraint *con); - /* run the provided callback function on all the ID-blocks linked to the constraint */ + /** run the provided callback function on all the ID-blocks linked to the constraint */ void (*id_looper)(struct bConstraint *con, ConstraintIDFunc func, void *userdata); - /* copy any special data that is allocated separately (optional) */ + /** copy any special data that is allocated separately (optional) */ void (*copy_data)(struct bConstraint *con, struct bConstraint *src); - /* set settings for data that will be used for bConstraint.data (memory already allocated using MEM_callocN) */ + /** set settings for data that will be used for bConstraint.data (memory already allocated using MEM_callocN) */ void (*new_data)(void *cdata); /* target handling function pointers */ - /* for multi-target constraints: return that list; otherwise make a temporary list (returns number of targets) */ + /** for multi-target constraints: return that list; otherwise make a temporary list (returns number of targets) */ int (*get_constraint_targets)(struct bConstraint *con, struct ListBase *list); - /* for single-target constraints only: flush data back to source data, and the free memory used */ + /** for single-target constraints only: flush data back to source data, and the free memory used */ void (*flush_constraint_targets)(struct bConstraint *con, struct ListBase *list, bool no_copy); /* evaluation */ - /* set the ct->matrix for the given constraint target (at the given ctime) */ + /** set the ct->matrix for the given constraint target (at the given ctime) */ void (*get_target_matrix)(struct Depsgraph *depsgraph, struct bConstraint *con, struct bConstraintOb *cob, struct bConstraintTarget *ct, float ctime); - /* evaluate the constraint for the given time */ + /** evaluate the constraint for the given time */ void (*evaluate_constraint)(struct bConstraint *con, struct bConstraintOb *cob, struct ListBase *targets); } bConstraintTypeInfo; |