Anim: update descriptions for slot-related properties #127185

Sybren A. Stüvel · 2024-09-05T12:57:24+02:00

Sybren A. Stüvel commented

2024-09-05 12:57:24 +02:00

Two commits, which are supposed to land as such:

~~Add description to~~ Remove RNA property Action.last_slot_handle
Add comment to explain why we need AnimData.action_slot_handle.

Based on Nathan's comment #124399 (comment)

Two commits, which are supposed to land as such: - ~~Add description to~~ Remove RNA property `Action.last_slot_handle` - Add comment to explain why we need `AnimData.action_slot_handle`. Based on Nathan's comment https://projects.blender.org/blender/blender/issues/124399#issuecomment-1238426

❤️ 1

Sybren A. Stüvel added the

Module

Animation & Rigging

label 2024-09-05 12:57:24 +02:00

Sybren A. Stüvel requested review from Nathan Vegdahl 2024-09-05 13:00:49 +02:00

Sybren A. Stüvel commented

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

@blender-bot build

Sybren A. Stüvel commented

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

Looking at things again, I think we could just remove the RNA property for Action.last_slot_handle. There's no Python code that uses it at the moment anyway.

Looking at things again, I think we could just remove the RNA property for `Action.last_slot_handle`. There's no Python code that uses it at the moment anyway.

Nathan Vegdahl reviewed 2024-09-06 10:27:47 +02:00

source/blender/makesrna/intern/rna_action.cc Outdated

						
				@ -2477,0 +2477,4 @@

				  RNA_def_property_ui_text(

				      prop,

				      "Last-Used Slot Handle",

				      "Each slot of an Action gets a different handle, and this is the last handle that was used "

Nathan Vegdahl commented

2024-09-06 10:27:47 +02:00

Ooooh, that makes sense now. Thanks for the description.

I think the reason I was confused is because I didn't expect this to be exposed. It seems very internal to me—the specifics of how slot handles are doled out is an implementation detail, IMO.

As you mentioned in your comment, I think we can just remove last_slot_handle from the Python API entirely. If someone needs it later for some reason, we can always expose it then. But honestly, I really doubt that's ever going to happen.

Ooooh, that makes sense now. Thanks for the description. I think the reason I was confused is because I didn't expect this to be exposed. It seems very internal to me—the specifics of how slot handles are doled out is an implementation detail, IMO. As you mentioned in your comment, I think we can just remove `last_slot_handle` from the Python API entirely. If someone needs it later for some reason, we can always expose it then. But honestly, I really doubt that's ever going to happen.

Nathan Vegdahl approved these changes 2024-09-06 10:29:35 +02:00

Nathan Vegdahl left a comment

Happy to land this as-is for now, with the caveat that I would like us to remove last_slot_handle from RNA before Baklava makes its way into an official release. (But if you want to remove it now while landing, that's also great.)

Happy to land this as-is for now, with the caveat that I would like us to remove `last_slot_handle` from RNA before Baklava makes its way into an official release. (But if you want to remove it now while landing, that's also great.)

👍 1

Sybren A. Stüvel force-pushed anim/add-adt-prop-descriptions-comments from 0ff2143086 to aa54de445d

2024-09-06 11:13:47 +02:00

Compare

Sybren A. Stüvel referenced this issue from a commit

2024-09-06 11:13:47 +02:00

Anim: remove RNA property `Action.last_slot_handle`

Sybren A. Stüvel merged commit fbfe407201 into main

2024-09-06 11:15:12 +02:00

Sybren A. Stüvel referenced this issue from a commit

2024-09-06 11:15:12 +02:00

Cleanup: Anim, add comment to explain `AnimData.action_slot_handle`