Blender
V3.3
|
#include <stdio.h>
#include <string.h>
#include "GHOST_C-api.h"
#include "BLI_utildefines.h"
#include "BLI_sys_types.h"
#include "DNA_listBase.h"
#include "DNA_userdef_types.h"
#include "DNA_workspace_types.h"
#include "BKE_context.h"
#include "BKE_global.h"
#include "BKE_main.h"
#include "WM_api.h"
#include "WM_types.h"
#include "wm_cursors.h"
#include "wm_window.h"
Go to the source code of this file.
Classes | |
struct | BCursor |
Macros | |
#define | BEGIN_CURSOR_BLOCK |
#define | END_CURSOR_BLOCK |
Typedefs | |
typedef struct BCursor | BCursor |
Functions | |
static GHOST_TStandardCursor | convert_to_ghost_standard_cursor (WMCursorType curs) |
static void | window_set_custom_cursor (wmWindow *win, const uchar mask[16][2], const uchar bitmap[16][2], int hotx, int hoty) |
static void | window_set_custom_cursor_ex (wmWindow *win, BCursor *cursor) |
void | WM_cursor_set (wmWindow *win, int curs) |
bool | WM_cursor_set_from_tool (struct wmWindow *win, const ScrArea *area, const ARegion *region) |
void | WM_cursor_modal_set (wmWindow *win, int val) |
void | WM_cursor_modal_restore (wmWindow *win) |
void | WM_cursor_wait (bool val) |
void | WM_cursor_grab_enable (wmWindow *win, int wrap, bool hide, int bounds[4]) |
void | WM_cursor_grab_disable (wmWindow *win, const int mouse_ungrab_xy[2]) |
static void | wm_cursor_warp_relative (wmWindow *win, int x, int y) |
bool | wm_cursor_arrow_move (wmWindow *win, const wmEvent *event) |
void | WM_cursor_time (wmWindow *win, int nr) |
void | wm_init_cursor_data (void) |
Variables | |
static BCursor * | BlenderCursor [WM_CURSOR_NUM] = {0} |
Cursor pixmap and cursor utility functions to change the cursor.
Definition in file wm_cursors.c.
#define BEGIN_CURSOR_BLOCK |
Each bit represents a pixel, so 1 byte = 8 pixels, the bytes go Left to Right. Top to bottom the bits in a byte go right to left (ie; 0x01, 0x80 represents a line of 16 pix with the first and last pix set.)
This type of cursor is 16x16 pixels only.
There is a nice Python GUI utility that can be used for drawing cursors in this format in the Blender source distribution, in ./source/tools/utils/make_cursor_gui.py
.
Start it with the command python3 make_cursor_gui.py
It will copy its output to the console when you press 'Do it'. Because defining a cursor mixes declarations and executable code each cursor needs its own scoping block or it would be split up over several hundred lines of code. To enforce/document this better I define 2 pretty brain-dead macros so it's obvious what the extra "[]" are for
Definition at line 389 of file wm_cursors.c.
#define END_CURSOR_BLOCK |
Definition at line 392 of file wm_cursors.c.
|
static |
Definition at line 44 of file wm_cursors.c.
References GHOST_kStandardCursorCopy, GHOST_kStandardCursorCrosshair, GHOST_kStandardCursorCrosshairA, GHOST_kStandardCursorCrosshairB, GHOST_kStandardCursorCrosshairC, GHOST_kStandardCursorCustom, GHOST_kStandardCursorDefault, GHOST_kStandardCursorDownArrow, GHOST_kStandardCursorEraser, GHOST_kStandardCursorEWScroll, GHOST_kStandardCursorEyedropper, GHOST_kStandardCursorHorizontalSplit, GHOST_kStandardCursorKnife, GHOST_kStandardCursorLeftArrow, GHOST_kStandardCursorLeftRight, GHOST_kStandardCursorMove, GHOST_kStandardCursorNSEWScroll, GHOST_kStandardCursorNSScroll, GHOST_kStandardCursorPencil, GHOST_kStandardCursorRightArrow, GHOST_kStandardCursorStop, GHOST_kStandardCursorText, GHOST_kStandardCursorUpArrow, GHOST_kStandardCursorUpDown, GHOST_kStandardCursorVerticalSplit, GHOST_kStandardCursorWait, GHOST_kStandardCursorZoomIn, GHOST_kStandardCursorZoomOut, WM_CURSOR_COPY, WM_CURSOR_CROSS, WM_CURSOR_CROSSC, WM_CURSOR_DEFAULT, WM_CURSOR_DOT, WM_CURSOR_E_ARROW, WM_CURSOR_EDIT, WM_CURSOR_ERASER, WM_CURSOR_EW_SCROLL, WM_CURSOR_EYEDROPPER, WM_CURSOR_H_SPLIT, WM_CURSOR_HAND, WM_CURSOR_KNIFE, WM_CURSOR_N_ARROW, WM_CURSOR_NS_SCROLL, WM_CURSOR_NSEW_SCROLL, WM_CURSOR_PAINT, WM_CURSOR_PAINT_BRUSH, WM_CURSOR_S_ARROW, WM_CURSOR_STOP, WM_CURSOR_TEXT_EDIT, WM_CURSOR_V_SPLIT, WM_CURSOR_W_ARROW, WM_CURSOR_WAIT, WM_CURSOR_X_MOVE, WM_CURSOR_Y_MOVE, WM_CURSOR_ZOOM_IN, and WM_CURSOR_ZOOM_OUT.
Referenced by WM_cursor_set().
|
static |
Definition at line 107 of file wm_cursors.c.
References GHOST_SetCustomCursorShape(), wmWindow::ghostwin, and mask().
Referenced by WM_cursor_time().
Definition at line 114 of file wm_cursors.c.
References BCursor::bitmap, BCursor::can_invert_color, GHOST_SetCustomCursorShape(), wmWindow::ghostwin, BCursor::hotx, BCursor::hoty, and BCursor::mask.
Referenced by WM_cursor_set().
Definition at line 289 of file wm_cursors.c.
References EVT_DOWNARROWKEY, EVT_LEFTARROWKEY, EVT_RIGHTARROWKEY, EVT_UPARROWKEY, GHOST_GetNativePixelSize(), wmWindow::ghostwin, KM_PRESS, wmEvent::type, wmEvent::val, and wm_cursor_warp_relative().
Referenced by wm_handlers_do_intern().
Definition at line 263 of file wm_cursors.c.
References G, G_DEBUG, GHOST_kAxisNone, GHOST_kGrabDisable, GHOST_SetCursorGrab(), wmWindow::ghostwin, wmWindow::grabcursor, NULL, and wm_cursor_position_to_ghost_screen_coords().
Referenced by button_activate_state(), poselib_blend_cleanup(), WM_event_remove_handlers(), wm_gizmomap_modal_set(), and wm_handler_operator_call().
bounds | can be NULL |
Definition at line 226 of file wm_cursors.c.
References bounds(), wmWindow::eventstate, G, G_DEBUG, GHOST_kAxisX, GHOST_kAxisY, GHOST_kGrabHide, GHOST_kGrabNormal, GHOST_kGrabWrap, GHOST_SetCursorGrab(), wmWindow::ghostwin, wmWindow::grabcursor, wmTabletData::is_motion_absolute, NULL, wmEvent::tablet, wm_cursor_position_to_ghost_screen_coords(), WM_CURSOR_WRAP_X, WM_CURSOR_WRAP_Y, and blender::bke::image::partial_update::wrap().
Referenced by button_activate_state(), initWalkInfo(), poselib_blend_cursor_update(), walkEnd(), wm_gizmomap_modal_set(), wm_macro_modal(), and wm_operator_invoke().
Definition at line 200 of file wm_cursors.c.
References wmWindow::lastcursor, wmWindow::modalcursor, and WM_cursor_set().
Referenced by annotation_draw_exit(), area_split_exit(), area_swap_exit(), button_activate_exit(), curve_draw_exit(), datadropper_exit(), depthdropper_exit(), driverdropper_exit(), eyedropper_colorband_exit(), eyedropper_exit(), face_set_extract_modal(), gesture_modal_end(), gpencil_draw_modal(), gpencil_fill_exit(), gpencil_fill_modal(), gpencil_interpolate_modal(), gpencil_primitive_interaction_end(), gpencil_primitive_modal(), graph_slider_exit(), image_view_pan_exit(), image_view_zoom_exit(), knifetool_exit_ex(), blender::ed::space_node::node_resize_exit(), pose_slide_modal(), postTrans(), sample_color_modal(), screen_opengl_render_end(), sculpt_sample_detail_size_modal(), ui_handler_wait_for_input(), ui_numedit_set_active(), ui_textedit_end(), view_pan_exit(), view_pan_modal(), view_zoom_exit(), view_zoomdrag_modal(), WM_cursor_wait(), and wm_drags_exit().
Definition at line 191 of file wm_cursors.c.
References wmWindow::cursor, wmWindow::lastcursor, wmWindow::modalcursor, and WM_cursor_set().
Referenced by annotation_draw_cursor_set(), area_swap_invoke(), button_activate_init(), curve_draw_invoke(), datadropper_invoke(), depthdropper_invoke(), driverdropper_invoke(), eyedropper_colorband_invoke(), eyedropper_invoke(), face_set_extract_invoke(), gpencil_draw_modal(), gpencil_fill_invoke(), gpencil_interpolate_invoke(), gpencil_primitive_edit_event_handling(), gpencil_primitive_invoke(), gpencil_primitive_modal(), graph_slider_invoke(), image_view_pan_init(), image_view_zoom_init(), initMouseInputMode(), knifetool_invoke(), blender::ed::space_node::node_resize_init(), pose_slide_invoke_common(), sample_color_invoke(), sculpt_sample_detail_size_invoke(), ui_numedit_set_active(), ui_textedit_begin(), view_pan_init(), view_pan_invoke(), view_zoom_init(), view_zoomdrag_invoke(), WM_cursor_wait(), wm_drags_check_ops(), WM_gesture_lasso_invoke(), WM_gesture_lines_invoke(), WM_gesture_straightline_invoke(), and WM_operator_name_call_ptr_with_depends_on_cursor().
Definition at line 126 of file wm_cursors.c.
References BlenderCursor, BLI_assert_msg, convert_to_ghost_standard_cursor(), wmWindow::cursor, G, GHOST_HasCursorShape(), GHOST_kStandardCursorCustom, GHOST_kStandardCursorDefault, GHOST_SetCursorShape(), GHOST_SetCursorVisibility(), wmWindow::ghostwin, wmWindow::modalcursor, NULL, window_set_custom_cursor_ex(), WM_CURSOR_DEFAULT, WM_CURSOR_NONE, and WM_CURSOR_NUM.
Referenced by actionzone_modal(), area_join_modal(), area_split_preview_update_cursor(), area_swap_modal(), clip_tracking_hide_cursor(), clip_tracking_show_cursor(), console_cursor(), ED_region_cursor_set(), gpencil_transform_fill_invoke(), gpencil_uv_transform_exit(), blender::ed::space_node::node_set_cursor(), paint_update_mouse_cursor(), screen_cursor_set(), text_cursor(), ui_popup_block_create(), view3d_main_region_cursor(), WM_cursor_modal_restore(), WM_cursor_modal_set(), WM_cursor_set_from_tool(), WM_gizmomap_cursor_set(), and wm_gizmomap_highlight_set().
bool WM_cursor_set_from_tool | ( | struct wmWindow * | win, |
const ScrArea * | area, | ||
const ARegion * | region | ||
) |
Definition at line 174 of file wm_cursors.c.
References blender::compositor::area(), wmWindow::cursor, bToolRef_Runtime::cursor, ELEM, if(), wmWindow::modalcursor, NULL, ARegion::regiontype, RGN_TYPE_PREVIEW, RGN_TYPE_WINDOW, WM_CURSOR_DEFAULT, and WM_cursor_set().
Referenced by ED_region_cursor_set(), and view3d_main_region_cursor().
After this you can call restore too.
Definition at line 317 of file wm_cursors.c.
References wmWindow::cursor, wmWindow::lastcursor, mask(), window_set_custom_cursor(), x, and y.
Referenced by gpencil_do_frame_fill(), gpencil_fill_modal(), and screen_opengl_render_anim_step().
To allow usage all over, we do entire WM.
Definition at line 209 of file wm_cursors.c.
References ListBase::first, G, G_MAIN, wmWindow::next, NULL, wmWindowManager::windows, WM_cursor_modal_restore(), WM_cursor_modal_set(), and WM_CURSOR_WAIT.
Referenced by asset_bundle_install_exec(), associate_blend_exec(), bake_invoke(), ED_object_parent_set(), edbm_duplicate_invoke(), gpencil_bake_grease_pencil_animation_exec(), light_cache_bake_invoke(), multiresbake_image_exec(), redraw_timer_exec(), save_image_op(), screen_render_invoke(), script_reload_exec(), sculpt_dynamic_topology_toggle_exec(), separate_armature_exec(), separate_exec(), solve_camera_invoke(), track_markers(), WM_file_read(), and wm_file_write().
Definition at line 281 of file wm_cursors.c.
References wm_cursor_position_get(), WM_cursor_warp(), x, and y.
Referenced by wm_cursor_arrow_move().
Definition at line 396 of file wm_cursors.c.
References BEGIN_CURSOR_BLOCK, BlenderCursor, END_CURSOR_BLOCK, WM_CURSOR_COPY, WM_CURSOR_CROSS, WM_CURSOR_CROSSC, WM_CURSOR_DEFAULT, WM_CURSOR_DOT, WM_CURSOR_E_ARROW, WM_CURSOR_EDIT, WM_CURSOR_ERASER, WM_CURSOR_EW_ARROW, WM_CURSOR_EW_SCROLL, WM_CURSOR_EYEDROPPER, WM_CURSOR_H_SPLIT, WM_CURSOR_HAND, WM_CURSOR_KNIFE, WM_CURSOR_MUTE, WM_CURSOR_N_ARROW, WM_CURSOR_NS_ARROW, WM_CURSOR_NS_SCROLL, WM_CURSOR_NSEW_SCROLL, WM_CURSOR_NW_ARROW, WM_CURSOR_PAINT, WM_CURSOR_PAINT_BRUSH, WM_CURSOR_PICK_AREA, WM_CURSOR_S_ARROW, WM_CURSOR_STOP, WM_CURSOR_SWAP_AREA, WM_CURSOR_TEXT_EDIT, WM_CURSOR_V_SPLIT, WM_CURSOR_VERTEX_LOOP, WM_CURSOR_W_ARROW, WM_CURSOR_WAIT, WM_CURSOR_X_MOVE, WM_CURSOR_Y_MOVE, WM_CURSOR_ZOOM_IN, and WM_CURSOR_ZOOM_OUT.
Referenced by WM_init().
|
static |
Definition at line 41 of file wm_cursors.c.
Referenced by WM_cursor_set(), and wm_init_cursor_data().