lumiera_/src/gui/timeline/body-canvas-widget.hpp
Ichthyostega 0b1bc6a579 define and document the building blocks of the new timeline UI
these are just empty class files, but writing a basic description
for each made me flesh out a lot of organisational aspects of what
I am about to build now
2016-12-02 01:53:00 +01:00

88 lines
3.3 KiB
C++

/*
BODY-CANVAS-WIDGET.hpp - custom drawing canvas to display the timeline body
Copyright (C) Lumiera.org
2016, Hermann Vosseler <Ichthyostega@web.de>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/** @file body-canvas-widget.hpp
** Widget to render the body of timeline display, by custom drawing into
** a canvas control. The body part of the timeline display can not be sensibly
** implemented with automatic layout by the UI toolkit set. Rather, we need to
** control a precise temporal display grid, and we need to limit the actual widgets
** added for display, since a given timeline may easily hold several hundred up to
** thousands of elements. To ease such tasks, a _canvas control_ -- here implemented
** on top of Gtk::Layout, allows to combine _custom drawing_ with the placement of
** embedded child widgets, where the latter's layout is again managed automatically
** by the toolkit set. This approach allows us to circumvent some of the perils of
** custom drawing, where we might forfeit several of the benefits of using a toolkit
** unintentionally, and create an UI which feels foreign and brittle in comparison
** to standard software.
**
** # Layout management
**
** To create a consistent layout of the timeline, header pane and body need to react
** to the same scrolling adjustments, and use the same vertical size allocations for
** each embedded track. Such a consistent global layout needs to be built up in a
** *display evaluation pass*, carried out collaboratively between the building blocks
** of the timeline. To this end, the TrackPresenter and ClipPresenter elements act
** as (view) model entities, visited by the timeline::LayoutManager to establish
** coherent display parameters. From within this evaluation pass, the individual
** presenters communicate with their _slave widgets,_ which are inserted into the
** display context of the track header pane or this body widget respectively. As
** a result, some new widgets may be injected, existing widgets may be removed or
** hidden, and other widgets may be relocated to different virtual canvas coordinates.
**
** @todo WIP-WIP-WIP as of 12/2016
**
*/
#ifndef GUI_TIMELINE_BODY_CANVAS_WIDGET_H
#define GUI_TIMELINE_BODY_CANVAS_WIDGET_H
#include "gui/gtk-base.hpp"
//#include "lib/util.hpp"
//#include <memory>
//#include <vector>
namespace gui {
namespace timeline {
/**
* @todo WIP-WIP as of 12/2016
*/
class BodyCanvasWidget
{
public:
BodyCanvasWidget();
~BodyCanvasWidget();
private:/* ===== Internals ===== */
};
}}// namespace gui::timeline
#endif /*GUI_TIMELINE_BODY_CANVAS_WIDGET_H*/