WM_gizmo_types.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2016 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_compiler_attrs.h"
#include "BLI_utildefines.h"
#include "BLI_vector.hh"
 
#include "DNA_listBase.h"
 
struct wmGizmo;
struct wmGizmoType;
struct wmGizmoGroup;
struct wmGizmoGroupType;
struct wmGizmoMap;
struct wmGizmoMapType;
struct wmGizmoProperty;
struct wmGizmoPropertyType;
struct wmKeyConfig;
struct wmOperatorType;
 
/* -------------------------------------------------------------------- */
/* Enum Typedef's. */
 
enum eWM_GizmoFlagState {
  WM_GIZMO_STATE_HIGHLIGHT = (1 << 0),
  WM_GIZMO_STATE_MODAL = (1 << 1),
  WM_GIZMO_STATE_SELECT = (1 << 2),
};
ENUM_OPERATORS(eWM_GizmoFlagState, WM_GIZMO_STATE_SELECT)
 
 
enum eWM_GizmoFlag {
  WM_GIZMO_DRAW_HOVER = (1 << 0),
  WM_GIZMO_DRAW_MODAL = (1 << 1),
  WM_GIZMO_DRAW_VALUE = (1 << 2),
  WM_GIZMO_HIDDEN = (1 << 3),
  WM_GIZMO_HIDDEN_SELECT = (1 << 4),
  WM_GIZMO_HIDDEN_KEYMAP = (1 << 5),
  WM_GIZMO_DRAW_OFFSET_SCALE = (1 << 6),
  WM_GIZMO_DRAW_NO_SCALE = (1 << 7),
  WM_GIZMO_MOVE_CURSOR = (1 << 8),
  WM_GIZMO_SELECT_BACKGROUND = (1 << 9),
 
  WM_GIZMO_OPERATOR_TOOL_INIT = (1 << 10),
 
  WM_GIZMO_EVENT_HANDLE_ALL = (1 << 11),
 
  WM_GIZMO_NO_TOOLTIP = (1 << 12),
  WM_GIZMO_NEEDS_UNDO = (1 << 13),
};
ENUM_OPERATORS(eWM_GizmoFlag, WM_GIZMO_NEEDS_UNDO);
 
enum eWM_GizmoFlagGroupTypeFlag {
  WM_GIZMOGROUPTYPE_3D = (1 << 0),
  WM_GIZMOGROUPTYPE_SCALE = (1 << 1),
  WM_GIZMOGROUPTYPE_DEPTH_3D = (1 << 2),
  WM_GIZMOGROUPTYPE_SELECT = (1 << 3),
  WM_GIZMOGROUPTYPE_PERSISTENT = (1 << 4),
  WM_GIZMOGROUPTYPE_DRAW_MODAL_ALL = (1 << 5),
 
  WM_GIZMOGROUPTYPE_DRAW_MODAL_EXCLUDE = (1 << 6),
 
  WM_GIZMOGROUPTYPE_TOOL_INIT = (1 << 7),
 
  WM_GIZMOGROUPTYPE_TOOL_FALLBACK_KEYMAP = (1 << 8),
 
  WM_GIZMOGROUPTYPE_DELAY_REFRESH_FOR_TWEAK = (1 << 9),
 
  WM_GIZMOGROUPTYPE_VR_REDRAWS = (1 << 10),
};
 
ENUM_OPERATORS(eWM_GizmoFlagGroupTypeFlag, WM_GIZMOGROUPTYPE_VR_REDRAWS);
 
enum eWM_GizmoFlagGroupInitFlag {
  WM_GIZMOGROUP_INIT_SETUP = (1 << 0),
  WM_GIZMOGROUP_INIT_REFRESH = (1 << 1),
};
ENUM_OPERATORS(eWM_GizmoFlagGroupInitFlag, WM_GIZMOGROUP_INIT_REFRESH)
 
 
enum eWM_GizmoFlagMapTypeUpdateFlag {
  WM_GIZMOMAPTYPE_UPDATE_INIT = (1 << 0),
  WM_GIZMOMAPTYPE_UPDATE_REMOVE = (1 << 1),
 
  WM_GIZMOMAPTYPE_KEYMAP_INIT = (1 << 2),
};
ENUM_OPERATORS(eWM_GizmoFlagMapTypeUpdateFlag, WM_GIZMOMAPTYPE_KEYMAP_INIT)
 
/* -------------------------------------------------------------------- */
/* #wmGizmo. */
 
 
enum eWM_GizmoFlagTweak {
  WM_GIZMO_TWEAK_PRECISE = (1 << 0),
  WM_GIZMO_TWEAK_SNAP = (1 << 1),
};
 
#include "wm_gizmo_fn.hh"
 
struct wmGizmoOpElem {
  wmOperatorType *type = nullptr;
  PointerRNA ptr = {};
 
  bool is_redo = false;
};
 
struct wmGizmo {
  wmGizmo *next, *prev;
 
  const wmGizmoType *type;
 
  wmGizmoFnModal custom_modal;
 
  wmGizmoGroup *parent_gzgroup;
 
  wmKeyMap *keymap;
 
  void *py_instance;
 
  PointerRNA *ptr;
 
  eWM_GizmoFlag flag;
  eWM_GizmoFlagState state;
 
  int highlight_part;
 
  int drag_part;
 
  float select_bias;
 
  /* Transformation of the gizmo in 2d or 3d space.
   * - Matrix axis are expected to be unit length (scale is applied after).
   * - Behavior when axis aren't orthogonal depends on each gizmo.
   * - Typically the +Z is the primary axis for gizmos to use.
   * - 'matrix[3]' must be used for location,
   *   besides this it's up to the gizmos internal code how the
   *   rotation components are used for drawing and interaction. */
 
  float matrix_space[4][4];
  float matrix_basis[4][4];
  float matrix_offset[4][4];
  float scale_final;
  float scale_basis;
  float line_width;
  float color[4], color_hi[4];
 
  void *interaction_data;
 
  blender::Vector<wmGizmoOpElem, 4> op_data;
 
  IDProperty *properties;
 
  bool do_draw;
 
  union {
    float f;
  } temp;
 
  /* Over alloc target_properties after #wmGizmoType::struct_size. */
};
 
struct wmGizmoProperty {
  const wmGizmoPropertyType *type;
 
  PointerRNA ptr;
  PropertyRNA *prop;
  int index;
 
  /* Optional functions for converting to/from RNA. */
  struct {
    wmGizmoPropertyFnGet value_get_fn;
    wmGizmoPropertyFnSet value_set_fn;
    wmGizmoPropertyFnRangeGet range_get_fn;
    wmGizmoPropertyFnFree free_fn;
    void *user_data;
  } custom_func;
};
 
struct wmGizmoPropertyType {
  wmGizmoPropertyType *next, *prev;
  int data_type;
  int array_length;
 
  int index_in_type;
 
  char idname[0];
};
 
struct wmGizmoWrapper {
  wmGizmo *gizmo;
};
 
struct wmGizmoMapType_Params {
  short spaceid;
  short regionid;
};
 
struct wmGizmoType {
 
  const char *idname; /* #MAX_NAME. */
 
  uint struct_size;
 
  wmGizmoFnSetup setup;
 
  wmGizmoFnDraw draw;
 
  wmGizmoFnDrawSelect draw_select;
 
  wmGizmoFnTestSelect test_select;
 
  wmGizmoFnModal modal;
 
  wmGizmoFnPropertyUpdate property_update;
 
  wmGizmoFnMatrixBasisGet matrix_basis_get;
 
  wmGizmoFnScreenBoundsGet screen_bounds_get;
 
  wmGizmoFnInvoke invoke;
 
  wmGizmoFnExit exit;
 
  wmGizmoFnCursorGet cursor_get;
 
  wmGizmoFnSelectRefresh select_refresh;
 
  wmGizmoFnFree free;
 
  StructRNA *srna;
 
  ExtensionRNA rna_ext;
 
  ListBase target_property_defs;
  int target_property_defs_len;
};
 
/* -------------------------------------------------------------------- */
/* #wmGizmoGroup. */
 
struct wmGizmoGroupTypeRef {
  wmGizmoGroupTypeRef *next, *prev;
  wmGizmoGroupType *type;
};
 
struct wmGizmoGroupType {
  const char *idname; /* #MAX_NAME. */
  const char *name;
  char owner_id[128];
 
  wmGizmoGroupFnPoll poll;
  wmGizmoGroupFnInit setup;
  wmGizmoGroupFnRefresh refresh;
  wmGizmoGroupFnDrawPrepare draw_prepare;
  wmGizmoGroupFnInvokePrepare invoke_prepare;
 
  wmGizmoGroupFnSetupKeymap setup_keymap;
 
  wmGizmoGroupFnMsgBusSubscribe message_subscribe;
 
  wmKeyMap *keymap;
  wmKeyConfig *keyconf;
 
  /* NOTE: currently gizmo-group instances don't store properties,
   * they're kept in the tool properties. */
 
  StructRNA *srna;
 
  ExtensionRNA rna_ext;
 
  eWM_GizmoFlagGroupTypeFlag flag;
 
  eWM_GizmoFlagMapTypeUpdateFlag type_update_flag;
 
  wmGizmoMapType_Params gzmap_params;
 
  int users;
};
 
struct wmGizmoGroup {
  wmGizmoGroup *next, *prev;
 
  wmGizmoGroupType *type;
  ListBase gizmos;
 
  wmGizmoMap *parent_gzmap;
 
  void *py_instance;
 
  union {
    struct {
      uint delay_refresh_for_tweak : 1;
    };
    uint any;
  } hide;
 
  bool tag_remove;
 
  void *customdata;
  void (*customdata_free)(void *);
  eWM_GizmoFlagGroupInitFlag init_flag;
};
 
/* -------------------------------------------------------------------- */
/* #wmGizmoMap. */
 
enum eWM_GizmoFlagMapDrawStep {
  WM_GIZMOMAP_DRAWSTEP_2D = 0,
  WM_GIZMOMAP_DRAWSTEP_3D,
};
#define WM_GIZMOMAP_DRAWSTEP_MAX 2