From b8e8c0e325d213f2dcf4adad5506989fa224716e Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 15 Jan 2019 23:24:20 +1100 Subject: Cleanup: comment line length (editors) Prevents clang-format wrapping text before comments. --- source/blender/editors/include/ED_anim_api.h | 206 +++++++++++++-------- source/blender/editors/include/ED_armature.h | 56 +++--- source/blender/editors/include/ED_fileselect.h | 6 +- source/blender/editors/include/ED_keyframes_draw.h | 21 ++- source/blender/editors/include/ED_keyframes_edit.h | 36 ++-- source/blender/editors/include/ED_keyframing.h | 31 +++- source/blender/editors/include/ED_numinput.h | 32 ++-- source/blender/editors/include/ED_object.h | 9 +- source/blender/editors/include/ED_screen_types.h | 16 +- source/blender/editors/include/ED_transverts.h | 9 +- source/blender/editors/include/ED_view3d.h | 15 +- source/blender/editors/include/UI_interface.h | 22 ++- 12 files changed, 296 insertions(+), 163 deletions(-) (limited to 'source/blender/editors/include') diff --git a/source/blender/editors/include/ED_anim_api.h b/source/blender/editors/include/ED_anim_api.h index bbc9f25b542..ec7c5f989d0 100644 --- a/source/blender/editors/include/ED_anim_api.h +++ b/source/blender/editors/include/ED_anim_api.h @@ -69,29 +69,46 @@ struct PropertyRNA; * 'context' information */ typedef struct bAnimContext { - void *data; /* data to be filtered for use in animation editor */ - short datatype; /* type of data eAnimCont_Types */ - - short mode; /* editor->mode */ - short spacetype; /* sa->spacetype */ - short regiontype; /* active region -> type (channels or main) */ - - struct ScrArea *sa; /* editor host */ - struct SpaceLink *sl; /* editor data */ - struct ARegion *ar; /* region within editor */ - - struct bDopeSheet *ads; /* dopesheet data for editor (or which is being used) */ - - struct Depsgraph *depsgraph; /* active dependency graph */ - struct Main *bmain; /* Current Main */ - struct Scene *scene; /* active scene */ - struct ViewLayer *view_layer; /* active scene layer */ - struct Object *obact; /* active object */ - ListBase *markers; /* active set of markers */ - - struct ReportList *reports; /* pointer to current reports list */ - - float yscale_fac; /* scale factor for height of channels (i.e. based on the size of keyframes) */ + /** data to be filtered for use in animation editor */ + void *data; + /** type of data eAnimCont_Types */ + short datatype; + + /** editor->mode */ + short mode; + /** sa->spacetype */ + short spacetype; + /** active region -> type (channels or main) */ + short regiontype; + + /** editor host */ + struct ScrArea *sa; + /** editor data */ + struct SpaceLink *sl; + /** region within editor */ + struct ARegion *ar; + + /** dopesheet data for editor (or which is being used) */ + struct bDopeSheet *ads; + + /** active dependency graph */ + struct Depsgraph *depsgraph; + /** Current Main */ + struct Main *bmain; + /** active scene */ + struct Scene *scene; + /** active scene layer */ + struct ViewLayer *view_layer; + /** active object */ + struct Object *obact; + /** active set of markers */ + ListBase *markers; + + /** pointer to current reports list */ + struct ReportList *reports; + + /** Scale factor for height of channels (i.e. based on the size of keyframes). */ + float yscale_fac; } bAnimContext; /* Main Data container types */ @@ -117,31 +134,44 @@ typedef enum eAnimCont_Types { typedef struct bAnimListElem { struct bAnimListElem *next, *prev; - void *data; /* source data this elem represents */ - int type; /* (eAnim_ChannelType) one of the ANIMTYPE_* values */ - int flag; /* copy of elem's flags for quick access */ - int index; /* for un-named data, the index of the data in its collection */ - - char update; /* (eAnim_Update_Flags) tag the element for updating */ - char tag; /* tag the included data. Temporary always */ - - short datatype; /* (eAnim_KeyType) type of motion data to expect */ - void *key_data; /* motion data - mostly F-Curves, but can be other types too */ - - - /* NOTE: id here is the "IdAdtTemplate"-style datablock (e.g. Object, Material, Texture, NodeTree) - * from which evaluation of the RNA-paths takes place. It's used to figure out how deep - * channels should be nested (e.g. for Textures/NodeTrees) in the tree, and allows property - * lookups (e.g. for sliders and for inserting keyframes) to work. If we had instead used - * bAction or something similar, none of this would be possible: although it's trivial - * to use an IdAdtTemplate type to find the source action a channel (e.g. F-Curve) comes from - * (i.e. in the AnimEditors, it *must* be the active action, as only that can be edited), - * it's impossible to go the other way (i.e. one action may be used in multiple places). + /** source data this elem represents */ + void *data; + /** (eAnim_ChannelType) one of the ANIMTYPE_* values */ + int type; + /** copy of elem's flags for quick access */ + int flag; + /** for un-named data, the index of the data in its collection */ + int index; + + /** (eAnim_Update_Flags) tag the element for updating */ + char update; + /** tag the included data. Temporary always */ + char tag; + + /** (eAnim_KeyType) type of motion data to expect */ + short datatype; + /** motion data - mostly F-Curves, but can be other types too */ + void *key_data; + + + /** + * \note + * id here is the "IdAdtTemplate"-style datablock (e.g. Object, Material, Texture, NodeTree) + * from which evaluation of the RNA-paths takes place. It's used to figure out how deep + * channels should be nested (e.g. for Textures/NodeTrees) in the tree, and allows property + * lookups (e.g. for sliders and for inserting keyframes) to work. If we had instead used + * bAction or something similar, none of this would be possible: although it's trivial + * to use an IdAdtTemplate type to find the source action a channel (e.g. F-Curve) comes from + * (i.e. in the AnimEditors, it *must* be the active action, as only that can be edited), + * it's impossible to go the other way (i.e. one action may be used in multiple places). */ - struct ID *id; /* ID block that channel is attached to */ - struct AnimData *adt; /* source of the animation data attached to ID block (for convenience) */ + /** ID block that channel is attached to */ + struct ID *id; + /** source of the animation data attached to ID block (for convenience) */ + struct AnimData *adt; - /* For list element which corresponds to a f-curve, this is an ID which + /** + * For list element which corresponds to a f-curve, this is an ID which * owns the f-curve. * * For example, if the f-curve is coming from Action, this id will be set to @@ -153,13 +183,18 @@ typedef struct bAnimListElem { * object. */ struct ID *fcurve_owner_id; - void *owner; /* for per-element F-Curves (e.g. NLA Control Curves), the element that this represents (e.g. NlaStrip) */ + /** + * for per-element F-Curves + * (e.g. NLA Control Curves), the element that this represents (e.g. NlaStrip) */ + void *owner; } bAnimListElem; -/* Some types for easier type-testing - * NOTE: need to keep the order of these synchronized with the channels define code - * which is used for drawing and handling channel lists for +/** + * Some types for easier type-testing + * + * \note need to keep the order of these synchronized with the channels define code + * which is used for drawing and handling channel lists for. */ typedef enum eAnim_ChannelType { ANIMTYPE_NONE = 0, @@ -248,42 +283,46 @@ typedef enum eAnim_Update_Flags { /* filtering flags - under what circumstances should a channel be returned */ typedef enum eAnimFilter_Flags { - /* data which channel represents is fits the dopesheet filters (i.e. scene visibility criteria) */ + /** data which channel represents is fits the dopesheet filters + * (i.e. scene visibility criteria) */ // XXX: it's hard to think of any examples where this *ISN'T* the case... perhaps becomes implicit? ANIMFILTER_DATA_VISIBLE = (1 << 0), - /* channel is visible within the channel-list hierarchy (i.e. F-Curves within Groups in ActEdit) */ + /** channel is visible within the channel-list hierarchy + * (i.e. F-Curves within Groups in ActEdit) */ ANIMFILTER_LIST_VISIBLE = (1 << 1), - /* channel has specifically been tagged as visible in Graph Editor (* Graph Editor Only) */ + /** channel has specifically been tagged as visible in Graph Editor (* Graph Editor Only) */ ANIMFILTER_CURVE_VISIBLE = (1 << 2), - /* include summary channels and "expanders" (for drawing/mouse-selection in channel list) */ + /** include summary channels and "expanders" (for drawing/mouse-selection in channel list) */ ANIMFILTER_LIST_CHANNELS = (1 << 3), - /* for its type, channel should be "active" one */ + /** for its type, channel should be "active" one */ ANIMFILTER_ACTIVE = (1 << 4), - /* channel is a child of the active group (* Actions speciality) */ + /** channel is a child of the active group (* Actions speciality) */ ANIMFILTER_ACTGROUPED = (1 << 5), - /* channel must be selected/not-selected, but both must not be set together */ + /** channel must be selected/not-selected, but both must not be set together */ ANIMFILTER_SEL = (1 << 6), ANIMFILTER_UNSEL = (1 << 7), - /* editability status - must be editable to be included */ + /** editability status - must be editable to be included */ ANIMFILTER_FOREDIT = (1 << 8), - /* only selected animchannels should be considerable as editable - mainly for Graph Editor's option for keys on select curves only */ + /** only selected animchannels should be considerable as editable - mainly + * for Graph Editor's option for keys on select curves only */ ANIMFILTER_SELEDIT = (1 << 9), - /* flags used to enforce certain data types */ - // NOTE: the ones for curves and NLA tracks were redundant and have been removed for now... + /** flags used to enforce certain data types + * \node the ones for curves and NLA tracks were redundant and have been removed for now... + */ ANIMFILTER_ANIMDATA = (1 << 10), - /* duplicate entries for animation data attached to multi-user blocks must not occur */ + /** duplicate entries for animation data attached to multi-user blocks must not occur */ ANIMFILTER_NODUPLIS = (1 << 11), - /* for checking if we should keep some collapsed channel around (internal use only!) */ + /** for checking if we should keep some collapsed channel around (internal use only!) */ ANIMFILTER_TMP_PEEK = (1 << 30), - /* ignore ONLYSEL flag from filterflag, (internal use only!) */ + /** ignore ONLYSEL flag from filterflag, (internal use only!) */ ANIMFILTER_TMP_IGNORE_ONLYSEL = (1u << 31) } eAnimFilter_Flags; @@ -429,30 +468,42 @@ void ANIM_animdata_freelist(ListBase *anim_data); /* role or level of animchannel in the hierarchy */ typedef enum eAnimChannel_Role { - ACHANNEL_ROLE_EXPANDER = -1, /* datablock expander - a "composite" channel type */ - ACHANNEL_ROLE_SPECIAL = 0, /* special purposes - not generally for hierarchy processing */ - ACHANNEL_ROLE_CHANNEL = 1 /* data channel - a channel representing one of the actual building blocks of channels */ + /** datablock expander - a "composite" channel type */ + ACHANNEL_ROLE_EXPANDER = -1, + /** special purposes - not generally for hierarchy processing */ + ACHANNEL_ROLE_SPECIAL = 0, + /** data channel - a channel representing one of the actual building blocks of channels */ + ACHANNEL_ROLE_CHANNEL = 1 } eAnimChannel_Role; /* flag-setting behavior */ typedef enum eAnimChannels_SetFlag { - ACHANNEL_SETFLAG_CLEAR = 0, /* turn off */ - ACHANNEL_SETFLAG_ADD = 1, /* turn on */ - ACHANNEL_SETFLAG_INVERT = 2, /* on->off, off->on */ - ACHANNEL_SETFLAG_TOGGLE = 3 /* some on -> all off // all on */ + /** turn off */ + ACHANNEL_SETFLAG_CLEAR = 0, + /** turn on */ + ACHANNEL_SETFLAG_ADD = 1, + /** on->off, off->on */ + ACHANNEL_SETFLAG_INVERT = 2, + /** some on -> all off // all on */ + ACHANNEL_SETFLAG_TOGGLE = 3 } eAnimChannels_SetFlag; /* types of settings for AnimChannels */ typedef enum eAnimChannel_Settings { ACHANNEL_SETTING_SELECT = 0, - ACHANNEL_SETTING_PROTECT = 1, /* warning: for drawing UI's, need to check if this is off (maybe inverse this later) */ + /** warning: for drawing UI's, need to check if this is off (maybe inverse this later) */ + ACHANNEL_SETTING_PROTECT = 1, ACHANNEL_SETTING_MUTE = 2, ACHANNEL_SETTING_EXPAND = 3, - ACHANNEL_SETTING_VISIBLE = 4, /* only for Graph Editor */ - ACHANNEL_SETTING_SOLO = 5, /* only for NLA Tracks */ - ACHANNEL_SETTING_PINNED = 6, /* only for NLA Actions */ + /** only for Graph Editor */ + ACHANNEL_SETTING_VISIBLE = 4, + /** only for NLA Tracks */ + ACHANNEL_SETTING_SOLO = 5, + /** only for NLA Actions */ + ACHANNEL_SETTING_PINNED = 6, ACHANNEL_SETTING_MOD_OFF = 7, - ACHANNEL_SETTING_ALWAYS_VISIBLE = 8, /* channel is pinned and always visible */ + /** channel is pinned and always visible */ + ACHANNEL_SETTING_ALWAYS_VISIBLE = 8, } eAnimChannel_Settings; @@ -542,7 +593,8 @@ void ANIM_deselect_anim_channels(bAnimContext *ac, void *data, eAnimCont_Types d void ANIM_set_active_channel(bAnimContext *ac, void *data, eAnimCont_Types datatype, eAnimFilter_Flags filter, void *channel_data, eAnim_ChannelType channel_type); -/* Delete the F-Curve from the given AnimData block (if possible), as appropriate according to animation context */ +/* Delete the F-Curve from the given AnimData block (if possible), + * as appropriate according to animation context */ void ANIM_fcurve_delete_from_animdata(bAnimContext *ac, struct AnimData *adt, struct FCurve *fcu); /* ************************************************ */ diff --git a/source/blender/editors/include/ED_armature.h b/source/blender/editors/include/ED_armature.h index 3306fa09f12..bce04f4382f 100644 --- a/source/blender/editors/include/ED_armature.h +++ b/source/blender/editors/include/ED_armature.h @@ -58,26 +58,32 @@ struct UndoType; typedef struct EditBone { struct EditBone *next, *prev; - struct IDProperty *prop; /* User-Defined Properties on this Bone */ - struct EditBone *parent; /* Editbones have a one-way link (i.e. children refer - * to parents. This is converted to a two-way link for - * normal bones when leaving editmode. */ - char name[64]; /* MAXBONENAME */ - float roll; /* Roll along axis. We'll ultimately use the axis/angle method - * for determining the transformation matrix of the bone. The axis - * is tail-head while roll provides the angle. Refer to Graphics - * Gems 1 p. 466 (section IX.6) if it's not already in here somewhere*/ - - float head[3]; /* Orientation and length is implicit during editing */ + /** User-Defined Properties on this Bone */ + struct IDProperty *prop; + /** Editbones have a one-way link (i.e. children refer + * to parents. This is converted to a two-way link for + * normal bones when leaving editmode. */ + struct EditBone *parent; + /** (64 == MAXBONENAME) */ + char name[64]; + /** Roll along axis. We'll ultimately use the axis/angle method + * for determining the transformation matrix of the bone. The axis + * is tail-head while roll provides the angle. Refer to Graphics + * Gems 1 p. 466 (section IX.6) if it's not already in here somewhere*/ + float roll; + + /** Orientation and length is implicit during editing */ + float head[3]; float tail[3]; - /* All joints are considered to have zero rotation with respect to + /** All joints are considered to have zero rotation with respect to * their parents. Therefore any rotations specified during the * animation are automatically relative to the bones' rest positions*/ int flag; int layer; float dist, weight; - float xwidth, length, zwidth; /* put them in order! transform uses this as scale */ + /** put them in order! transform uses this as scale */ + float xwidth, length, zwidth; float rad_head, rad_tail; /* Bendy-Bone parameters */ @@ -87,22 +93,28 @@ typedef struct EditBone { float ease1, ease2; float scaleIn, scaleOut; - float oldlength; /* for envelope scaling */ + /** for envelope scaling */ + float oldlength; short segments; - char bbone_prev_type; /* Type of next/prev bone handles */ + /** Type of next/prev bone handles */ + char bbone_prev_type; char bbone_next_type; - struct EditBone *bbone_prev; /* Next/prev bones to use as handle references when calculating bbones (optional) */ + /** Next/prev bones to use as handle references when calculating bbones (optional) */ + struct EditBone *bbone_prev; struct EditBone *bbone_next; /* Used for display */ - float disp_mat[4][4]; /* in Armature space, rest pos matrix */ - float disp_tail_mat[4][4]; /* in Armature space, rest pos matrix */ - /* 32 == MAX_BBONE_SUBDIV */ - float disp_bbone_mat[32][4][4]; /* in Armature space, rest pos matrix */ - - struct EditBone *bbone_child; /* connected child temporary during drawing */ + /** in Armature space, rest pos matrix */ + float disp_mat[4][4]; + /** in Armature space, rest pos matrix */ + float disp_tail_mat[4][4]; + /** in Armature space, rest pos matrix (32 == MAX_BBONE_SUBDIV) */ + float disp_bbone_mat[32][4][4]; + + /** connected child temporary during drawing */ + struct EditBone *bbone_child; /* Used to store temporary data */ union { diff --git a/source/blender/editors/include/ED_fileselect.h b/source/blender/editors/include/ED_fileselect.h index 64739d968b8..aa54005ab5e 100644 --- a/source/blender/editors/include/ED_fileselect.h +++ b/source/blender/editors/include/ED_fileselect.h @@ -134,8 +134,10 @@ typedef enum FSMenuCategory { typedef enum FSMenuInsert { FS_INSERT_SORTED = (1 << 0), FS_INSERT_SAVE = (1 << 1), - FS_INSERT_FIRST = (1 << 2), /* moves the item to the front of the list when its not already there */ - FS_INSERT_LAST = (1 << 3), /* just append to preseve delivered order */ + /** moves the item to the front of the list when its not already there */ + FS_INSERT_FIRST = (1 << 2), + /** just append to preseve delivered order */ + FS_INSERT_LAST = (1 << 3), } FSMenuInsert; struct FSMenu; diff --git a/source/blender/editors/include/ED_keyframes_draw.h b/source/blender/editors/include/ED_keyframes_draw.h index 87c6c0be45a..9fce191561e 100644 --- a/source/blender/editors/include/ED_keyframes_draw.h +++ b/source/blender/editors/include/ED_keyframes_draw.h @@ -67,14 +67,20 @@ typedef struct ActKeyColumn { struct ActKeyColumn *next, *prev; /* sorting-tree linkage */ - struct ActKeyColumn *left, *right; /* 'children' of this node, less than and greater than it (respectively) */ - struct ActKeyColumn *parent; /* parent of this node in the tree */ - char tree_col; /* DLRB_BLACK or DLRB_RED */ + /** 'children' of this node, less than and greater than it (respectively) */ + struct ActKeyColumn *left, *right; + /** parent of this node in the tree */ + struct ActKeyColumn *parent; + /** DLRB_BLACK or DLRB_RED */ + char tree_col; /* keyframe info */ - char key_type; /* eBezTripe_KeyframeType */ - char handle_type; /* eKeyframeHandleDrawOpts */ - char extreme_type; /* eKeyframeExtremeDrawOpts */ + /** eBezTripe_KeyframeType */ + char key_type; + /** eKeyframeHandleDrawOpts */ + char handle_type; + /** eKeyframeExtremeDrawOpts */ + char extreme_type; short sel; float cfra; @@ -134,7 +140,8 @@ typedef enum eKeyframeExtremeDrawOpts { } eKeyframeExtremeDrawOpts; /* draw simple diamond-shape keyframe */ -/* caller should set up vertex format, bind GPU_SHADER_KEYFRAME_DIAMOND, immBegin(GPU_PRIM_POINTS, n), then call this n times */ +/* caller should set up vertex format, bind GPU_SHADER_KEYFRAME_DIAMOND, + * immBegin(GPU_PRIM_POINTS, n), then call this n times */ void draw_keyframe_shape(float x, float y, float size, bool sel, short key_type, short mode, float alpha, unsigned int pos_id, unsigned int size_id, unsigned int color_id, unsigned int outline_color_id, unsigned int linemask_id, short ipo_type, short extreme_type); diff --git a/source/blender/editors/include/ED_keyframes_edit.h b/source/blender/editors/include/ED_keyframes_edit.h index e7ea5cf159e..8a398c97506 100644 --- a/source/blender/editors/include/ED_keyframes_edit.h +++ b/source/blender/editors/include/ED_keyframes_edit.h @@ -155,20 +155,30 @@ typedef enum eKeyframeIterFlags { typedef struct KeyframeEditData { /* generic properties/data access */ - ListBase list; /* temp list for storing custom list of data to check */ - struct Scene *scene; /* pointer to current scene - many tools need access to cfra/etc. */ - void *data; /* pointer to custom data - usually 'Object' but also 'rectf', but could be other types too */ - float f1, f2; /* storage of times/values as 'decimals' */ - int i1, i2; /* storage of times/values/flags as 'whole' numbers */ + /** temp list for storing custom list of data to check */ + ListBase list; + /** pointer to current scene - many tools need access to cfra/etc. */ + struct Scene *scene; + /** pointer to custom data - usually 'Object' but also 'rectf', but could be other types too */ + void *data; + /** storage of times/values as 'decimals' */ + float f1, f2; + /** storage of times/values/flags as 'whole' numbers */ + int i1, i2; /* current iteration data */ - struct FCurve *fcu; /* F-Curve that is being iterated over */ - int curIndex; /* index of current keyframe being iterated over */ - float channel_y; /* y-position of midpoint of the channel (for the dopesheet) */ + /** F-Curve that is being iterated over */ + struct FCurve *fcu; + /** index of current keyframe being iterated over */ + int curIndex; + /** y-position of midpoint of the channel (for the dopesheet) */ + float channel_y; /* flags */ - eKeyframeVertOk curflags; /* current flags for the keyframe we're reached in the iteration process */ - eKeyframeIterFlags iterflags; /* settings for iteration process */ + /** current flags for the keyframe we're reached in the iteration process */ + eKeyframeVertOk curflags; + /** settings for iteration process */ + eKeyframeIterFlags iterflags; } KeyframeEditData; /* ------- Function Pointer Typedefs ---------------- */ @@ -213,7 +223,8 @@ typedef enum eKeyMergeMode { /* ---------------- Looping API --------------------- */ /* functions for looping over keyframes */ -/* function for working with F-Curve data only (i.e. when filters have been chosen to explicitly use this) */ +/* function for working with F-Curve data only + * (i.e. when filters have been chosen to explicitly use this) */ short ANIM_fcurve_keyframes_loop(KeyframeEditData *ked, struct FCurve *fcu, KeyframeEditFunc key_ok, KeyframeEditFunc key_cb, FcuEditFunc fcu_cb); /* function for working with any type (i.e. one of the known types) of animation channel * - filterflag is bDopeSheet->flag (DOPESHEET_FILTERFLAG) @@ -267,7 +278,8 @@ short bezt_to_cfraelem(KeyframeEditData *ked, struct BezTriple *bezt); void bezt_remap_times(KeyframeEditData *ked, struct BezTriple *bezt); /* ------ 1.5-D Region Testing Uitls (Lasso/Circle Select) ------- */ -/* XXX: These are temporary, until we can unify GP/Mask Keyframe handling and standard FCurve Keyframe handling */ +/* XXX: These are temporary, + * until we can unify GP/Mask Keyframe handling and standard FCurve Keyframe handling */ bool keyframe_region_lasso_test( const KeyframeEdit_LassoData *data_lasso, diff --git a/source/blender/editors/include/ED_keyframing.h b/source/blender/editors/include/ED_keyframing.h index aba381f7989..b1140630dc0 100644 --- a/source/blender/editors/include/ED_keyframing.h +++ b/source/blender/editors/include/ED_keyframing.h @@ -195,7 +195,8 @@ typedef enum eModifyKey_Returns { MODIFYKEY_MISSING_TYPEINFO = -2, } eModifyKey_Returns; -/* poll the current KeyingSet, updating it's set of paths (if "builtin"/"relative") for context changes */ +/* poll the current KeyingSet, updating it's set of paths + * (if "builtin"/"relative") for context changes */ short ANIM_validate_keyingset(struct bContext *C, ListBase *dsources, struct KeyingSet *ks); /* use the specified KeyingSet to add/remove various Keyframes on the specified frame */ @@ -203,7 +204,8 @@ int ANIM_apply_keyingset(struct bContext *C, ListBase *dsources, struct bAction /* -------- */ -/* Get the first builtin KeyingSet with the given name, which occurs after the given one (or start of list if none given) */ +/* Get the first builtin KeyingSet with the given name, which occurs after the given one + * (or start of list if none given) */ struct KeyingSet *ANIM_builtin_keyingset_get_named(struct KeyingSet *prevKS, const char name[]); /* Find KeyingSet type info given a name */ @@ -240,18 +242,27 @@ bool ANIM_keyingset_context_ok_poll(struct bContext *C, struct KeyingSet *ks); /* Flags for use by driver creation calls */ typedef enum eCreateDriverFlags { - CREATEDRIVER_WITH_DEFAULT_DVAR = (1 << 0), /* create drivers with a default variable for nicer UI */ - CREATEDRIVER_WITH_FMODIFIER = (1 << 1), /* create drivers with Generator FModifier (for backwards compat) */ + /** create drivers with a default variable for nicer UI */ + CREATEDRIVER_WITH_DEFAULT_DVAR = (1 << 0), + /** create drivers with Generator FModifier (for backwards compat) */ + CREATEDRIVER_WITH_FMODIFIER = (1 << 1), } eCreateDriverFlags; /* Heuristic to use for connecting target properties to driven ones */ typedef enum eCreateDriver_MappingTypes { - CREATEDRIVER_MAPPING_1_N = 0, /* 1 to Many - Use the specified index, and drive all elements with it */ - CREATEDRIVER_MAPPING_1_1 = 1, /* 1 to 1 - Only for the specified index on each side */ - CREATEDRIVER_MAPPING_N_N = 2, /* Many to Many - Match up the indices one by one (only for drivers on vectors/arrays) */ - - CREATEDRIVER_MAPPING_NONE = 3, /* None (Single Prop) - Do not create driver with any targets; these will get added later instead */ - CREATEDRIVER_MAPPING_NONE_ALL = 4, /* None (All Properties) - Do not create driver with any targets; these will get added later instead */ + /** 1 to Many - Use the specified index, and drive all elements with it */ + CREATEDRIVER_MAPPING_1_N = 0, + /** 1 to 1 - Only for the specified index on each side */ + CREATEDRIVER_MAPPING_1_1 = 1, + /** Many to Many - Match up the indices one by one (only for drivers on vectors/arrays) */ + CREATEDRIVER_MAPPING_N_N = 2, + + /** None (Single Prop): + * Do not create driver with any targets; these will get added later instead */ + CREATEDRIVER_MAPPING_NONE = 3, + /** None (All Properties): + * Do not create driver with any targets; these will get added later instead */ + CREATEDRIVER_MAPPING_NONE_ALL = 4, } eCreateDriver_MappingTypes; /* RNA Enum of eCreateDriver_MappingTypes, for use by the appropriate operators */ diff --git a/source/blender/editors/include/ED_numinput.h b/source/blender/editors/include/ED_numinput.h index f674a0d87f9..0ff1ee4206e 100644 --- a/source/blender/editors/include/ED_numinput.h +++ b/source/blender/editors/include/ED_numinput.h @@ -33,20 +33,30 @@ struct wmEvent; typedef struct NumInput { - short idx_max; /* idx_max < NUM_MAX_ELEMENTS */ + /** idx_max < NUM_MAX_ELEMENTS */ + short idx_max; int unit_sys; - int unit_type[NUM_MAX_ELEMENTS]; /* Each value can have a different type */ + /** Each value can have a different type */ + int unit_type[NUM_MAX_ELEMENTS]; bool unit_use_radians; - short flag; /* Flags affecting all values' behavior */ - short val_flag[NUM_MAX_ELEMENTS]; /* Per-value flags */ - float val[NUM_MAX_ELEMENTS]; /* Direct value of the input */ - float val_org[NUM_MAX_ELEMENTS]; /* Original value of the input, for reset */ - float val_inc[NUM_MAX_ELEMENTS]; /* Increment steps */ - - short idx; /* Active element/value */ - char str[NUM_STR_REP_LEN]; /* String as typed by user for edited value (we assume ASCII world!) */ - /* Current position of cursor in edited value str (first byte of "current" letter, so 0 for an empty str) */ + /** Flags affecting all values' behavior */ + short flag; + /** Per-value flags */ + short val_flag[NUM_MAX_ELEMENTS]; + /** Direct value of the input */ + float val[NUM_MAX_ELEMENTS]; + /** Original value of the input, for reset */ + float val_org[NUM_MAX_ELEMENTS]; + /** Increment steps */ + float val_inc[NUM_MAX_ELEMENTS]; + + /** Active element/value */ + short idx; + /** String as typed by user for edited value (we assume ASCII world!) */ + char str[NUM_STR_REP_LEN]; + /** Current position of cursor in edited value str + * (first byte of "current" letter, so 0 for an empty str) */ int str_cur; } NumInput; diff --git a/source/blender/editors/include/ED_object.h b/source/blender/editors/include/ED_object.h index 288ee8a3598..5a02bc2310a 100644 --- a/source/blender/editors/include/ED_object.h +++ b/source/blender/editors/include/ED_object.h @@ -67,8 +67,10 @@ struct uiLayout; #include "BLI_compiler_attrs.h" /* object_edit.c */ -struct Object *ED_object_context(struct bContext *C); /* context.object */ -struct Object *ED_object_active_context(struct bContext *C); /* context.object or context.active_object */ +/* context.object */ +struct Object *ED_object_context(struct bContext *C); +/* context.object or context.active_object */ +struct Object *ED_object_active_context(struct bContext *C); void ED_collection_hide_menu_draw(const struct bContext *C, struct uiLayout *layout); /* object_utils.c */ @@ -175,7 +177,8 @@ float ED_object_new_primitive_matrix( const float loc[3], const float rot[3], float primmat[4][4]); -/* Avoid allowing too much insane values even by typing (typos can hang/crash Blender otherwise). */ +/* Avoid allowing too much insane values even by typing + * (typos can hang/crash Blender otherwise). */ #define OBJECT_ADD_SIZE_MAXF 1.0e12f void ED_object_add_unit_props_size(struct wmOperatorType *ot); diff --git a/source/blender/editors/include/ED_screen_types.h b/source/blender/editors/include/ED_screen_types.h index 8ef7fee0f32..e53f303ea39 100644 --- a/source/blender/editors/include/ED_screen_types.h +++ b/source/blender/editors/include/ED_screen_types.h @@ -77,10 +77,18 @@ typedef struct ScreenFrameRateInfo { /* Enum for Action Zone Edges. Which edge of area is action zone. */ typedef enum { - AE_RIGHT_TO_TOPLEFT, /* Region located on the left, _right_ edge is action zone. Region minimized to the top left */ - AE_LEFT_TO_TOPRIGHT, /* Region located on the right, _left_ edge is action zone. Region minimized to the top right */ - AE_TOP_TO_BOTTOMRIGHT, /* Region located at the bottom, _top_ edge is action zone. Region minimized to the bottom right */ - AE_BOTTOM_TO_TOPLEFT /* Region located at the top, _bottom_ edge is action zone. Region minimized to the top left */ + /** Region located on the left, _right_ edge is action zone. + * Region minimized to the top left */ + AE_RIGHT_TO_TOPLEFT, + /** Region located on the right, _left_ edge is action zone. + * Region minimized to the top right */ + AE_LEFT_TO_TOPRIGHT, + /** Region located at the bottom, _top_ edge is action zone. + * Region minimized to the bottom right */ + AE_TOP_TO_BOTTOMRIGHT, + /** Region located at the top, _bottom_ edge is action zone. + * Region minimized to the top left */ + AE_BOTTOM_TO_TOPLEFT } AZEdge; typedef enum { diff --git a/source/blender/editors/include/ED_transverts.h b/source/blender/editors/include/ED_transverts.h index 363bb31c3dc..e15514f8cd8 100644 --- a/source/blender/editors/include/ED_transverts.h +++ b/source/blender/editors/include/ED_transverts.h @@ -61,9 +61,12 @@ enum { /* mode flags: */ enum { - TM_ALL_JOINTS = (1 << 0), /* all joints (for bones only) */ - TM_SKIP_HANDLES = (1 << 1), /* skip handles when control point is selected (for curves only) */ - TM_CALC_NORMALS = (1 << 2), /* fill in normals when available */ + /** all joints (for bones only) */ + TM_ALL_JOINTS = (1 << 0), + /** skip handles when control point is selected (for curves only) */ + TM_SKIP_HANDLES = (1 << 1), + /** fill in normals when available */ + TM_CALC_NORMALS = (1 << 2), }; enum { diff --git a/source/blender/editors/include/ED_view3d.h b/source/blender/editors/include/ED_view3d.h index 748fb180c1a..b3c3a6a9840 100644 --- a/source/blender/editors/include/ED_view3d.h +++ b/source/blender/editors/include/ED_view3d.h @@ -155,11 +155,16 @@ void ED_view3d_depth_tag_update(struct RegionView3D *rv3d); /* return values for ED_view3d_project_...() */ typedef enum { V3D_PROJ_RET_OK = 0, - V3D_PROJ_RET_CLIP_NEAR = 1, /* can't avoid this when in perspective mode, (can't avoid) */ - V3D_PROJ_RET_CLIP_ZERO = 2, /* so close to zero we can't apply a perspective matrix usefully */ - V3D_PROJ_RET_CLIP_BB = 3, /* bounding box clip - RV3D_CLIPPING */ - V3D_PROJ_RET_CLIP_WIN = 4, /* outside window bounds */ - V3D_PROJ_RET_OVERFLOW = 5 /* outside range (mainly for short), (can't avoid) */ + /** can't avoid this when in perspective mode, (can't avoid) */ + V3D_PROJ_RET_CLIP_NEAR = 1, + /** so close to zero we can't apply a perspective matrix usefully */ + V3D_PROJ_RET_CLIP_ZERO = 2, + /** bounding box clip - RV3D_CLIPPING */ + V3D_PROJ_RET_CLIP_BB = 3, + /** outside window bounds */ + V3D_PROJ_RET_CLIP_WIN = 4, + /** outside range (mainly for short), (can't avoid) */ + V3D_PROJ_RET_OVERFLOW = 5 } eV3DProjStatus; /* some clipping tests are optional */ diff --git a/source/blender/editors/include/UI_interface.h b/source/blender/editors/include/UI_interface.h index 821f683cf6e..e0969ff07b8 100644 --- a/source/blender/editors/include/UI_interface.h +++ b/source/blender/editors/include/UI_interface.h @@ -539,7 +539,9 @@ typedef void (*uiBlockCancelFunc)(struct bContext *C, void *arg1); void UI_popup_block_invoke(struct bContext *C, uiBlockCreateFunc func, void *arg); void UI_popup_block_invoke_ex(struct bContext *C, uiBlockCreateFunc func, void *arg, const char *opname, int opcontext); void UI_popup_block_ex(struct bContext *C, uiBlockCreateFunc func, uiBlockHandleFunc popup_func, uiBlockCancelFunc cancel_func, void *arg, struct wmOperator *op); -/* void uiPupBlockOperator(struct bContext *C, uiBlockCreateFunc func, struct wmOperator *op, int opcontext); */ /* UNUSED */ +#if 0 /* UNUSED */ +void uiPupBlockOperator(struct bContext *C, uiBlockCreateFunc func, struct wmOperator *op, int opcontext); +#endif void UI_popup_block_close(struct bContext *C, struct wmWindow *win, uiBlock *block); @@ -1254,13 +1256,19 @@ void uiItemsFullEnumO_items( const EnumPropertyItem *item_array, int totitem); void uiItemL(uiLayout *layout, const char *name, int icon); /* label */ -void uiItemLDrag(uiLayout *layout, struct PointerRNA *ptr, const char *name, int icon); /* label icon for dragging */ -void uiItemM(uiLayout *layout, const char *menuname, const char *name, int icon); /* menu */ -void uiItemMContents(uiLayout *layout, const char *menuname); /* menu contents */ -void uiItemV(uiLayout *layout, const char *name, int icon, int argval); /* value */ -void uiItemS(uiLayout *layout); /* separator */ +/* label icon for dragging */ +void uiItemLDrag(uiLayout *layout, struct PointerRNA *ptr, const char *name, int icon); +/* menu */ +void uiItemM(uiLayout *layout, const char *menuname, const char *name, int icon); +/* menu contents */ +void uiItemMContents(uiLayout *layout, const char *menuname); +/* value */ +void uiItemV(uiLayout *layout, const char *name, int icon, int argval); +/* separator */ +void uiItemS(uiLayout *layout); void uiItemS_ex(uiLayout *layout, float factor); -void uiItemSpacer(uiLayout *layout); /* Special separator. */ +/* Special separator. */ +void uiItemSpacer(uiLayout *layout); void uiItemPopoverPanel_ptr( uiLayout *layout, struct bContext *C, -- cgit v1.2.3