Refactor yscale of bAnimContext #104500

Christoph Lendenfeld · 2023-02-09T10:32:51+01:00

2023-02-09 10:32:51 +01:00

bAnimContext had a float property called yscale_fac that was used to define the height of the keyframe channels.

However the property was never set, only read so there really is no need to have it in the struct.

Moreover it complicated getting the channel height because bAnimContext had to be passed in.

Speaking of getting the channel height. This was done with macros. I ripped them all out and replaced them with function calls.

Originally it was introduced in this patch: https://developer.blender.org/rB095c8dbe6919857ea322b213a1e240161cd7c843

`bAnimContext` had a float property called `yscale_fac` that was used to define the height of the keyframe channels. However the property was never set, only read so there really is no need to have it in the struct. Moreover it complicated getting the channel height because `bAnimContext` had to be passed in. Speaking of getting the channel height. This was done with macros. I ripped them all out and replaced them with function calls. Originally it was introduced in this patch: https://developer.blender.org/rB095c8dbe6919857ea322b213a1e240161cd7c843

Christoph Lendenfeld added the

Module

Animation & Rigging

label 2023-02-09 10:32:51 +01:00

Sybren A. Stüvel was assigned by Christoph Lendenfeld

2023-02-09 10:32:52 +01:00

Christoph Lendenfeld added 3 commits 2023-02-09 10:32:54 +01:00

f3cb017049 remove macros

2db1575c77 refactor

78f8c2abbe Merge branch 'main' into refactor_channel_yscale

Christoph Lendenfeld added this to the Animation & Rigging project 2023-02-09 10:33:40 +01:00

Christoph Lendenfeld added 1 commit 2023-02-09 10:56:54 +01:00

8b809e7977 implement sybrens changes

Christoph Lendenfeld added 1 commit 2023-02-09 11:04:26 +01:00

7a59a4670b rename new functions withg ANIM_UI prefix

Christoph Lendenfeld added 1 commit 2023-02-09 11:05:09 +01:00

6a6520d41c Merge branch 'main' into refactor_channel_yscale

Christoph Lendenfeld changed title from ~~WIP: Refactor yscale of bAnimContext~~ to Refactor yscale of bAnimContext

2023-02-09 11:31:38 +01:00

Christoph Lendenfeld self-assigned this 2023-02-09 11:32:18 +01:00

Christoph Lendenfeld requested review from Sybren A. Stüvel 2023-02-09 11:32:33 +01:00

Sybren A. Stüvel was unassigned by Christoph Lendenfeld

2023-02-09 11:32:45 +01:00

Christoph Lendenfeld removed their assignment 2023-02-09 11:32:45 +01:00

Sybren A. Stüvel reviewed 2023-02-09 11:39:09 +01:00

source/blender/editors/animation/anim_channels_defines.c

						
				@ -4376,0 +4376,4 @@

				float ANIM_UI_get_keyframe_scale_factor(void)

				{

				  bTheme *btheme = UI_GetTheme();

				  float yscale_fac = btheme->space_action.keyframe_scale_fac;

Sybren A. Stüvel commented

2023-02-09 11:39:09 +01:00

can be const

can be `const`

ChrisLend marked this conversation as resolved

Sybren A. Stüvel requested changes 2023-02-09 12:26:16 +01:00

Sybren A. Stüvel left a comment

Nice improvements!

source/blender/editors/include/ED_anim_api.h

						
				@ -615,0 +598,4 @@

				float ANIM_UI_get_channel_skip(void);

				float ANIM_UI_get_first_channel_top(View2D *v2d);

				float ANIM_UI_get_channel_step(void);

				float ANIM_UI_get_channels_total_height(View2D *v2d, const int item_count);

Sybren A. Stüvel commented

2023-02-09 11:49:42 +01:00

Here remove const, it has no meaning in a function declaration for pass-by-value types.

Here remove `const`, it has no meaning in a function declaration for pass-by-value types.

ChrisLend marked this conversation as resolved

source/blender/editors/space_action/action_draw.c

						
				@ -74,2 +75,2 @@

				    for (ale = anim_data.first; ale; ale = ale->next, ymax -= ACHANNEL_STEP(ac), channel_index++) {

				      float ymin = ymax - ACHANNEL_HEIGHT(ac);

				    for (ale = anim_data.first; ale; ale = ale->next, ymax -= channel_step, channel_index++) {

				      float ymin = ymax - ANIM_UI_get_channel_height();

Sybren A. Stüvel commented

2023-02-09 11:50:31 +01:00

const float -- it doesn't change value within its scope, so it can be const even when it's different on every loop iteration. Same with some others below.

`const float` -- it doesn't change value within its scope, so it can be `const` even when it's different on every loop iteration. Same with some others below.

ChrisLend marked this conversation as resolved

Christoph Lendenfeld added 1 commit 2023-02-09 12:37:23 +01:00

35923b22e0 add const to variables

Christoph Lendenfeld requested review from Sybren A. Stüvel 2023-02-09 12:38:52 +01:00

Sybren A. Stüvel approved these changes 2023-02-09 13:08:21 +01:00

Sybren A. Stüvel left a comment

LGTM!

Christoph Lendenfeld added 1 commit 2023-02-09 14:22:05 +01:00

5c0f4a02d9 Merge branch 'main' into refactor_channel_yscale

Christoph Lendenfeld merged commit 666c2ea012 into main

2023-02-09 14:28:06 +01:00

Christoph Lendenfeld referenced this issue from a commit