examples/cube-transition-effect/cube-transition-effect-example.cpp

   1 /*
   2  * Copyright (c) 2014 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 <math.h>
  20
  21 // INTERNAL INCLUDES
  22 #include "shared/view.h"
  23
  24 #include <dali/dali.h>
  25 #include <dali-toolkit/dali-toolkit.h>
  26
  27 using namespace Dali;
  28
  29 using Dali::Toolkit::TextLabel;
  30
  31 // LOCAL STUFF
  32 namespace
  33 {
  34
  35 const char * const TOOLBAR_IMAGE( DALI_IMAGE_DIR "top-bar.png" );
  36 const char * const APPLICATION_TITLE_WAVE( "Cube Transition: Wave" );
  37 const char * const APPLICATION_TITLE_CROSS( "Cube Transition: Cross" );
  38 const char * const APPLICATION_TITLE_FOLD( "Cube Transition: Fold" );
  39 const char * const EFFECT_WAVE_IMAGE( DALI_IMAGE_DIR "icon-effect-wave.png" );
  40 const char * const EFFECT_CROSS_IMAGE( DALI_IMAGE_DIR "icon-effect-cross.png" );
  41 const char * const EFFECT_FOLD_IMAGE( DALI_IMAGE_DIR "icon-effect-fold.png" );
  42 const char * const SLIDE_SHOW_START_ICON( DALI_IMAGE_DIR "icon-play.png" );
  43 const char * const SLIDE_SHOW_STOP_ICON( DALI_IMAGE_DIR "icon-stop.png" );
  44
  45 const char* IMAGES[] =
  46 {
  47   DALI_IMAGE_DIR "gallery-large-1.jpg",
  48   DALI_IMAGE_DIR "gallery-large-2.jpg",
  49   DALI_IMAGE_DIR "gallery-large-3.jpg",
  50   DALI_IMAGE_DIR "gallery-large-4.jpg",
  51   DALI_IMAGE_DIR "gallery-large-5.jpg",
  52   DALI_IMAGE_DIR "gallery-large-6.jpg",
  53   DALI_IMAGE_DIR "gallery-large-7.jpg",
  54   DALI_IMAGE_DIR "gallery-large-8.jpg",
  55   DALI_IMAGE_DIR "gallery-large-9.jpg",
  56   DALI_IMAGE_DIR "gallery-large-10.jpg",
  57   DALI_IMAGE_DIR "gallery-large-11.jpg",
  58   DALI_IMAGE_DIR "gallery-large-12.jpg",
  59   DALI_IMAGE_DIR "gallery-large-13.jpg",
  60   DALI_IMAGE_DIR "gallery-large-14.jpg",
  61   DALI_IMAGE_DIR "gallery-large-15.jpg",
  62   DALI_IMAGE_DIR "gallery-large-16.jpg",
  63   DALI_IMAGE_DIR "gallery-large-17.jpg",
  64   DALI_IMAGE_DIR "gallery-large-18.jpg",
  65   DALI_IMAGE_DIR "gallery-large-19.jpg",
  66   DALI_IMAGE_DIR "gallery-large-20.jpg",
  67   DALI_IMAGE_DIR "gallery-large-21.jpg",
  68 };
  69 const int NUM_IMAGES( sizeof(IMAGES) / sizeof(IMAGES[0]) );
  70
  71 // the number of cubes: NUM_COLUMNS*NUM_ROWS
  72 // better choose the numbers that can divide viewAreaSize.x
  73 const int NUM_COLUMNS_WAVE(16);
  74 const int NUM_COLUMNS_CROSS(8);
  75 const int NUM_COLUMNS_FOLD(8);
  76 // better choose the numbers that can divide viewAreaSize.y
  77 const int NUM_ROWS_WAVE(20);
  78 const int NUM_ROWS_CROSS(10);
  79 const int NUM_ROWS_FOLD(10);
  80 //transition effect duration
  81 const float ANIMATION_DURATION_WAVE(1.5f);
  82 const float ANIMATION_DURATION_CROSS(1.f);
  83 const float ANIMATION_DURATION_FOLD(1.f);
  84 //transition effect displacement
  85 const float CUBE_DISPLACEMENT_WAVE(70.f);
  86 const float CUBE_DISPLACEMENT_CROSS(30.f);
  87
  88 // The duration of the current image staying on screen when slideshow is on
  89 const int VIEWINGTIME = 2000; // 2 seconds
  90
  91 /**
  92  * @brief Load an image, scaled-down to no more than the stage dimensions.
  93  *
  94  * Uses image scaling mode ImageAttributes::ScaleToFill to resize the image at
  95  * load time to cover the entire stage with pixels with no borders,
  96  * and filter mode ImageAttributes::BoxThenLinear to sample the image with
  97  * maximum quality.
  98  */
  99 ResourceImage LoadStageFillingImage( const char * const imagePath )
 100 {
 101   Size stageSize = Stage::GetCurrent().GetSize();
 102   ImageAttributes attributes;
 103   attributes.SetSize( stageSize.x, stageSize.y );
 104   attributes.SetFilterMode( ImageAttributes::BoxThenLinear );
 105   attributes.SetScalingMode( ImageAttributes::ScaleToFill );
 106   return ResourceImage::New( imagePath, attributes );
 107 }
 108
 109 } // namespace
 110
 111 class CubeTransitionApp : public ConnectionTracker
 112 {
 113 public:
 114
 115   /**
 116    * Constructor
 117    * @param application class, stored as reference
 118    */
 119   CubeTransitionApp( Application& application );
 120
 121   ~CubeTransitionApp();
 122
 123 private:
 124
 125   /**
 126    * This method gets called once the main loop of application is up and running
 127    */
 128   void OnInit( Application& application );
 129   /**
 130    * PanGesture callback. This method gets called when the pan gesture is detected.
 131    * @param[in] actor The actor receiving the pan gesture.
 132    * @param[in] gesture The detected pan gesture.
 133    */
 134   void OnPanGesture( Actor actor, const PanGesture& gesture );
 135   /**
 136    * Load the next image and start the transition;
 137    */
 138   void GoToNextImage();
 139   /**
 140    * Callback function of image resource loading succeed
 141    * Start the transition
 142    * @param[in] image The image content of the imageActor for transition
 143    */
 144   void OnImageLoaded(ResourceImage image);
 145   /**
 146    * Main key event handler
 147    */
 148   void OnKeyEvent(const KeyEvent& event);
 149   /**
 150    * Callback function of effect-switch button
 151    * Change the effect when the effect button is clicked
 152    * @param[in] button The handle of the clicked button
 153    */
 154   bool OnEffectButtonClicked( Toolkit::Button button );
 155   /**
 156    * Callback function of slideshow button
 157    * Start or stop the automatical image display when the slideshow button is clicked
 158    * @param[in] button The handle of the clicked button
 159    */
 160   bool OnSildeshowButtonClicked( Toolkit::Button button );
 161   /**
 162    * Callback function of cube transition completed signal
 163    * @param[in] effect The cube effect used for the transition
 164    * @param[in] imageActor The target imageActor of the completed transition
 165    */
 166   void OnTransitionCompleted(Toolkit::CubeTransitionEffect effect, ImageActor imageActor);
 167   /**
 168    * Callback function of timer tick
 169    * The timer is used to count the image display duration in slideshow,
 170    */
 171   bool OnTimerTick();
 172
 173 private:
 174   Application&                    mApplication;
 175   Toolkit::View                   mView;
 176   Toolkit::ToolBar                mToolBar;
 177   Layer                           mContent;
 178   Toolkit::TextLabel              mTitleActor;
 179   Actor                           mParent;
 180
 181   Vector2                         mViewSize;
 182
 183   ImageActor                      mCurrentImage;
 184   ImageActor                      mNextImage;
 185   unsigned int                    mIndex;
 186   bool                            mIsImageLoading;
 187   Constraint                      mImageConstraint;
 188
 189   PanGestureDetector              mPanGestureDetector;
 190
 191   Toolkit::CubeTransitionEffect   mCubeWaveEffect;
 192   Toolkit::CubeTransitionEffect   mCubeCrossEffect;
 193   Toolkit::CubeTransitionEffect   mCubeFoldEffect;
 194   Toolkit::CubeTransitionEffect   mCurrentEffect;
 195
 196   bool                            mSlideshow;
 197   Timer                           mViewTimer;
 198   Toolkit::PushButton             mSlideshowButton;
 199   Image                           mIconSlideshowStart;
 200   Image                           mIconSlideshowStop;
 201
 202   Vector2                         mPanPosition;
 203   Vector2                         mPanDisplacement;
 204
 205   Image                           mImageWave;
 206   Image                           mImageCross;
 207   Image                           mImageFold;
 208   Toolkit::PushButton             mEffectChangeButton;
 209 };
 210
 211 CubeTransitionApp::CubeTransitionApp( Application& application )
 212 : mApplication( application ),
 213   mIndex( 0 ),
 214   mIsImageLoading( false ),
 215   mSlideshow( false )
 216 {
 217   mApplication.InitSignal().Connect( this, &CubeTransitionApp::OnInit );
 218 }
 219
 220 CubeTransitionApp::~CubeTransitionApp()
 221 {
 222   //Nothing to do
 223 }
 224
 225 void CubeTransitionApp::OnInit( Application& application )
 226 {
 227   DemoHelper::RequestThemeChange();
 228
 229   Stage::GetCurrent().KeyEventSignal().Connect(this, &CubeTransitionApp::OnKeyEvent);
 230
 231   // Creates a default view with a default tool bar, the view is added to the stage.
 232   mContent = DemoHelper::CreateView( application, mView, mToolBar, "", TOOLBAR_IMAGE, "" );
 233
 234   // Add an effect-changing button on the right of the tool bar.
 235   mImageWave = ResourceImage::New( EFFECT_WAVE_IMAGE );
 236   mImageCross = ResourceImage::New( EFFECT_CROSS_IMAGE );
 237   mImageFold = ResourceImage::New( EFFECT_FOLD_IMAGE );
 238   mEffectChangeButton = Toolkit::PushButton::New();
 239   mEffectChangeButton.SetBackgroundImage(mImageWave);
 240   mEffectChangeButton.ClickedSignal().Connect( this, &CubeTransitionApp::OnEffectButtonClicked );
 241   mToolBar.AddControl( mEffectChangeButton, DemoHelper::DEFAULT_VIEW_STYLE.mToolBarButtonPercentage, Toolkit::Alignment::HorizontalRight, DemoHelper::DEFAULT_MODE_SWITCH_PADDING );
 242
 243   // Add title to the tool bar.
 244   mTitleActor = DemoHelper::CreateToolBarLabel( APPLICATION_TITLE_WAVE );
 245   mToolBar.AddControl( mTitleActor, DemoHelper::DEFAULT_VIEW_STYLE.mToolBarTitlePercentage, Toolkit::Alignment::HorizontalCenter );
 246
 247   //Add an slideshow icon on the right of the title
 248   mIconSlideshowStart = ResourceImage::New( SLIDE_SHOW_START_ICON );
 249   mIconSlideshowStop = ResourceImage::New( SLIDE_SHOW_STOP_ICON );
 250   mSlideshowButton = Toolkit::PushButton::New();
 251   mSlideshowButton.SetBackgroundImage( mIconSlideshowStart );
 252   mSlideshowButton.ClickedSignal().Connect( this, &CubeTransitionApp::OnSildeshowButtonClicked );
 253   mToolBar.AddControl( mSlideshowButton, DemoHelper::DEFAULT_VIEW_STYLE.mToolBarButtonPercentage, Toolkit::Alignment::HorizontalCenter, DemoHelper::DEFAULT_PLAY_PADDING );
 254
 255   // Set size to stage size to avoid seeing a black border on transition
 256   mViewSize = Stage::GetCurrent().GetSize();
 257
 258   mParent = Actor::New();
 259   mParent.SetSize( mViewSize );
 260   mParent.SetPositionInheritanceMode( USE_PARENT_POSITION );
 261   mContent.Add( mParent );
 262
 263   // use pan gesture to detect the cursor or finger movement
 264   mPanGestureDetector = PanGestureDetector::New();
 265   mPanGestureDetector.DetectedSignal().Connect( this, &CubeTransitionApp::OnPanGesture );
 266   mPanGestureDetector.Attach( mParent );
 267
 268   //use small cubes
 269   mCubeWaveEffect = Toolkit::CubeTransitionWaveEffect::New(NUM_ROWS_WAVE, NUM_COLUMNS_WAVE, mViewSize);
 270   mCubeWaveEffect.SetTransitionDuration( ANIMATION_DURATION_WAVE );
 271   mCubeWaveEffect.SetCubeDisplacement( CUBE_DISPLACEMENT_WAVE );
 272   mCubeWaveEffect.TransitionCompletedSignal().Connect(this, &CubeTransitionApp::OnTransitionCompleted);
 273   mParent.Add(mCubeWaveEffect.GetRoot());
 274   // use big cubes
 275   mCubeCrossEffect = Toolkit::CubeTransitionCrossEffect::New(NUM_ROWS_CROSS, NUM_COLUMNS_CROSS, mViewSize);
 276   mCubeCrossEffect.SetTransitionDuration( ANIMATION_DURATION_CROSS);
 277   mCubeCrossEffect.SetCubeDisplacement( CUBE_DISPLACEMENT_CROSS );
 278   mCubeCrossEffect.TransitionCompletedSignal().Connect(this, &CubeTransitionApp::OnTransitionCompleted);
 279   mParent.Add(mCubeCrossEffect.GetRoot());
 280
 281   mCubeFoldEffect = Toolkit::CubeTransitionFoldEffect::New(NUM_ROWS_FOLD, NUM_COLUMNS_FOLD, mViewSize);
 282   mCubeFoldEffect.SetTransitionDuration( ANIMATION_DURATION_FOLD);
 283   mCubeFoldEffect.TransitionCompletedSignal().Connect(this, &CubeTransitionApp::OnTransitionCompleted);
 284   mParent.Add(mCubeFoldEffect.GetRoot());
 285
 286   mViewTimer = Timer::New( VIEWINGTIME );
 287   mViewTimer.TickSignal().Connect( this, &CubeTransitionApp::OnTimerTick );
 288
 289   // show the first image
 290   mImageConstraint = Constraint::New<Vector3>( Actor::Property::SCALE, LocalSource( Actor::Property::SIZE ), ParentSource( Actor::Property::SIZE ), ScaleToFitKeepAspectRatioConstraint() );
 291
 292   mCurrentImage = ImageActor::New( LoadStageFillingImage( IMAGES[mIndex] ) );
 293   mCurrentImage.SetPositionInheritanceMode( USE_PARENT_POSITION );
 294   mCurrentImage.ApplyConstraint( mImageConstraint );
 295   mCurrentImage.SetRelayoutEnabled( false );
 296   mParent.Add( mCurrentImage );
 297
 298   mCurrentEffect = mCubeWaveEffect;
 299   mCurrentEffect.SetCurrentImage( mCurrentImage );
 300 }
 301
 302 // signal handler, called when the pan gesture is detected
 303 void CubeTransitionApp::OnPanGesture( Actor actor, const PanGesture& gesture )
 304 {
 305   // does not response when the transition has not finished
 306   if( mIsImageLoading || mCubeWaveEffect.IsTransiting() || mCubeCrossEffect.IsTransiting() || mCubeFoldEffect.IsTransiting() || mSlideshow )
 307   {
 308     return;
 309   }
 310
 311   if( gesture.state == Gesture::Continuing )
 312   {
 313     if( gesture.displacement.x < 0)
 314     {
 315       mIndex = (mIndex + 1)%NUM_IMAGES;
 316     }
 317     else
 318     {
 319       mIndex = (mIndex + NUM_IMAGES -1)%NUM_IMAGES;
 320     }
 321
 322     mPanPosition = gesture.position;
 323     mPanDisplacement = gesture.displacement;
 324     GoToNextImage();
 325   }
 326 }
 327
 328 void CubeTransitionApp::GoToNextImage()
 329 {
 330   ResourceImage image = LoadStageFillingImage( IMAGES[ mIndex ] );
 331   mNextImage = ImageActor::New( image );
 332
 333   mNextImage.SetPositionInheritanceMode(USE_PARENT_POSITION);
 334   mNextImage.ApplyConstraint( mImageConstraint );
 335   mNextImage.SetRelayoutEnabled( false );
 336   mCurrentEffect.SetTargetImage(mNextImage);
 337   if( image.GetLoadingState() == ResourceLoadingSucceeded )
 338   {
 339     mIsImageLoading = false;
 340     OnImageLoaded( image );
 341   }
 342   else
 343   {
 344     mIsImageLoading = true;
 345     image.LoadingFinishedSignal().Connect( this, &CubeTransitionApp::OnImageLoaded );
 346   }
 347 }
 348
 349 void CubeTransitionApp::OnImageLoaded(ResourceImage image)
 350 {
 351    mIsImageLoading = false;
 352    mCurrentEffect.StartTransition( mPanPosition, mPanDisplacement );
 353    mParent.Remove(mCurrentImage);
 354    mParent.Add(mNextImage);
 355    mCurrentImage = mNextImage;
 356 }
 357
 358 bool CubeTransitionApp::OnEffectButtonClicked( Toolkit::Button button )
 359 {
 360   if(mCurrentEffect == mCubeWaveEffect)
 361   {
 362     mCurrentEffect = mCubeCrossEffect;
 363     mTitleActor.SetProperty( TextLabel::Property::TEXT, std::string(APPLICATION_TITLE_CROSS) );
 364     mEffectChangeButton.SetBackgroundImage(mImageCross);
 365
 366   }
 367   else if(mCurrentEffect == mCubeCrossEffect)
 368   {
 369     mCurrentEffect = mCubeFoldEffect;
 370     mTitleActor.SetProperty( TextLabel::Property::TEXT, std::string(APPLICATION_TITLE_FOLD) );
 371     mEffectChangeButton.SetBackgroundImage(mImageFold);
 372   }
 373   else
 374   {
 375     mCurrentEffect = mCubeWaveEffect;
 376     mTitleActor.SetProperty( TextLabel::Property::TEXT, std::string(APPLICATION_TITLE_WAVE) );
 377     mEffectChangeButton.SetBackgroundImage(mImageWave);
 378   }
 379
 380   // Set the current image to cube transition effect
 381   // only need to set at beginning or change from another effect
 382   mCurrentEffect.SetCurrentImage(mCurrentImage);
 383   return true;
 384 }
 385
 386 bool CubeTransitionApp::OnSildeshowButtonClicked( Toolkit::Button button )
 387 {
 388   mSlideshow = !mSlideshow;
 389   if( mSlideshow )
 390   {
 391     mPanGestureDetector.Detach( mParent );
 392     mSlideshowButton.SetBackgroundImage( mIconSlideshowStop );
 393     mPanPosition = Vector2( mViewSize.width, mViewSize.height*0.5f );
 394     mPanDisplacement = Vector2( -10.f, 0.f );
 395     mViewTimer.Start();
 396   }
 397   else
 398   {
 399     mPanGestureDetector.Attach( mParent );
 400     mSlideshowButton.SetBackgroundImage( mIconSlideshowStart );
 401     mViewTimer.Stop();
 402   }
 403   return true;
 404 }
 405
 406 void CubeTransitionApp::OnTransitionCompleted(Toolkit::CubeTransitionEffect effect, ImageActor imageActor)
 407 {
 408   if( mSlideshow )
 409   {
 410     mViewTimer.Start();
 411   }
 412 }
 413
 414 bool CubeTransitionApp::OnTimerTick()
 415 {
 416   if(mSlideshow)
 417   {
 418     mIndex = (mIndex + 1)%NUM_IMAGES;
 419     GoToNextImage();
 420   }
 421
 422   //return false to stop the timer
 423   return false;
 424 }
 425
 426 void CubeTransitionApp::OnKeyEvent(const KeyEvent& event)
 427 {
 428   if(event.state == KeyEvent::Down)
 429   {
 430     if( IsKey( event, Dali::DALI_KEY_ESCAPE) || IsKey( event, Dali::DALI_KEY_BACK) )
 431     {
 432       mApplication.Quit();
 433     }
 434   }
 435 }
 436
 437 // Entry point for Linux & Tizen applications
 438 int main( int argc, char **argv )
 439 {
 440   Application application = Application::New( &argc, &argv );
 441   CubeTransitionApp test( application );
 442   application.MainLoop();
 443
 444   return 0;
 445 }