Fix #107030: return accurate action frame ranges from the Python API #112709

Merged
Nathan Vegdahl merged 6 commits from nathanvegdahl/blender:fix_107030_action_frame_range into main 2023-09-26 18:19:04 +02:00
Member

This changes the action.frame_range Python API to return an accurate
frame range for actions. Specifically, it was previously special-cased
to return a range with length 1 whenever the length was actually 0. This
led to a bizarre situation where a real frame range of [0.0, 0.2] would
return that range as-is, but a real frame range of [0.0, 0.0] would
instead return a range of [0.0, 1.0].

The new behavior simply always returns the real frame range.

The reason for the previous behavior was obscure: the relevant code was
also used internally in Blender's NLA system, and returning a zero-length
range could result in NLA strips getting infinite scale. The code is now
separated out appropriately so that the NLA system still gets the
non-zero-length range, while the Python API for actions returns the real
range.

This changes the `action.frame_range` Python API to return an accurate frame range for actions. Specifically, it was previously special-cased to return a range with length 1 whenever the length was actually 0. This led to a bizarre situation where a real frame range of `[0.0, 0.2]` would return that range as-is, but a real frame range of `[0.0, 0.0]` would instead return a range of `[0.0, 1.0]`. The new behavior simply always returns the real frame range. The reason for the previous behavior was obscure: the relevant code was also used internally in Blender's NLA system, and returning a zero-length range could result in NLA strips getting infinite scale. The code is now separated out appropriately so that the NLA system still gets the non-zero-length range, while the Python API for actions returns the real range.
Nathan Vegdahl added 1 commit 2023-09-22 10:44:20 +02:00
Nathan Vegdahl added 1 commit 2023-09-26 14:21:15 +02:00
Nathan Vegdahl added 1 commit 2023-09-26 15:51:50 +02:00
Nathan Vegdahl added 1 commit 2023-09-26 16:14:16 +02:00
Nathan Vegdahl changed title from WIP: Fix #107030: compute accurate frame ranges for actions to Fix #107030: compute accurate frame ranges for actions 2023-09-26 16:22:21 +02:00
Nathan Vegdahl changed title from Fix #107030: compute accurate frame ranges for actions to Fix #107030: return accurate action frame ranges from the Python API 2023-09-26 16:36:33 +02:00
Sybren A. Stüvel requested changes 2023-09-26 16:44:27 +02:00
Sybren A. Stüvel left a comment
Member

This feels a lot saner than the old whack-a-mole.

This might also be a good time to add a unit test for at least the BKE_action_frame_range_calc(), BKE_nla_clip_length_get_nonzero(), and BKE_nla_clip_length_ensure_nonzero() functions. Shouldn't be too much work, and it'll protect us a bit from future accidental alterations.

This feels a lot saner than the old whack-a-mole. This might also be a good time to add a unit test for at least the `BKE_action_frame_range_calc()`, `BKE_nla_clip_length_get_nonzero()`, and `BKE_nla_clip_length_ensure_nonzero()` functions. Shouldn't be too much work, and it'll protect us a bit from future accidental alterations.
@ -449,0 +451,4 @@
if (strip->actend <= strip->actstart) {
return 1.0f;
}
else {

Code style: no else after return.

Code style: no `else` after `return`.
nathanvegdahl marked this conversation as resolved
Nathan Vegdahl added 1 commit 2023-09-26 17:01:13 +02:00
Nathan Vegdahl added 1 commit 2023-09-26 18:04:52 +02:00
Sybren A. Stüvel approved these changes 2023-09-26 18:17:18 +02:00
Sybren A. Stüvel left a comment
Member

Looking good!

Looking good!
Nathan Vegdahl merged commit 49eab72141 into main 2023-09-26 18:19:04 +02:00
Nathan Vegdahl deleted branch fix_107030_action_frame_range 2023-09-26 18:19:08 +02:00
Sign in to join this conversation.
No reviewers
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#112709
No description provided.