Dev:Adding a Render progress bar - Revision history

BobSynfig: /* synfig-studio/src/gui/docks/dock_info.cpp */

2019-01-07T23:10:51Z

‎synfig-studio/src/gui/docks/dock_info.cpp

BobSynfig: Done

2019-01-03T21:53:11Z

Done

BobSynfig: 2nd part

2019-01-03T20:52:13Z

2nd part

BobSynfig: Create + 1st part

2019-01-03T18:40:43Z

Create + 1st part

New page

Now let's implement a Render Progress Bar! 
It has been requested several time: 
[https://github.com/synfig/synfig/issues/383| Indication needed that rendering is in progress. #383] 
[https://github.com/synfig/synfig/issues/626| Feature request: Give feedback when rendering is happening and complete #626] 
also in [https://github.com/synfig/synfig/issues/464| Default render parameter are bad #464]

== Things to take into account ==
* Where to place the Progress Bar? 
* How does really a render work? 
* Where to do calls and implementation? 

=== Where to place the Progress Bar? ===
I chose to implement it in the Dock_Info panel. 
After all, this is a kind of information!

== Implementation ==
=== synfig-studio/src/gui/docks/dock_info.h ===
* Declare the components and members 
In #include section
#include <gtkmm/progressbar.h>

In private section
Gtk::ProgressBar render_progress;

//! Number of passes request - 1 or 2 (if alpha)
int n_passes_requested;
//! Number of passes pending - 2,1,0
int n_passes_pending;

In public section
//! Current render progress - 0.0 to 1.0
// depends on n_passes_requested and current_pass
void set_render_progress (float value);
void set_n_passes_requested(int value);
void set_n_passes_pending (int value);

=== synfig-studio/src/gui/docks/dock_info.cpp ===

@@ Line 73: / Line 73: @@
   //Render progress
   set_n_passes_requested(1); //Default
-  set_n_passes_pending  (1); //Default
+  set_n_passes_pending  (0); //Default
   set_render_progress (0.0); //Default, 0.0%

@@ Line 1: / Line 1: @@
 Now let's implement a Render Progress Bar!<br />
 It has been requested several time:<br />
-[https://github.com/synfig/synfig/issues/383| Indication needed that rendering is in progress. #383]<br />
+[https://github.com/synfig/synfig/issues/383 Indication needed that rendering is in progress. #383]<br />
-[https://github.com/synfig/synfig/issues/626| Feature request: Give feedback when rendering is happening and complete #626]<br />
+[https://github.com/synfig/synfig/issues/626 Feature request: Give feedback when rendering is happening and complete #626]<br />
-also in [https://github.com/synfig/synfig/issues/464| Default render parameter are bad #464]
+also in [https://github.com/synfig/synfig/issues/464 Default render parameter are bad #464]
 == Things to take into account ==
@@ Line 17: / Line 17: @@
 '''App''' ([https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/app.h .h][https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/app.cpp .cpp]) is the root of everything and used to store globals.<br />
 But we start in fact from '''CanvasView''' ([https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/canvasview.h .h][https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/canvasview.cpp .cpp]) which contains the call to display the '''RenderSettings''' Dialog ([https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/render.h .h][https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/render.cpp .cpp]).<br />
-Then we press on render button which leads to execute an '''AsyncRender''' ([https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/asyncrenderer.h .h][https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/asyncrenderer.cpp .cpp]) (or 2, sequentially, if we have a second pass for Alpha extraction).<br />
+Then we press on render button which leads to execute an '''AsyncRenderer''' ([https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/asyncrenderer.h .h][https://github.com/synfig/synfig/blob/master/synfig-studio/src/gui/asyncrenderer.cpp .cpp]) (or 2, sequentially, if we have a second pass for Alpha extraction).<br />
 '''AsyncRenderer''' can have 4 types of targets, ''AsyncTarget_Cairo'', AsyncTarget_Cairo_Tile, ''AsyncTarget_Scanline'', AsyncTarget_Tile.<br />
 Only ''AsyncTarget_Cairo'' and ''AsyncTarget_Scanline'' have a ''frame_ready()'' function that we will use to implement our call to update to the Render ProgressBar.<br />
 Note that we can have 2 passes, this has to be considered when displaying the percents of accomplished render.<br />
 == Implementation ==
@@ Line 52: / Line 58: @@
 In Dock_Info(), at the end:
   //Render Progress Bar
   table->attach(*manage(new Gtk::Label(_("Render Progress: "))),0,1,5,6,Gtk::EXPAND|Gtk::FILL,Gtk::SHRINK|Gtk::FILL);
@@ Line 61: / Line 68: @@
   //Another spacer
   table->attach(*manage(new Gtk::Label),0,5,7,8);
 ''and after add(*table);''
@@ Line 99: / Line 104: @@
 % of pass 2 while be displayed as 100%.<br />
 If we had 3 passes, it would be 33.3%, 66.6% and 100.0%<br />

@@ Line 14: / Line 14: @@
 After all, this is a kind of information!
 == Implementation ==
 === synfig-studio/src/gui/docks/dock_info.h ===
 * Declare the components and members<br />
-In #include section
+In #include section:
   #include <gtkmm/progressbar.h>
-In private section
+In private section:
   Gtk::ProgressBar render_progress;
@@ Line 29: / Line 37: @@
   int              n_passes_pending;
-In public section
+In public section:
   //! Current render progress - 0.0 to 1.0
   //  depends on n_passes_requested and current_pass
@@ Line 37: / Line 45: @@
 === synfig-studio/src/gui/docks/dock_info.cpp ===