wm_gizmo_wmapi.h File Reference

Go to the source code of this file.

Functions
Gizmos Window Manager API
API for usage in window manager code only. It should contain all functionality needed to hook up the gizmo system with Blender's window manager. It's mostly the event system that needs to communicate with gizmo code. Only included in wm.h and lower level files.
void	wm_gizmotype_free (void)
void	wm_gizmotype_init (void)
void	wm_gizmogrouptype_free (void)
void	wm_gizmogrouptype_init (void)
void	GIZMOGROUP_OT_gizmo_select (struct wmOperatorType *ot)
void	GIZMOGROUP_OT_gizmo_tweak (struct wmOperatorType *ot)
bool	wm_gizmogroup_is_any_selected (const struct wmGizmoGroup *gzgroup)
void	wm_gizmomap_remove (struct wmGizmoMap *gzmap)
void	wm_gizmos_keymap (struct wmKeyConfig *keyconf)
void	wm_gizmomaps_handled_modal_update (bContext *C, struct wmEvent *event, struct wmEventHandler_Op *handler)
void	wm_gizmomap_handler_context_op (bContext *C, struct wmEventHandler_Op *handler)
void	wm_gizmomap_handler_context_gizmo (bContext *C, struct wmEventHandler_Gizmo *handler)
struct wmGizmo *	wm_gizmomap_highlight_find (struct wmGizmoMap *gzmap, bContext *C, const struct wmEvent *event, int *r_part)
bool	wm_gizmomap_highlight_set (struct wmGizmoMap *gzmap, const bContext *C, struct wmGizmo *gz, int part)
struct wmGizmo *	wm_gizmomap_highlight_get (struct wmGizmoMap *gzmap)
void	wm_gizmomap_modal_set (struct wmGizmoMap *gzmap, bContext *C, struct wmGizmo *gz, const struct wmEvent *event, bool enable)
struct wmGizmo *	wm_gizmomap_modal_get (struct wmGizmoMap *gzmap)
struct wmGizmo **	wm_gizmomap_selected_get (wmGizmoMap *gzmap, int *r_selected_len)
struct ListBase *	wm_gizmomap_groups_get (wmGizmoMap *gzmap)
void	wm_gizmomaptypes_free (void)

Function Documentation

GIZMOGROUP_OT_gizmo_select()

void GIZMOGROUP_OT_gizmo_select

(

struct wmOperatorType *

ot

)

Definition at line 400 of file wm_gizmo_group.c.

References wmOperatorType::description, wmOperatorType::flag, gizmo_select_invoke(), wmOperatorType::idname, wmOperatorType::invoke, wmOperatorType::name, OPTYPE_UNDO, ot, and WM_operator_properties_mouse_select().

Referenced by wm_operatortypes_register().

GIZMOGROUP_OT_gizmo_tweak()

void GIZMOGROUP_OT_gizmo_tweak

(

struct wmOperatorType *

ot

)

Definition at line 625 of file wm_gizmo_group.c.

References wmOperatorType::description, wmOperatorType::flag, gizmo_tweak_invoke(), gizmo_tweak_modal(), wmOperatorType::idname, wmOperatorType::invoke, wmOperatorType::modal, wmOperatorType::name, OPTYPE_UNDO, and ot.

Referenced by wm_operatortypes_register().

wm_gizmogroup_is_any_selected()

bool wm_gizmogroup_is_any_selected

(

const struct wmGizmoGroup *

gzgroup

)

wm_gizmogrouptype_free()

void wm_gizmogrouptype_free

(

void

)

Definition at line 186 of file wm_gizmo_group_type.c.

References BLI_ghash_free(), global_gizmogrouptype_hash, NULL, and wm_gizmogrouptype_ghash_free_cb().

Referenced by WM_exit_ex().

wm_gizmogrouptype_init()

void wm_gizmogrouptype_init

(

void

)

Definition at line 194 of file wm_gizmo_group_type.c.

References BLI_ghash_str_new_ex(), and global_gizmogrouptype_hash.

Referenced by WM_init().

wm_gizmomap_groups_get()

struct ListBase* wm_gizmomap_groups_get

(

wmGizmoMap *

gzmap

)

Definition at line 1144 of file wm_gizmo_map.c.

References wmGizmoMap::groups.

wm_gizmomap_handler_context_gizmo()

void wm_gizmomap_handler_context_gizmo	(	bContext *	C,
		struct wmEventHandler_Gizmo *	handler
	)

wm_gizmomap_handler_context_op()

void wm_gizmomap_handler_context_op	(	bContext *	C,
		wmEventHandler_Op *	handler
	)

Prepare context for gizmo handling (but only if area/region is part of screen). Version of wm_handler_op_context for gizmos.

Definition at line 950 of file wm_gizmo_map.c.

References blender::compositor::area(), wmEventHandler_Op::area, bScreen::areabase, C, wmEventHandler_Op::context, CTX_wm_area_set(), CTX_wm_region_set(), CTX_wm_screen(), ListBase::first, ARegion::next, NULL, and wmEventHandler_Op::region.

Referenced by wm_gizmomaps_handled_modal_update().

wm_gizmomap_highlight_find()

struct wmGizmo* wm_gizmomap_highlight_find	(	struct wmGizmoMap *	gzmap,
		bContext *	C,
		const struct wmEvent *	event,
		int *	r_part
	)

wm_gizmomap_highlight_get()

struct wmGizmo* wm_gizmomap_highlight_get

(

struct wmGizmoMap *

gzmap

)

Definition at line 1046 of file wm_gizmo_map.c.

References wmGizmoMap::gzmap_context, and wmGizmoMap::highlight.

Referenced by WM_event_get_keymap_from_toolsystem_fallback(), WM_gizmo_group_refresh(), wm_handler_operator_call(), and wm_handlers_do_gizmo_handler().

wm_gizmomap_highlight_set()

bool wm_gizmomap_highlight_set	(	struct wmGizmoMap *	gzmap,
		const bContext *	C,
		struct wmGizmo *	gz,
		int	part
	)

Definition at line 999 of file wm_gizmo_map.c.

References C, CTX_wm_region(), CTX_wm_window(), wmWindow::cursor, wmGizmoType::cursor_get, ED_region_tag_redraw_editor_overlays(), wmGizmoMap::gzmap_context, wmGizmoMap::highlight, wmGizmo::highlight_part, wmGizmoMap::last_cursor, wmGizmo::state, wmGizmo::type, WM_cursor_set(), and WM_GIZMO_STATE_HIGHLIGHT.

Referenced by WM_gizmo_highlight_set(), wm_gizmo_select_and_highlight(), WM_gizmo_unlink(), wm_gizmogroup_free(), wm_gizmomap_select_all_intern(), wm_gizmomaps_handled_modal_update(), WM_gizmomaptype_group_init_runtime_with_region(), and wm_handlers_do_gizmo_handler().

wm_gizmomap_modal_get()

struct wmGizmo* wm_gizmomap_modal_get

(

struct wmGizmoMap *

gzmap

)

Definition at line 1133 of file wm_gizmo_map.c.

References wmGizmoMap::gzmap_context, and wmGizmoMap::modal.

Referenced by drawDial3d(), wm_gizmomaps_handled_modal_update(), and wm_handlers_do_gizmo_handler().

wm_gizmomap_modal_set()

void wm_gizmomap_modal_set	(	struct wmGizmoMap *	gzmap,
		bContext *	C,
		struct wmGizmo *	gz,
		const struct wmEvent *	event,
		bool	enable
	)

wm_gizmomap_remove()

void wm_gizmomap_remove

(

struct wmGizmoMap *

gzmap

)

Definition at line 204 of file wm_gizmo_map.c.

References MEM_freeN, and wm_gizmomap_free_data().

Referenced by WM_init().

wm_gizmomap_selected_get()

struct wmGizmo** wm_gizmomap_selected_get	(	wmGizmoMap *	gzmap,
		int *	r_selected_len
	)

Definition at line 1138 of file wm_gizmo_map.c.

References wmGizmoMap::gzmap_context, wmGizmoMapSelectState::items, wmGizmoMapSelectState::len, and wmGizmoMap::select.

wm_gizmomaps_handled_modal_update()

void wm_gizmomaps_handled_modal_update	(	bContext *	C,
		struct wmEvent *	event,
		struct wmEventHandler_Op *	handler
	)

Definition at line 810 of file wm_gizmo_map.c.

References blender::compositor::area(), BLI_assert, C, wmEventHandler_Op::context, CTX_wm_area(), CTX_wm_area_set(), CTX_wm_region(), CTX_wm_region_set(), wmGizmo::custom_modal, wmGizmoType::exit, ARegion::gizmo_map, wmGizmo::highlight_part, wmGizmoType::modal, NULL, wmEventHandler_Op::op, OPERATOR_RUNNING_MODAL, wmEventHandler_Op::region, wmOperator::type, wmGizmoOpElem::type, wmGizmo::type, UNUSED_VARS_NDEBUG, WM_gizmo_operator_get(), wm_gizmomap_handler_context_op(), wm_gizmomap_highlight_set(), wm_gizmomap_modal_get(), and wm_gizmomap_modal_set().

Referenced by wm_handler_operator_call().

wm_gizmomaptypes_free()

void wm_gizmomaptypes_free

(

void

)

Definition at line 1233 of file wm_gizmo_map.c.

References ListBase::first, gizmomaptypes, MEM_freeN, and WM_gizmomaptype_group_free().

Referenced by WM_exit_ex().

wm_gizmos_keymap()

void wm_gizmos_keymap

(

wmKeyConfig *

keyconf

)

Initialize keymaps for all existing gizmo-groups

Definition at line 1250 of file wm_gizmo_map.c.

References gizmomaptypes, LISTBASE_FOREACH, wm_gizmogroup_tweak_modal_keymap(), and wm_gizmogrouptype_setup_keymap().

Referenced by wm_window_keymap().

wm_gizmotype_free()

void wm_gizmotype_free

(

void

)

Definition at line 192 of file wm_gizmo_type.c.

References BLI_ghash_free(), global_gizmotype_hash, NULL, and wm_gizmotype_ghash_free_cb().

Referenced by WM_exit_ex().

wm_gizmotype_init()

void wm_gizmotype_init

(

void

)

Definition at line 199 of file wm_gizmo_type.c.

References BLI_ghash_str_new_ex(), and global_gizmotype_hash.

Referenced by WM_init().