demo/dali-table-view.h

   1 #ifndef __DALI_DEMO_H__
   2 #define __DALI_DEMO_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 #include <map>
  22
  23 #include <dali/dali.h>
  24 #include <dali-toolkit/dali-toolkit.h>
  25 #include <dali-toolkit/devel-api/controls/popup/popup.h>
  26
  27 class Example;
  28
  29 typedef std::vector<Example> ExampleList;
  30 typedef std::map<std::string,Example> ExampleMap;
  31 typedef ExampleList::iterator ExampleListIter;
  32 typedef ExampleList::const_iterator ExampleListConstIter;
  33 typedef ExampleMap::iterator ExampleMapIter;
  34 typedef ExampleMap::const_iterator ExampleMapConstIter;
  35
  36 typedef std::vector<Dali::Toolkit::TableView> TableViewList;
  37 typedef TableViewList::iterator TableViewListIter;
  38 typedef TableViewList::const_iterator TableViewListConstIter;
  39
  40 typedef std::vector<Dali::ImageActor> ImageActorList;
  41 typedef ImageActorList::iterator ImageActorListIter;
  42 typedef ImageActorList::const_iterator ImageActorListConstIter;
  43
  44 typedef std::vector<Dali::Animation> AnimationList;
  45 typedef AnimationList::iterator AnimationListIter;
  46 typedef AnimationList::const_iterator AnimationListConstIter;
  47
  48
  49 /**
  50  * Example information
  51  *
  52  * Represents a single Example.
  53  */
  54 struct Example
  55 {
  56   // Constructors
  57
  58   /**
  59    * @param[in] name unique name of example
  60    * @param[in] title The caption for the example to appear on a tile button.
  61    */
  62   Example(std::string name, std::string title)
  63   : name(name),
  64     title(title)
  65   {
  66   }
  67
  68   Example()
  69   {
  70   }
  71
  72   // Data
  73
  74   std::string name;                       ///< unique name of example
  75   std::string title;                      ///< title (caption) of example to appear on tile button.
  76 };
  77
  78
  79
  80 /**
  81  * Dali-Demo instance
  82  */
  83 class DaliTableView : public Dali::ConnectionTracker
  84 {
  85 public:
  86
  87   DaliTableView(Dali::Application& application);
  88   ~DaliTableView();
  89
  90 public:
  91
  92   /**
  93    * Adds an Example to our demo showcase
  94    *
  95    * @param[in] example The Example description.
  96    *
  97    * @note Should be called before the Application MainLoop is started.
  98    */
  99   void AddExample(Example example);
 100
 101   /**
 102    * Sets the background image PATH.
 103    *
 104    * @param[in] imagePath The file path to the image to use as the background.
 105    *
 106    * @note Should be called before the Application MainLoop is started.
 107    */
 108   void SetBackgroundPath( std::string imagePath );
 109
 110   /**
 111    * Sorts the example list alphabetically by Title if parameter is true.
 112    *
 113    * @param[in] sortAlphabetically If true, example list is sorted alphabetically.
 114    *
 115    * @note Should be called before the Application MainLoop is started.
 116    * @note By default the examples are NOT sorted alphabetically by Title.
 117    */
 118   void SortAlphabetically( bool sortAlphabetically );
 119
 120 private: // Application callbacks & implementation
 121
 122   /**
 123    * Shape enum for create function
 124    */
 125   enum ShapeType
 126   {
 127     CIRCLE,
 128     SQUARE
 129   };
 130
 131   /**
 132    * Initialize application.
 133    *
 134    * @param[in] app Application instance
 135    */
 136   void Initialize( Dali::Application& app );
 137
 138   /**
 139    * Populates the contents (ScrollView) with all the
 140    * Examples that have been Added using the AddExample(...)
 141    * call
 142    */
 143   void Populate();
 144
 145   /**
 146    * Rotate callback from the device.
 147    *
 148    * @param[in] orientation that device notified.
 149    */
 150   void OrientationChanged( Dali::Orientation orientation );
 151
 152   /**
 153    * Rotates RootActor orientation to that specified.
 154    *
 155    * @param[in] degrees The requested angle.
 156    */
 157   void Rotate( unsigned int degrees );
 158
 159   /**
 160    * Creates a tile for the main menu and toolbar.
 161    *
 162    * @param[in] name The unique name for this Tile
 163    * @param[in] title The text caption that appears on the Tile
 164    * @param[in] parentSize Tile's parent size.
 165    * @param[in] addBackground Whether to add a background graphic to the tile or not
 166    *
 167    * @return The Actor for the created tile.
 168    */
 169   Dali::Actor CreateTile( const std::string& name, const std::string& title, const Dali::Vector3& sizeMultiplier, bool addBackground );
 170
 171   /**
 172    * Create a stencil image
 173    *
 174    * @return The stencil image
 175    */
 176   Dali::ImageActor NewStencilImage();
 177
 178   // Signal handlers
 179
 180   /**
 181    * Signal emitted when any tile has been pressed
 182    *
 183    * @param[in] actor The Actor representing this tile.
 184    * @param[in] event The TouchEvent
 185    *
 186    * @return Consume flag
 187    */
 188   bool OnTilePressed( Dali::Actor actor, const Dali::TouchEvent& event );
 189
 190   /**
 191    * Signal emitted when any tile has been hovered
 192    *
 193    * @param[in] actor The Actor representing this tile.
 194    * @param[in] event The HoverEvent
 195    *
 196    * @return Consume flag
 197    */
 198   bool OnTileHovered( Dali::Actor actor, const Dali::HoverEvent& event );
 199
 200   /**
 201    * Signal emitted when the pressed animation has completed.
 202    *
 203    * @param[in] source The animation source.
 204    */
 205   void OnPressedAnimationFinished(Dali::Animation& source);
 206
 207   /**
 208    * Signal emitted when the button has been clicked
 209    *
 210    * @param[in] button The Button that is clicked.
 211    *
 212    * @return Consume flag
 213    */
 214   bool OnButtonClicked( Dali::Toolkit::Button& button );
 215
 216   /**
 217    * Signal emitted when scrolling has started.
 218    *
 219    * @param[in] position The current position of the scroll contents.
 220    */
 221   void OnScrollStart(const Dali::Vector2& position);
 222
 223   /**
 224    * Signal emitted when scrolling has completed.
 225    *
 226    * @param[in] position The current position of the scroll contents.
 227    */
 228   void OnScrollComplete(const Dali::Vector2& position);
 229
 230   /**
 231    * Signal emitted when any Sensitive Actor has been touched
 232    * (other than those touches consumed by OnTilePressed)
 233    *
 234    * @param[in] actor The Actor touched.
 235    * @param[in] event The TouchEvent
 236    *
 237    * @return Consume flag
 238    */
 239   bool OnScrollTouched( Dali::Actor actor, const Dali::TouchEvent& event );
 240
 241   /**
 242    * Setup the effect on the scroll view
 243    */
 244   void ApplyScrollViewEffect();
 245
 246   /**
 247    * Apply the cube effect to all the page actors
 248    */
 249   void ApplyCubeEffectToPages();
 250
 251   /**
 252    * Setup the inner cube effect
 253    */
 254   void SetupInnerPageCubeEffect();
 255
 256   /**
 257    * Apply a shader effect to a table tile
 258    */
 259   void ApplyEffectToTile(Dali::Actor tile);
 260
 261   /**
 262    * Apply effect to the content of a tile
 263    */
 264   void ApplyEffectToTileContent(Dali::Actor tileContent);
 265
 266   /**
 267    * Key event handler
 268    */
 269   void OnKeyEvent( const Dali::KeyEvent& event );
 270
 271   /**
 272    * Create a depth field background
 273    *
 274    * @param[in] bubbleLayer Add the graphics to this layer
 275    */
 276   void SetupBackground( Dali::Actor bubbleLayer );
 277
 278   /**
 279    * Create background actors for the given layer
 280    *
 281    * @param[in] layer The layer to add the actors to
 282    * @param[in] count The number of actors to generate
 283    * @param[in] distanceField The distance field bitmap to use
 284    */
 285   void AddBackgroundActors( Dali::Actor layer, int count, Dali::BufferImage distanceField );
 286
 287   /**
 288    * Create a bitmap with the specified shape and also output a distance field
 289    *
 290    * @param[in] shapeType The shape to generate
 291    * @param[in] size The size of the bitmap to create
 292    * @param[out] distanceFieldOut The return depth field alpha map
 293    */
 294   void CreateShapeImage( ShapeType shapeType, const Dali::Size& size, Dali::BufferImage& distanceFieldOut );
 295
 296   /**
 297    * Generate a square bit pattern and depth field
 298    *
 299    * @param[in] size The size of the bitmap to create
 300    * @param[out] imageOut The return bitmap
 301    * @param[out] distanceFieldOut The return depth field alpha map
 302    */
 303   void GenerateSquare( const Dali::Size& size, std::vector<unsigned char>& distanceFieldOut );
 304
 305   /**
 306    * Generate a circle bit pattern and depth field
 307    *
 308    * @param[in] size The size of the bitmap to create
 309    * @param[out] imageOut The return bitmap
 310    * @param[out] distanceFieldOut The return depth field alpha map
 311    */
 312   void GenerateCircle( const Dali::Size& size, std::vector<unsigned char>& distanceFieldOut );
 313
 314   /**
 315    * Creates the logo.
 316    *
 317    * @param[in] imagePath The path to the image file to load
 318    *
 319    * @return The created image actor
 320    */
 321   Dali::ImageActor CreateLogo( std::string imagePath );
 322
 323   /**
 324    * Timer handler for ending background animation
 325    *
 326    * @return Return value for timer handler
 327    */
 328   bool PauseBackgroundAnimation();
 329
 330   /**
 331    * Pause all animations
 332    */
 333   void PauseAnimation();
 334
 335   /**
 336    * Resume all animations
 337    */
 338   void PlayAnimation();
 339
 340   /**
 341    * Callback when the keyboard focus is going to be changed.
 342    *
 343    * @param[in] current The current focused actor
 344    * @param[in] proposed The actor proposed by the keyboard focus manager to move the focus to
 345    * @param[in] direction The direction to move the focus
 346    * @return The actor to move the keyboard focus to.
 347    */
 348   Dali::Actor OnKeyboardPreFocusChange( Dali::Actor current, Dali::Actor proposed, Dali::Toolkit::Control::KeyboardFocus::Direction direction );
 349
 350   /**
 351    * Callback when the keyboard focused actor is activated.
 352    *
 353    * @param[in] activatedActor The activated actor
 354    */
 355   void OnFocusedActorActivated( Dali::Actor activatedActor );
 356
 357   /**
 358    * Called when the logo is tapped
 359    *
 360    * @param[in]  actor  The tapped actor
 361    * @param[in]  tap    The tap information.
 362    */
 363   void OnLogoTapped( Dali::Actor actor, const Dali::TapGesture& tap );
 364
 365   /**
 366    * Hides the popup
 367    */
 368   void HideVersionPopup();
 369
 370   /**
 371    * Called when the popup is completely hidden
 372    */
 373   void PopupHidden();
 374
 375  /*
 376   * @brief Callback called when the buttons page actor is relaid out
 377   *
 378   * @param[in] actor The page actor
 379   */
 380  void OnButtonsPageRelayout( const Dali::Actor& actor );
 381
 382  /**
 383   * @brief Callback called to set up background actors
 384   *
 385   * @param[in] actor The actor raising the callback
 386   */
 387  void InitialiseBackgroundActors( Dali::Actor actor );
 388
 389 private:
 390
 391   Dali::Application&              mApplication;              ///< Application instance.
 392   Dali::Layer                     mBackgroundLayer;          ///< Background resides on a separate layer.
 393   Dali::Toolkit::TableView        mRootActor;                ///< All content (excluding background is anchored to this Actor)
 394   Dali::Animation                 mRotateAnimation;          ///< Animation to rotate and resize mRootActor.
 395   Dali::ImageActor                mBackground;               ///< Background's static image.
 396   Dali::Animation                 mPressedAnimation;         ///< Button press scaling animation.
 397   Dali::Layer                     mScrollViewLayer;          ///< ScrollView resides on a separate layer.
 398   Dali::Toolkit::ScrollView       mScrollView;               ///< ScrollView container (for all Examples)
 399   Dali::Toolkit::ScrollViewEffect mScrollViewEffect;         ///< Effect to be applied to the scroll view
 400   Dali::Toolkit::RulerPtr         mScrollRulerX;             ///< ScrollView X (horizontal) ruler
 401   Dali::Toolkit::RulerPtr         mScrollRulerY;             ///< ScrollView Y (vertical) ruler
 402   Dali::Toolkit::TableView        mButtons;                  ///< Navigation buttons
 403   Dali::Actor                     mPressedActor;             ///< The currently pressed actor.
 404   Dali::Timer                     mAnimationTimer;           ///< Timer used to turn off animation after a specific time period
 405   Dali::TapGestureDetector        mLogoTapDetector;          ///< To detect taps on the logo
 406   Dali::Toolkit::Popup            mVersionPopup;             ///< Displays DALi library version information
 407   Dali::Vector3                   mButtonsPageRelativeSize;  ///< Size of a buttons page relative to the stage size
 408
 409   std::vector< Dali::Actor >      mPages;                    ///< List of pages.
 410   std::vector< Dali::Actor >      mTableViewImages;          ///< Offscreen render of tableview
 411   std::vector< Dali::Actor >      mBackgroundActors;         ///< List of background actors used in the effect
 412   AnimationList                   mBackgroundAnimations;     ///< List of background bubble animations
 413   ExampleList                     mExampleList;              ///< List of examples.
 414   ExampleMap                      mExampleMap;               ///< Map LUT for examples.
 415
 416   std::string                     mBackgroundImagePath;      ///< The path to the background image.
 417   int                             mTotalPages;               ///< Total pages within scrollview.
 418
 419   bool                            mScrolling:1;              ///< Flag indicating whether view is currently being scrolled
 420   bool                            mSortAlphabetically:1;     ///< Sort examples alphabetically.
 421   bool                            mBackgroundAnimsPlaying:1; ///< Are background animations playing
 422   bool                            mVersionPopupShown:1;      ///< Whehter the version popup is shown or not
 423
 424 };
 425
 426 #endif // __DALI_DEMO_H__