wmGesture Struct Reference

#include <WM_types.h>

Public Attributes
struct wmGesture *	next
struct wmGesture *	prev
int	event_type
int	type
rcti	winrct
int	points
int	points_alloc
int	modal_state
bool	draw_active_side
uint	is_active: 1
uint	is_active_prev: 1
uint	wait_for_input: 1
uint	move: 1
uint	use_snap: 1
uint	use_flip: 1
void *	customdata
wmGenericUserData	user_data

Detailed Description

wmGesture is registered to wmWindow.gesture, handled by operator callbacks. Tweak gesture is builtin feature.

Definition at line 487 of file WM_types.h.

Member Data Documentation

customdata

void* wmGesture::customdata

customdata

• for border is a rcti.
• for circle is recti, (xmin, ymin) is center, xmax radius.
• for lasso is short array.
• for straight line is a recti: (xmin,ymin) is start, (xmax, ymax) is end.

Definition at line 529 of file WM_types.h.

Referenced by draw_filled_lasso(), gesture_box_apply_rect(), gesture_circle_apply(), gesture_lasso_apply(), gesture_straightline_apply(), gesture_tweak_modal(), WM_gesture_box_modal(), WM_gesture_circle_invoke(), WM_gesture_circle_modal(), wm_gesture_draw_circle(), wm_gesture_draw_cross(), wm_gesture_draw_lasso(), wm_gesture_draw_line(), wm_gesture_draw_rect(), WM_gesture_end(), wm_gesture_evaluate(), WM_gesture_lasso_modal(), WM_gesture_new(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

draw_active_side

bool wmGesture::draw_active_side

optional, draw the active side of the straightline gesture.

Definition at line 501 of file WM_types.h.

Referenced by wm_gesture_draw_line(), and WM_gesture_straightline_active_side_invoke().

event_type

int wmGesture::event_type

wmEvent.type

Definition at line 490 of file WM_types.h.

Referenced by gesture_tweak_modal(), and WM_gesture_new().

is_active

uint wmGesture::is_active

For modal operators which may be running idle, waiting for an event to activate the gesture. Typically this is set when the user is click-dragging the gesture (box and circle select for eg).

Definition at line 508 of file WM_types.h.

Referenced by paint_weight_gradient_invoke(), WM_gesture_box_modal(), WM_gesture_circle_invoke(), WM_gesture_circle_modal(), wm_gesture_draw(), WM_gesture_lasso_modal(), WM_gesture_straightline_invoke(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

is_active_prev

uint wmGesture::is_active_prev

Previous value of is-active (use to detect first run & edge cases).

Definition at line 510 of file WM_types.h.

Referenced by WM_gesture_box_modal(), WM_gesture_circle_modal(), WM_gesture_is_modal_first(), WM_gesture_lasso_modal(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

modal_state

int wmGesture::modal_state

Definition at line 499 of file WM_types.h.

Referenced by gesture_box_apply(), gesture_circle_apply(), WM_gesture_box_modal(), WM_gesture_circle_modal(), WM_gesture_new(), and WM_gesture_straightline_oneshot_modal().

move

uint wmGesture::move

Use for gestures that can be moved, like box selection

Definition at line 514 of file WM_types.h.

Referenced by WM_gesture_box_modal(), WM_gesture_lasso_modal(), WM_gesture_new(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

next

struct wmGesture* wmGesture::next

Definition at line 488 of file WM_types.h.

Referenced by wm_gesture_draw().

points

int wmGesture::points

optional, amount of points stored.

Definition at line 496 of file WM_types.h.

Referenced by draw_filled_lasso(), gesture_lasso_apply(), wm_gesture_draw_lasso(), WM_gesture_lasso_modal(), and WM_gesture_new().

points_alloc

int wmGesture::points_alloc

optional, maximum amount of points stored.

Definition at line 498 of file WM_types.h.

Referenced by WM_gesture_lasso_modal(), and WM_gesture_new().

prev

struct wmGesture * wmGesture::prev

Definition at line 488 of file WM_types.h.

type

int wmGesture::type

Gesture type define.

Definition at line 492 of file WM_types.h.

Referenced by WM_gesture_box_modal(), wm_gesture_draw(), wm_gesture_draw_lasso(), wm_gesture_evaluate(), and WM_gesture_new().

use_flip

uint wmGesture::use_flip

For gestures that support flip, stores if flip is enabled using the modal keymap toggle.

Definition at line 520 of file WM_types.h.

Referenced by gesture_straightline_apply(), wm_gesture_draw_line(), WM_gesture_straightline_active_side_invoke(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

use_snap

uint wmGesture::use_snap

For gestures that support snapping, stores if snapping is enabled using the modal keymap toggle.

Definition at line 517 of file WM_types.h.

Referenced by WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

user_data

wmGenericUserData wmGesture::user_data

Free pointer to use for operator allocs (if set, its freed on exit).

Definition at line 532 of file WM_types.h.

Referenced by mesh_bisect_exec(), mesh_bisect_invoke(), mesh_bisect_modal(), paint_weight_gradient_exec(), paint_weight_gradient_modal(), view3d_circle_select_exec(), WM_gesture_end(), and WM_gesture_new().

wait_for_input

uint wmGesture::wait_for_input

Use for gestures that support both immediate or delayed activation.

Definition at line 512 of file WM_types.h.

Referenced by gesture_box_apply(), gesture_circle_apply(), WM_gesture_box_invoke(), WM_gesture_box_modal(), WM_gesture_circle_invoke(), WM_gesture_circle_modal(), and WM_gesture_straightline_oneshot_modal().

winrct

rcti wmGesture::winrct

bounds of region to draw gesture within.

Definition at line 494 of file WM_types.h.

Referenced by draw_filled_lasso(), gesture_tweak_modal(), WM_gesture_box_modal(), WM_gesture_circle_modal(), wm_gesture_draw(), WM_gesture_lasso_modal(), WM_gesture_new(), WM_gesture_straightline_modal(), WM_gesture_straightline_oneshot_modal(), and WM_gizmo_group_refresh().

---

The documentation for this struct was generated from the following file:

• WM_types.h