Fix most of the warnings from doxygen for synfig-studio sources.
[synfig.git] / synfig-studio / trunk / src / gtkmm / workarea.cpp
index 14a54c0..d65d3d0 100644 (file)
@@ -7,6 +7,7 @@
 **     \legal
 **     Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
 **     Copyright 2006 Yue Shi Lai
+**     Copyright (c) 2007 Chris Moore
 **
 **     This package is free software; you can redistribute it and/or
 **     modify it under the terms of the GNU General Public License as
@@ -71,6 +72,8 @@
 
 #include <synfig/mutex.h>
 
+#include "general.h"
+
 #endif
 
 /* === U S I N G =========================================================== */
@@ -634,7 +637,9 @@ WorkArea::WorkArea(etl::loose_handle<synfigapp::CanvasInterface> canvas_interfac
        dragging(DRAG_NONE),
        show_grid(false),
        tile_w(128),
-       tile_h(128)
+       tile_h(128),
+       timecode_width(0),
+       timecode_height(0)
 {
        show_guides=true;
        curr_input_device=0;
@@ -800,6 +805,24 @@ WorkArea::WorkArea(etl::loose_handle<synfigapp::CanvasInterface> canvas_interfac
 WorkArea::~WorkArea()
 {
 //     delete [] buffer;
+
+       // don't leave the render function queued if we are about to vanish;
+       // that causes crashes
+       if(render_idle_func_id)
+               render_idle_func_id=0;
+}
+
+bool
+WorkArea::get_updating()const
+{
+       return App::single_threaded && async_renderer && async_renderer->updating;
+}
+
+void
+WorkArea::stop_updating(bool cancel)
+{
+       async_renderer->stop();
+       if (cancel) canceled_=true;
 }
 
 void
@@ -1040,7 +1063,7 @@ void
 WorkArea::set_focus_point(const synfig::Point &point)
 {
        // These next three lines try to ensure that we place the
-       // focus on a pixel boundry
+       // focus on a pixel boundary
        /*Point adjusted(point[0]/abs(get_pw()),point[1]/abs(get_ph()));
        adjusted[0]=(abs(adjusted[0]-floor(adjusted[0]))<0.5)?floor(adjusted[0])*abs(get_pw()):ceil(adjusted[0])*abs(get_ph());
        adjusted[1]=(abs(adjusted[1]-floor(adjusted[1]))<0.5)?floor(adjusted[1])*abs(get_ph()):ceil(adjusted[1])*abs(get_ph());
@@ -1181,7 +1204,7 @@ WorkArea::on_drawing_area_event(GdkEvent *event)
                        modifier=Gdk::ModifierType(event->button.state);
                }
 
-               // Make sure we recognise the device
+               // Make sure we recognize the device
                if(curr_input_device)
                {
                        if(curr_input_device!=device)
@@ -1247,7 +1270,7 @@ WorkArea::on_drawing_area_event(GdkEvent *event)
        // GDK mouse scrolling events
        else if(event->any.type==GDK_SCROLL)
        {
-               // GDK information needed to properly interprete mouse
+               // GDK information needed to properly interpret mouse
                // scrolling events are: scroll.state, scroll.x/scroll.y, and
                // scroll.direction. The value of scroll.direction will be
                // obtained later.
@@ -1424,19 +1447,15 @@ WorkArea::on_drawing_area_event(GdkEvent *event)
                                if(get_selected_ducks().size()<=1)
                                        duck->signal_user_click(2)();
                                else
-                               {
                                        canvas_view->get_smach().process_event(EventMouse(EVENT_WORKAREA_MULTIPLE_DUCKS_CLICKED,BUTTON_RIGHT,mouse_pos,pressure,modifier));
-                               }
                                return true;
                        }
-                       else
-                       if(bezier)
+                       else if(bezier)
                        {
                                bezier->signal_user_click(2)(bezier_click_pos);
                                return true;
                        }
-                       else
-                       if(layer)
+                       else if (layer)
                        {
                                if(canvas_view->get_smach().process_event(EventLayerClick(layer,BUTTON_RIGHT,mouse_pos))==Smach::RESULT_OK)
                                        return false;
@@ -1474,7 +1493,7 @@ WorkArea::on_drawing_area_event(GdkEvent *event)
 
                signal_cursor_moved_();
 
-               // Guide/Duck hilights on hover
+               // Guide/Duck highlights on hover
                if(dragging==DRAG_NONE)
                {
                        GuideList::iterator iter;
@@ -1525,11 +1544,13 @@ WorkArea::on_drawing_area_event(GdkEvent *event)
 
                        drawing_area->queue_draw();
                }
+
                if(dragging==DRAG_BOX)
                {
                        curr_point=mouse_pos;
                        drawing_area->queue_draw();
                }
+
                if(dragging==DRAG_GUIDE)
                {
                        if(curr_guide_is_x)
@@ -1538,30 +1559,34 @@ WorkArea::on_drawing_area_event(GdkEvent *event)
                                *curr_guide=mouse_pos[1];
                        drawing_area->queue_draw();
                }
+
                if(dragging!=DRAG_WINDOW)
                {       // Update those triangle things on the rulers
                        const synfig::Point point(mouse_pos);
                        hruler->property_position()=Distance(point[0],Distance::SYSTEM_UNITS).get(App::distance_system,get_canvas()->rend_desc());
                        vruler->property_position()=Distance(point[1],Distance::SYSTEM_UNITS).get(App::distance_system,get_canvas()->rend_desc());
                }
-               if(dragging==DRAG_WINDOW)
-               {
-                       set_focus_point(get_focus_point()+mouse_pos-drag_point);
-               }
-               else
-               if(event->motion.state&GDK_BUTTON1_MASK && canvas_view->get_smach().process_event(EventMouse(EVENT_WORKAREA_MOUSE_BUTTON_DRAG,BUTTON_LEFT,mouse_pos,pressure,modifier))==Smach::RESULT_ACCEPT)
+
+               if(dragging == DRAG_WINDOW)
+                       set_focus_point(get_focus_point() + mouse_pos-drag_point);
+               else if (event->motion.state & GDK_BUTTON1_MASK &&
+                               canvas_view->get_smach().process_event(EventMouse(EVENT_WORKAREA_MOUSE_BUTTON_DRAG, BUTTON_LEFT,
+                                                                                                                                 mouse_pos,pressure,modifier)) == Smach::RESULT_ACCEPT)
                        return true;
-               else
-               if(event->motion.state&GDK_BUTTON2_MASK && canvas_view->get_smach().process_event(EventMouse(EVENT_WORKAREA_MOUSE_BUTTON_DRAG,BUTTON_MIDDLE,mouse_pos,pressure,modifier))==Smach::RESULT_ACCEPT)
+               else if (event->motion.state & GDK_BUTTON2_MASK &&
+                                canvas_view->get_smach().process_event(EventMouse(EVENT_WORKAREA_MOUSE_BUTTON_DRAG, BUTTON_MIDDLE,
+                                                                                                                                  mouse_pos, pressure, modifier)) == Smach::RESULT_ACCEPT)
                        return true;
-               else
-               if(event->motion.state&GDK_BUTTON3_MASK && canvas_view->get_smach().process_event(EventMouse(EVENT_WORKAREA_MOUSE_BUTTON_DRAG,BUTTON_RIGHT,mouse_pos,pressure,modifier))==Smach::RESULT_ACCEPT)
+               else if (event->motion.state & GDK_BUTTON3_MASK &&
+                                canvas_view->get_smach().process_event(EventMouse(EVENT_WORKAREA_MOUSE_BUTTON_DRAG, BUTTON_RIGHT,
+                                                                                                                                  mouse_pos, pressure, modifier)) == Smach::RESULT_ACCEPT)
                        return true;
-               else
-               if(canvas_view->get_smach().process_event(EventMouse(EVENT_WORKAREA_MOUSE_MOTION,BUTTON_NONE,mouse_pos,pressure,modifier))==Smach::RESULT_ACCEPT)
+               else if(canvas_view->get_smach().process_event(EventMouse(EVENT_WORKAREA_MOUSE_MOTION, BUTTON_NONE,
+                                                                                                                                 mouse_pos, pressure,modifier)) == Smach::RESULT_ACCEPT)
                        return true;
 
                break;
+
        case GDK_BUTTON_RELEASE:
        {
                bool ret(false);
@@ -2166,6 +2191,13 @@ public:
 bool
 studio::WorkArea::async_update_preview()
 {
+       if (get_updating())
+       {
+               stop_updating();
+               queue_render_preview();
+               return false;
+       }
+
        async_renderer=0;
 
        queued=false;
@@ -2210,8 +2242,11 @@ studio::WorkArea::async_update_preview()
        // Create the render target
        handle<Target> target;
 
-       if(w*h>(low_resolution?480*270:480*270/2))
+       // if we have lots of pixels to render and the tile renderer isn't disabled, use it
+       if(w*h>(low_resolution?480*270:480*270/2) &&
+          !getenv("SYNFIG_DISABLE_TILE_RENDER"))
        {
+               // do a tile render
                handle<WorkAreaTarget> trgt(new class WorkAreaTarget(this,w,h));
 
                trgt->set_rend_desc(&desc);
@@ -2220,6 +2255,7 @@ studio::WorkArea::async_update_preview()
        }
        else
        {
+               // do a scanline render
                handle<WorkAreaTarget_Full> trgt(new class WorkAreaTarget_Full(this,w,h));
 
                trgt->set_rend_desc(&desc);
@@ -2386,7 +2422,7 @@ again:
 }
 
 void
-studio::WorkArea::async_render_preview(Time time)
+studio::WorkArea::async_render_preview(synfig::Time time)
 {
        cur_time=time;
        //tile_book.clear();
@@ -2407,7 +2443,7 @@ WorkArea::async_render_preview()
 }
 
 bool
-studio::WorkArea::sync_render_preview(Time time)
+studio::WorkArea::sync_render_preview(synfig::Time time)
 {
        cur_time=time;
        //tile_book.clear();
@@ -2453,13 +2489,41 @@ WorkArea::queue_scroll()
 
        drawing_area->get_window()->scroll(-dx,-dy);
 
-       /*drawing_area->queue_draw_area(
-               0,
-               0,
-               128,
-               64
-       );
-       */
+       if (timecode_width && timecode_height)
+       {
+               drawing_area->queue_draw_area(4,       4,    4+timecode_width,    4+timecode_height);
+               drawing_area->queue_draw_area(4-dx, 4-dy, 4-dx+timecode_width, 4-dy+timecode_height);
+       }
+
+#ifndef USE_FRAME_BACKGROUND_TO_SHOW_EDIT_MODE
+       if(canvas_interface->get_mode()&synfigapp::MODE_ANIMATE)
+       {
+               int maxx = drawing_area->get_width()-1;
+               int maxy = drawing_area->get_height()-1;
+
+               if (dx > 0)
+               {
+                       drawing_area->queue_draw_area(      0, 0,       1, maxy);
+                       drawing_area->queue_draw_area(maxx-dx, 0, maxx-dx, maxy);
+               }
+               else if (dx < 0) 
+               {
+                       drawing_area->queue_draw_area(   maxx, 0,    maxx, maxy);
+                       drawing_area->queue_draw_area(    -dx, 0,     -dx, maxy);
+               }
+               if (dy > 0)
+               {
+                       drawing_area->queue_draw_area(0,       0, maxx,       1);
+                       drawing_area->queue_draw_area(0, maxy-dy, maxx, maxy-dy);
+               }
+               else if (dy < 0) 
+               {
+                       drawing_area->queue_draw_area(0,    maxy, maxx,    maxy);
+                       drawing_area->queue_draw_area(0,     -dy, maxx,     -dy);
+               }
+       }
+#endif // USE_FRAME_BACKGROUND_TO_SHOW_EDIT_MODE
+
        last_focus_point=focus_point;
 }
 
@@ -2497,9 +2561,11 @@ studio::WorkArea::zoom_norm()
 gboolean
 studio::WorkArea::__render_preview(gpointer data)
 {
-
        WorkArea *work_area(static_cast<WorkArea*>(data));
 
+       // there's no point anyone trying to cancel the timer now - it's gone off already
+       work_area->render_idle_func_id = 0;
+
        work_area->queued=false;
        work_area->async_render_preview(work_area->get_canvas_view()->get_time());
 
@@ -2587,12 +2653,12 @@ studio::WorkArea::set_cursor(Gdk::CursorType x)
        drawing_area->get_window()->set_cursor(Gdk::Cursor(x));
 }
 
-#include "iconcontroler.h"
+#include "iconcontroller.h"
 
 void
 studio::WorkArea::refresh_cursor()
 {
-//     set_cursor(IconControler::get_tool_cursor(canvas_view->get_smach().get_state_name(),drawing_area->get_window()));
+//     set_cursor(IconController::get_tool_cursor(canvas_view->get_smach().get_state_name(),drawing_area->get_window()));
 }
 
 void