dali/integration-api/adaptor-framework/scene-holder-impl.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 // CLASS HEADER
  19 #include <dali/integration-api/adaptor-framework/scene-holder-impl.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <sys/time.h>
  23 #include <dali/public-api/actors/actor.h>
  24 #include <dali/public-api/actors/layer.h>
  25 #include <dali/integration-api/debug.h>
  26 #include <dali/integration-api/events/key-event-integ.h>
  27 #include <dali/integration-api/events/touch-event-integ.h>
  28 #include <dali/integration-api/events/hover-event-integ.h>
  29 #include <dali/integration-api/events/wheel-event-integ.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <dali/internal/adaptor/common/adaptor-impl.h>
  33 #include <dali/internal/adaptor/common/lifecycle-observer.h>
  34 #include <dali/internal/input/common/key-impl.h>
  35 #include <dali/internal/input/common/physical-keyboard-impl.h>
  36
  37 namespace Dali
  38 {
  39
  40 namespace Internal
  41 {
  42
  43 namespace Adaptor
  44 {
  45
  46 namespace
  47 {
  48
  49 #if defined(DEBUG_ENABLED)
  50 Integration::Log::Filter* gTouchEventLogFilter  = Integration::Log::Filter::New(Debug::NoLogging, false, "LOG_ADAPTOR_EVENTS_TOUCH");
  51 #endif
  52
  53 // Copied from x server
  54 static uint32_t GetCurrentMilliSeconds(void)
  55 {
  56   struct timeval tv;
  57
  58   struct timespec tp;
  59   static clockid_t clockid;
  60
  61   if (!clockid)
  62   {
  63 #ifdef CLOCK_MONOTONIC_COARSE
  64     if (clock_getres(CLOCK_MONOTONIC_COARSE, &tp) == 0 &&
  65       (tp.tv_nsec / 1000) <= 1000 && clock_gettime(CLOCK_MONOTONIC_COARSE, &tp) == 0)
  66     {
  67       clockid = CLOCK_MONOTONIC_COARSE;
  68     }
  69     else
  70 #endif
  71     if (clock_gettime(CLOCK_MONOTONIC, &tp) == 0)
  72     {
  73       clockid = CLOCK_MONOTONIC;
  74     }
  75     else
  76     {
  77       clockid = ~0L;
  78     }
  79   }
  80   if (clockid != ~0L && clock_gettime(clockid, &tp) == 0)
  81   {
  82     return static_cast<uint32_t>( (tp.tv_sec * 1000 ) + (tp.tv_nsec / 1000000L) );
  83   }
  84
  85   gettimeofday(&tv, NULL);
  86   return static_cast<uint32_t>( (tv.tv_sec * 1000 ) + (tv.tv_usec / 1000) );
  87 }
  88
  89 } // unnamed namespace
  90
  91 uint32_t SceneHolder::mSceneHolderCounter = 0;
  92
  93 class SceneHolder::SceneHolderLifeCycleObserver : public LifeCycleObserver
  94 {
  95 public:
  96
  97   SceneHolderLifeCycleObserver(Adaptor*& adaptor)
  98   : mAdaptor( adaptor )
  99   {
 100   };
 101
 102 private: // Adaptor::LifeCycleObserver interface
 103
 104   void OnStart() override {};
 105   void OnPause() override {};
 106   void OnResume() override {};
 107   void OnStop() override {};
 108   void OnDestroy() override
 109   {
 110     mAdaptor = nullptr;
 111   };
 112
 113 private:
 114   Adaptor*& mAdaptor;
 115 };
 116
 117
 118 SceneHolder::SceneHolder()
 119 : mLifeCycleObserver( new SceneHolderLifeCycleObserver( mAdaptor ) ),
 120   mId( mSceneHolderCounter++ ),
 121   mSurface( nullptr ),
 122   mAdaptor( nullptr ),
 123   mIsBeingDeleted( false ),
 124   mAdaptorStarted( false ),
 125   mVisible( true )
 126 {
 127 }
 128
 129 SceneHolder::~SceneHolder()
 130 {
 131   if ( mAdaptor )
 132   {
 133     mAdaptor->RemoveObserver( *mLifeCycleObserver.get() );
 134     mAdaptor->RemoveWindow( this );
 135
 136     mAdaptor = nullptr;
 137   }
 138
 139   if ( mScene )
 140   {
 141     mScene.Discard();
 142   }
 143 }
 144
 145 void SceneHolder::Add( Dali::Actor actor )
 146 {
 147   if ( mScene )
 148   {
 149     mScene.Add( actor );
 150   }
 151 }
 152
 153 void SceneHolder::Remove( Dali::Actor actor )
 154 {
 155   if ( mScene )
 156   {
 157     mScene.Remove( actor );
 158   }
 159 }
 160
 161 Dali::Layer SceneHolder::GetRootLayer() const
 162 {
 163   return mScene ? mScene.GetRootLayer() : Dali::Layer();
 164 }
 165
 166 uint32_t SceneHolder::GetId() const
 167 {
 168   return mId;
 169 }
 170
 171 std::string SceneHolder::GetName() const
 172 {
 173   return mName;
 174 }
 175
 176 bool SceneHolder::IsVisible() const
 177 {
 178   return mVisible;
 179 }
 180
 181 Dali::Integration::Scene SceneHolder::GetScene()
 182 {
 183   return mScene;
 184 }
 185
 186 void SceneHolder::SetSurface(Dali::RenderSurfaceInterface* surface)
 187 {
 188   mSurface.reset( surface );
 189
 190   mScene.SurfaceReplaced();
 191
 192   SurfaceResized();
 193
 194   unsigned int dpiHorizontal, dpiVertical;
 195   dpiHorizontal = dpiVertical = 0;
 196
 197   mSurface->GetDpi( dpiHorizontal, dpiVertical );
 198   mScene.SetDpi( Vector2( static_cast<float>( dpiHorizontal ), static_cast<float>( dpiVertical ) ) );
 199
 200   mSurface->SetAdaptor( *mAdaptor );
 201
 202   OnSurfaceSet( surface );
 203 }
 204
 205 void SceneHolder::SurfaceResized()
 206 {
 207   PositionSize surfacePositionSize = mSurface->GetPositionSize();
 208   mScene.SurfaceResized( static_cast<float>( surfacePositionSize.width ), static_cast<float>( surfacePositionSize.height ) );
 209 }
 210
 211 Dali::RenderSurfaceInterface* SceneHolder::GetSurface() const
 212 {
 213   return mSurface.get();
 214 }
 215
 216 void SceneHolder::SetBackgroundColor( const Vector4& color )
 217 {
 218   if( mScene )
 219   {
 220     mScene.SetBackgroundColor( color );
 221   }
 222 }
 223
 224 Vector4 SceneHolder::GetBackgroundColor() const
 225 {
 226   return mScene ? mScene.GetBackgroundColor() : Color::BLACK;
 227 }
 228
 229 void SceneHolder::SetAdaptor(Dali::Adaptor& adaptor)
 230 {
 231   // Avoid doing this more than once
 232   if( mAdaptorStarted )
 233   {
 234     return;
 235   }
 236
 237   mAdaptorStarted = true;
 238
 239   // Create the scene
 240   PositionSize surfacePositionSize = mSurface->GetPositionSize();
 241   mScene = Dali::Integration::Scene::New( Size(static_cast<float>( surfacePositionSize.width ), static_cast<float>( surfacePositionSize.height )) );
 242
 243   Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation( adaptor );
 244   mAdaptor = &adaptorImpl;
 245
 246   // Create an observer for the adaptor lifecycle
 247   mAdaptor->AddObserver( *mLifeCycleObserver );
 248
 249   if ( mSurface )
 250   {
 251     unsigned int dpiHorizontal, dpiVertical;
 252     dpiHorizontal = dpiVertical = 0;
 253
 254     mSurface->GetDpi( dpiHorizontal, dpiVertical );
 255     mScene.SetDpi( Vector2( static_cast<float>( dpiHorizontal ), static_cast<float>( dpiVertical ) ) );
 256
 257     mSurface->SetAdaptor( *mAdaptor );
 258   }
 259
 260   OnAdaptorSet( adaptor );
 261 }
 262
 263 void SceneHolder::Pause()
 264 {
 265   Reset();
 266
 267   OnPause();
 268 }
 269
 270 void SceneHolder::Resume()
 271 {
 272   Reset();
 273
 274   OnResume();
 275 }
 276
 277 void SceneHolder::FeedTouchPoint( Dali::Integration::Point& point, int timeStamp )
 278 {
 279   if( timeStamp < 1 )
 280   {
 281     timeStamp = GetCurrentMilliSeconds();
 282   }
 283
 284   RecalculateTouchPosition( point );
 285
 286   Integration::TouchEvent touchEvent;
 287   Integration::HoverEvent hoverEvent;
 288   Integration::TouchEventCombiner::EventDispatchType type = mCombiner.GetNextTouchEvent(point, timeStamp, touchEvent, hoverEvent);
 289   if( type != Integration::TouchEventCombiner::DispatchNone )
 290   {
 291     DALI_LOG_INFO( gTouchEventLogFilter, Debug::General, "%d: Device %d: Button state %d (%.2f, %.2f)\n", timeStamp, point.GetDeviceId(), point.GetState(), point.GetScreenPosition().x, point.GetScreenPosition().y );
 292
 293     // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 294     // Keep the handle alive until the core events are processed.
 295     Dali::BaseHandle sceneHolder( this );
 296
 297     // First the touch and/or hover event & related gesture events are queued
 298     if( type == Integration::TouchEventCombiner::DispatchTouch || type == Integration::TouchEventCombiner::DispatchBoth )
 299     {
 300       mScene.QueueEvent( touchEvent );
 301     }
 302
 303     if( type == Integration::TouchEventCombiner::DispatchHover || type == Integration::TouchEventCombiner::DispatchBoth )
 304     {
 305       mScene.QueueEvent( hoverEvent );
 306     }
 307
 308     // Next the events are processed with a single call into Core
 309     mAdaptor->ProcessCoreEvents();
 310   }
 311 }
 312
 313 void SceneHolder::FeedWheelEvent( Dali::Integration::WheelEvent& wheelEvent )
 314 {
 315   // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 316   // Keep the handle alive until the core events are processed.
 317   Dali::BaseHandle sceneHolder( this );
 318
 319   mScene.QueueEvent( wheelEvent );
 320   mAdaptor->ProcessCoreEvents();
 321 }
 322
 323 void SceneHolder::FeedKeyEvent( Dali::Integration::KeyEvent& keyEvent )
 324 {
 325   Dali::PhysicalKeyboard physicalKeyboard = PhysicalKeyboard::Get();
 326   if( physicalKeyboard )
 327   {
 328     if( ! KeyLookup::IsDeviceButton( keyEvent.keyName.c_str() ) )
 329     {
 330       GetImplementation( physicalKeyboard ).KeyReceived( keyEvent.time > 1 );
 331     }
 332   }
 333
 334   // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 335   // Keep the handle alive until the core events are processed.
 336   Dali::BaseHandle sceneHolder( this );
 337
 338   // Create send KeyEvent to Core.
 339   mScene.QueueEvent( keyEvent );
 340   mAdaptor->ProcessCoreEvents();
 341 }
 342
 343 Dali::Integration::SceneHolder SceneHolder::Get( Dali::Actor actor )
 344 {
 345   SceneHolder* sceneHolderImpl = nullptr;
 346
 347   if ( Internal::Adaptor::Adaptor::IsAvailable() )
 348   {
 349     Dali::Internal::Adaptor::Adaptor& adaptor = Internal::Adaptor::Adaptor::GetImplementation( Internal::Adaptor::Adaptor::Get() );
 350     sceneHolderImpl = adaptor.GetWindow( actor );
 351   }
 352
 353   return Dali::Integration::SceneHolder( sceneHolderImpl );
 354 }
 355
 356 void SceneHolder::Reset()
 357 {
 358   mCombiner.Reset();
 359
 360   // Any touch listeners should be told of the interruption.
 361   Integration::TouchEvent event;
 362   Integration::Point point;
 363   point.SetState( PointState::INTERRUPTED );
 364   event.AddPoint( point );
 365
 366   // First the touch event & related gesture events are queued
 367   mScene.QueueEvent( event );
 368
 369   // Next the events are processed with a single call into Core
 370   mAdaptor->ProcessCoreEvents();
 371 }
 372
 373
 374 }// Adaptor
 375
 376 }// Internal
 377
 378 } // Dali