wm_gizmo_intern.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "DNA_listBase.h"
 
#include "WM_gizmo_types.hh"
 
#include "BLI_vector.hh"
 
struct wmGizmoMap;
struct wmGizmoGroupType;
struct wmGizmoMapType;
struct wmGizmoType;
struct wmKeyConfig;
struct wmWindowManager;
 
#include "wm_gizmo_fn.hh"
 
/* -------------------------------------------------------------------- */
/* #wmGizmo. */

bool wm_gizmo_select_set_ex(
    wmGizmoMap *gzmap, wmGizmo *gz, bool select, bool use_array, bool use_callback);
bool wm_gizmo_select_and_highlight(bContext *C, wmGizmoMap *gzmap, wmGizmo *gz);
 
void wm_gizmo_calculate_scale(wmGizmo *gz, const bContext *C);
void wm_gizmo_update(wmGizmo *gz, const bContext *C, bool refresh_map);
 
int wm_gizmo_is_visible(wmGizmo *gz);
enum {
  WM_GIZMO_IS_VISIBLE_UPDATE = (1 << 0),
  WM_GIZMO_IS_VISIBLE_DRAW = (1 << 1),
};
 
/* -------------------------------------------------------------------- */
/* #wmGizmoGroup. */
 
enum {
  TWEAK_MODAL_CANCEL = 1,
  TWEAK_MODAL_CONFIRM,
  TWEAK_MODAL_PRECISION_ON,
  TWEAK_MODAL_PRECISION_OFF,
  TWEAK_MODAL_SNAP_ON,
  TWEAK_MODAL_SNAP_OFF,
};

wmGizmoGroup *wm_gizmogroup_new_from_type(wmGizmoMap *gzmap, wmGizmoGroupType *gzgt);
void wm_gizmogroup_free(bContext *C, wmGizmoGroup *gzgroup);
void wm_gizmogroup_gizmo_register(wmGizmoGroup *gzgroup, wmGizmo *gz);
wmGizmoGroup *wm_gizmogroup_find_by_type(const wmGizmoMap *gzmap, const wmGizmoGroupType *gzgt);
wmGizmo *wm_gizmogroup_find_intersected_gizmo(wmWindowManager *wm,
                                              const wmGizmoGroup *gzgroup,
                                              bContext *C,
                                              int event_modifier,
                                              const int mval[2],
                                              int *r_part);
void wm_gizmogroup_intersectable_gizmos_to_list(wmWindowManager *wm,
                                                const wmGizmoGroup *gzgroup,
                                                int event_modifier,
                                                blender::Vector<wmGizmo *, 128> *r_visible_gizmos);
bool wm_gizmogroup_is_visible_in_drawstep(const wmGizmoGroup *gzgroup,
                                          eWM_GizmoFlagMapDrawStep drawstep);
 
void wm_gizmogrouptype_setup_keymap(wmGizmoGroupType *gzgt, wmKeyConfig *keyconf);
 
wmKeyMap *wm_gizmogroup_tweak_modal_keymap(wmKeyConfig *keyconf);
 
/* -------------------------------------------------------------------- */
/* #wmGizmoMap. */
 
struct wmGizmoMapSelectState {
  struct wmGizmo **items;
  int len, len_alloc;
};
 
struct wmGizmoMap {
  wmGizmoMapType *type;
  ListBase groups; /* #wmGizmoGroup. */
 
  /* Private, update tagging (enum defined in C source). */
  char update_flag[WM_GIZMOMAP_DRAWSTEP_MAX];

  bool is_init;

  bool tag_remove_group;

  bool tag_highlight_pending;

  struct {
    wmGizmo *highlight;
    wmGizmo *modal;
    wmGizmoMapSelectState select;
    int event_xy[2];
    short event_grabcursor;
    int last_cursor;
  } gzmap_context;
};

struct wmGizmoMapType {
  wmGizmoMapType *next, *prev;
  short spaceid, regionid;
  /* Types of gizmo-groups for this gizmo-map type. */
  ListBase grouptype_refs;
 
  /* #eGizmoMapTypeUpdateFlags. */
  eWM_GizmoFlagMapTypeUpdateFlag type_update_flag;
};
 
void wm_gizmomap_select_array_clear(wmGizmoMap *gzmap);
bool wm_gizmomap_deselect_all(wmGizmoMap *gzmap);
void wm_gizmomap_select_array_shrink(wmGizmoMap *gzmap, int len_subtract);
void wm_gizmomap_select_array_push_back(wmGizmoMap *gzmap, wmGizmo *gz);
void wm_gizmomap_select_array_remove(wmGizmoMap *gzmap, wmGizmo *gz);