750 lines
		
	
	
		
			26 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			750 lines
		
	
	
		
			26 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
| /*
 | |
|  * ***** BEGIN GPL LICENSE BLOCK *****
 | |
|  *
 | |
|  * 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.
 | |
|  *
 | |
|  * The Original Code is: all of this file.
 | |
|  *
 | |
|  * Contributor(s): none yet.
 | |
|  *
 | |
|  * ***** END GPL LICENSE BLOCK *****
 | |
|  */
 | |
| 
 | |
| /** \file blender/editors/interface/interface_intern.h
 | |
|  *  \ingroup edinterface
 | |
|  */
 | |
| 
 | |
| 
 | |
| #ifndef __INTERFACE_INTERN_H__
 | |
| #define __INTERFACE_INTERN_H__
 | |
| 
 | |
| #include "BLI_compiler_attrs.h"
 | |
| #include "UI_resources.h"
 | |
| #include "RNA_types.h"
 | |
| #include "DNA_listBase.h"
 | |
| 
 | |
| struct ARegion;
 | |
| struct bContext;
 | |
| struct uiHandleButtonData;
 | |
| struct wmEvent;
 | |
| struct wmKeyConfig;
 | |
| struct wmOperatorType;
 | |
| struct wmTimer;
 | |
| struct uiStyle;
 | |
| struct uiWidgetColors;
 | |
| struct uiLayout;
 | |
| struct bContextStore;
 | |
| struct Scene;
 | |
| struct ID;
 | |
| struct ImBuf;
 | |
| 
 | |
| /* ****************** general defines ************** */
 | |
| 
 | |
| #define RNA_NO_INDEX    -1
 | |
| #define RNA_ENUM_VALUE  -2
 | |
| 
 | |
| /* visual types for drawing */
 | |
| /* for time being separated from functional types */
 | |
| typedef enum {
 | |
| 	/* default */
 | |
| 	UI_WTYPE_REGULAR,
 | |
| 
 | |
| 	/* standard set */
 | |
| 	UI_WTYPE_LABEL,
 | |
| 	UI_WTYPE_TOGGLE,
 | |
| 	UI_WTYPE_CHECKBOX,
 | |
| 	UI_WTYPE_RADIO,
 | |
| 	UI_WTYPE_NUMBER,
 | |
| 	UI_WTYPE_SLIDER,
 | |
| 	UI_WTYPE_EXEC,
 | |
| 	UI_WTYPE_TOOLTIP,
 | |
| 	
 | |
| 	/* strings */
 | |
| 	UI_WTYPE_NAME,
 | |
| 	UI_WTYPE_NAME_LINK,
 | |
| 	UI_WTYPE_POINTER_LINK,
 | |
| 	UI_WTYPE_FILENAME,
 | |
| 	
 | |
| 	/* menus */
 | |
| 	UI_WTYPE_MENU_RADIO,
 | |
| 	UI_WTYPE_MENU_ICON_RADIO,
 | |
| 	UI_WTYPE_MENU_POINTER_LINK,
 | |
| 	UI_WTYPE_MENU_NODE_LINK,
 | |
| 	
 | |
| 	UI_WTYPE_PULLDOWN,
 | |
| 	UI_WTYPE_MENU_ITEM,
 | |
| 	UI_WTYPE_MENU_ITEM_RADIAL,
 | |
| 	UI_WTYPE_MENU_BACK,
 | |
| 
 | |
| 	/* specials */
 | |
| 	UI_WTYPE_ICON,
 | |
| 	UI_WTYPE_ICON_LABEL,
 | |
| 	UI_WTYPE_SWATCH,
 | |
| 	UI_WTYPE_RGB_PICKER,
 | |
| 	UI_WTYPE_UNITVEC,
 | |
| 	UI_WTYPE_BOX,
 | |
| 	UI_WTYPE_SCROLL,
 | |
| 	UI_WTYPE_LISTITEM,
 | |
| 	UI_WTYPE_PROGRESSBAR,
 | |
| } uiWidgetTypeEnum;
 | |
| 
 | |
| /* menu scrolling */
 | |
| #define UI_MENU_SCROLL_ARROW	12
 | |
| #define UI_MENU_SCROLL_MOUSE	(UI_MENU_SCROLL_ARROW + 2)
 | |
| #define UI_MENU_SCROLL_PAD		4
 | |
| 
 | |
| /* panel limits */
 | |
| #define UI_PANEL_MINX   100
 | |
| #define UI_PANEL_MINY   70
 | |
| 
 | |
| /* uiBut->flag */
 | |
| enum {
 | |
| 	UI_SELECT       = (1 << 0),  /* use when the button is pressed */
 | |
| 	UI_SCROLLED     = (1 << 1),  /* temp hidden, scrolled away */
 | |
| 	UI_ACTIVE       = (1 << 2),
 | |
| 	UI_HAS_ICON     = (1 << 3),
 | |
| 	UI_TEXTINPUT    = (1 << 4),
 | |
| 	UI_HIDDEN       = (1 << 5),
 | |
| 	/* warn: rest of uiBut->flag in UI_interface.h */
 | |
| };
 | |
| 
 | |
| /* some buttons display icons only under special conditions
 | |
|  * (e.g. 'x' icon in search menu) - used with ui_but_icon_extra_get */
 | |
| typedef enum uiButExtraIconType {
 | |
| 	UI_BUT_ICONEXTRA_NONE = 1,
 | |
| 	UI_BUT_ICONEXTRA_UNLINK,
 | |
| 	UI_BUT_ICONEXTRA_EYEDROPPER,
 | |
| } uiButExtraIconType;
 | |
| 
 | |
| /* uiBut->dragflag */
 | |
| enum {
 | |
| 	UI_BUT_DRAGPOIN_FREE = (1 << 0),
 | |
| };
 | |
| 
 | |
| /* but->pie_dir */
 | |
| typedef enum RadialDirection {
 | |
| 	UI_RADIAL_NONE  = -1,
 | |
| 	UI_RADIAL_N     =  0,
 | |
| 	UI_RADIAL_NE    =  1,
 | |
| 	UI_RADIAL_E     =  2,
 | |
| 	UI_RADIAL_SE    =  3,
 | |
| 	UI_RADIAL_S     =  4,
 | |
| 	UI_RADIAL_SW    =  5,
 | |
| 	UI_RADIAL_W     =  6,
 | |
| 	UI_RADIAL_NW    =  7,
 | |
| } RadialDirection;
 | |
| 
 | |
| extern const char  ui_radial_dir_order[8];
 | |
| extern const char  ui_radial_dir_to_numpad[8];
 | |
| extern const short ui_radial_dir_to_angle[8];
 | |
| 
 | |
| /* internal panel drawing defines */
 | |
| #define PNL_GRID    (UI_UNIT_Y / 5) /* 4 default */
 | |
| #define PNL_HEADER  (UI_UNIT_Y + 4) /* 24 default */
 | |
| 
 | |
| /* bit button defines */
 | |
| /* Bit operations */
 | |
| #define UI_BITBUT_TEST(a, b)    ( ( (a) & 1 << (b) ) != 0)
 | |
| #define UI_BITBUT_SET(a, b)     ( (a) | 1 << (b) )
 | |
| #define UI_BITBUT_CLR(a, b)     ( (a) & ~(1 << (b)) )
 | |
| /* bit-row */
 | |
| #define UI_BITBUT_ROW(min, max)  (((max) >= 31 ? 0xFFFFFFFF : (1 << ((max) + 1)) - 1) - ((min) ? ((1 << (min)) - 1) : 0) )
 | |
| 
 | |
| /* split numbuts by ':' and align l/r */
 | |
| #define USE_NUMBUTS_LR_ALIGN
 | |
| 
 | |
| /* Use new 'align' computation code. */
 | |
| #define USE_UIBUT_SPATIAL_ALIGN
 | |
| 
 | |
| /* PieMenuData->flags */
 | |
| enum {
 | |
| 	UI_PIE_DEGREES_RANGE_LARGE  = (1 << 0),  /* pie menu item collision is detected at 90 degrees */
 | |
| 	UI_PIE_INITIAL_DIRECTION    = (1 << 1),  /* use initial center of pie menu to calculate direction */
 | |
| 	UI_PIE_DRAG_STYLE           = (1 << 2),  /* pie menu is drag style */
 | |
| 	UI_PIE_INVALID_DIR          = (1 << 3),  /* mouse not far enough from center position  */
 | |
| 	UI_PIE_CLICK_STYLE          = (1 << 4),  /* pie menu changed to click style, click to confirm  */
 | |
| 	UI_PIE_ANIMATION_FINISHED   = (1 << 5),  /* pie animation finished, do not calculate any more motion  */
 | |
| 	UI_PIE_GESTURE_END_WAIT     = (1 << 6),  /* pie gesture selection has been done, now wait for mouse motion to end */
 | |
| };
 | |
| 
 | |
| #define PIE_CLICK_THRESHOLD_SQ 50.0f
 | |
| 
 | |
| /* max amount of items a radial menu (pie menu) can contain */
 | |
| #define PIE_MAX_ITEMS 8
 | |
| 
 | |
| typedef struct uiLinkLine {  /* only for draw/edit */
 | |
| 	struct uiLinkLine *next, *prev;
 | |
| 	struct uiBut *from, *to;
 | |
| 	short flag, deactive;
 | |
| } uiLinkLine;
 | |
| 
 | |
| typedef struct {
 | |
| 	void **poin;        /* pointer to original pointer */
 | |
| 	void ***ppoin;      /* pointer to original pointer-array */
 | |
| 	short *totlink;     /* if pointer-array, here is the total */
 | |
| 	
 | |
| 	short maxlink, pad;
 | |
| 	short fromcode, tocode;
 | |
| 	
 | |
| 	ListBase lines;
 | |
| } uiLink;
 | |
| 
 | |
| struct uiBut {
 | |
| 	struct uiBut *next, *prev;
 | |
| 	int flag, drawflag;
 | |
| 	eButType         type;
 | |
| 	eButPointerType  pointype;
 | |
| 	short bit, bitnr, retval, strwidth, alignnr;
 | |
| 	short ofs, pos, selsta, selend;
 | |
| 
 | |
| 	char *str;
 | |
| 	char strdata[UI_MAX_NAME_STR];
 | |
| 	char drawstr[UI_MAX_DRAW_STR];
 | |
| 
 | |
| 	rctf rect;  /* block relative coords */
 | |
| 
 | |
| 	char *poin;
 | |
| 	float hardmin, hardmax, softmin, softmax;
 | |
| 
 | |
| 	/* both these values use depends on the button type
 | |
| 	 * (polymorphic struct or union would be nicer for this stuff) */
 | |
| 
 | |
| 	/* (type == UI_BTYPE_HSVCUBE),    Use UI_GRAD_* values.
 | |
| 	 * (type == UI_BTYPE_NUM),        Use to store RNA 'step' value, for dragging and click-step.
 | |
| 	 * (type == UI_BTYPE_LABEL),      Use (a1 == 1.0f) to use a2 as a blending factor (wow, this is imaginative!).
 | |
| 	 * (type == UI_BTYPE_SCROLL)      Use as scroll size.
 | |
| 	 * (type == UI_BTYPE_SEARCH_MENU) Use as number or rows.
 | |
| 	 * (type == UI_BTYPE_COLOR)       Use as indication of color palette
 | |
| 	 * (type == UI_BTYPE_PROGRESS_BAR) Use to store progress (0..1).
 | |
| 	 */
 | |
| 	float a1;
 | |
| 
 | |
| 	/* (type == UI_BTYPE_HSVCIRCLE ), Use to store the luminosity.
 | |
| 	 * (type == UI_BTYPE_NUM),        Use to store RNA 'precision' value, for dragging and click-step.
 | |
| 	 * (type == UI_BTYPE_LABEL),      If (a1 == 1.0f) use a2 as a blending factor.
 | |
| 	 * (type == UI_BTYPE_SEARCH_MENU) Use as number or columns.
 | |
| 	 * (type == UI_BTYPE_COLOR)       Use as index in palette (not so good, needs refactor)
 | |
| 	 */
 | |
| 	float a2;
 | |
| 
 | |
| 	unsigned char col[4];
 | |
| 
 | |
| 	uiButHandleFunc func;
 | |
| 	void *func_arg1;
 | |
| 	void *func_arg2;
 | |
| 
 | |
| 	uiButHandleNFunc funcN;
 | |
| 	void *func_argN;
 | |
| 
 | |
| 	struct bContextStore *context;
 | |
| 
 | |
| 	uiButCompleteFunc autocomplete_func;
 | |
| 	void *autofunc_arg;
 | |
| 	
 | |
| 	uiButSearchCreateFunc search_create_func;
 | |
| 	uiButSearchFunc search_func;
 | |
| 	void *search_arg;
 | |
| 
 | |
| 	uiButHandleRenameFunc rename_func;
 | |
| 	void *rename_arg1;
 | |
| 	void *rename_orig;
 | |
| 
 | |
| 	uiLink *link;
 | |
| 	short linkto[2];  /* region relative coords */
 | |
| 	
 | |
| 	const char *tip;
 | |
| 	uiButToolTipFunc tip_func;
 | |
| 	void *tip_argN;
 | |
| 
 | |
| 	const char *lockstr;
 | |
| 
 | |
| 	BIFIconID icon;
 | |
| 	bool lock;
 | |
| 	char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied from the block */
 | |
| 	signed char pie_dir; /* direction in a pie menu, used for collision detection (RadialDirection) */
 | |
| 	char changed; /* could be made into a single flag */
 | |
| 	unsigned char unit_type; /* so buttons can support unit systems which are not RNA */
 | |
| 	short modifier_key;
 | |
| 	short iconadd;
 | |
| 
 | |
| 	/* UI_BTYPE_BLOCK data */
 | |
| 	uiBlockCreateFunc block_create_func;
 | |
| 
 | |
| 	/* UI_BTYPE_PULLDOWN/UI_BTYPE_MENU data */
 | |
| 	uiMenuCreateFunc menu_create_func;
 | |
| 
 | |
| 	uiMenuStepFunc menu_step_func;
 | |
| 
 | |
| 	/* RNA data */
 | |
| 	struct PointerRNA rnapoin;
 | |
| 	struct PropertyRNA *rnaprop;
 | |
| 	int rnaindex;
 | |
| 
 | |
| 	struct PointerRNA rnasearchpoin;
 | |
| 	struct PropertyRNA *rnasearchprop;
 | |
| 
 | |
| 	/* Operator data */
 | |
| 	struct wmOperatorType *optype;
 | |
| 	struct PointerRNA *opptr;
 | |
| 	short opcontext;
 | |
| 	unsigned char menu_key; /* 'a'-'z', always lower case */
 | |
| 
 | |
| 	/* Draggable data, type is WM_DRAG_... */
 | |
| 	char dragtype;
 | |
| 	short dragflag;
 | |
| 	void *dragpoin;
 | |
| 	struct ImBuf *imb;
 | |
| 	float imb_scale;
 | |
| 	
 | |
| 	/* active button data */
 | |
| 	struct uiHandleButtonData *active;
 | |
| 
 | |
| 	/* Custom button data. */
 | |
| 	void *custom_data;
 | |
| 
 | |
| 	char *editstr;
 | |
| 	double *editval;
 | |
| 	float *editvec;
 | |
| 	void *editcoba;
 | |
| 	void *editcumap;
 | |
| 	
 | |
| 	/* pointer back */
 | |
| 	uiBlock *block;
 | |
| };
 | |
| 
 | |
| typedef struct ColorPicker {
 | |
| 	struct ColorPicker *next, *prev;
 | |
| 	float color_data[3]; /* colr data may be HSV or HSL for now */
 | |
| 	int representation; /* store hsv/hsl value */
 | |
| } ColorPicker;
 | |
| 
 | |
| typedef struct ColorPickerData {
 | |
| 	ListBase list;
 | |
| } ColorPickerData;
 | |
| 
 | |
| struct PieMenuData {
 | |
| 	/* store title and icon to allow access when pie levels are created */
 | |
| 	const char *title;
 | |
| 	int icon;
 | |
| 
 | |
| 	float pie_dir[2];
 | |
| 	float pie_center_init[2];
 | |
| 	float pie_center_spawned[2];
 | |
| 	float last_pos[2];
 | |
| 	double duration_gesture;
 | |
| 	int flags;
 | |
| 	int event; /* initial event used to fire the pie menu, store here so we can query for release */
 | |
| 	float alphafac;
 | |
| };
 | |
| 
 | |
| struct uiBlock {
 | |
| 	uiBlock *next, *prev;
 | |
| 
 | |
| 	ListBase buttons;
 | |
| 	Panel *panel;
 | |
| 	uiBlock *oldblock;
 | |
| 
 | |
| 	ListBase butstore;  /* UI_butstore_* runtime function */
 | |
| 
 | |
| 	ListBase layouts;
 | |
| 	struct uiLayout *curlayout;
 | |
| 
 | |
| 	ListBase contexts;
 | |
| 	
 | |
| 	char name[UI_MAX_NAME_STR];
 | |
| 	
 | |
| 	float winmat[4][4];
 | |
| 
 | |
| 	rctf rect;
 | |
| 	float aspect;
 | |
| 
 | |
| 	unsigned int puphash;  /* popup menu hash for memory */
 | |
| 
 | |
| 	uiButHandleFunc func;
 | |
| 	void *func_arg1;
 | |
| 	void *func_arg2;
 | |
| 
 | |
| 	uiButHandleNFunc funcN;
 | |
| 	void *func_argN;
 | |
| 
 | |
| 	uiMenuHandleFunc butm_func;
 | |
| 	void *butm_func_arg;
 | |
| 
 | |
| 	uiBlockHandleFunc handle_func;
 | |
| 	void *handle_func_arg;
 | |
| 	
 | |
| 	/* custom extra handling */
 | |
| 	int (*block_event_func)(const struct bContext *C, struct uiBlock *, const struct wmEvent *);
 | |
| 	
 | |
| 	/* extra draw function for custom blocks */
 | |
| 	void (*drawextra)(const struct bContext *C, void *idv, void *arg1, void *arg2, rcti *rect);
 | |
| 	void *drawextra_arg1;
 | |
| 	void *drawextra_arg2;
 | |
| 
 | |
| 	int flag;
 | |
| 	short alignnr;
 | |
| 
 | |
| 	char direction;
 | |
| 	char dt; /* drawtype: UI_EMBOSS, UI_EMBOSS_NONE ... etc, copied to buttons */
 | |
| 	bool auto_open;
 | |
| 	char _pad[7];
 | |
| 	double auto_open_last;
 | |
| 
 | |
| 	const char *lockstr;
 | |
| 
 | |
| 	char lock;
 | |
| 	char active;                /* to keep blocks while drawing and free them afterwards */
 | |
| 	char tooltipdisabled;       /* to avoid tooltip after click */
 | |
| 	char endblock;              /* UI_block_end done? */
 | |
| 
 | |
| 	eBlockBoundsCalc bounds_type;  /* for doing delayed */
 | |
| 	int mx, my;
 | |
| 	int bounds, minbounds;      /* for doing delayed */
 | |
| 
 | |
| 	rctf safety;                /* pulldowns, to detect outside, can differ per case how it is created */
 | |
| 	ListBase saferct;           /* uiSafetyRct list */
 | |
| 
 | |
| 	uiPopupBlockHandle *handle; /* handle */
 | |
| 
 | |
| 	struct wmOperator *ui_operator; /* use so presets can find the operator, */
 | |
| 	                                /* across menus and from nested popups which fail for operator context. */
 | |
| 
 | |
| 	void *evil_C;               /* XXX hack for dynamic operator enums */
 | |
| 
 | |
| 	struct UnitSettings *unit;  /* unit system, used a lot for numeric buttons so include here rather then fetching through the scene every time. */
 | |
| 	ColorPickerData color_pickers; /* XXX, only accessed by color picker templates */
 | |
| 
 | |
| 	bool color_profile;         /* color profile for correcting linear colors for display */
 | |
| 
 | |
| 	char display_device[64]; /* display device name used to display this block,
 | |
| 	                          * used by color widgets to transform colors from/to scene linear
 | |
| 	                          */
 | |
| 	struct PieMenuData pie_data;
 | |
| };
 | |
| 
 | |
| typedef struct uiSafetyRct {
 | |
| 	struct uiSafetyRct *next, *prev;
 | |
| 	rctf parent;
 | |
| 	rctf safety;
 | |
| } uiSafetyRct;
 | |
| 
 | |
| /* interface.c */
 | |
| 
 | |
| extern void ui_linkline_remove(uiLinkLine *line, uiBut *but);
 | |
| 
 | |
| void ui_fontscale(short *points, float aspect);
 | |
| 
 | |
| extern bool ui_block_is_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
 | |
| extern bool ui_block_is_pie_menu(const uiBlock *block) ATTR_WARN_UNUSED_RESULT;
 | |
| extern void ui_block_to_window_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
 | |
| extern void ui_block_to_window(const struct ARegion *ar, uiBlock *block, int *x, int *y);
 | |
| extern void ui_block_to_window_rctf(const struct ARegion *ar, uiBlock *block, rctf *rct_dst, const rctf *rct_src);
 | |
| extern void ui_window_to_block_fl(const struct ARegion *ar, uiBlock *block, float *x, float *y);
 | |
| extern void ui_window_to_block(const struct ARegion *ar, uiBlock *block, int *x, int *y);
 | |
| extern void ui_window_to_region(const ARegion *ar, int *x, int *y);
 | |
| extern void ui_region_to_window(const struct ARegion *ar, int *x, int *y);
 | |
| extern void ui_region_winrct_get_no_margin(const struct ARegion *ar, struct rcti *r_rect);
 | |
| 
 | |
| extern double ui_but_value_get(uiBut *but);
 | |
| extern void ui_but_value_set(uiBut *but, double value);
 | |
| extern void ui_but_hsv_set(uiBut *but);
 | |
| extern void ui_but_v3_get(uiBut *but, float vec[3]);
 | |
| extern void ui_but_v3_set(uiBut *but, const float vec[3]);
 | |
| 
 | |
| extern void ui_hsvcircle_vals_from_pos(
 | |
|         float *val_rad, float *val_dist, const rcti *rect,
 | |
|         const float mx, const float my);
 | |
| extern void ui_hsvcircle_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xpos, float *ypos);
 | |
| extern void ui_hsvcube_pos_from_vals(struct uiBut *but, const rcti *rect, float *hsv, float *xp, float *yp);
 | |
| bool ui_but_is_colorpicker_display_space(struct uiBut *but);
 | |
| 
 | |
| extern void ui_but_string_get_ex(uiBut *but, char *str, const size_t maxlen, const int float_precision) ATTR_NONNULL();
 | |
| extern void ui_but_string_get(uiBut *but, char *str, const size_t maxlen) ATTR_NONNULL();
 | |
| extern char *ui_but_string_get_dynamic(uiBut *but, int *r_str_size);
 | |
| extern void ui_but_convert_to_unit_alt_name(uiBut *but, char *str, size_t maxlen) ATTR_NONNULL();
 | |
| extern bool ui_but_string_set(struct bContext *C, uiBut *but, const char *str) ATTR_NONNULL();
 | |
| extern bool ui_but_string_set_eval_num(struct bContext *C, uiBut *but, const char *str, double *value) ATTR_NONNULL();
 | |
| extern int  ui_but_string_get_max_length(uiBut *but);
 | |
| extern uiBut *ui_but_drag_multi_edit_get(uiBut *but);
 | |
| 
 | |
| void ui_def_but_icon(uiBut *but, const int icon, const int flag);
 | |
| extern uiButExtraIconType ui_but_icon_extra_get(uiBut *but);
 | |
| 
 | |
| extern void ui_but_default_set(struct bContext *C, const bool all, const bool use_afterfunc);
 | |
| 
 | |
| extern void ui_but_update_ex(uiBut *but, const bool validate);
 | |
| extern void ui_but_update(uiBut *but);
 | |
| extern void ui_but_update_edited(uiBut *but);
 | |
| extern bool ui_but_is_float(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
 | |
| extern bool ui_but_is_bool(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
 | |
| extern bool ui_but_is_unit(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
 | |
| extern bool ui_but_is_compatible(const uiBut *but_a, const uiBut *but_b) ATTR_WARN_UNUSED_RESULT;
 | |
| extern bool ui_but_is_rna_valid(uiBut *but) ATTR_WARN_UNUSED_RESULT;
 | |
| extern bool ui_but_is_utf8(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
 | |
| extern bool ui_but_supports_cycling(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
 | |
| 
 | |
| extern int  ui_but_is_pushed_ex(uiBut *but, double *value) ATTR_WARN_UNUSED_RESULT;
 | |
| extern int  ui_but_is_pushed(uiBut *but) ATTR_WARN_UNUSED_RESULT;
 | |
| 
 | |
| 
 | |
| extern void ui_block_bounds_calc(uiBlock *block);
 | |
| extern void ui_block_translate(uiBlock *block, int x, int y);
 | |
| 
 | |
| extern struct ColorManagedDisplay *ui_block_cm_display_get(uiBlock *block);
 | |
| void ui_block_cm_to_display_space_v3(uiBlock *block, float pixel[3]);
 | |
| void ui_block_cm_to_scene_linear_v3(uiBlock *block, float pixel[3]);
 | |
| void ui_block_cm_to_display_space_range(uiBlock *block, float *min, float *max);
 | |
| 
 | |
| /* interface_regions.c */
 | |
| 
 | |
| struct uiKeyNavLock {
 | |
| 	/* set when we're using keyinput */
 | |
| 	bool is_keynav;
 | |
| 	/* only used to check if we've moved the cursor */
 | |
| 	int event_xy[2];
 | |
| };
 | |
| 
 | |
| typedef uiBlock * (*uiBlockHandleCreateFunc)(struct bContext *C, struct uiPopupBlockHandle *handle, void *arg1);
 | |
| 
 | |
| struct uiPopupBlockCreate {
 | |
| 	uiBlockCreateFunc              create_func;
 | |
| 	uiBlockHandleCreateFunc handle_create_func;
 | |
| 	void *arg;
 | |
| 
 | |
| 	int event_xy[2];
 | |
| 
 | |
| 	/* when popup is initialized from a button */
 | |
| 	ARegion *butregion;
 | |
| };
 | |
| 
 | |
| struct uiPopupBlockHandle {
 | |
| 	/* internal */
 | |
| 	struct ARegion *region;
 | |
| 
 | |
| 	/* use only for 'UI_BLOCK_MOVEMOUSE_QUIT' popups */
 | |
| 	float towards_xy[2];
 | |
| 	double towardstime;
 | |
| 	bool dotowards;
 | |
| 
 | |
| 	bool popup;
 | |
| 	void (*popup_func)(struct bContext *C, void *arg, int event);
 | |
| 	void (*cancel_func)(struct bContext *C, void *arg);
 | |
| 	void *popup_arg;
 | |
| 	
 | |
| 	/* store data for refreshing popups */
 | |
| 	struct uiPopupBlockCreate popup_create_vars;
 | |
| 
 | |
| 	struct wmTimer *scrolltimer;
 | |
| 
 | |
| 	struct uiKeyNavLock keynav_state;
 | |
| 
 | |
| 	/* for operator popups */
 | |
| 	struct wmOperatorType *optype;
 | |
| 	ScrArea *ctx_area;
 | |
| 	ARegion *ctx_region;
 | |
| 	int opcontext;
 | |
| 	
 | |
| 	/* return values */
 | |
| 	int butretval;
 | |
| 	int menuretval;
 | |
| 	int   retvalue;
 | |
| 	float retvec[4];
 | |
| 
 | |
| 	/* menu direction */
 | |
| 	int direction;
 | |
| 
 | |
| /* #ifdef USE_DRAG_POPUP */
 | |
| 	bool is_grab;
 | |
| 	int     grab_xy_prev[2];
 | |
| /* #endif */
 | |
| };
 | |
| 
 | |
| uiBlock *ui_block_func_COLOR(struct bContext *C, uiPopupBlockHandle *handle, void *arg_but);
 | |
| 
 | |
| struct ARegion *ui_tooltip_create(struct bContext *C, struct ARegion *butregion, uiBut *but);
 | |
| void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
 | |
| 
 | |
| uiBut *ui_popup_menu_memory_get(struct uiBlock *block);
 | |
| void   ui_popup_menu_memory_set(uiBlock *block, struct uiBut *but);
 | |
| 
 | |
| void   ui_popup_translate(struct bContext *C, struct ARegion *ar, const int mdiff[2]);
 | |
| 
 | |
| ColorPicker *ui_block_colorpicker_create(struct uiBlock *block);
 | |
| void ui_popup_block_scrolltest(struct uiBlock *block);
 | |
| 
 | |
| void ui_rgb_to_color_picker_compat_v(const float rgb[3], float r_cp[3]);
 | |
| void ui_rgb_to_color_picker_v(const float rgb[3], float r_cp[3]);
 | |
| void ui_color_picker_to_rgb_v(const float r_cp[3], float rgb[3]);
 | |
| void ui_color_picker_to_rgb(float r_cp0, float r_cp1, float r_cp2, float *r, float *g, float *b);
 | |
| 
 | |
| /* searchbox for string button */
 | |
| ARegion *ui_searchbox_create_generic(struct bContext *C, struct ARegion *butregion, uiBut *but);
 | |
| ARegion *ui_searchbox_create_operator(struct bContext *C, struct ARegion *butregion, uiBut *but);
 | |
| bool ui_searchbox_inside(struct ARegion *ar, int x, int y);
 | |
| int  ui_searchbox_find_index(struct ARegion *ar, const char *name);
 | |
| void ui_searchbox_update(struct bContext *C, struct ARegion *ar, uiBut *but, const bool reset);
 | |
| int ui_searchbox_autocomplete(struct bContext *C, struct ARegion *ar, uiBut *but, char *str);
 | |
| void ui_searchbox_event(struct bContext *C, struct ARegion *ar, uiBut *but, const struct wmEvent *event);
 | |
| bool ui_searchbox_apply(uiBut *but, struct ARegion *ar);
 | |
| void ui_searchbox_free(struct bContext *C, struct ARegion *ar);
 | |
| void ui_but_search_refresh(uiBut *but);
 | |
| 
 | |
| uiBlock *ui_popup_block_refresh(
 | |
|         struct bContext *C, uiPopupBlockHandle *handle,
 | |
|         ARegion *butregion, uiBut *but);
 | |
| 
 | |
| uiPopupBlockHandle *ui_popup_block_create(
 | |
|         struct bContext *C, struct ARegion *butregion, uiBut *but,
 | |
|         uiBlockCreateFunc create_func, uiBlockHandleCreateFunc handle_create_func,
 | |
|         void *arg);
 | |
| uiPopupBlockHandle *ui_popup_menu_create(
 | |
|         struct bContext *C, struct ARegion *butregion, uiBut *but,
 | |
|         uiMenuCreateFunc create_func, void *arg);
 | |
| 
 | |
| void ui_pie_menu_level_create(
 | |
|         uiBlock *block, struct wmOperatorType *ot, const char *propname, IDProperty *properties,
 | |
|         const EnumPropertyItem *items, int totitem, int context, int flag);
 | |
| 
 | |
| void ui_popup_block_free(struct bContext *C, uiPopupBlockHandle *handle);
 | |
| 
 | |
| int  ui_but_menu_step(uiBut *but, int step);
 | |
| bool ui_but_menu_step_poll(const uiBut *but);
 | |
| 
 | |
| 
 | |
| /* interface_panel.c */
 | |
| extern int ui_handler_panel_region(
 | |
|         struct bContext *C, const struct wmEvent *event,
 | |
|         struct ARegion *ar, const uiBut *active_but);
 | |
| extern void ui_draw_aligned_panel(struct uiStyle *style, uiBlock *block, const rcti *rect, const bool show_pin);
 | |
| 
 | |
| /* interface_draw.c */
 | |
| extern void ui_draw_dropshadow(const rctf *rct, float radius, float aspect, float alpha, int select);
 | |
| 
 | |
| void ui_draw_gradient(const rcti *rect, const float hsv[3], const int type, const float alpha);
 | |
| 
 | |
| void ui_draw_but_HISTOGRAM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
 | |
| void ui_draw_but_WAVEFORM(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
 | |
| void ui_draw_but_VECTORSCOPE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
 | |
| void ui_draw_but_COLORBAND(uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
 | |
| void ui_draw_but_UNITVEC(uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
 | |
| void ui_draw_but_CURVE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
 | |
| void ui_draw_but_IMAGE(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
 | |
| void ui_draw_but_TRACKPREVIEW(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
 | |
| void ui_draw_but_NODESOCKET(ARegion *ar, uiBut *but, struct uiWidgetColors *wcol, const rcti *rect);
 | |
| 
 | |
| /* interface_handlers.c */
 | |
| PointerRNA *ui_handle_afterfunc_add_operator(struct wmOperatorType *ot, int opcontext, bool create_props);
 | |
| extern void ui_pan_to_scroll(const struct wmEvent *event, int *type, int *val);
 | |
| extern void ui_but_activate_event(struct bContext *C, struct ARegion *ar, uiBut *but);
 | |
| extern void ui_but_activate_over(struct bContext *C, struct ARegion *ar, uiBut *but);
 | |
| extern void ui_but_execute_begin(struct bContext *C, struct ARegion *ar, uiBut *but, void **active_back);
 | |
| extern void ui_but_execute_end(struct bContext *C, struct ARegion *ar, uiBut *but, void *active_back);
 | |
| extern void ui_but_active_free(const struct bContext *C, uiBut *but);
 | |
| extern bool ui_but_is_active(struct ARegion *ar) ATTR_WARN_UNUSED_RESULT;
 | |
| extern int ui_but_menu_direction(uiBut *but);
 | |
| extern void ui_but_text_password_hide(char password_str[UI_MAX_DRAW_STR], uiBut *but, const bool restore);
 | |
| extern uiBut *ui_but_find_select_in_enum(uiBut *but, int direction);
 | |
| extern uiBut *ui_but_find_active_in_region(struct ARegion *ar);
 | |
| bool ui_but_is_editable(const uiBut *but);
 | |
| bool ui_but_is_editable_as_text(const uiBut *but);
 | |
| void ui_but_pie_dir_visual(RadialDirection dir, float vec[2]);
 | |
| void ui_but_pie_dir(RadialDirection dir, float vec[2]);
 | |
| float ui_block_calc_pie_segment(struct uiBlock *block, const float event_xy[2]);
 | |
| 
 | |
| void ui_but_add_shortcut(uiBut *but, const char *key_str, const bool do_strip);
 | |
| void ui_but_clipboard_free(void);
 | |
| void ui_panel_menu(struct bContext *C, ARegion *ar, Panel *pa);
 | |
| uiBut *ui_but_find_old(uiBlock *block_old, const uiBut *but_new);
 | |
| uiBut *ui_but_find_new(uiBlock *block_old, const uiBut *but_new);
 | |
| 
 | |
| #ifdef WITH_INPUT_IME
 | |
| void ui_but_ime_reposition(uiBut *but, int x, int y, bool complete);
 | |
| struct wmIMEData *ui_but_ime_data_get(uiBut *but);
 | |
| #endif
 | |
| 
 | |
| /* interface_widgets.c */
 | |
| void ui_draw_anti_tria(float x1, float y1, float x2, float y2, float x3, float y3);
 | |
| void ui_draw_anti_roundbox(int mode, float minx, float miny, float maxx, float maxy, float rad, bool use_alpha);
 | |
| void ui_draw_menu_back(struct uiStyle *style, uiBlock *block, rcti *rect);
 | |
| void ui_draw_pie_center(uiBlock *block);
 | |
| uiWidgetColors *ui_tooltip_get_theme(void);
 | |
| void ui_draw_tooltip_background(uiStyle *UNUSED(style), uiBlock *block, rcti *rect);
 | |
| void ui_draw_search_back(struct uiStyle *style, uiBlock *block, rcti *rect);
 | |
| bool ui_link_bezier_points(const rcti *rect, float coord_array[][2], int resol);
 | |
| void ui_draw_link_bezier(const rcti *rect);
 | |
| 
 | |
| extern void ui_draw_but(const struct bContext *C, ARegion *ar, struct uiStyle *style, uiBut *but, rcti *rect);
 | |
| /* theme color init */
 | |
| struct ThemeUI;
 | |
| void ui_widget_color_init(struct ThemeUI *tui);
 | |
| 
 | |
| void ui_draw_menu_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state, bool use_sep);
 | |
| void ui_draw_preview_item(struct uiFontStyle *fstyle, rcti *rect, const char *name, int iconid, int state);
 | |
| 
 | |
| #define UI_TEXT_MARGIN_X 0.4f
 | |
| #define UI_POPUP_MARGIN (UI_DPI_FAC * 12)
 | |
| /* margin at top of screen for popups */
 | |
| #define UI_POPUP_MENU_TOP (int)(8 * UI_DPI_FAC)
 | |
| 
 | |
| /* interface_style.c */
 | |
| void uiStyleInit(void);
 | |
| 
 | |
| /* interface_icons.c */
 | |
| void ui_icon_ensure_deferred(const struct bContext *C, const int icon_id, const bool big);
 | |
| int ui_id_icon_get(const struct bContext *C, struct ID *id, const bool big);
 | |
| 
 | |
| /* resources.c */
 | |
| void init_userdef_do_versions(void);
 | |
| void ui_theme_init_default(void);
 | |
| void ui_style_init_default(void);
 | |
| void ui_resources_init(void);
 | |
| void ui_resources_free(void);
 | |
| 
 | |
| /* interface_layout.c */
 | |
| void ui_layout_add_but(uiLayout *layout, uiBut *but);
 | |
| void ui_but_add_search(uiBut *but, PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop);
 | |
| void ui_layout_list_set_labels_active(uiLayout *layout);
 | |
| 
 | |
| /* interface_align.c */
 | |
| bool ui_but_can_align(const uiBut *but) ATTR_WARN_UNUSED_RESULT;
 | |
| void ui_block_align_calc(uiBlock *block);
 | |
| 
 | |
| /* interface_anim.c */
 | |
| void ui_but_anim_flag(uiBut *but, float cfra);
 | |
| void ui_but_anim_insert_keyframe(struct bContext *C);
 | |
| void ui_but_anim_delete_keyframe(struct bContext *C);
 | |
| void ui_but_anim_clear_keyframe(struct bContext *C);
 | |
| void ui_but_anim_add_driver(struct bContext *C);
 | |
| void ui_but_anim_remove_driver(struct bContext *C);
 | |
| void ui_but_anim_copy_driver(struct bContext *C);
 | |
| void ui_but_anim_paste_driver(struct bContext *C);
 | |
| void ui_but_anim_add_keyingset(struct bContext *C);
 | |
| void ui_but_anim_remove_keyingset(struct bContext *C);
 | |
| bool ui_but_anim_expression_get(uiBut *but, char *str, size_t maxlen);
 | |
| bool ui_but_anim_expression_set(uiBut *but, const char *str);
 | |
| bool ui_but_anim_expression_create(uiBut *but, const char *str);
 | |
| void ui_but_anim_autokey(struct bContext *C, uiBut *but, struct Scene *scene, float cfra);
 | |
| 
 | |
| /* interface_eyedropper.c */
 | |
| struct wmKeyMap *eyedropper_modal_keymap(struct wmKeyConfig *keyconf);
 | |
| void UI_OT_eyedropper_color(struct wmOperatorType *ot);
 | |
| void UI_OT_eyedropper_id(struct wmOperatorType *ot);
 | |
| void UI_OT_eyedropper_depth(struct wmOperatorType *ot);
 | |
| 
 | |
| #endif  /* __INTERFACE_INTERN_H__ */
 |