Ichthyostega
9c21164ae6
This changeset fixes a huge pile of problems, as indicated in the error log of the Doxygen run after merging all the recent Doxygen improvements unfortunately, auto-linking does still not work at various places. There is no clear indication what might be the problem. Possibly the rather unstable Sqlite support in this Doxygen version is the cause. Anyway, needs to be investigated further.
314 lines
10 KiB
C++
314 lines
10 KiB
C++
/*
|
|
TIMELINE-WIDGET.hpp - custom widget for timeline display of the project
|
|
|
|
Copyright (C) Lumiera.org
|
|
2008, Joel Holdsworth <joel@airwebreathe.org.uk>
|
|
|
|
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 widget/timeline-widget.hpp
|
|
** This file defines the core component of the Lumiera GUI
|
|
**
|
|
** @deprecated broken since transition to GTK-3
|
|
** @todo needs to be reworked from ground as if 5/2015
|
|
** GTK-3 uses different event handling callbacks,
|
|
** so the existing implementation is defunct.
|
|
** Moreover, this class is designed way to monolithic.
|
|
** It will never be able to scale to the full planned
|
|
** timeline and editing functionality of Lumiera
|
|
** @see gui::timeline::TimelineWidget new timeline display
|
|
*/
|
|
|
|
|
|
#ifndef GUI_WIDGET_TIMELINE_WIDGET_H
|
|
#define GUI_WIDGET_TIMELINE_WIDGET_H
|
|
|
|
#include "gui/widget/timeline/timeline-state.hpp"
|
|
#include "gui/widget/timeline/timeline-header-container.hpp"
|
|
#include "gui/widget/timeline/timeline-body.hpp"
|
|
#include "gui/widget/timeline/timeline-ruler.hpp"
|
|
#include "gui/widget/timeline/timeline-tool.hpp"
|
|
#include "gui/widget/timeline/timeline-arrow-tool.hpp"
|
|
#include "gui/widget/timeline/timeline-ibeam-tool.hpp"
|
|
#include "gui/widget/timeline/timeline-group-track.hpp"
|
|
#include "gui/widget/timeline/timeline-clip-track.hpp"
|
|
#include "gui/widget/timeline/timeline-layout-helper.hpp"
|
|
|
|
#include "gui/model/sequence.hpp"
|
|
|
|
#include "lib/time/timevalue.hpp"
|
|
|
|
#include <memory>
|
|
|
|
|
|
namespace gui {
|
|
namespace widget {
|
|
|
|
using lib::time::Time;
|
|
using std::shared_ptr;
|
|
|
|
/** namespace of timeline widget helper classes.
|
|
* @deprecated as of 11/2016, a complete rework of the timeline display is underway
|
|
* @see (\ref gui::timeline) namespace of the new timeline display
|
|
*/
|
|
namespace timeline {}
|
|
|
|
|
|
/**
|
|
* Core timeline display (custom widget).
|
|
* @remarks This widget is a composite of several widgets contained
|
|
* within the timeline namespace.
|
|
* @deprecated dysfunctional and broken by switch to GTK-3. Needs to be rewritten
|
|
*/
|
|
class TimelineWidget
|
|
: public Gtk::Table
|
|
{
|
|
public:
|
|
/**
|
|
* @param source_state state to be used used as the
|
|
* data source (model) for this timeline widget.
|
|
*/
|
|
TimelineWidget (shared_ptr<timeline::TimelineState> source_state);
|
|
|
|
|
|
virtual ~TimelineWidget();
|
|
|
|
|
|
|
|
public: /* ===== Data Access ===== */
|
|
|
|
/**
|
|
* Gets a pointer to the current state object.
|
|
* @return The state object that the timeline widget is currently
|
|
* working with.
|
|
*/
|
|
shared_ptr<timeline::TimelineState> get_state();
|
|
|
|
/**
|
|
* Replaces the current TimelineState object with another.
|
|
* @param new_state The new state to swap in.
|
|
*/
|
|
void set_state(shared_ptr<timeline::TimelineState> new_state);
|
|
|
|
/**
|
|
* Zooms the view in or out as by a number of steps while keeping a
|
|
* given point on the timeline still.
|
|
* @param zoom_size The number of steps to zoom by. The scale factor
|
|
* is 1.25^(-zoom_size).
|
|
*/
|
|
void zoom_view(double timescale_ratio);
|
|
|
|
/**
|
|
* Gets the type of the tool currently active.
|
|
*/
|
|
timeline::ToolType get_tool() const;
|
|
|
|
/**
|
|
* Sets the type of the tool currently active.
|
|
*/
|
|
void set_tool(timeline::ToolType tool_type);
|
|
|
|
shared_ptr<timeline::Track>
|
|
get_hovering_track() const;
|
|
|
|
public:
|
|
/* ===== Signals ===== */
|
|
using TimelineStateChangeSignal = sigc::signal<void, shared_ptr<timeline::TimelineState>>;
|
|
using HoveringTrackChangedSignal = sigc::signal<void, shared_ptr<timeline::Track>>;
|
|
|
|
sigc::signal<void, lib::time::Time> mouse_hover_signal() const;
|
|
|
|
sigc::signal<void> playback_period_drag_released_signal() const;
|
|
|
|
HoveringTrackChangedSignal hovering_track_changed_signal() const;
|
|
|
|
TimelineStateChangeSignal state_changed_signal() const;
|
|
|
|
/* ===== Events ===== */
|
|
protected:
|
|
|
|
void on_scroll();
|
|
|
|
void on_size_allocate(Gtk::Allocation& allocation);
|
|
|
|
void on_view_window_changed();
|
|
|
|
void on_body_changed();
|
|
|
|
void on_add_track_command();
|
|
|
|
/* ===== Utilities ===== */
|
|
protected:
|
|
|
|
|
|
/* ===== Internals ===== */
|
|
private:
|
|
|
|
// ----- Track Mapping Functions ----- //
|
|
|
|
/**
|
|
* Updates the timeline widget to match the state of the track tree.
|
|
*/
|
|
void update_tracks();
|
|
|
|
void freeze_update_tracks();
|
|
|
|
void thaw_update_tracks();
|
|
|
|
/**
|
|
* Ensures timeline UI tracks have been created for every model track
|
|
* present in sequence.
|
|
*/
|
|
void create_timeline_tracks();
|
|
|
|
/**
|
|
* Iterates through a branch of tracks, recursing into each sub-branch
|
|
* creating UI timeline tracks for each model track if they don't
|
|
* already exist in trackMap.
|
|
* @param list The parent track of the branch.
|
|
*/
|
|
void
|
|
create_timeline_tracks_from_branch (shared_ptr<model::Track> modelTrack);
|
|
|
|
/**
|
|
* Creates a timeline UI track to correspond to a model track.
|
|
* @param modelTrack The model track to create a timeline track from.
|
|
* @return The timeline track created, or an empty shared_ptr if
|
|
* modelTrack has an unreckognised type (this is an error condition).
|
|
*/
|
|
shared_ptr<timeline::Track>
|
|
create_timeline_track_from_modelTrack(shared_ptr<model::Track> modelTrack);
|
|
|
|
/**
|
|
* Removes any UI tracks which no longer have corresponding model
|
|
* tracks present in the sequence.
|
|
*/
|
|
void remove_orphaned_tracks();
|
|
|
|
void
|
|
search_orphaned_tracks_in_branch (shared_ptr<model::Track> modelTrack,
|
|
std::map<shared_ptr<model::Track>,
|
|
shared_ptr<timeline::Track>>& orphan_track_map);
|
|
|
|
/**
|
|
* Looks up a timeline UI track in trackMap that corresponds to a
|
|
* given modelTrack.
|
|
* @param modelTrack The model track to look up.
|
|
* @returns The timeline UI track found, or an empty shared_ptr if
|
|
* modelTrack has no corresponding timeline UI track (this is an
|
|
* error condition).
|
|
*/
|
|
shared_ptr<timeline::Track>
|
|
lookup_timeline_track (shared_ptr<model::Track> modelTrack) const;
|
|
|
|
// ----- Layout Functions ----- //
|
|
|
|
void on_layout_changed();
|
|
|
|
void update_scroll();
|
|
|
|
int get_y_scroll_offset() const;
|
|
|
|
void set_y_scroll_offset(const int offset);
|
|
|
|
// ----- Event Handlers -----//
|
|
|
|
/**
|
|
* An event handler that receives notifications for when the
|
|
* sequence's track tree has been changed.
|
|
*/
|
|
void on_track_list_changed();
|
|
|
|
void on_playback_period_drag_released();
|
|
|
|
bool on_motion_in_body_notify_event(GdkEventMotion *event);
|
|
|
|
// ----- Helper Functions ----- //
|
|
|
|
/**
|
|
* Helper to get the sequence object from the state.
|
|
* @return Returns a shared pointer to the sequence.
|
|
*/
|
|
shared_ptr<model::Sequence> sequence() const;
|
|
|
|
// ----- Other Functions ----- //
|
|
|
|
void
|
|
set_hovering_track (shared_ptr<timeline::Track> hovering_track);
|
|
|
|
protected:
|
|
|
|
/**
|
|
* The state that will be used as the data source for this timeline
|
|
* widget.
|
|
* @deprecated for #955
|
|
*/
|
|
shared_ptr<timeline::TimelineState> state;
|
|
|
|
// Model Data
|
|
|
|
/**
|
|
* The trackMap maps model tracks to timeline widget tracks which are
|
|
* responsible for the UI representation of a track.
|
|
* @remarks The tree structure is maintained by the model, and as the
|
|
* widget is updated with update_tracks, timeline tracks are added and
|
|
* removed from the map in correspondence with the tree.
|
|
* @deprecated for #955
|
|
*/
|
|
std::map<shared_ptr<model::Track>
|
|
,shared_ptr<timeline::Track>>
|
|
trackMap;
|
|
|
|
shared_ptr<timeline::Track> hoveringTrack;
|
|
|
|
// Helper Classes
|
|
timeline::TimelineLayoutHelper layoutHelper;
|
|
|
|
// Child Widgets
|
|
timeline::TimelineHeaderContainer *headerContainer;
|
|
timeline::TimelineBody *body;
|
|
timeline::TimelineRuler *ruler;
|
|
|
|
Glib::RefPtr<Gtk::Adjustment> horizontalAdjustment, verticalAdjustment;
|
|
Gtk::HScrollbar horizontalScroll;
|
|
Gtk::VScrollbar verticalScroll;
|
|
|
|
// Signals
|
|
sigc::signal<void, Time> mouseHoverSignal;
|
|
sigc::signal<void> playbackPeriodDragReleasedSignal;
|
|
HoveringTrackChangedSignal hoveringTrackChangedSignal;
|
|
TimelineStateChangeSignal stateChangedSignal;
|
|
|
|
bool update_tracks_frozen;
|
|
|
|
/* ===== Constants ===== */
|
|
protected:
|
|
static const int TrackPadding;
|
|
static const int HeaderWidth;
|
|
static const int HeaderIndentWidth;
|
|
|
|
friend class timeline::TimelineBody;
|
|
friend class timeline::TimelineHeaderContainer;
|
|
friend class timeline::TimelineHeaderWidget;
|
|
friend class timeline::TimelineLayoutHelper;
|
|
friend class timeline::TimelineRuler;
|
|
friend class timeline::GroupTrack;
|
|
};
|
|
|
|
|
|
}}// gui::widget
|
|
#endif /*GUI_WIDGET_TIMELINE_WIDGET_H*/
|