examples/frame-callback/frame-callback-example.cpp

   1 /*
   2  * Copyright (c) 2020 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/common/stage-devel.h>
  21
  22 // INTERNAL INCLUDES
  23 #include "frame-callback.h"
  24
  25 using namespace Dali;
  26 using namespace Dali::Toolkit;
  27
  28 namespace
  29 {
  30 const char * IMAGE_NAME = DEMO_IMAGE_DIR "application-icon-1.png";
  31
  32 const char * TEXT_ENABLED( "FrameCallback: ON" );
  33 const char * TEXT_DISABLED( "FrameCallback: OFF" );
  34 Vector4 TEXT_COLOR_ENABLED( Color::BLACK );
  35 Vector4 TEXT_COLOR_DISABLED( Color::RED );
  36
  37 float ANIMATION_TIME( 4.0f );
  38 float ANIMATION_PROGRESS_MULTIPLIER( 0.02f );
  39 } // unnamed namespace
  40
  41 /**
  42  * @brief An example of how to set/unset the FrameCallbackInterface in DALi.
  43  *
  44  * Creates a scene with several image-views which are animated from side-to-side.
  45  * With the frame-callback enabled, the image-views' sizes expand as they hits the sides and the opacity
  46  * changes to transparent as they go to the middle.
  47  */
  48 class FrameCallbackController : public ConnectionTracker
  49 {
  50 public:
  51
  52   /**
  53    * @brief Constructor.
  54    * @param[in]  application  The application.
  55    */
  56   FrameCallbackController( Application& application )
  57   : mApplication( application ),
  58     mFrameCallback(),
  59     mTextLabel(),
  60     mTapDetector(),
  61     mFrameCallbackEnabled( false )
  62   {
  63     // Connect to the Application's Init signal
  64     mApplication.InitSignal().Connect( this, &FrameCallbackController::Create );
  65   }
  66
  67 private:
  68
  69   /**
  70    * @brief Creates the scene.
  71    *
  72    * Creates several image-views and places them appropriately.
  73    * Animate all image-views.
  74    * Set the FrameCallbackInterface on the window.
  75    * Tapping on the window enables/disables the FrameCallback.
  76    */
  77   void Create( Application& application )
  78   {
  79     // Set the window background color and connect to the window's key signal to allow Back and Escape to exit.
  80     Window window = application.GetWindow();
  81     window.SetBackgroundColor( Color::WHITE );
  82     window.KeyEventSignal().Connect( this, &FrameCallbackController::OnKeyEvent );
  83
  84     // Notify mFrameCallback about the window width.
  85     // Can call methods in mFrameCallback directly as we have not set it on the window yet.
  86     Vector2 windowSize = window.GetSize();
  87     mFrameCallback.SetWindowWidth( windowSize.width );
  88
  89     // Detect taps on the root layer.
  90     mTapDetector = TapGestureDetector::New();
  91     mTapDetector.Attach( window.GetRootLayer() );
  92     mTapDetector.DetectedSignal().Connect( this, &FrameCallbackController::OnTap );
  93
  94     // Create some key-frames to be used by all animations.
  95     KeyFrames keyFrames = KeyFrames::New();
  96     keyFrames.Add( 0.0f,   0.0f );
  97     keyFrames.Add( 0.25f,  windowSize.width * 0.5f );
  98     keyFrames.Add( 0.75f, -windowSize.width * 0.5f );
  99     keyFrames.Add( 1.0f,   0.0f );
 100
 101     float yPos = 0.0f;
 102     for( int i = 0; yPos < windowSize.height; ++i )
 103     {
 104       ImageView imageView = ImageView::New( IMAGE_NAME );
 105       imageView.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_CENTER );
 106       imageView.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_CENTER );
 107       imageView.SetProperty( Actor::Property::POSITION_Y,  yPos );
 108       yPos += imageView.GetNaturalSize().height;
 109
 110       // Add the ID of the created ImageView to mFrameCallback.
 111       // Again, can call methods in mFrameCallback directly as we have not set it on the window yet.
 112       mFrameCallback.AddId( imageView.GetProperty< int >( Actor::Property::ID ) );
 113
 114       window.Add( imageView );
 115
 116       // Create an animation and set the progress so that each image starts at a different point.
 117       Animation animation = Animation::New( ANIMATION_TIME );
 118       animation.SetLooping( true );
 119       animation.AnimateBetween( Property( imageView, Actor::Property::POSITION_X ), keyFrames );
 120       animation.SetCurrentProgress( std::min( 1.0f, ANIMATION_PROGRESS_MULTIPLIER * i ) );
 121       animation.Play();
 122     }
 123
 124     // Create a text-label to display whether the FrameCallback is enabled/disabled.
 125     mTextLabel = TextLabel::New( TEXT_ENABLED );
 126     mTextLabel.SetProperty( TextLabel::Property::TEXT_COLOR, TEXT_COLOR_ENABLED );
 127     mTextLabel.SetProperty( TextLabel::Property::HORIZONTAL_ALIGNMENT, "CENTER" );
 128     mTextLabel.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
 129     mTextLabel.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
 130     window.Add( mTextLabel );
 131
 132     // Set the FrameCallbackInterface on the root layer.
 133     DevelStage::AddFrameCallback( Stage::GetCurrent(), mFrameCallback, window.GetRootLayer() );
 134     mFrameCallbackEnabled = true;
 135   }
 136
 137   /**
 138    * @brief Called when a tap on the window occurs.
 139    *
 140    * Toggle enabling/disabling of the FrameCallbackInterface
 141    */
 142   void OnTap( Actor actor, const TapGesture& /* tap */ )
 143   {
 144     if( mFrameCallbackEnabled )
 145     {
 146       DevelStage::RemoveFrameCallback( Stage::GetCurrent(), mFrameCallback );
 147       mTextLabel.SetProperty( TextLabel::Property::TEXT, TEXT_DISABLED );
 148       mTextLabel.SetProperty( TextLabel::Property::TEXT_COLOR, TEXT_COLOR_DISABLED );
 149     }
 150     else
 151     {
 152       DevelStage::AddFrameCallback( Stage::GetCurrent(), mFrameCallback, actor );
 153       mTextLabel.SetProperty( TextLabel::Property::TEXT, TEXT_ENABLED );
 154       mTextLabel.SetProperty( TextLabel::Property::TEXT_COLOR, TEXT_COLOR_ENABLED );
 155     }
 156
 157     mFrameCallbackEnabled = !mFrameCallbackEnabled;
 158   }
 159
 160   /**
 161    * @brief Called when any key event is received
 162    *
 163    * Will use this to quit the application if Back or the Escape key is received
 164    * @param[in] event The key event information
 165    */
 166   void OnKeyEvent( const KeyEvent& event )
 167   {
 168     if( event.state == KeyEvent::Down )
 169     {
 170       if ( IsKey( event, Dali::DALI_KEY_ESCAPE ) || IsKey( event, Dali::DALI_KEY_BACK ) )
 171       {
 172         mApplication.Quit();
 173       }
 174     }
 175   }
 176
 177 private:
 178   Application&        mApplication;          ///< A reference to the application instance.
 179   FrameCallback       mFrameCallback;        ///< An instance of our implementation of the FrameCallbackInterface.
 180   TextLabel           mTextLabel;            ///< Text label which shows whether the frame-callback is enabled/disabled.
 181   TapGestureDetector  mTapDetector;          ///< Tap detector to enable/disable the FrameCallbackInterface.
 182   bool                mFrameCallbackEnabled; ///< Stores whether the FrameCallbackInterface is enabled/disabled.
 183 };
 184
 185 int DALI_EXPORT_API main( int argc, char **argv )
 186 {
 187   Application application = Application::New( &argc, &argv );
 188   FrameCallbackController controller( application );
 189   application.MainLoop();
 190   return 0;
 191 }