1 /* === S Y N F I G ========================================================= */
3 ** \brief Template Header
5 ** $Id: workarea.h,v 1.1.1.1 2005/01/07 03:34:37 darco Exp $
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
10 ** This package is free software; you can redistribute it and/or
11 ** modify it under the terms of the GNU General Public License as
12 ** published by the Free Software Foundation; either version 2 of
13 ** the License, or (at your option) any later version.
15 ** This package is distributed in the hope that it will be useful,
16 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ** General Public License for more details.
21 /* ========================================================================= */
23 /* === S T A R T =========================================================== */
25 #ifndef __SYNFIG_GTKMM_WORKAREA_H
26 #define __SYNFIG_GTKMM_WORKAREA_H
28 /* === H E A D E R S ======================================================= */
34 #include <ETL/smart_ptr>
37 #include <gtkmm/drawingarea.h>
38 #include <gtkmm/table.h>
39 #include <gtkmm/adjustment.h>
40 #include <gtkmm/ruler.h>
41 #include <gtkmm/image.h>
42 #include <gdkmm/pixbuf.h>
43 #include <gdkmm/cursor.h>
44 #include <gdkmm/device.h>
46 #include <synfig/time.h>
47 #include <synfig/vector.h>
48 #include <synfig/general.h>
49 #include <synfig/renddesc.h>
50 #include <synfig/canvas.h>
53 #include "duckmatic.h"
56 /* === M A C R O S ========================================================= */
58 /* === T Y P E D E F S ===================================================== */
60 /* === C L A S S E S & S T R U C T S ======================================= */
65 template <typename T_, typename C_=std::less<T_,T_> >
66 class dereferenced_compare
69 typedef etl::loose_handle<T_> first_argument_type;
70 typedef etl::loose_handle<T_> second_argument_type;
71 typedef bool result_type;
78 class WorkAreaTarget_Full;
79 namespace synfigapp { class CanvasInterface; };
81 namespace synfig { class Layer; };
82 namespace Gtk { class Frame; };
89 class WorkAreaRenderer;
93 friend class WorkArea;
96 DirtyTrap(WorkArea *work_area);
101 class WorkArea : public Gtk::Table, public Duckmatic
103 friend class WorkAreaTarget;
104 friend class WorkAreaTarget_Full;
105 friend class DirtyTrap;
106 friend class WorkAreaRenderer;
109 -- ** -- P U B L I C T Y P E S ---------------------------------------------
114 void insert_renderer(const etl::handle<WorkAreaRenderer> &x);
115 void insert_renderer(const etl::handle<WorkAreaRenderer> &x,int priority);
116 void erase_renderer(const etl::handle<WorkAreaRenderer> &x);
117 void resort_render_set();
129 -- ** -- P R I V A T E D A T A ---------------------------------------------
134 std::set<etl::handle<WorkAreaRenderer> > renderer_set_;
136 etl::handle<studio::AsyncRenderer> async_renderer;
139 etl::loose_handle<synfigapp::CanvasInterface> canvas_interface;
140 etl::handle<synfig::Canvas> canvas;
141 etl::loose_handle<studio::Instance> instance;
142 etl::loose_handle<studio::CanvasView> canvas_view;
145 Gtk::DrawingArea *drawing_area;
146 Gtk::Adjustment scrollx_adjustment;
147 Gtk::Adjustment scrolly_adjustment;
150 Gtk::Button *menubutton;
151 Gtk::Frame *drawing_frame;
153 GdkDevice* curr_input_device;
156 int w; //!< Width of the image (in pixels)
157 int h; //!< Height of the image (in pixels)
158 synfig::Real canvaswidth; //!< Width of the canvas
159 synfig::Real canvasheight; //!< Height of the canvas
160 synfig::Real pw; //!< The width of a pixel
161 synfig::Real ph; //!< The height of a pixel
162 float zoom; //!< Zoom factor
163 float prev_zoom; //!< Previous Zoom factor
164 synfig::Point window_tl; //!< The (theoretical) top-left corner of the view window
165 synfig::Point window_br; //!< The (theoretical) bottom-right corner of the view window
167 guint32 last_event_time;
170 //unsigned char *buffer;
173 synfig::ProgressCallback *progresscallback;
176 synfig::RendDesc desc;
178 //! This flag is set if the user is dragging the video window
179 /*! \see drag_point */
182 etl::handle<Duckmatic::Duck> clicked_duck;
183 etl::handle<Duckmatic::Duck> hover_duck;
185 //! When dragging the viewport, this is set to the origin of the drag
186 synfig::Point drag_point;
188 synfig::Point curr_point;
191 synfig::Point previous_focus;
193 //! This flag is set if the grid should be drawn
196 //! This flag is set if the guides should be drawn
203 //! This flag is set if the entire frame is rendered rather than using tiles
206 //Glib::RefPtr<Gdk::Pixbuf> pix_buf;
208 //! This vector holds all of the tiles for this image
209 std::vector< std::pair<Glib::RefPtr<Gdk::Pixbuf>,int> > tile_book;
211 //! This integer describes the total times that the work are has been refreshed
214 //! This list holds the queue of tiles that need to be rendered
215 //std::list<int> tile_queue;
219 gint render_idle_func_id;
221 //! The coordinates of the focus the last time a part of the screen was refreshed
222 synfig::Point last_focus_point;
228 bool dirty_trap_enabled;
230 int dirty_trap_queued;
235 etl::loose_handle<synfig::ValueNode> selected_value_node_;
239 -- ** -- P U B L I C D A T A -----------------------------------------------
244 const etl::loose_handle<synfig::ValueNode>& get_selected_value_node() { return selected_value_node_; }
245 const synfig::Point& get_drag_point()const { return drag_point; }
246 std::vector< std::pair<Glib::RefPtr<Gdk::Pixbuf>,int> >& get_tile_book(){ return tile_book; }
247 int get_refreshes()const { return refreshes; }
248 bool get_canceled()const { return canceled_; }
249 bool get_queued()const { return queued; }
250 bool get_rendering()const { return rendering; }
251 bool get_full_frame()const { return full_frame; }
252 //int get_w()const { return w; }
253 //int get_h()const { return h; }
255 int get_tile_w()const { return tile_w; }
256 int get_tile_h()const { return tile_h; }
263 bool allow_layer_clicks;
264 bool allow_duck_clicks;
266 GuideList::iterator curr_guide;
267 bool curr_guide_is_x;
270 -- ** -- P R I V A T E M E T H O D S ---------------------------------------
275 //unsigned char *get_buffer() { return buffer; }
276 bool set_wh(int w, int h,int chan=3);
278 int next_unrendered_tile(int refreshes)const;
279 int next_unrendered_tile()const { return next_unrendered_tile(refreshes); }
282 -- ** -- S I G N A L S -------------------------------------------------------
287 sigc::signal<void,GdkDevice* > signal_input_device_changed_;
289 //! One signal per button
290 sigc::signal<void,synfig::Point> signal_user_click_[5];
292 sigc::signal<void> signal_popup_menu_;
294 sigc::signal<void> signal_cursor_moved_;
295 sigc::signal<void> signal_rendering_;
297 sigc::signal<void> signal_onion_skin_changed_;
299 //! Signal for when the user clicks on a layer
300 sigc::signal<void, etl::handle<synfig::Layer> > signal_layer_selected_;
302 sigc::signal<void> signal_view_window_changed_;
306 sigc::signal<void>& signal_onion_skin_changed() { return signal_onion_skin_changed_; }
308 sigc::signal<void>& signal_rendering() { return signal_rendering_; }
310 sigc::signal<void>& signal_cursor_moved() { return signal_cursor_moved_; }
312 sigc::signal<void>& signal_view_window_changed() { return signal_view_window_changed_; }
313 void view_window_changed() { signal_view_window_changed()(); }
315 sigc::signal<void,GdkDevice* >& signal_input_device_changed() { return signal_input_device_changed_; }
317 sigc::signal<void> &signal_popup_menu() { return signal_popup_menu_; }
319 //! One signal per button (5 buttons)
320 sigc::signal<void,synfig::Point> &signal_user_click(int button=0){ return signal_user_click_[button]; }
322 sigc::signal<void, etl::handle<synfig::Layer> >& signal_layer_selected() { return signal_layer_selected_; }
325 -- ** -- P U B L I C M E T H O D S -----------------------------------------
329 void set_onion_skin(bool x);
330 bool get_onion_skin()const;
331 void toggle_onion_skin() { set_onion_skin(!get_onion_skin()); }
333 void set_selected_value_node(etl::loose_handle<synfig::ValueNode> x);
335 bool is_dragging() { return dragging!=DRAG_NONE; }
337 DragMode get_dragging_mode() { return dragging; }
339 WorkArea(etl::loose_handle<synfigapp::CanvasInterface> canvas_interface);
342 void set_cursor(const Gdk::Cursor& x);
343 void set_cursor(Gdk::CursorType x);
345 const synfig::Point& get_cursor_pos()const { return curr_point; }
347 Gtk::Adjustment *get_scrollx_adjustment() { return &scrollx_adjustment; }
348 Gtk::Adjustment *get_scrolly_adjustment() { return &scrolly_adjustment; }
349 const Gtk::Adjustment *get_scrollx_adjustment()const { return &scrollx_adjustment; }
350 const Gtk::Adjustment *get_scrolly_adjustment()const { return &scrolly_adjustment; }
352 void set_instance(etl::loose_handle<studio::Instance> x) { instance=x; }
353 void set_canvas(etl::handle<synfig::Canvas> x) { canvas=x; }
354 void set_canvas_view(etl::loose_handle<studio::CanvasView> x) { canvas_view=x; }
355 etl::handle<synfig::Canvas> get_canvas()const { return canvas; }
356 etl::handle<studio::Instance> get_instance()const { return instance; }
357 etl::loose_handle<studio::CanvasView> get_canvas_view()const { return canvas_view; }
359 void refresh_dimension_info();
361 //! Enables showing of the grid
364 //! Disables showing of the grid
367 //! Toggles the showing of the grid
370 //! Returns the state of the show_grid flag
371 bool grid_status()const { return show_grid; }
373 void toggle_grid_snap() { Duckmatic::toggle_grid_snap(); }
375 bool get_show_guides()const { return show_guides; }
376 void set_show_guides(bool x);
377 void toggle_show_guides() { set_show_guides(!get_show_guides()); }
379 bool get_low_resolution_flag()const { return low_resolution; }
380 void set_low_resolution_flag(bool x);
381 void toggle_low_resolution_flag();
386 //! Sets the size of the grid
387 void set_grid_size(const synfig::Vector &s);
392 int get_quality()const { return quality; }
394 void set_quality(int x);
397 int get_w()const { return w; }
398 int get_h()const { return h; }
399 int get_bpp()const { return bpp; }
402 const synfig::RendDesc &get_rend_desc()const { return desc; }
405 void set_rend_desc(const synfig::RendDesc &x) { desc=x; }
407 //! Converts screen coords (ie: pixels) to composition coordinates
408 synfig::Point screen_to_comp_coords(synfig::Point pos)const;
410 //! Converts composition coordinates to screen coords (ie: pixels)
411 synfig::Point comp_to_screen_coords(synfig::Point pos)const;
413 float get_pw()const { return pw; }
414 float get_ph()const { return ph; }
416 const synfig::Point &get_window_tl()const { return window_tl; }
417 const synfig::Point &get_window_br()const { return window_br; }
420 bool async_update_preview();
421 void async_update_finished();
422 void async_render_preview(synfig::Time time);
423 void async_render_preview();
425 bool sync_update_preview();
426 bool sync_render_preview(synfig::Time time);
427 bool sync_render_preview();
428 void sync_render_preview_hook();
430 void queue_render_preview();
433 void queue_draw_preview();
439 float get_zoom()const { return zoom; }
441 void set_zoom(float z);
444 void set_progress_callback(synfig::ProgressCallback *x) { progresscallback=x; }
445 synfig::ProgressCallback *get_progress_callback() { return progresscallback; }
447 void set_focus_point(const synfig::Point &x);
449 synfig::Point get_focus_point()const;
451 void done_rendering();
453 bool refresh(GdkEventExpose*bleh=NULL);
456 void refresh_cursor();
458 void save_meta_data();
459 void load_meta_data();
462 -- ** -- S I G N A L T E R M I N A L S -------------------------------------
466 bool on_key_press_event(GdkEventKey* event);
467 bool on_drawing_area_event(GdkEvent* event);
468 bool on_hruler_event(GdkEvent* event);
469 bool on_vruler_event(GdkEvent* event);
472 -- ** -- S T A T I C P U B L I C M E T H O D S ---------------------------
478 -- ** -- S T A T I C P R I V A T E M E T H O D S -------------------------
483 static gboolean __render_preview(gpointer data);
485 }; // END of class WorkArea
487 }; // END of namespace studio
489 /* === E N D =============================================================== */