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     mStage(),
  59     mFrameCallback(),
  60     mTextLabel(),
  61     mTapDetector(),
  62     mFrameCallbackEnabled( false )
  63   {
  64     // Connect to the Application's Init signal
  65     mApplication.InitSignal().Connect( this, &FrameCallbackController::Create );
  66   }
  67
  68 private:
  69
  70   /**
  71    * @brief Creates the scene.
  72    *
  73    * Creates several image-views and places them appropriately.
  74    * Animate all image-views.
  75    * Set the FrameCallbackInterface on the stage.
  76    * Tapping on the stage enables/disables the FrameCallback.
  77    */
  78   void Create( Application& /* application */ )
  79   {
  80     // Set the stage background color and connect to the stage's key signal to allow Back and Escape to exit.
  81     mStage = Stage::GetCurrent();
  82     mStage.SetBackgroundColor( Color::WHITE );
  83     mStage.KeyEventSignal().Connect( this, &FrameCallbackController::OnKeyEvent );
  84
  85     // Notify mFrameCallback about the stage width.
  86     // Can call methods in mFrameCallback directly as we have not set it on the stage yet.
  87     Vector2 stageSize = mStage.GetSize();
  88     mFrameCallback.SetStageWidth( stageSize.width );
  89
  90     // Detect taps on the root layer.
  91     mTapDetector = TapGestureDetector::New();
  92     mTapDetector.Attach( mStage.GetRootLayer() );
  93     mTapDetector.DetectedSignal().Connect( this, &FrameCallbackController::OnTap );
  94
  95     // Create some key-frames to be used by all animations.
  96     KeyFrames keyFrames = KeyFrames::New();
  97     keyFrames.Add( 0.0f,   0.0f );
  98     keyFrames.Add( 0.25f,  stageSize.width * 0.5f );
  99     keyFrames.Add( 0.75f, -stageSize.width * 0.5f );
 100     keyFrames.Add( 1.0f,   0.0f );
 101
 102     float yPos = 0.0f;
 103     for( int i = 0; yPos < stageSize.height; ++i )
 104     {
 105       ImageView imageView = ImageView::New( IMAGE_NAME );
 106       imageView.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::TOP_CENTER );
 107       imageView.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::TOP_CENTER );
 108       imageView.SetProperty( Actor::Property::POSITION_Y,  yPos );
 109       yPos += imageView.GetNaturalSize().height;
 110
 111       // Add the ID of the created ImageView to mFrameCallback.
 112       // Again, can call methods in mFrameCallback directly as we have not set it on the stage yet.
 113       mFrameCallback.AddId( imageView.GetProperty< int >( Actor::Property::ID ) );
 114
 115       mStage.Add( imageView );
 116
 117       // Create an animation and set the progress so that each image starts at a different point.
 118       Animation animation = Animation::New( ANIMATION_TIME );
 119       animation.SetLooping( true );
 120       animation.AnimateBetween( Property( imageView, Actor::Property::POSITION_X ), keyFrames );
 121       animation.SetCurrentProgress( std::min( 1.0f, ANIMATION_PROGRESS_MULTIPLIER * i ) );
 122       animation.Play();
 123     }
 124
 125     // Create a text-label to display whether the FrameCallback is enabled/disabled.
 126     mTextLabel = TextLabel::New( TEXT_ENABLED );
 127     mTextLabel.SetProperty( TextLabel::Property::TEXT_COLOR, TEXT_COLOR_ENABLED );
 128     mTextLabel.SetProperty( TextLabel::Property::HORIZONTAL_ALIGNMENT, "CENTER" );
 129     mTextLabel.SetProperty( Actor::Property::ANCHOR_POINT, AnchorPoint::CENTER );
 130     mTextLabel.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
 131     mStage.Add( mTextLabel );
 132
 133     // Set the FrameCallbackInterface on the root layer.
 134     DevelStage::AddFrameCallback( mStage, mFrameCallback, mStage.GetRootLayer() );
 135     mFrameCallbackEnabled = true;
 136   }
 137
 138   /**
 139    * @brief Called when a tap on the stage occurs.
 140    *
 141    * Toggle enabling/disabling of the FrameCallbackInterface
 142    */
 143   void OnTap( Actor /* actor */, const TapGesture& /* tap */ )
 144   {
 145     if( mFrameCallbackEnabled )
 146     {
 147       DevelStage::RemoveFrameCallback( mStage, mFrameCallback );
 148       mTextLabel.SetProperty( TextLabel::Property::TEXT, TEXT_DISABLED );
 149       mTextLabel.SetProperty( TextLabel::Property::TEXT_COLOR, TEXT_COLOR_DISABLED );
 150     }
 151     else
 152     {
 153       DevelStage::AddFrameCallback( mStage, mFrameCallback, mStage.GetRootLayer() );
 154       mTextLabel.SetProperty( TextLabel::Property::TEXT, TEXT_ENABLED );
 155       mTextLabel.SetProperty( TextLabel::Property::TEXT_COLOR, TEXT_COLOR_ENABLED );
 156     }
 157
 158     mFrameCallbackEnabled = !mFrameCallbackEnabled;
 159   }
 160
 161   /**
 162    * @brief Called when any key event is received
 163    *
 164    * Will use this to quit the application if Back or the Escape key is received
 165    * @param[in] event The key event information
 166    */
 167   void OnKeyEvent( const KeyEvent& event )
 168   {
 169     if( event.state == KeyEvent::Down )
 170     {
 171       if ( IsKey( event, Dali::DALI_KEY_ESCAPE ) || IsKey( event, Dali::DALI_KEY_BACK ) )
 172       {
 173         mApplication.Quit();
 174       }
 175     }
 176   }
 177
 178 private:
 179   Application&        mApplication;          ///< A reference to the application instance.
 180   Stage               mStage;                ///< The stage we enable the FrameCallback on.
 181   FrameCallback       mFrameCallback;        ///< An instance of our implementation of the FrameCallbackInterface.
 182   TextLabel           mTextLabel;            ///< Text label which shows whether the frame-callback is enabled/disabled.
 183   TapGestureDetector  mTapDetector;          ///< Tap detector to enable/disable the FrameCallbackInterface.
 184   bool                mFrameCallbackEnabled; ///< Stores whether the FrameCallbackInterface is enabled/disabled.
 185 };
 186
 187 int DALI_EXPORT_API main( int argc, char **argv )
 188 {
 189   Application application = Application::New( &argc, &argv );
 190   FrameCallbackController controller( application );
 191   application.MainLoop();
 192   return 0;
 193 }