#include "stage/timeline/body-canvas-widget.hpp"

Description

Presentation of the timeline workspace by custom drawing on a canvas.

This widget allows for uniform access and handling of that body area; however, in fact we need several TimelineCanvas spaces, since part of the display needs to stay "pinned" on top (the overview rulers), while the majority of the track body area is packaged into a scrolling pane.

Interface

We have to distinguish two kinds of drawing access to this BodyCanvasWidget:

painting of areas for background, profile and for overlays
relative attachment of widgets onto this canvas For the former, we use the TrackProfile as a drawing Visitor (double dispatch): The layout code identifies a sequence of spaces (horizontally extended) corresponding to tracks and rulers. This is abstracted into the profile, and can then be (re)rendered as often as necessary by "playback" of this profile. On the other hand, for attachment of sub-widgets onto the canvas (Clips, Effects, Markers) we use the Interface model::CanvasHook, which allows us to break down the access hierarchically. Each sub-Track can be outfitted with its own "virtual canvas", exposed as delegating CanvasHook.

Definition at line 130 of file body-canvas-widget.hpp.

Public Types
using	ProfileGetter = std::function< TrackProfile &()>
	a way to get and possibly (re)compute the current TrackProfile

Public Member Functions
	BodyCanvasWidget (DisplayManager &)

	~BodyCanvasWidget ()

void	installForkRoot (TrackBody &rootTrackBody)
	The Lumiera Timeline model does not rely on a list of tracks, as most conventional video editing software does – rather, each sequence holds a fork of nested scopes.

void	forceRedraw ()

void	disable ()

auto	get_vadjustment ()

auto	get_hadjustment ()

Public Member Functions inherited from CanvasHook< Gtk::Widget >
virtual	~CanvasHook ()
	this is an interface

virtual CanvasHook< Gtk::Widget > &	getAnchorHook () noexcept
	Anchor point to build chains of related View Hooks.

Pos	hookedAt (int x, int y)

Pos	hookedAt (Time start, int downshift=0)
	build the "construction hook" for a CanvasHooked element, which is to be attached to some timeline canvas view.

Public Member Functions inherited from LayoutElement
virtual	~LayoutElement ()
	this is an interface

Protected Member Functions
void	hook (Gtk::Widget &, int xPos=0, int yPos=0) override

void	move (Gtk::Widget &, int xPos, int yPos) override

void	remove (Gtk::Widget &) override

model::DisplayMetric &	getMetric () const override
	access the component to handle layout metric

void	establishLayout (DisplayEvaluation &) override
	respond to the DisplayEvaluation pass.

void	completeLayout (DisplayEvaluation &) override

Private Member Functions
TimelineCanvas &	getCanvas (int yPos)

void	slotStructureChange () noexcept
	force rebuilding of theTrackProfile whenever the global timeline structure changes

void	maybeRebuildLayout ()
	Possibly (re)build the allocation and distribution of layout space.

void	adjustCanvasSize (int canvasWidth, int totalHeight, int rulerHeight)
	After the (recent) display evaluation pass has negotiated the required space for the currently presented content, this function adjusts the actual Gtk::Layout canvas extension to match.

Private Attributes
DisplayManager &	layout_

TrackProfile	profile_

TrackBody *	rootBody_

Gtk::ScrolledWindow	contentArea_

Gtk::ScrolledWindow	rulerArea_

TimelineCanvas	rulerCanvas_

TimelineCanvas	mainCanvas_

ProfileGetter	getProfile

Constructor & Destructor Documentation

◆ BodyCanvasWidget()

BodyCanvasWidget ( DisplayManager & displayManager )

Definition at line 444 of file body-canvas-widget.cpp.

References BodyCanvasWidget::adjustCanvasSize(), stage::CLASS_timeline, stage::CLASS_timeline_body, BodyCanvasWidget::contentArea_, BodyCanvasWidget::getProfile, BodyCanvasWidget::layout_, BodyCanvasWidget::mainCanvas_, BodyCanvasWidget::maybeRebuildLayout(), BodyCanvasWidget::profile_, BodyCanvasWidget::rulerArea_, BodyCanvasWidget::rulerCanvas_, DisplayManager::signalStructureChange_, and BodyCanvasWidget::slotStructureChange().

Here is the call graph for this function:

◆ ~BodyCanvasWidget()

~BodyCanvasWidget ( )

Definition at line 441 of file body-canvas-widget.cpp.

Member Typedef Documentation

◆ ProfileGetter

using ProfileGetter = std::function<TrackProfile&()>

a way to get and possibly (re)compute the current TrackProfile

Definition at line 158 of file body-canvas-widget.hpp.

Member Function Documentation

◆ installForkRoot()

void installForkRoot ( TrackBody & rootTrackBody )

The Lumiera Timeline model does not rely on a list of tracks, as most conventional video editing software does – rather, each sequence holds a fork of nested scopes.

Initially install the contents corresponding to the root track fork

This recursively nested structure is parallelled in the way we organise and draw the timeline representation onto the TimelineCanvas: we use an intermediary entity, the TrackBody as an organisational grouping device, even while we draw all of the timeline representation onto a single global mainCanvas_ within the (scrollable) contentArea_. Thus, adding the first TrackBody to represent the root track of a Timeline, will also prepare the grounding for any other nested entities to be drawn on top.

Definition at line 500 of file body-canvas-widget.cpp.

References BodyCanvasWidget::rootBody_.

Referenced by TimelineLayout::hook(), and TimelineLayout::installRootTrack().

Here is the caller graph for this function:

◆ forceRedraw()

void forceRedraw ( )

Definition at line 569 of file body-canvas-widget.cpp.

References BodyCanvasWidget::mainCanvas_, and BodyCanvasWidget::rulerCanvas_.

◆ disable()

void disable ( )

Definition at line 506 of file body-canvas-widget.cpp.

References TrackProfile::clear(), BodyCanvasWidget::profile_, and BodyCanvasWidget::rootBody_.

Referenced by TimelineLayout::remove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_vadjustment()

auto get_vadjustment ( )

inline

allow the header pane to follow our vertical scrolling movement

Definition at line 154 of file body-canvas-widget.hpp.

References BodyCanvasWidget::contentArea_.

◆ get_hadjustment()

auto get_hadjustment ( )

inline

Definition at line 155 of file body-canvas-widget.hpp.

References BodyCanvasWidget::contentArea_.

Referenced by TimelineLayout::TimelineLayout(), and TimelineLayout::establishLayout().

Here is the caller graph for this function:

◆ hook()

void hook	(	Gtk::Widget &	widget,
		int	xPos = `0`,
		int	yPos = `0`
	)

overrideprotectedvirtual

Implements CanvasHook< Gtk::Widget >.

Definition at line 585 of file body-canvas-widget.cpp.

References BodyCanvasWidget::getCanvas().

Here is the call graph for this function:

◆ move()

void move	(	Gtk::Widget &	widget,
		int	xPos,
		int	yPos
	)

overrideprotectedvirtual

Implements CanvasHook< Gtk::Widget >.

Definition at line 599 of file body-canvas-widget.cpp.

References BodyCanvasWidget::getCanvas().

Here is the call graph for this function:

◆ remove()

void remove ( Gtk::Widget & widget )

overrideprotectedvirtual

Implements CanvasHook< Gtk::Widget >.

Definition at line 592 of file body-canvas-widget.cpp.

References BodyCanvasWidget::getCanvas().

Here is the call graph for this function:

◆ getMetric()

model::DisplayMetric & getMetric ( ) const

overrideprotectedvirtual

access the component to handle layout metric

Implements CanvasHook< Gtk::Widget >.

Definition at line 606 of file body-canvas-widget.cpp.

References BodyCanvasWidget::layout_.

◆ establishLayout()

void establishLayout ( DisplayEvaluation & )

overrideprotectedvirtual

respond to the DisplayEvaluation pass.

Remarks: assuming that each track has already established it own vertical space requirement, thereby placing the established vertical extension into TrackBody::contentHeight_

Todo:: 2/2020 WIP

TODO: anything to publish into the DisplayEvaluation ??

Implements LayoutElement.

Definition at line 617 of file body-canvas-widget.cpp.

References BodyCanvasWidget::adjustCanvasSize(), TrackBody::calcRulerHeight(), PixSpan::delta(), TrackBody::establishTrackSpace(), DisplayManager::getPixSpan(), BodyCanvasWidget::layout_, BodyCanvasWidget::profile_, and BodyCanvasWidget::rootBody_.

Here is the call graph for this function:

◆ completeLayout()

void completeLayout ( DisplayEvaluation & )

overrideprotectedvirtual

Implements LayoutElement.

Definition at line 628 of file body-canvas-widget.cpp.

◆ getCanvas()

TimelineCanvas & getCanvas ( int yPos )

private

Definition at line 576 of file body-canvas-widget.cpp.

References BodyCanvasWidget::mainCanvas_.

Referenced by BodyCanvasWidget::hook(), BodyCanvasWidget::move(), and BodyCanvasWidget::remove().

Here is the caller graph for this function:

◆ slotStructureChange()

void slotStructureChange ( )

privatenoexcept

force rebuilding of theTrackProfile whenever the global timeline structure changes

Definition at line 515 of file body-canvas-widget.cpp.

References TrackProfile::clear(), and BodyCanvasWidget::profile_.

Referenced by BodyCanvasWidget::BodyCanvasWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maybeRebuildLayout()

void maybeRebuildLayout ( )

private

Possibly (re)build the allocation and distribution of layout space.

Check the internal trigger flag and recalculate the extension of relevant parts.

Remarks: this function will be called on demand right before actual drawing.

Definition at line 527 of file body-canvas-widget.cpp.

References BodyCanvasWidget::layout_, BodyCanvasWidget::profile_, BodyCanvasWidget::rootBody_, and DisplayManager::triggerDisplayEvaluation().

Referenced by BodyCanvasWidget::BodyCanvasWidget().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ adjustCanvasSize()

void adjustCanvasSize	(	int	canvasWidth,
		int	contentHeight,
		int	rulerHeight
	)

private

After the (recent) display evaluation pass has negotiated the required space for the currently presented content, this function adjusts the actual Gtk::Layout canvas extension to match.

Note that we use two Gtk::Layout controls, one to show the overview rules always visible at the top, while the second one is placed into a scrollable pane to accommodate an arbitrary number of tracks.

Definition at line 547 of file body-canvas-widget.cpp.

References BodyCanvasWidget::mainCanvas_, and BodyCanvasWidget::rulerCanvas_.

Referenced by BodyCanvasWidget::BodyCanvasWidget(), and BodyCanvasWidget::establishLayout().

Here is the caller graph for this function: