This commit takes the 'Slotted Actions' out of the experimental phase. As a result: - All newly created Actions will be slotted Actions. - Legacy Actions loaded from disk will be versioned to slotted Actions. - The new Python API for slots, layers, strips, and channel bags is available. - The legacy Python API for accessing F-Curves and Action Groups is still available, and will operate on the F-Curves/Groups for the first slot only. - Creating an Action by keying (via the UI, operators, or the `rna_struct.keyframe_insert` function) will try and share Actions between related data-blocks. See !126655 for more info about this. - Assigning an Action to a data-block will auto-assign a suitable Action Slot. The logic for this is described below. However, There are cases where this does _not_ automatically assign a slot, and thus the Action will effectively _not_ animate the data-block. Effort has been spent to make Action selection work both reliably for Blender users as well as keep the behaviour the same for Python scripts. Where these two goals did not converge, reliability and understandability for users was prioritised. Auto-selection of the Action Slot upon assigning the Action works as follows. The first rule to find a slot wins. 1. The data-block remembers the slot name that was last assigned. If the newly assigned Action has a slot with that name, it is chosen. 2. If the Action has a slot with the same name as the data-block, it is chosen. 3. If the Action has only one slot, and it has never been assigned to anything, it is chosen. 4. If the Action is assigned to an NLA strip or an Action constraint, and the Action has a single slot, and that slot has a suitable ID type, it is chosen. This last step is what I was referring to with "Where these two goals did not converge, reliability and understandability for users was prioritised." For regular Action assignments (like via the Action selectors in the Properties editor) this rule doesn't apply, even though with legacy Actions the final state ("it is animated by this Action") differs from the final state with slotted Actions ("it has no slot so is not animated"). This is done to support the following workflow: - Create an Action by animating Cube. - In order to animate Suzanne with that same Action, assign the Action to Suzanne. - Start keying Suzanne. This auto-creates and auto-assigns a new slot for Suzanne. If rule 4. above would apply in this case, the 2nd step would automatically select the Cube slot for Suzanne as well, which would immediately overwrite Suzanne's properties with the Cube animation. Technically, this commit: - removes the `WITH_ANIM_BAKLAVA` build flag, - removes the `use_animation_baklava` experimental flag in preferences, - updates the code to properly deal with the fact that empty Actions are now always considered slotted/layered Actions (instead of that relying on the user preference). Note that 'slotted Actions' and 'layered Actions' are the exact same thing, just focusing on different aspects (slot & layers) of the new data model. The "Baklava phase 1" assumptions are still asserted. This means that: - an Action can have zero or one layer, - that layer can have zero or one strip, - that strip must be of type 'keyframe' and be infinite with zero offset. The code to handle legacy Actions is NOT removed in this commit. It will be removed later. For now it's likely better to keep it around as reference to the old behaviour in order to aid in some inevitable bugfixing. Ref: #120406
152 lines
4.8 KiB
Python
152 lines
4.8 KiB
Python
# SPDX-FileCopyrightText: 2009-2023 Blender Authors
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
from bpy.types import Header, Panel
|
|
from rna_prop_ui import PropertyPanel
|
|
|
|
|
|
class PROPERTIES_HT_header(Header):
|
|
bl_space_type = 'PROPERTIES'
|
|
|
|
def draw(self, context):
|
|
layout = self.layout
|
|
view = context.space_data
|
|
region = context.region
|
|
ui_scale = context.preferences.system.ui_scale
|
|
|
|
layout.template_header()
|
|
|
|
layout.separator_spacer()
|
|
|
|
# The following is an ugly attempt to make the search button center-align better visually.
|
|
# A dummy icon is inserted that has to be scaled as the available width changes.
|
|
content_size_est = 160 * ui_scale
|
|
layout_scale = min(1, max(0, (region.width / content_size_est) - 1))
|
|
if layout_scale > 0:
|
|
row = layout.row()
|
|
row.scale_x = layout_scale
|
|
row.label(icon='BLANK1')
|
|
|
|
layout.prop(view, "search_filter", icon='VIEWZOOM', text="")
|
|
|
|
layout.separator_spacer()
|
|
|
|
layout.popover(panel="PROPERTIES_PT_options", text="")
|
|
|
|
|
|
class PROPERTIES_PT_navigation_bar(Panel):
|
|
bl_space_type = 'PROPERTIES'
|
|
bl_region_type = 'NAVIGATION_BAR'
|
|
bl_label = "Navigation Bar"
|
|
bl_options = {'HIDE_HEADER'}
|
|
|
|
def draw(self, context):
|
|
layout = self.layout
|
|
|
|
view = context.space_data
|
|
|
|
layout.scale_x = 1.4
|
|
layout.scale_y = 1.4
|
|
if view.search_filter:
|
|
layout.prop_tabs_enum(
|
|
view, "context", data_highlight=view,
|
|
property_highlight="tab_search_results", icon_only=True,
|
|
)
|
|
else:
|
|
layout.prop_tabs_enum(view, "context", icon_only=True)
|
|
|
|
|
|
class PROPERTIES_PT_options(Panel):
|
|
"""Show options for the properties editor"""
|
|
bl_space_type = 'PROPERTIES'
|
|
bl_region_type = 'HEADER'
|
|
bl_label = "Options"
|
|
|
|
def draw(self, context):
|
|
layout = self.layout
|
|
|
|
space = context.space_data
|
|
|
|
col = layout.column()
|
|
col.label(text="Sync with Outliner")
|
|
col.row().prop(space, "outliner_sync", expand=True)
|
|
|
|
|
|
class PropertiesAnimationMixin:
|
|
"""Mix-in class for Animation panels.
|
|
|
|
This class can be used to show a generic 'Animation' panel for IDs shown in
|
|
the properties editor. Specific ID types need specific subclasses.
|
|
|
|
For an example, see DATA_PT_camera_animation in properties_data_camera.py
|
|
"""
|
|
bl_space_type = 'PROPERTIES'
|
|
bl_region_type = 'WINDOW'
|
|
bl_context = "data"
|
|
bl_label = "Animation"
|
|
bl_options = {'DEFAULT_CLOSED'}
|
|
bl_order = PropertyPanel.bl_order - 1 # Order just above the Custom Properties.
|
|
|
|
_animated_id_context_property = ""
|
|
"""context.{_animatable_id_context_property} is used to find the animated ID."""
|
|
|
|
@classmethod
|
|
def _animated_id(cls, context):
|
|
assert cls._animated_id_context_property, "set _animated_id_context_property on {!r}".format(cls)
|
|
|
|
# If the pinned ID is of a different type, there could still be a an ID
|
|
# for which to show this panel. For example, a camera object can be
|
|
# pinned, and then this panel can be shown for its camera data.
|
|
return getattr(context, cls._animated_id_context_property, None)
|
|
|
|
@classmethod
|
|
def poll(cls, context):
|
|
animated_id = cls._animated_id(context)
|
|
return animated_id is not None
|
|
|
|
def draw(self, context):
|
|
layout = self.layout
|
|
|
|
col = layout.column(align=True)
|
|
col.use_property_split = True
|
|
col.use_property_decorate = False
|
|
self.draw_action_and_slot_selector(context, col, self._animated_id(context))
|
|
|
|
@classmethod
|
|
def draw_action_and_slot_selector(cls, context, layout, animated_id):
|
|
if not animated_id:
|
|
class_list = [c.__name__ for c in cls.mro()]
|
|
print("PropertiesAnimationMixin: no animatable data-block, this is a bug "
|
|
"in one of these classes: {!r}".format(class_list))
|
|
layout.label(text='No animatable data-block, please report as bug', icon='ERROR')
|
|
return
|
|
|
|
layout.template_action(animated_id, new="action.new", unlink="action.unlink")
|
|
|
|
adt = animated_id.animation_data
|
|
if not adt or not adt.action:
|
|
return
|
|
|
|
# Only show the slot selector when a layered Action is assigned.
|
|
if adt.action.is_action_layered:
|
|
layout.context_pointer_set("animated_id", animated_id)
|
|
layout.template_search(
|
|
adt, "action_slot",
|
|
adt, "action_slots",
|
|
new="anim.slot_new_for_id",
|
|
unlink="anim.slot_unassign_from_id",
|
|
)
|
|
|
|
|
|
classes = (
|
|
PROPERTIES_HT_header,
|
|
PROPERTIES_PT_navigation_bar,
|
|
PROPERTIES_PT_options,
|
|
)
|
|
|
|
if __name__ == "__main__": # only for live edit.
|
|
from bpy.utils import register_class
|
|
for cls in classes:
|
|
register_class(cls)
|