Blender  V3.3
Public Attributes | List of all members
wmGesture Struct Reference

#include <WM_types.h>

Public Attributes

struct wmGesturenext
 
struct wmGestureprev
 
int event_type
 
uint8_t event_modifier
 
short event_keymodifier
 
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
 
voidcustomdata
 
wmGenericUserData user_data
 

Detailed Description

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

Definition at line 546 of file WM_types.h.

Member Data Documentation

◆ customdata

void* wmGesture::customdata

◆ draw_active_side

bool wmGesture::draw_active_side

optional, draw the active side of the straightline gesture.

Definition at line 564 of file WM_types.h.

Referenced by wm_gesture_draw_line(), and WM_gesture_straightline_active_side_invoke().

◆ event_keymodifier

short wmGesture::event_keymodifier

wmEvent.keymodifier

Definition at line 553 of file WM_types.h.

Referenced by WM_gesture_new().

◆ event_modifier

uint8_t wmGesture::event_modifier

wmEvent.modifier

Definition at line 551 of file WM_types.h.

Referenced by WM_gesture_new().

◆ event_type

int wmGesture::event_type

wmEvent.type

Definition at line 549 of file WM_types.h.

Referenced by 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 571 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

◆ modal_state

int wmGesture::modal_state

◆ move

uint wmGesture::move

Use for gestures that can be moved, like box selection

Definition at line 577 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 547 of file WM_types.h.

Referenced by wm_gesture_draw().

◆ points

int wmGesture::points

optional, amount of points stored.

Definition at line 559 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 561 of file WM_types.h.

Referenced by WM_gesture_lasso_modal(), and WM_gesture_new().

◆ prev

struct wmGesture * wmGesture::prev

Definition at line 547 of file WM_types.h.

◆ type

int wmGesture::type

Gesture type define.

Definition at line 555 of file WM_types.h.

Referenced by WM_gesture_box_modal(), wm_gesture_draw(), wm_gesture_draw_lasso(), 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 583 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 580 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 595 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 575 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

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