UI: Add eyedropper button to camera focus distance #121486

Falk David · 2024-05-06T15:42:56+02:00

Falk David commented

2024-05-06 15:42:56 +02:00

Blender already had the ability to sample the depth with an eyedropper and fill the focus distance
(see "ui.eyedropper_depth"). But this feature is fairly hidden. You have to hover over the focal_distance property in the camera data panel and then press E.

This patch adds a prop_data_path property to the ui.eyedropper_depth operator to
allow specifying the property that should be filled with the depth value.

The idea for this is taken from wm.radial_control, which also uses this approach to write to a property.

This allows us to add the eyedropper as a button:

TODO:

Fix the poll function of ui.eyedropper_depth. This poll function was very specific and I noticed that without it, e.g. pressing E in the console editor no longer works.

Blender already had the ability to sample the depth with an eyedropper and fill the focus distance (see `"ui.eyedropper_depth"`). But this feature is fairly hidden. You have to hover over the `focal_distance` property in the camera data panel and then press `E`. This patch adds a `prop_data_path` property to the `ui.eyedropper_depth` operator to allow specifying the property that should be filled with the depth value. The idea for this is taken from `wm.radial_control`, which also uses this approach to write to a property. This allows us to add the eyedropper as a button: ![image](/attachments/1149a1a7-427f-4312-9822-61e0f99a4036) TODO: - [x] Fix the `poll` function of `ui.eyedropper_depth`. This poll function was very specific and I noticed that without it, e.g. pressing `E` in the console editor no longer works.

image.png

23 KiB

❤️ 12

Falk David added 1 commit 2024-05-06 15:43:07 +02:00

UI: Add eyedropper button to camera focus distance ceb06decd2

Falk David added this to the User Interface project 2024-05-06 15:43:12 +02:00

Falk David added 1 commit 2024-05-06 17:28:05 +02:00

Fix missing free of DepthDropper struct a5fd16e5fd

Falk David changed title from ~~WIP: UI: Add eyedropper button to camera focus distance~~ to UI: Add eyedropper button to camera focus distance

2024-05-07 16:53:58 +02:00

Falk David added 2 commits 2024-05-07 16:53:59 +02:00

Merge branch 'main' into eyedropper-focus-distance 293f7ca6a4

Fix operator consuming events

buildbot/vexp-code-patch-linux-x86_64 Build done.

Details

buildbot/vexp-code-patch-lint Build done.

Details

buildbot/vexp-code-patch-darwin-x86_64 Build done.

Details

buildbot/vexp-code-patch-windows-amd64 Build done.

Details

buildbot/vexp-code-patch-darwin-arm64 Build done.

Details

buildbot/vexp-code-patch-coordinator Build done.

Details

3ae218025a

Falk David requested review from Harley Acheson 2024-05-07 16:56:33 +02:00

Falk David commented

2024-05-07 16:56:43 +02:00

@blender-bot build

Falk David added 1 commit 2024-05-07 17:12:19 +02:00

Formatting 67d9ec9fb2

Harley Acheson commented

2024-05-08 20:11:55 +02:00

You could leave the poll in by adding a coarse test for this situation. You can't get very specific so you'd still need your new (awesome) tests in depthdropper_init, but there might be some utility is having the poll for enabling/disabling buttons.

static bool depthdropper_poll(bContext *C)
{
  PointerRNA ptr;
  PropertyRNA *prop;
  int index_dummy;
  uiBut *but;

  /* check if there's an active button taking depth value */
  if ((CTX_wm_window(C) != nullptr) &&
      (but = UI_context_active_but_prop_get(C, &ptr, &prop, &index_dummy)))
  {
    if (but->icon == ICON_EYEDROPPER) {
      return true;
    }
    if ((but->type == UI_BTYPE_NUM) && (prop != nullptr) &&
        (RNA_property_type(prop) == PROP_FLOAT) &&
        (RNA_property_subtype(prop) & PROP_UNIT_LENGTH) &&
        (RNA_property_array_check(prop) == false))
    {
      return true;
    }
  }
  else {
    RegionView3D *rv3d = CTX_wm_region_view3d(C);
    if (rv3d && rv3d->persp == RV3D_CAMOB) {
      View3D *v3d = CTX_wm_view3d(C);
      if (v3d->camera && v3d->camera->data &&
          BKE_id_is_editable(CTX_data_main(C), static_cast<const ID *>(v3d->camera->data)))
      {
        return true;
      }
    }
  }

  return false;
}

You could leave the poll in by adding a coarse test for this situation. You can't get very specific so you'd still need your new (awesome) tests in depthdropper_init, but there might be some utility is having the poll for enabling/disabling buttons. ```Cpp static bool depthdropper_poll(bContext *C) { PointerRNA ptr; PropertyRNA *prop; int index_dummy; uiBut *but; /* check if there's an active button taking depth value */ if ((CTX_wm_window(C) != nullptr) && (but = UI_context_active_but_prop_get(C, &ptr, &prop, &index_dummy))) { if (but->icon == ICON_EYEDROPPER) { return true; } if ((but->type == UI_BTYPE_NUM) && (prop != nullptr) && (RNA_property_type(prop) == PROP_FLOAT) && (RNA_property_subtype(prop) & PROP_UNIT_LENGTH) && (RNA_property_array_check(prop) == false)) { return true; } } else { RegionView3D *rv3d = CTX_wm_region_view3d(C); if (rv3d && rv3d->persp == RV3D_CAMOB) { View3D *v3d = CTX_wm_view3d(C); if (v3d->camera && v3d->camera->data && BKE_id_is_editable(CTX_data_main(C), static_cast<const ID *>(v3d->camera->data))) { return true; } } } return false; } ```

Falk David commented

2024-05-09 18:52:52 +02:00

@Harley But the poll function will always be false for a button next to the focus distance since 1) we're not hovering over a float value (which we are not if we're pressing the eyedropper button), and 2) because the properties editor doesn't have a 3D viewport.

Harley Acheson commented

2024-05-10 05:36:36 +02:00

@Harley But the poll function will always be false for a button next to the focus distance since 1) we're not hovering over a float value (which we are not if we're pressing the eyedropper button), and 2) because the properties editor doesn't have a 3D viewport.

I swear that I tested the poll function above and it worked correctly with focus distance. If it has a window and an icon of ICON_EYEDROPPER it will return true. That is a little broad but then it still has to go through your improved tests in depthdropper_init.

> @Harley But the poll function will always be false for a button next to the focus distance since 1) we're not hovering over a float value (which we are not if we're pressing the eyedropper button), and 2) because the properties editor doesn't have a 3D viewport. I swear that I tested the poll function above and it worked correctly with focus distance. If it has a window and an icon of ICON_EYEDROPPER it will return true. That is a little broad but then it still has to go through your improved tests in depthdropper_init.

Falk David commented

2024-05-10 08:21:59 +02:00

@Harley Oh! I missed the icon case. This whole poll function just seems incredible hackish 😅 But if others are fine with it, I guess it's ok.

Harley Acheson commented

2024-05-10 17:44:26 +02:00

This whole poll function just seems incredible hackish 😅

Yes, it definitely seems hacky and my change certainly wouldn't help it. I only offered that in case you wanted it.

My own gut feeling is we should do it as you propose here and remove that poll.

> This whole poll function just seems incredible hackish 😅 Yes, it definitely seems hacky and my change certainly wouldn't help it. I only offered that in case you wanted it. My own gut feeling is we should do it as you propose here and remove that poll.

Harley Acheson requested changes 2024-05-10 17:47:27 +02:00

Dismissed

source/blender/editors/interface/eyedroppers/eyedropper_depth.cc

						
				@ -73,1 +77,4 @@

				                                 const char *prop_path,

				                                 PointerRNA *r_ptr,

				                                 PropertyRNA **r_prop)

				{

Harley Acheson commented

2024-05-10 17:37:49 +02:00

This function could return bool?

filedescriptor marked this conversation as resolved

source/blender/editors/interface/eyedroppers/eyedropper_depth.cc

						
				@ -74,0 +84,4 @@

				    if (r_prop) {

				      *r_prop = nullptr;

				    }

				    return 1;

Harley Acheson commented

2024-05-10 17:39:05 +02:00

I'm unsure why this state is returning true. It looks like it would cause problems later if this happened.

Falk David commented

2024-05-10 18:28:06 +02:00

It does catch it later, but you're right, we can just return false here.

filedescriptor marked this conversation as resolved

Falk David added 3 commits 2024-05-10 18:30:10 +02:00

Add back poll function 5b5520b54c

Return bool from depthdropper_get_path b06c123693

Merge branch 'main' into eyedropper-focus-distance

buildbot/vexp-code-patch-lint Build done.

Details

buildbot/vexp-code-patch-linux-x86_64 Build done.

Details

buildbot/vexp-code-patch-darwin-x86_64 Build done.

Details

buildbot/vexp-code-patch-darwin-arm64 Build done.

Details

buildbot/vexp-code-patch-windows-amd64 Build done.

Details

buildbot/vexp-code-patch-coordinator Build done.

Details

19eb39ee14

Falk David requested review from Harley Acheson 2024-05-10 18:30:22 +02:00

Harley Acheson approved these changes 2024-05-10 19:36:04 +02:00

Harley Acheson left a comment

This is awesome. Our ancestors will be singing your praises for generations...

😆 1

Falk David commented

2024-05-13 10:32:23 +02:00

@blender-bot build

❤️ 1

Falk David referenced this issue from a commit

2024-05-13 11:02:09 +02:00

UI: Add eyedropper button to camera focus distance

Falk David merged commit 7f8d4df410 into main

2024-05-13 11:02:10 +02:00

Falk David deleted branch eyedropper-focus-distance

2024-05-13 11:02:12 +02:00

Falk David commented

2024-05-13 11:05:25 +02:00

Also added this to the release notes in https://developer.blender.org/docs/release_notes/4.2/user_interface/

Dvorakir referenced this pull request

2024-05-30 15:09:48 +02:00

DOF pick in context menu grayed out #122491

Jonathan Lampel referenced this pull request

2024-07-17 23:11:31 +02:00

DOF Distance picker not shown if using Cycles #124934

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

UI: Add eyedropper button to camera focus distance #121486