WM_gizmo_types.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2016 Blender Foundation.
 * All rights reserved.
 */
 
#pragma once
 
#include "BLI_compiler_attrs.h"
 
struct wmGizmo;
struct wmGizmoGroup;
struct wmGizmoGroupType;
struct wmGizmoMapType;
struct wmGizmoProperty;
struct wmKeyConfig;
 
#include "DNA_listBase.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* -------------------------------------------------------------------- */
/* Enum Typedef's */
 
typedef enum eWM_GizmoFlagState {
  WM_GIZMO_STATE_HIGHLIGHT = (1 << 0),
  WM_GIZMO_STATE_MODAL = (1 << 1),
  WM_GIZMO_STATE_SELECT = (1 << 2),
} eWM_GizmoFlagState;
 
typedef 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),
} eWM_GizmoFlag;
 
typedef 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_TOOL_INIT = (1 << 6),
 
  WM_GIZMOGROUPTYPE_TOOL_FALLBACK_KEYMAP = (1 << 7),
 
  WM_GIZMOGROUPTYPE_DELAY_REFRESH_FOR_TWEAK = (1 << 8),
 
  WM_GIZMOGROUPTYPE_VR_REDRAWS = (1 << 9),
} eWM_GizmoFlagGroupTypeFlag;
 
typedef enum eWM_GizmoFlagGroupInitFlag {
  WM_GIZMOGROUP_INIT_SETUP = (1 << 0),
  WM_GIZMOGROUP_INIT_REFRESH = (1 << 1),
} eWM_GizmoFlagGroupInitFlag;
 
typedef enum eWM_GizmoFlagMapTypeUpdateFlag {
  WM_GIZMOMAPTYPE_UPDATE_INIT = (1 << 0),
  WM_GIZMOMAPTYPE_UPDATE_REMOVE = (1 << 1),
 
  WM_GIZMOMAPTYPE_KEYMAP_INIT = (1 << 2),
} eWM_GizmoFlagMapTypeUpdateFlag;
 
/* -------------------------------------------------------------------- */
/* wmGizmo */
 
typedef enum {
  /* Drag with extra precision (Shift). */
  WM_GIZMO_TWEAK_PRECISE = (1 << 0),
  /* Drag with snap enabled (Ctrl).  */
  WM_GIZMO_TWEAK_SNAP = (1 << 1),
} eWM_GizmoFlagTweak;
 
#include "wm_gizmo_fn.h"
 
typedef struct wmGizmoOpElem {
  struct wmOperatorType *type;
  PointerRNA ptr;
 
  bool is_redo;
} wmGizmoOpElem;
 
/* gizmos are set per region by registering them on gizmo-maps */
struct wmGizmo {
  struct wmGizmo *next, *prev;
 
  const struct wmGizmoType *type;
 
  wmGizmoFnModal custom_modal;
 
  struct wmGizmoGroup *parent_gzgroup;
 
  struct wmKeyMap *keymap;
 
  void *py_instance;
 
  struct PointerRNA *ptr;
 
  eWM_GizmoFlag flag;
  eWM_GizmoFlagState state;
 
  int highlight_part;
 
  int drag_part;
 
  float select_bias;
 
  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;
 
  wmGizmoOpElem *op_data;
  int op_data_len;
 
  struct IDProperty *properties;
 
  bool do_draw;
 
  union {
    float f;
  } temp;
 
  /* over alloc target_properties after 'wmGizmoType.struct_size' */
};
 
typedef struct wmGizmoProperty {
  const struct 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;
} wmGizmoProperty;
 
typedef struct wmGizmoPropertyType {
  struct wmGizmoPropertyType *next, *prev;
  int data_type;
  int array_length;
 
  /* index within 'wmGizmoType' */
  int index_in_type;
 
  char idname[0];
} wmGizmoPropertyType;
 
typedef struct wmGizmoWrapper {
  struct wmGizmo *gizmo;
} wmGizmoWrapper;
 
struct wmGizmoMapType_Params {
  short spaceid;
  short regionid;
};
 
typedef 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;
 
  struct StructRNA *srna;
 
  ExtensionRNA rna_ext;
 
  ListBase target_property_defs;
  int target_property_defs_len;
 
} wmGizmoType;
 
/* -------------------------------------------------------------------- */
/* wmGizmoGroup */
 
typedef struct wmGizmoGroupTypeRef {
  struct wmGizmoGroupTypeRef *next, *prev;
  struct wmGizmoGroupType *type;
} wmGizmoGroupTypeRef;
 
/* factory class for a gizmo-group type, gets called every time a new area is spawned */
typedef struct wmGizmoGroupType {
  const char *idname; /* MAX_NAME */
  const char *name;
  char owner_id[64]; /* MAX_NAME */
 
  wmGizmoGroupFnPoll poll;
  wmGizmoGroupFnInit setup;
  wmGizmoGroupFnRefresh refresh;
  wmGizmoGroupFnDrawPrepare draw_prepare;
  wmGizmoGroupFnInvokePrepare invoke_prepare;
 
  wmGizmoGroupFnSetupKeymap setup_keymap;
 
  wmGizmoGroupFnMsgBusSubscribe message_subscribe;
 
  struct wmKeyMap *keymap;
  struct wmKeyConfig *keyconf;
 
  /* Note: currently gizmo-group instances don't store properties,
   * they're kept in the tool properties. */
 
  struct StructRNA *srna;
 
  ExtensionRNA rna_ext;
 
  eWM_GizmoFlagGroupTypeFlag flag;
 
  eWM_GizmoFlagMapTypeUpdateFlag type_update_flag;
 
  struct wmGizmoMapType_Params gzmap_params;
 
  int users;
 
} wmGizmoGroupType;
 
typedef struct wmGizmoGroup {
  struct wmGizmoGroup *next, *prev;
 
  struct wmGizmoGroupType *type;
  ListBase gizmos;
 
  struct wmGizmoMap *parent_gzmap;
 
  void *py_instance;
  struct ReportList *reports;
 
  union {
    struct {
      uint delay_refresh_for_tweak : 1;
    };
    uint any;
  } hide;
 
  bool tag_remove;
 
  bool use_fallback_keymap;
 
  void *customdata;
  void (*customdata_free)(void *);
  eWM_GizmoFlagGroupInitFlag init_flag;
} wmGizmoGroup;
 
/* -------------------------------------------------------------------- */
/* wmGizmoMap */
 
typedef enum eWM_GizmoFlagMapDrawStep {
  WM_GIZMOMAP_DRAWSTEP_2D = 0,
  WM_GIZMOMAP_DRAWSTEP_3D,
} eWM_GizmoFlagMapDrawStep;
#define WM_GIZMOMAP_DRAWSTEP_MAX 2
 
#ifdef __cplusplus
}
#endif