Using migrated Public Visual API
[platform/core/uifw/dali-demo.git] / examples / homescreen-benchmark / homescreen-benchmark.cpp
1 /*
2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17
18 // EXTERNAL INCLUDES
19 #include <dali-toolkit/dali-toolkit.h>
20 #include <dali/devel-api/actors/actor-devel.h>
21 #include <sstream>
22 #include <iostream>
23
24 #include <dali-toolkit/devel-api/visual-factory/visual-factory.h>
25
26 using namespace Dali;
27 using Dali::Toolkit::TextLabel;
28
29 namespace
30 {
31 enum IconType
32 {
33   IMAGEVIEW,
34   CHECKBOX
35 };
36
37 const char* IMAGE_PATH_PREFIX               ( DEMO_IMAGE_DIR "application-icon-" );
38 const char* IMAGE_PATH_POSTFIX              ( ".png" );
39 const int   TOTAL_ICON_DEFINITIONS          ( 147 );
40
41 const char* BACKGROUND_IMAGE                ( DEMO_IMAGE_DIR "background-3.jpg" );
42 const float PAGE_SCALE_FACTOR_X             ( 0.95f );
43 const float PAGE_SCALE_FACTOR_Y             ( 0.95f );
44 const float PAGE_DURATION_SCALE_FACTOR      ( 10.0f ); ///< Time-scale factor, larger = animation is slower
45
46 const float DEFAULT_OPT_ROW_COUNT           ( 5 );
47 const float DEFAULT_OPT_COL_COUNT           ( 4 );
48 const float DEFAULT_OPT_PAGE_COUNT          ( 10 );
49 const bool  DEFAULT_OPT_USE_TABLEVIEW       ( true );
50 const bool  DEFAULT_OPT_ICON_LABELS         ( true );
51 const IconType  DEFAULT_OPT_ICON_TYPE       ( IMAGEVIEW );
52 const bool  DEFAULT_OPT_USE_TEXT_LABEL      ( false );
53
54 // The image/label area tries to make sure the positioning will be relative to previous sibling
55 const float IMAGE_AREA                      ( 0.60f );
56 const float LABEL_AREA                      ( 0.50f );
57
58
59
60 /**
61  * Random words used as unique application names.
62  * The number matches the value of TOTAL_ICON_DEFINITIONS.
63  */
64 const char* DEMO_APPS_NAMES[] =
65 {
66   "Achdyer",   "Aughm",       "Cerl",       "Daril",      "Emgha",     "Ghatan",     "Issum",     "Lertan",    "Mosorrad",
67   "Achtortor", "Aughtheryer", "Certin",     "Darpban",    "Emiton",    "Gibanis",    "Itenthbel", "Liadem",    "Mosraye",
68   "Ackirlor",  "Awitad",      "Checerper",  "Dasrad",     "Emworeng",  "Hatdyn",     "K'ackves",  "Liathar",   "Mosth",
69   "Ackptin",   "Banengon",    "Chegit",     "Deeqskel",   "Endnys",    "Heesban",    "Kagdra",    "Liephden",  "Neabar",
70   "Aighte",    "Banhinat",    "Cheirat",    "Delurnther", "Enessray",  "Hesub",      "Kalbankim", "Likellor",  "Neerdem",
71   "Akala",     "Belrisash",   "Che'rak",    "Denalda",    "Engyer",    "Hinkelenth", "Kal'enda",  "Loightmos", "Nichqua",
72   "Alealdny",  "Bilorm",      "Cheves",     "Derynkel",   "En'rady",   "Hirryer",    "Kimest",    "Loromum",   "Nudraough",
73   "Angash",    "Bleustcer",   "Chiperath",  "Deurnos",    "Enthount",  "Ideinta",    "Kimundeng", "Lorr",      "Nuyim",
74   "Anglor",    "Bliagelor",   "Chralerack", "Doyaryke",   "Enundem",   "Im'eld",     "Koachlor",  "Lortas",    "Nycha",
75   "Anveraugh", "Blorynton",   "Chram",      "Draithon",   "Essina",    "Ina'ir",     "Kuren",     "Lyerr",     "Nyia",
76   "Ardangas",  "Booten",      "Clyimen",    "Drantess",   "Faughald",  "Ing'moro",   "Kygver",    "Maustbur",  "Nyjac",
77   "Ardug",     "Bripolqua",   "Coqueang",   "Druardny",   "Fiummos",   "Ingormess",  "Kyning",    "Menvor",    "Nystondar",
78   "Ardworu",   "Bryray",      "Craennther", "Dynsaytor",  "Garash",    "Ingshy",     "Laiyach",   "Meusten",   "Okine",
79   "Ascerald",  "Burust",      "Cykage",     "Dytinris",   "Garight",   "Issath",     "Lasuzu",    "Mirodskel", "Oldit",
80   "Ash'ach",   "Cataikel",    "Dalek",      "Eeni",       "Garrynath", "Issendris",  "Lekew",     "Morhatrod", "Om'mose",
81   "Athiund",   "Cerilwar",    "Darhkel",    "Elmryn",     "Ghalora",   "Issey",      "Lerengom",  "Moserbel",  "Onye",
82   "Ososrak",   "Pecertin",    "Perrd"
83 };
84
85 // This code comes from command-line-options.cpp. the reason it's here is to
86 // keep consistent the extra-help formatting when '--help' used.
87 void PrintHelp( const char * const opt, const char * const optDescription)
88 {
89   const std::ios_base::fmtflags flags = std::cout.flags();
90   std::cout << std::left << "  -";
91   std::cout.width( 18 );
92   std::cout << opt;
93   std::cout << optDescription;
94   std::cout << std::endl;
95   std::cout.flags( flags );
96 }
97
98 }
99
100 /**
101  * @brief This example is a benchmark that mimics the paged applications list of the homescreen application.
102  */
103 class HomescreenBenchmark : public ConnectionTracker
104 {
105 public:
106
107   // Config structure passed to the constructor. It makes easier to increase number
108   // of setup parameters if needed.
109   struct Config
110   {
111     Config() :
112       mRows( DEFAULT_OPT_ROW_COUNT ),
113       mCols( DEFAULT_OPT_COL_COUNT ),
114       mPageCount( DEFAULT_OPT_PAGE_COUNT ),
115       mTableViewEnabled( DEFAULT_OPT_USE_TABLEVIEW ),
116       mIconLabelsEnabled( DEFAULT_OPT_ICON_LABELS ),
117       mIconType( DEFAULT_OPT_ICON_TYPE ),
118       mUseTextLabel( DEFAULT_OPT_USE_TEXT_LABEL )
119     {
120     }
121
122     int  mRows;
123     int  mCols;
124     int  mPageCount;
125     bool mTableViewEnabled;
126     bool mIconLabelsEnabled;
127     IconType mIconType;
128     bool mUseTextLabel;
129   };
130
131   // animation script data
132   struct ScriptData
133   {
134     ScriptData( int pages, float duration, bool flick )
135     : mPages( pages ),
136       mDuration( duration ),
137       mFlick( flick )
138     {
139     }
140
141     int   mPages;    ///< Number of pages to scroll
142     float mDuration; ///< Duration
143     bool  mFlick;    ///< Use flick or 'one-by-one' scroll
144   };
145
146   HomescreenBenchmark( Application& application, const Config& config )
147   : mApplication( application ),
148     mConfig( config ),
149     mScriptFrame( 0 ),
150     mCurrentPage( 0 )
151   {
152     // Connect to the Application's Init signal.
153     mApplication.InitSignal().Connect( this, &HomescreenBenchmark::Create );
154   }
155
156   ~HomescreenBenchmark()
157   {
158   }
159
160   // The Init signal is received once (only) during the Application lifetime.
161   void Create( Application& application )
162   {
163     // Create benchmark script
164     CreateScript();
165
166     // Get a handle to the stage
167     Stage stage = Stage::GetCurrent();
168
169     mScrollParent = Actor::New();
170     mScrollParent.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
171     mScrollParent.SetAnchorPoint( AnchorPoint::CENTER );
172     mScrollParent.SetParentOrigin( ParentOrigin::CENTER );
173
174     // create background
175     Toolkit::ImageView background = Toolkit::ImageView::New( BACKGROUND_IMAGE );
176     Stage::GetCurrent().Add( background );
177     background.SetResizePolicy( ResizePolicy::FILL_TO_PARENT, Dimension::ALL_DIMENSIONS );
178     background.SetAnchorPoint( AnchorPoint::CENTER );
179     background.SetParentOrigin( ParentOrigin::CENTER );
180
181     PopulatePages();
182
183     stage.Add( mScrollParent );
184
185     // Respond to a click anywhere on the stage.
186     stage.GetRootLayer().TouchSignal().Connect( this, &HomescreenBenchmark::OnTouch );
187   }
188
189   bool OnTouch( Actor actor, const TouchData& touch )
190   {
191     // Quit the application.
192     mApplication.Quit();
193     return true;
194   }
195
196   Actor AddPage()
197   {
198     // Create root page actor.
199     Actor pageActor;
200
201     if( mConfig.mTableViewEnabled )
202     {
203       Toolkit::TableView tableView = Toolkit::TableView::New( mConfig.mRows, mConfig.mCols );
204
205       // Create geometry batcher for table view.
206       tableView.SetBackgroundColor( Vector4( 0.0f, 0.0f, 0.0f, 0.5f ) );
207       pageActor = tableView;
208     }
209     else
210     {
211       pageActor = Toolkit::Control::New();
212       pageActor.SetProperty( Toolkit::Control::Property::BACKGROUND_COLOR, Vector4( 0.0f, 0.0f, 0.0f, 0.5f ) );
213     }
214
215     pageActor.SetParentOrigin( ParentOrigin::CENTER );
216     pageActor.SetAnchorPoint( AnchorPoint::CENTER );
217     pageActor.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::ALL_DIMENSIONS );
218     pageActor.SetSizeModeFactor( Vector3( PAGE_SCALE_FACTOR_X, PAGE_SCALE_FACTOR_Y, 1.0f ) );
219     return pageActor;
220   }
221
222   Toolkit::ImageView CreateImageView( const unsigned int currentIconIndex )
223   {
224     // Create empty image to avoid early renderer creation
225     Toolkit::ImageView imageView = Toolkit::ImageView::New();
226
227     // Auto-generate the Icons image URL.
228     Property::Map map;
229     std::stringstream imagePath;
230     imagePath << IMAGE_PATH_PREFIX << currentIconIndex << IMAGE_PATH_POSTFIX;
231     map[ Dali::Toolkit::ImageVisual::Property::URL ] = imagePath.str();
232
233     imageView.SetProperty( Toolkit::ImageView::Property::IMAGE, map );
234     imageView.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::ALL_DIMENSIONS );
235     imageView.SetSizeScalePolicy( SizeScalePolicy::FIT_WITH_ASPECT_RATIO );
236     imageView.SetAnchorPoint( AnchorPoint::CENTER );
237     imageView.SetParentOrigin( ParentOrigin::CENTER );
238     imageView.SetSizeModeFactor( Vector3( IMAGE_AREA, IMAGE_AREA, 1.0f ) );
239
240     return imageView;
241   }
242
243   Toolkit::Button CreateButton( const unsigned int currentIconIndex )
244   {
245     Toolkit::CheckBoxButton button = Toolkit::CheckBoxButton::New();
246     button.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::ALL_DIMENSIONS );
247     button.SetSizeScalePolicy( SizeScalePolicy::FIT_WITH_ASPECT_RATIO );
248     button.SetAnchorPoint( AnchorPoint::CENTER );
249     button.SetParentOrigin( ParentOrigin::CENTER );
250     button.SetProperty( Toolkit::Button::Property::SELECTED, ( currentIconIndex % 2 == 0 ) ); // Select half the button
251
252     return button;
253   }
254
255   void AddIconsToPage( Actor page, bool useTextLabel )
256   {
257     Size stageSize( Stage::GetCurrent().GetSize() );
258     const float scaledHeight = stageSize.y * PAGE_SCALE_FACTOR_Y;
259     const float scaledWidth = stageSize.x * PAGE_SCALE_FACTOR_X;
260     const float PADDING = stageSize.y / 64.0f;
261     const float ROW_HEIGHT = ( scaledHeight - (PADDING*2.0f) ) / static_cast<float>( mConfig.mRows );
262     const float COL_WIDTH = ( scaledWidth - (PADDING*2.0f) ) / static_cast<float>( mConfig.mCols );
263
264     Vector2 dpi = Stage::GetCurrent().GetDpi();
265
266     static int currentIconIndex = 0;
267
268     for( int y = 0; y < mConfig.mRows; ++y )
269     {
270       for( int x = 0; x < mConfig.mCols; ++x )
271       {
272         // Create parent icon view
273         Toolkit::Control iconView = Toolkit::Control::New();
274         iconView.SetAnchorPoint( AnchorPoint::TOP_LEFT );
275         iconView.SetParentOrigin( ParentOrigin::TOP_LEFT );
276
277         if( !mConfig.mTableViewEnabled )
278         {
279           float rowX = x * COL_WIDTH + PADDING;
280           float rowY = y * ROW_HEIGHT + PADDING;
281           iconView.SetSize( Vector3( COL_WIDTH, ROW_HEIGHT, 1.0f ) );
282           iconView.SetPosition( Vector3( rowX, rowY, 0.0f ) );
283         }
284         else
285         {
286           iconView.SetResizePolicy( ResizePolicy::SIZE_RELATIVE_TO_PARENT, Dimension::ALL_DIMENSIONS );
287           iconView.SetSizeScalePolicy( SizeScalePolicy::FIT_WITH_ASPECT_RATIO );
288         }
289
290         Actor icon;
291
292         switch( mConfig.mIconType )
293         {
294           case CHECKBOX:
295           {
296             icon = CreateButton( currentIconIndex );
297             break;
298           }
299           case IMAGEVIEW:
300           {
301             icon = CreateImageView( currentIconIndex );
302             break;
303           }
304         }
305
306         if( mConfig.mIconLabelsEnabled )
307         {
308           // create label
309           if( useTextLabel )
310           {
311             Toolkit::TextLabel textLabel = Toolkit::TextLabel::New( DEMO_APPS_NAMES[currentIconIndex] );
312             textLabel.SetAnchorPoint( AnchorPoint::TOP_CENTER );
313             textLabel.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
314             textLabel.SetResizePolicy( ResizePolicy::USE_NATURAL_SIZE, Dimension::ALL_DIMENSIONS );
315             textLabel.SetProperty( Toolkit::TextLabel::Property::TEXT_COLOR, Vector4( 1.0f, 1.0f, 1.0f, 1.0f ) ); // White.
316             textLabel.SetProperty( Toolkit::TextLabel::Property::POINT_SIZE, ( ( static_cast<float>( ROW_HEIGHT * LABEL_AREA ) * 72.0f )  / dpi.y ) * 0.25f );
317             textLabel.SetProperty( Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT, "CENTER" );
318             textLabel.SetProperty( Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT, "TOP" );
319             icon.Add( textLabel );
320           }
321           else
322           {
323             Property::Map map;
324             map.Add( Toolkit::Visual::Property::TYPE, Toolkit::Visual::TEXT ).
325               Add( Toolkit::TextVisual::Property::TEXT, DEMO_APPS_NAMES[currentIconIndex] ).
326               Add( Toolkit::TextVisual::Property::TEXT_COLOR, Color::WHITE ).
327               Add( Toolkit::TextVisual::Property::POINT_SIZE, ( ( static_cast<float>( ROW_HEIGHT * LABEL_AREA ) * 72.0f )  / dpi.y ) * 0.25f ).
328               Add( Toolkit::TextVisual::Property::HORIZONTAL_ALIGNMENT, "CENTER" ).
329               Add( Toolkit::TextVisual::Property::VERTICAL_ALIGNMENT, "TOP" );
330
331             Toolkit::Control control = Toolkit::Control::New();
332             control.SetProperty( Toolkit::Control::Property::BACKGROUND, map );
333             control.SetAnchorPoint( AnchorPoint::TOP_CENTER );
334             control.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
335             icon.Add( control );
336           }
337         }
338
339         iconView.Add( icon );
340         page.Add( iconView );
341
342         // We only have images and names for a certain number of icons.
343         // Wrap around if we have used them all.
344         if( ++currentIconIndex == TOTAL_ICON_DEFINITIONS )
345         {
346           currentIconIndex = 0;
347         }
348       }
349     }
350   }
351
352   void CreateScript()
353   {
354     const int lastPage = mConfig.mPageCount - 1;
355     const int halfA = lastPage / 2;
356     const int halfB = lastPage / 2 + lastPage % 2;
357     mScriptFrameData.push_back( ScriptData( lastPage,  1.5f, true  ) );
358     mScriptFrameData.push_back( ScriptData( -lastPage, 1.5f, true  ) );
359     mScriptFrameData.push_back( ScriptData( halfA,     1.0f, true  ) );
360     mScriptFrameData.push_back( ScriptData( halfB,     1.0f, true  ) );
361     mScriptFrameData.push_back( ScriptData( -lastPage, 0.5f, false ) );
362     mScriptFrameData.push_back( ScriptData( halfA,     0.5f, false ) );
363     mScriptFrameData.push_back( ScriptData( halfB,     1.0f, true  ) );
364     mScriptFrameData.push_back( ScriptData( -halfA,    1.0f, true  ) );
365     mScriptFrameData.push_back( ScriptData( 1,         0.1f, true  ) );
366     mScriptFrameData.push_back( ScriptData( -1,        0.1f, true  ) );
367     mScriptFrameData.push_back( ScriptData( 1,         0.1f, true  ) );
368     mScriptFrameData.push_back( ScriptData( -1,        0.1f, true  ) );
369     mScriptFrameData.push_back( ScriptData( 1,         0.1f, true  ) );
370     mScriptFrameData.push_back( ScriptData( -1,        0.1f, true  ) );
371     mScriptFrameData.push_back( ScriptData( halfA,     1.0f, true  ) );
372   }
373
374   void PopulatePages()
375   {
376     Vector3 stageSize( Stage::GetCurrent().GetSize() );
377
378     for( int i = 0; i < mConfig.mPageCount; ++i )
379     {
380       // Create page.
381       Actor page = AddPage();
382
383       // Populate icons.
384       AddIconsToPage( page, mConfig.mUseTextLabel );
385
386       // Move page 'a little bit up'.
387       page.SetParentOrigin( ParentOrigin::CENTER );
388       page.SetAnchorPoint( AnchorPoint::CENTER );
389       page.SetPosition( Vector3( stageSize.x * i, 0.0f, 0.0f ) );
390       mScrollParent.Add( page );
391     }
392
393     mScrollParent.SetOpacity( 1.0f );
394     mScrollParent.SetScale( Vector3::ONE );
395
396     // Fade in.
397     ShowAnimation();
398   }
399
400   void ShowAnimation()
401   {
402     mShowAnimation = Animation::New( 1.0f );
403     mShowAnimation.AnimateTo( Property( mScrollParent, Actor::Property::COLOR_ALPHA ), 1.0f, AlphaFunction::EASE_IN_OUT );
404     mShowAnimation.AnimateTo( Property( mScrollParent, Actor::Property::SCALE ), Vector3::ONE, AlphaFunction::EASE_IN_OUT );
405     mShowAnimation.FinishedSignal().Connect( this, &HomescreenBenchmark::OnAnimationEnd );
406     mShowAnimation.Play();
407   }
408
409   void ScrollPages(int pages, float duration, bool flick)
410   {
411     duration *= PAGE_DURATION_SCALE_FACTOR;
412     Vector3 stageSize( Stage::GetCurrent().GetSize() );
413     mScrollAnimation = Animation::New( duration );
414     if( flick )
415     {
416       mScrollAnimation.AnimateBy( Property( mScrollParent, Actor::Property::POSITION ), Vector3( -stageSize.x * pages, 0.0f, 0.0f ), AlphaFunction::EASE_IN_OUT );
417     }
418     else
419     {
420       int totalPages = abs( pages );
421       for( int i = 0; i < totalPages; ++i )
422       {
423         mScrollAnimation.AnimateBy( Property( mScrollParent, Actor::Property::POSITION ), Vector3( pages < 0 ? stageSize.x : -stageSize.x, 0.0f, 0.0f ), AlphaFunction::EASE_IN_OUT, TimePeriod( duration * i, duration ) );
424       }
425     }
426     mScrollAnimation.FinishedSignal().Connect( this, &HomescreenBenchmark::OnAnimationEnd );
427     mScrollAnimation.Play();
428     mCurrentPage += pages;
429   }
430
431   void OnAnimationEnd( Animation& source )
432   {
433     if( mScriptFrame < mScriptFrameData.size() )
434     {
435       ScriptData& frame = mScriptFrameData[mScriptFrame];
436       ScrollPages( frame.mPages, frame.mDuration, frame.mFlick );
437       ++mScriptFrame;
438     }
439     else
440     {
441       mApplication.Quit();
442     }
443   }
444
445 private:
446
447   Application&                mApplication;
448   Actor                       mScrollParent;
449   Animation                   mShowAnimation;
450   Animation                   mScrollAnimation;
451   Config                      mConfig;
452   std::vector<ScriptData>     mScriptFrameData;
453   size_t                      mScriptFrame;
454   int                         mCurrentPage;
455 };
456
457 void RunTest( Application& application, const HomescreenBenchmark::Config& config, bool printHelpAndExit )
458 {
459   HomescreenBenchmark test( application, config );
460
461   if( printHelpAndExit )
462   {
463     PrintHelp( "c<num>",               " Number of columns" );
464     PrintHelp( "r<num>",               " Number of rows" );
465     PrintHelp( "p<num>",               " Number of pages ( must be greater than 1 )" );
466     PrintHelp( "-disable-tableview",   " Disables the use of TableView for layouting" );
467     PrintHelp( "-disable-icon-labels", " Disables labels for each icon" );
468     PrintHelp( "-use-checkbox",        " Uses checkboxes for icons" );
469     PrintHelp( "-use-text-label",      " Uses TextLabel instead of a TextVisual" );
470     return;
471   }
472
473   application.MainLoop();
474 }
475
476 // Entry point for Linux & Tizen applications.
477 int DALI_EXPORT_API main( int argc, char **argv )
478 {
479   // Default settings.
480   HomescreenBenchmark::Config config;
481
482   bool printHelpAndExit = false;
483
484   for( int i = 1 ; i < argc; ++i )
485   {
486     std::string arg( argv[i] );
487     if( arg.compare( 0, 2, "-r" ) == 0 )
488     {
489       config.mRows = atoi( arg.substr( 2 ).c_str() );
490     }
491     else if( arg.compare( 0, 2, "-c" ) == 0 )
492     {
493       config.mCols = atoi( arg.substr( 2 ).c_str() );
494     }
495     else if( arg.compare( 0, 2, "-p" ) == 0 )
496     {
497       config.mPageCount = atoi( arg.substr( 2 ).c_str() );
498     }
499     else if( arg.compare( "--disable-tableview" ) == 0 )
500     {
501       config.mTableViewEnabled = false;
502     }
503     else if( arg.compare( "--disable-icon-labels" ) == 0 )
504     {
505       config.mIconLabelsEnabled = false;
506     }
507     else if( arg.compare( "--use-checkbox" ) == 0 )
508     {
509       config.mIconType = CHECKBOX;
510     }
511     else if( arg.compare("--use-text-label" ) == 0)
512     {
513       config.mUseTextLabel = true;
514     }
515     else if( arg.compare( "--help" ) == 0 )
516     {
517       printHelpAndExit = true;
518     }
519   }
520
521   Application application = Application::New( &argc, &argv );
522
523   RunTest( application, config, printHelpAndExit );
524
525   return 0;
526 }