[Bf-blender-cvs] [c2fb0bacb87] blender2.8: Gizmo: code comments
Campbell Barton
noreply at git.blender.org
Thu Sep 13 05:29:59 CEST 2018
Commit: c2fb0bacb87e327821daac6d1bce82660e8ef2d9
Author: Campbell Barton
Date: Thu Sep 13 13:35:26 2018 +1000
Branches: blender2.8
https://developer.blender.org/rBc2fb0bacb87e327821daac6d1bce82660e8ef2d9
Gizmo: code comments
Note about limits of new tool-init flag.
===================================================================
M source/blender/windowmanager/gizmo/WM_gizmo_types.h
M source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c
===================================================================
diff --git a/source/blender/windowmanager/gizmo/WM_gizmo_types.h b/source/blender/windowmanager/gizmo/WM_gizmo_types.h
index 2ab536752c3..386b4379339 100644
--- a/source/blender/windowmanager/gizmo/WM_gizmo_types.h
+++ b/source/blender/windowmanager/gizmo/WM_gizmo_types.h
@@ -93,20 +93,29 @@ typedef enum eWM_GizmoFlagFlag {
* Flags that influence the behavior of all gizmos in the group.
*/
typedef enum eWM_GizmoFlagGroupTypeFlag {
- /* Mark gizmo-group as being 3D */
+ /** Mark gizmo-group as being 3D */
WM_GIZMOGROUPTYPE_3D = (1 << 0),
- /* Scale gizmos as 3D object that respects zoom (otherwise zoom independent draw size).
+ /** Scale gizmos as 3D object that respects zoom (otherwise zoom independent draw size).
* note: currently only for 3D views, 2D support needs adding. */
WM_GIZMOGROUPTYPE_SCALE = (1 << 1),
- /* Gizmos can be depth culled with scene objects (covered by other geometry - TODO) */
+ /** Gizmos can be depth culled with scene objects (covered by other geometry - TODO) */
WM_GIZMOGROUPTYPE_DEPTH_3D = (1 << 2),
- /* Gizmos can be selected */
+ /** Gizmos can be selected */
WM_GIZMOGROUPTYPE_SELECT = (1 << 3),
- /* The gizmo group is to be kept (not removed on loading a new file for eg). */
+ /** The gizmo group is to be kept (not removed on loading a new file for eg). */
WM_GIZMOGROUPTYPE_PERSISTENT = (1 << 4),
- /* Show all other gizmos when interacting. */
+ /** Show all other gizmos when interacting. */
WM_GIZMOGROUPTYPE_DRAW_MODAL_ALL = (1 << 5),
- /* When used with tool, only run when activating the tool. */
+ /**
+ * When used with tool, only run when activating the tool,
+ * instead of linking the gizmo while the tool is active.
+ *
+ * \warning this option has some limitations, we might even re-implement this differently.
+ * Currently it's quite minimal so we can see how it works out.
+ * The main issue is controlling how a gizmo is activated with a tool
+ * when a tool can activate multiple operators based on the key-map.
+ * We could even move the options into the key-map item.
+ * ~ campbell */
WM_GIZMOGROUPTYPE_TOOL_INIT = (1 << 6),
} eWM_GizmoFlagGroupTypeFlag;
diff --git a/source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c b/source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c
index 583130a0099..0883a1726bd 100644
--- a/source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c
+++ b/source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c
@@ -569,7 +569,7 @@ static wmGizmo *gizmo_find_intersected_3d(
int select_id = 0;
for (LinkData *link = visible_gizmos->first; link; link = link->next, select_id++) {
wmGizmo *gz = link->data;
- /* With both defined, favor the 3D, incase the manipulator can be used in 2D or 3D views. */
+ /* With both defined, favor the 3D, incase the gizmo can be used in 2D or 3D views. */
if (gz->type->test_select && (gz->type->draw_select == NULL)) {
if ((*r_part = gz->type->test_select(C, gz, co)) != -1) {
hit = select_id;
More information about the Bf-blender-cvs
mailing list