Files
test2/scripts/startup/bl_ui/space_time.py
Falk David 1122a05cb6 VSE: Scene Selector & Scene Time Synchronization
Implements the proposed design (with some modifications) in #135058.

## Sequencer Scene

This adds a new property called `sequencer_scene` to workspaces. This scene is used
by the video sequence editors in the current workspace for their context.
This is a first step towards "detaching" the VSE from the active scene in the window.

Each sequencer timeline editor shows the sequencer scene that is being used.
By default, when no sequencer scene is selected, the timeline and preview are empty.

Pressing the "new" button will add a new scene and assign it to the sequencer
scene for the current workspace.

## Contextual Playback

Pressing `Space` (by default) for starting the animation playback is now contextual:
depending on the context (where your mouse cursor is), the scene that is played back
might be different. E.g. with a 3D Viewport and a Sequencer open, pressing "play"
in the 3D Viewport will play the _active scene_ of the window, while pressing "play"
in the sequencer will play the _sequencer scene_.

## Time & Scene Synchronization

Additionally, this adds a toggle called "Sync Active Scene".
With the property turned on, the active scene & scene time in the window will be
synced with the time & scene of the current scene strip in the sequencer.

Note that this is _not_ bi-directional. The sequencer can change the active scene
and map time, but it's not possible the other way around since it one can have
multiple strips using the same scene (+camera, and even time!).

Currently this setting is exposed in the footer of the sequencer timeline as well
as in the workspace settings.

This allows for one of the core concepts that the story tools projects aims at: Working
in a scene (e.g. in the 3D viewport) while also working with the edit
(in the sequencer timeline).

## Some technical notes

* Undoing while playback is running will now cancel playback. This is to avoid the timer,
   that points to the scene and viewlayer that are playing, to get de-synced after loading
   the memfile undo step.
* When the sequencer scene is not the same as the active scene, we ensure it has
   a depsgraph.
* Normally, when a `NC_SCENE` notifier points to a specific scene, the notifier is dropped
   if that scene doesn't match the active one in the window. We now also check that it
   doesn't match the sequencer scene in the active workspace.
* When loading older files, we need to make sure that the active workspace in a window
   uses the active scene as the sequencer scene. This is to make sure that the file opens with
   the same sequences open.
* Tool settings are stored per scene. To make sure the sequencer uses the tool settings for
   the sequencer scene, the "context.tool_settings" and `CTX_data_tool_settings` members
   are overridden in the sequence editors.

Pull Request: https://projects.blender.org/blender/blender/pulls/140271
2025-08-25 11:58:17 +02:00

315 lines
10 KiB
Python

# SPDX-FileCopyrightText: 2009-2023 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later
import bpy
from bpy.types import Menu, Panel
from bpy.app.translations import contexts as i18n_contexts
def playback_controls(layout, context):
st = context.space_data
is_sequencer = st.type == 'SEQUENCE_EDITOR' and st.view_type == 'SEQUENCER'
scene = context.scene if not is_sequencer else context.sequencer_scene
tool_settings = context.tool_settings
screen = context.screen
row = layout.row(align=True)
row.popover(
panel="TIME_PT_playback",
text="Playback",
)
row.popover(
panel="TIME_PT_keyframing_settings",
text="Keying",
text_ctxt=i18n_contexts.id_windowmanager,
)
if is_sequencer:
layout.prop(context.workspace, "use_scene_time_sync", text="Sync Scene Time")
layout.separator_spacer()
if tool_settings:
row = layout.row(align=True)
row.prop(tool_settings, "use_keyframe_insert_auto", text="", toggle=True)
sub = row.row(align=True)
sub.active = tool_settings.use_keyframe_insert_auto
sub.popover(
panel="TIME_PT_auto_keyframing",
text="",
)
row = layout.row(align=True)
row.operator("screen.frame_jump", text="", icon='REW').end = False
row.operator("screen.keyframe_jump", text="", icon='PREV_KEYFRAME').next = False
if not screen.is_animation_playing:
# if using JACK and A/V sync:
# hide the play-reversed button
# since JACK transport doesn't support reversed playback
if scene and scene.sync_mode == 'AUDIO_SYNC' and context.preferences.system.audio_device == 'JACK':
row.scale_x = 2
row.operator("screen.animation_play", text="", icon='PLAY')
row.scale_x = 1
else:
row.operator("screen.animation_play", text="", icon='PLAY_REVERSE').reverse = True
row.operator("screen.animation_play", text="", icon='PLAY')
else:
row.scale_x = 2
row.operator("screen.animation_play", text="", icon='PAUSE')
row.scale_x = 1
row.operator("screen.keyframe_jump", text="", icon='NEXT_KEYFRAME').next = True
row.operator("screen.frame_jump", text="", icon='FF').end = True
layout.separator_spacer()
if scene:
row = layout.row()
if scene.show_subframe:
row.scale_x = 1.15
row.prop(scene, "frame_float", text="")
else:
row.scale_x = 0.95
row.prop(scene, "frame_current", text="")
row = layout.row(align=True)
row.prop(scene, "use_preview_range", text="", toggle=True)
sub = row.row(align=True)
sub.scale_x = 0.8
if not scene.use_preview_range:
sub.prop(scene, "frame_start", text="Start")
sub.prop(scene, "frame_end", text="End")
else:
sub.prop(scene, "frame_preview_start", text="Start")
sub.prop(scene, "frame_preview_end", text="End")
class TIME_MT_editor_menus(Menu):
bl_idname = "TIME_MT_editor_menus"
bl_label = ""
def draw(self, context):
layout = self.layout
horizontal = (layout.direction == 'VERTICAL')
st = context.space_data
if horizontal:
row = layout.row()
sub = row.row(align=True)
else:
sub = layout
sub.menu("TIME_MT_view")
if st.show_markers:
sub.menu("TIME_MT_marker")
class TIME_MT_marker(Menu):
bl_label = "Marker"
def draw(self, context):
layout = self.layout
marker_menu_generic(layout, context)
class TIME_MT_view(Menu):
bl_label = "View"
def draw(self, context):
layout = self.layout
scene = context.scene
st = context.space_data
layout.prop(st, "show_region_hud")
layout.prop(st, "show_region_channels")
layout.separator()
# NOTE: "action" now, since timeline is in the dopesheet editor, instead of as own editor
layout.operator("action.view_all")
if context.scene.use_preview_range:
layout.operator("anim.scene_range_frame", text="Frame Preview Range")
else:
layout.operator("anim.scene_range_frame", text="Frame Scene Range")
layout.operator("action.view_frame")
layout.separator()
layout.prop(st, "show_markers")
layout.prop(st, "show_seconds")
layout.prop(st, "show_locked_time")
layout.separator()
layout.prop(scene, "show_keys_from_selected_only")
layout.prop(st.dopesheet, "show_only_errors")
layout.separator()
layout.menu("DOPESHEET_MT_cache")
layout.separator()
layout.menu("INFO_MT_area")
def marker_menu_generic(layout, context):
# layout.operator_context = 'EXEC_REGION_WIN'
layout.column()
tool_settings = context.tool_settings
layout.prop(tool_settings, "lock_markers")
layout.separator()
layout.operator("screen.marker_jump", text="Jump to Previous Marker").next = False
layout.operator("screen.marker_jump", text="Jump to Next Marker").next = True
layout.separator()
layout.operator("marker.camera_bind")
layout.separator()
layout.menu("NLA_MT_marker_select")
layout.separator()
layout.operator("marker.move", text="Move Marker")
props = layout.operator("wm.call_panel", text="Rename Marker")
props.name = "TOPBAR_PT_name_marker"
props.keep_open = False
layout.separator()
layout.operator("marker.delete", text="Delete Marker")
if len(bpy.data.scenes) > 10:
layout.operator_context = 'INVOKE_DEFAULT'
layout.operator("marker.make_links_scene", text="Duplicate Marker to Scene...", icon='OUTLINER_OB_EMPTY')
else:
layout.operator_menu_enum("marker.make_links_scene", "scene", text="Duplicate Marker to Scene")
layout.operator("marker.duplicate", text="Duplicate Marker")
layout.operator("marker.add", text="Add Marker")
###################################
class TimelinePanelButtons:
bl_space_type = 'DOPESHEET_EDITOR'
bl_region_type = 'UI'
class TIME_PT_playback(TimelinePanelButtons, Panel):
bl_label = "Playback"
bl_region_type = 'HEADER'
bl_ui_units_x = 13
def draw(self, context):
layout = self.layout
layout.use_property_split = True
layout.use_property_decorate = False
screen = context.screen
st = context.space_data
is_sequencer = st.type == 'SEQUENCE_EDITOR' and st.view_type == 'SEQUENCER'
scene = context.scene if not is_sequencer else context.sequencer_scene
layout.prop(scene, "sync_mode", text="Sync")
col = layout.column(heading="Audio")
col.prop(scene, "use_audio_scrub", text="Scrubbing")
col.prop(scene, "use_audio")
col = layout.column(heading="Playback")
col.prop(scene, "lock_frame_selection_to_range", text="Limit to Frame Range")
col.prop(screen, "use_follow", text="Follow Current Frame")
col = layout.column(heading="Play In")
col.prop(screen, "use_play_top_left_3d_editor", text="Active Editor")
col.prop(screen, "use_play_3d_editors", text="3D Viewport")
col.prop(screen, "use_play_animation_editors", text="Animation Editors")
col.prop(screen, "use_play_image_editors", text="Image Editor")
col.prop(screen, "use_play_properties_editors", text="Properties and Sidebars")
col.prop(screen, "use_play_clip_editors", text="Movie Clip Editor")
col.prop(screen, "use_play_node_editors", text="Node Editors")
col.prop(screen, "use_play_sequence_editors", text="Video Sequencer")
col.prop(screen, "use_play_spreadsheet_editors", text="Spreadsheet")
col = layout.column(heading="Show")
col.prop(scene, "show_subframe", text="Subframes")
layout.separator()
row = layout.row(align=True)
row.operator("anim.start_frame_set")
row.operator("anim.end_frame_set")
class TIME_PT_keyframing_settings(TimelinePanelButtons, Panel):
bl_label = "Keyframing Settings"
bl_options = {'HIDE_HEADER'}
bl_region_type = 'HEADER'
def draw(self, context):
layout = self.layout
st = context.space_data
is_sequencer = st.type == 'SEQUENCE_EDITOR' and st.view_type == 'SEQUENCER'
scene = context.scene if not is_sequencer else context.sequencer_scene
tool_settings = context.tool_settings
col = layout.column(align=True)
col.label(text="Active Keying Set")
row = col.row(align=True)
row.prop_search(scene.keying_sets_all, "active", scene, "keying_sets_all", text="")
row.operator("anim.keyframe_insert", text="", icon='KEY_HLT')
row.operator("anim.keyframe_delete", text="", icon='KEY_DEHLT')
col = layout.column(align=True)
col.label(text="New Keyframe Type")
col.prop(tool_settings, "keyframe_type", text="")
layout.prop(tool_settings, "use_keyframe_cycle_aware")
class TIME_PT_auto_keyframing(TimelinePanelButtons, Panel):
bl_label = "Auto Keyframing"
bl_options = {'HIDE_HEADER'}
bl_region_type = 'HEADER'
bl_ui_units_x = 9
def draw(self, context):
layout = self.layout
tool_settings = context.tool_settings
prefs = context.preferences
layout.active = tool_settings.use_keyframe_insert_auto
layout.prop(tool_settings, "auto_keying_mode", expand=True)
col = layout.column(align=True)
col.prop(tool_settings, "use_keyframe_insert_keyingset", text="Only Active Keying Set", toggle=False)
if not prefs.edit.use_keyframe_insert_available:
col.prop(tool_settings, "use_record_with_nla", text="Layered Recording")
###################################
classes = (
TIME_MT_editor_menus,
TIME_MT_marker,
TIME_MT_view,
TIME_PT_playback,
TIME_PT_keyframing_settings,
TIME_PT_auto_keyframing,
)
if __name__ == "__main__": # only for live edit.
from bpy.utils import register_class
for cls in classes:
register_class(cls)