Core: Add sub-types for float-type custom properties #106700

Colin Basnett · 2023-04-08T01:29:57+02:00

Colin Basnett commented

2023-04-08 01:29:57 +02:00

This adds the ability for users to assign sub-types to Float type custom properties (e.g., distance, angle, time, power etc.)

This adds the ability for users to assign sub-types to `Float` type custom properties (e.g., distance, angle, time, power etc.) ![image](/attachments/9d25a030-17c6-44b0-9478-73e7d337e641) ![image](/attachments/cb3145ef-0690-4a7f-8497-e833d5823fe7)

image.png

27 KiB

image.png

17 KiB

👍 4 🎉 2

Colin Basnett added 1 commit 2023-04-08 01:30:08 +02:00

4a5d150156 Add sub-types for float-type custom properties

Colin Basnett changed title from ~~WIP: Add sub-types for float-type custom properties~~ to Add sub-types for float-type custom properties

2023-04-08 01:30:36 +02:00

Colin Basnett self-assigned this 2023-04-08 01:31:12 +02:00

Colin Basnett changed title from ~~Add sub-types for float-type custom properties~~ to Core: Add sub-types for float-type custom properties

2023-04-08 02:02:15 +02:00

Colin Basnett added the

Module

Core

label 2023-04-08 02:02:33 +02:00

Colin Basnett requested review from Sybren A. Stüvel 2023-04-11 11:18:04 +02:00

Colin Basnett requested review from Campbell Barton 2023-04-11 11:18:18 +02:00

Campbell Barton requested changes 2023-04-13 09:22:26 +02:00

Campbell Barton left a comment

Initial review, I didn't check on the changes to _init_subtype in detail.

Initial review, I didn't check on the changes to `_init_subtype` in detail.

scripts/startup/bl_operators/wm.py Outdated

						
				@ -1357,3 +1357,3 @@

				)

				# Most useful entries of rna_enum_property_subtype_items for number arrays:

				rna_number_subtype_items = (

Campbell Barton commented

2023-04-13 09:14:09 +02:00

The reference to rna_enum_property_subtype_items was removed, this seems like it would be useful to keep, otherwise there is no hint that this is duplicating information defined elsewhere.

A reference to the enum the newly added list is copied from would be good here too.

The reference to `rna_enum_property_subtype_items` was removed, this seems like it would be useful to keep, otherwise there is no hint that this is duplicating information defined elsewhere. A reference to the enum the newly added list is copied from would be good here too.

Colin Basnett commented

2023-04-19 23:06:05 +02:00

I have restored the comment.

scripts/startup/bl_operators/wm.py Outdated

						
				@ -1366,6 +1375,21 @@ rna_vector_subtype_items = (

				)

				def subtype_items_cb(self, context):

Campbell Barton commented

2023-04-13 09:19:37 +02:00

This adds top-level functions without to wm.py which are isolated to WM_OT_properties_edit, prefer static methods on WM_OT_properties_edit to make it clear they're spesific to that operator.

This adds top-level functions without to `wm.py` which are isolated to `WM_OT_properties_edit`, prefer static methods on `WM_OT_properties_edit` to make it clear they're spesific to that operator.

Colin Basnett commented

2023-04-19 23:05:49 +02:00

I've moved them both into the WM_OT_properties_edit namespace.

Campbell Barton requested review from Hans Goudey 2023-04-13 09:23:02 +02:00

Colin Basnett added 1 commit 2023-04-14 11:08:40 +02:00

d998573c99 Restored comment and moved callback functions into class scope

Colin Basnett requested review from Campbell Barton 2023-04-14 11:09:17 +02:00

Colin Basnett added 1 commit 2023-04-15 07:01:00 +02:00

1e04c5e23d Merge branch 'main' into cmbasnett/custom-property-float-subtypes

Hans Goudey approved these changes 2023-04-18 22:44:29 +02:00

Hans Goudey left a comment

This works pretty nicely in my testing. Campbell should probably have another look at it though.

scripts/startup/bl_operators/wm.py Outdated

						
				@ -1372,6 +1382,19 @@ class WM_OT_properties_edit(Operator):

				    bl_label = "Edit Property"

				    # register only because invoke_props_popup requires.

				    bl_options = {'REGISTER', 'INTERNAL'}

Hans Goudey commented

2023-04-18 22:37:27 +02:00

Trailing whitespace here

cmbasnett marked this conversation as resolved

scripts/startup/bl_operators/wm.py Outdated

						
				@ -1375,0 +1385,4 @@

				    def subtype_items_cb(self, context):

				        subtype_items = [

				            ('NONE', "Plain Data", "Data values without special behavior")

Hans Goudey commented

2023-04-18 22:43:09 +02:00

It seems a bit simpler to duplicate NONE between the vector subtypes and the float subtypes. What do you think about that? Totally fine if you disagree, not a strong opinion at all.

It seems a bit simpler to duplicate `NONE` between the vector subtypes and the float subtypes. What do you think about that? Totally fine if you disagree, not a strong opinion at all.

Colin Basnett commented

2023-04-19 06:05:01 +02:00

I'd prefer to not have to duplicate the string literal and just have a single-source-of-truth for the NONE entry.

I'd prefer to not have to duplicate the string literal and just have a single-source-of-truth for the `NONE` entry.

Campbell Barton commented

2023-04-26 11:31:18 +02:00

Agree duplicating NONE is simpler but that can be done using a variable:

rna_generic_subtype_none_item = ('NONE', "Plain Data", "Data values without special behavior")

rna_number_subtype_items = (
    rna_generic_subtype_none_item,
    ('PIXEL', "Pixel", ""),
    ... snip ...
)

rna_vector_subtype_items = (
    rna_generic_subtype_none_item,
    ('COLOR', "Linear Color", "Color in the linear space"),
    ... snip ...
)

Agree duplicating NONE is simpler but that can be done using a variable: ``` rna_generic_subtype_none_item = ('NONE', "Plain Data", "Data values without special behavior") rna_number_subtype_items = ( rna_generic_subtype_none_item, ('PIXEL', "Pixel", ""), ... snip ... ) rna_vector_subtype_items = ( rna_generic_subtype_none_item, ('COLOR', "Linear Color", "Color in the linear space"), ... snip ... ) ```

Colin Basnett added 2 commits 2023-04-19 07:04:46 +02:00

beec7a0ee9 Removed trailing whitespace

9425e158f8 Merge branch 'cmbasnett/custom-property-float-subtypes' of https://projects.blender.org/blender/blender into cmbasnett/custom-property-float-subtypes

Sybren A. Stüvel commented

2023-04-20 10:59:35 +02:00

The proposal looks good to me. As for the code, I'll step down as reviewer as I trust Hans and Campbell to already do a good job.

Sybren A. Stüvel refused to review 2023-04-20 10:59:40 +02:00

Sybren A. Stüvel added the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Core: Add sub-types for float-type custom properties #106700