Blender V5.3
ED_gizmo_library.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
12
13#pragma once
14
15#include "DNA_scene_types.h"
16
17namespace blender {
18
19struct bContext;
20struct wmGizmo;
21struct wmGizmoGroup;
22namespace ed::transform {
24}
25
26/* initialize gizmos */
38
39/* -------------------------------------------------------------------- */
40/* Shape Presets
41 *
42 * Intended to be called by custom draw functions.
43 */
44
45/* `gizmo_library_presets.cc` */
46
47void ED_gizmo_draw_preset_box(const wmGizmo *gz, const float mat[4][4], int select_id);
48void ED_gizmo_draw_preset_arrow(const wmGizmo *gz, const float mat[4][4], int axis, int select_id);
50 const float mat[4][4],
51 int axis,
52 int select_id);
53
54/* -------------------------------------------------------------------- */
55/* 2D Button Gizmo */
56
57/* `button2d_gizmo.cc` */
58
60
61/* -------------------------------------------------------------------- */
62/* 3D Arrow Gizmo */
63
64enum {
70};
71
72/* transform */
73enum {
78};
79
80/* draw_options */
81enum {
82 /* Show arrow stem. */
85};
86
92void ED_gizmo_arrow3d_set_ui_range(wmGizmo *gz, float min, float max);
98void ED_gizmo_arrow3d_set_range_fac(wmGizmo *gz, float range_fac);
99
103void ED_gizmo_arrow3d_reset_offset(wmGizmo *gz);
104
105/* -------------------------------------------------------------------- */
106/* Cage Gizmo */
107
108enum {
109 ED_GIZMO_CAGE_XFORM_FLAG_TRANSLATE = (1 << 0), /* Translates */
110 ED_GIZMO_CAGE_XFORM_FLAG_ROTATE = (1 << 1), /* Rotates */
111 ED_GIZMO_CAGE_XFORM_FLAG_SCALE = (1 << 2), /* Scales */
112 ED_GIZMO_CAGE_XFORM_FLAG_SCALE_UNIFORM = (1 << 3), /* Scales uniformly */
113 ED_GIZMO_CAGE_XFORM_FLAG_SCALE_SIGNED = (1 << 4), /* Negative scale allowed */
114};
115
116/* draw_style */
117enum {
127};
128
129enum {
131 /* TODO: rename */
133};
134
135/* draw_options */
136enum {
142};
143
145enum {
147
149 /* Edges */
154 /* Corners */
159
161};
162
164enum {
165 /* ordered min/mid/max so we can loop over values (MIN/MID/MAX) on each axis. */
193
195
197};
198
199/* -------------------------------------------------------------------- */
200/* Dial Gizmo */
201
202/* draw_options */
203enum {
210 /* Always show the angle value as an arc in the dial. */
212};
213
214/* -------------------------------------------------------------------- */
215/* Move Gizmo */
216
217/* draw_options */
218enum {
220 /* only for solid shapes */
224};
225
226enum {
229};
230
231/* -------------------------------------------------------------------- */
232/* Button Gizmo */
233
234enum {
242};
243
244/* -------------------------------------------------------------------- */
245/* Primitive Gizmo */
246
247enum {
251};
252
253/* -------------------------------------------------------------------- */
254/* Specific gizmos utils */
255
256/* `snap3d_gizmo.cc` */
257
258ed::transform::SnapObjectContext *ED_gizmotypes_snap_3d_context_ensure(Scene *scene, wmGizmo *gz);
259
260void ED_gizmotypes_snap_3d_flag_set(wmGizmo *gz, int flag);
261
262bool ED_gizmotypes_snap_3d_is_enabled(const wmGizmo *gz);
263
264void ED_gizmotypes_snap_3d_data_get(const bContext *C,
265 wmGizmo *gz,
266 float r_loc[3],
267 float r_nor[3],
268 int r_elem_index[3],
269 eSnapMode *r_snap_elem);
270
271} // namespace blender
#define C
Definition RandGen.cpp:29
btScalar max
Definition scene.h:133
BMesh Iterators.
void ED_gizmo_draw_preset_circle(const wmGizmo *gz, const float mat[4][4], int axis, int select_id)
void ED_gizmotypes_arrow_3d()
void ED_gizmo_arrow3d_set_range_fac(wmGizmo *gz, const float range_fac)
void ED_gizmotypes_move_3d()
void ED_gizmotypes_snap_3d_data_get(const bContext *C, wmGizmo *gz, float r_loc[3], float r_nor[3], int r_elem_index[3], eSnapMode *r_snap_elem)
void ED_gizmotypes_cage_3d()
void ED_gizmo_arrow3d_reset_offset(wmGizmo *gz)
void ED_gizmotypes_snap_3d_flag_set(wmGizmo *gz, int flag)
void ED_gizmotypes_cage_2d()
bool ED_gizmotypes_snap_3d_is_enabled(const wmGizmo *)
@ ED_GIZMO_ARROW_DRAW_FLAG_ORIGIN
@ ED_GIZMO_ARROW_DRAW_FLAG_STEM
void ED_gizmo_draw_preset_box(const wmGizmo *gz, const float mat[4][4], int select_id)
@ ED_GIZMO_CAGE_XFORM_FLAG_SCALE
@ ED_GIZMO_CAGE_XFORM_FLAG_TRANSLATE
@ ED_GIZMO_CAGE_XFORM_FLAG_SCALE_SIGNED
@ ED_GIZMO_CAGE_XFORM_FLAG_ROTATE
@ ED_GIZMO_CAGE_XFORM_FLAG_SCALE_UNIFORM
void ED_gizmotypes_button_2d()
@ ED_GIZMO_CAGE2D_STYLE_CIRCLE
@ ED_GIZMO_CAGE2D_STYLE_BOX_TRANSFORM
@ ED_GIZMO_CAGE2D_STYLE_BOX
void ED_gizmotypes_facemap_3d()
@ ED_GIZMO_PRIMITIVE_STYLE_ANNULUS
@ ED_GIZMO_PRIMITIVE_STYLE_PLANE
@ ED_GIZMO_PRIMITIVE_STYLE_CIRCLE
@ ED_GIZMO_CAGE3D_PART_SCALE_MID_X_MIN_Y_MID_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MAX_X_MIN_Y_MAX_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MID_X_MAX_Y_MAX_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MID_X_MID_Y_MAX_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MIN_X_MAX_Y_MID_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MAX_X_MID_Y_MIN_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MIN_X_MIN_Y_MID_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MID_X_MIN_Y_MAX_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MIN_X_MID_Y_MAX_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MIN_X_MAX_Y_MAX_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MAX_X_MIN_Y_MID_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MAX_X_MIN_Y_MIN_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MAX_X_MAX_Y_MIN_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MID_X_MID_Y_MIN_Z
@ ED_GIZMO_CAGE3D_PART_TRANSLATE
@ ED_GIZMO_CAGE3D_PART_SCALE_MIN_X_MAX_Y_MIN_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MAX_X_MID_Y_MID_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MAX_X_MID_Y_MAX_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MAX_X_MAX_Y_MID_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MIN_X_MID_Y_MIN_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MIN_X_MIN_Y_MAX_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MID_X_MAX_Y_MIN_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MID_X_MAX_Y_MID_Z
@ ED_GIZMO_CAGE3D_PART_ROTATE
@ ED_GIZMO_CAGE3D_PART_SCALE_MID_X_MID_Y_MID_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MID_X_MIN_Y_MIN_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MAX_X_MAX_Y_MAX_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MIN_X_MIN_Y_MIN_Z
@ ED_GIZMO_CAGE3D_PART_SCALE_MIN_X_MID_Y_MID_Z
ed::transform::SnapObjectContext * ED_gizmotypes_snap_3d_context_ensure(Scene *scene, wmGizmo *)
@ ED_GIZMO_ARROW_XFORM_FLAG_CONSTRAINED
@ ED_GIZMO_ARROW_XFORM_FLAG_INVERTED
void ED_gizmo_button2d_group_background(const bContext *C, wmGizmoGroup *gzgroup)
@ ED_GIZMO_MOVE_DRAW_FLAG_FILL
@ ED_GIZMO_MOVE_DRAW_FLAG_ALIGN_VIEW
@ ED_GIZMO_MOVE_DRAW_FLAG_NOP
@ ED_GIZMO_MOVE_DRAW_FLAG_FILL_SELECT
void ED_gizmo_draw_preset_arrow(const wmGizmo *gz, const float mat[4][4], int axis, int select_id)
@ ED_GIZMO_MOVE_STYLE_CROSS_2D
@ ED_GIZMO_MOVE_STYLE_RING_2D
@ ED_GIZMO_CAGE3D_STYLE_BOX
@ ED_GIZMO_CAGE3D_STYLE_CIRCLE
@ ED_GIZMO_ARROW_STYLE_CONE
@ ED_GIZMO_ARROW_STYLE_NORMAL
@ ED_GIZMO_ARROW_STYLE_CROSS
@ ED_GIZMO_ARROW_STYLE_PLANE
@ ED_GIZMO_ARROW_STYLE_BOX
void ED_gizmotypes_dial_3d()
void ED_gizmotypes_snap_3d()
void ED_gizmo_arrow3d_set_ui_range(wmGizmo *gz, const float min, const float max)
@ ED_GIZMO_CAGE_DRAW_FLAG_XFORM_CENTER_HANDLE
@ ED_GIZMO_CAGE_DRAW_FLAG_CORNER_HANDLES
@ ED_GIZMO_CAGE_DRAW_FLAG_NOP
@ ED_GIZMO_BUTTON_SHOW_BACKDROP
@ ED_GIZMO_BUTTON_SHOW_OUTLINE
@ ED_GIZMO_BUTTON_SHOW_HELPLINE
void ED_gizmotypes_primitive_3d()
void ED_gizmotypes_blank_3d()
@ ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_MIRROR
@ ED_GIZMO_DIAL_DRAW_FLAG_CLIP
@ ED_GIZMO_DIAL_DRAW_FLAG_FILL_SELECT
@ ED_GIZMO_DIAL_DRAW_FLAG_FILL
@ ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_START_Y
@ ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_VALUE
@ ED_GIZMO_DIAL_DRAW_FLAG_NOP
@ ED_GIZMO_CAGE2D_PART_SCALE_MIN_X
@ ED_GIZMO_CAGE2D_PART_SCALE_MAX_X
@ ED_GIZMO_CAGE2D_PART_ROTATE
@ ED_GIZMO_CAGE2D_PART_SCALE_MIN_X_MAX_Y
@ ED_GIZMO_CAGE2D_PART_SCALE_MIN_X_MIN_Y
@ ED_GIZMO_CAGE2D_PART_SCALE_MAX_X_MAX_Y
@ ED_GIZMO_CAGE2D_PART_TRANSLATE
@ ED_GIZMO_CAGE2D_PART_SCALE_MAX_X_MIN_Y
@ ED_GIZMO_CAGE2D_PART_SCALE_MAX_Y
@ ED_GIZMO_CAGE2D_PART_SCALE
@ ED_GIZMO_CAGE2D_PART_SCALE_MIN_Y
#define min(a, b)
Definition sort.cc:38