dali/integration-api/adaptor-framework/scene-holder-impl.cpp

   1 /*
   2  * Copyright (c) 2022 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 <dali/integration-api/debug.h>
  23 #include <dali/integration-api/events/hover-event-integ.h>
  24 #include <dali/integration-api/events/key-event-integ.h>
  25 #include <dali/integration-api/events/touch-event-integ.h>
  26 #include <dali/integration-api/events/wheel-event-integ.h>
  27 #include <dali/public-api/actors/actor.h>
  28 #include <dali/public-api/actors/layer.h>
  29 #include <dali/public-api/common/dali-common.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/graphics/gles/egl-graphics.h>
  35 #include <dali/internal/input/common/key-impl.h>
  36 #include <dali/internal/input/common/physical-keyboard-impl.h>
  37 #include <dali/internal/system/common/time-service.h>
  38
  39 namespace Dali
  40 {
  41 namespace Internal
  42 {
  43 namespace Adaptor
  44 {
  45 namespace
  46 {
  47 #if defined(DEBUG_ENABLED)
  48 Debug::Filter* gSceneHolderLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_SCENE_HOLDER");
  49 #endif
  50 } // unnamed namespace
  51
  52 uint32_t SceneHolder::mSceneHolderCounter = 0;
  53
  54 class SceneHolder::SceneHolderLifeCycleObserver : public LifeCycleObserver
  55 {
  56 public:
  57   SceneHolderLifeCycleObserver(Adaptor*& adaptor)
  58   : mAdaptor(adaptor){};
  59
  60 private: // Adaptor::LifeCycleObserver interface
  61   void OnStart() override{};
  62   void OnPause() override{};
  63   void OnResume() override{};
  64   void OnStop() override{};
  65   void OnDestroy() override
  66   {
  67     mAdaptor = nullptr;
  68   };
  69
  70 private:
  71   Adaptor*& mAdaptor;
  72 };
  73
  74 SceneHolder::SceneHolder()
  75 : mLifeCycleObserver(new SceneHolderLifeCycleObserver(mAdaptor)),
  76   mId(mSceneHolderCounter++),
  77   mSurface(nullptr),
  78   mAdaptor(nullptr),
  79   mDpi(),
  80   mIsBeingDeleted(false),
  81   mAdaptorStarted(false),
  82   mVisible(true)
  83 {
  84 }
  85
  86 SceneHolder::~SceneHolder()
  87 {
  88   if(mAdaptor)
  89   {
  90     mAdaptor->RemoveObserver(*mLifeCycleObserver.get());
  91     mAdaptor->RemoveWindow(this);
  92
  93     mAdaptor->DeleteSurface(*mSurface.get());
  94
  95     mAdaptor = nullptr;
  96   }
  97
  98   if(mScene)
  99   {
 100     mScene.Discard();
 101   }
 102 }
 103
 104 void SceneHolder::Add(Dali::Actor actor)
 105 {
 106   if(mScene)
 107   {
 108     mScene.Add(actor);
 109   }
 110 }
 111
 112 void SceneHolder::Remove(Dali::Actor actor)
 113 {
 114   if(mScene)
 115   {
 116     mScene.Remove(actor);
 117   }
 118 }
 119
 120 Dali::Layer SceneHolder::GetRootLayer() const
 121 {
 122   return mScene ? mScene.GetRootLayer() : Dali::Layer();
 123 }
 124
 125 Dali::Layer SceneHolder::GetOverlayLayer()
 126 {
 127   return mScene ? mScene.GetOverlayLayer() : Dali::Layer();
 128 }
 129
 130 uint32_t SceneHolder::GetId() const
 131 {
 132   return mId;
 133 }
 134
 135 std::string SceneHolder::GetName() const
 136 {
 137   return mName;
 138 }
 139
 140 bool SceneHolder::IsVisible() const
 141 {
 142   return mVisible;
 143 }
 144
 145 Dali::Integration::Scene SceneHolder::GetScene()
 146 {
 147   return mScene;
 148 }
 149
 150 Uint16Pair SceneHolder::GetDpi() const
 151 {
 152   return mDpi;
 153 }
 154
 155 void SceneHolder::SetSurface(Dali::RenderSurfaceInterface* surface)
 156 {
 157   mSurface.reset(surface);
 158
 159   mScene.SurfaceReplaced();
 160
 161   PositionSize surfacePositionSize = surface->GetPositionSize();
 162
 163   SurfaceResized(static_cast<float>(surfacePositionSize.width), static_cast<float>(surfacePositionSize.height));
 164
 165   InitializeDpi();
 166
 167   mSurface->SetAdaptor(*mAdaptor);
 168   mSurface->SetScene(mScene);
 169
 170   // Recreate the render target
 171   CreateRenderTarget();
 172
 173   OnSurfaceSet(surface);
 174 }
 175
 176 void SceneHolder::SurfaceResized(float width, float height)
 177 {
 178   if(DALI_LIKELY(mScene))
 179   {
 180     mScene.SurfaceResized(width, height);
 181   }
 182
 183   mSurface->SetFullSwapNextFrame();
 184
 185   // Recreate the render target
 186   CreateRenderTarget();
 187 }
 188
 189 Dali::RenderSurfaceInterface* SceneHolder::GetSurface() const
 190 {
 191   return mSurface.get();
 192 }
 193
 194 void SceneHolder::SetBackgroundColor(const Vector4& color)
 195 {
 196   if(mScene)
 197   {
 198     mScene.SetBackgroundColor(color);
 199
 200     mSurface->SetFullSwapNextFrame();
 201   }
 202 }
 203
 204 Vector4 SceneHolder::GetBackgroundColor() const
 205 {
 206   return mScene ? mScene.GetBackgroundColor() : Color::BLACK;
 207 }
 208
 209 void SceneHolder::SetAdaptor(Dali::Adaptor& adaptor)
 210 {
 211   // Avoid doing this more than once
 212   if(mAdaptorStarted)
 213   {
 214     return;
 215   }
 216
 217   DALI_ASSERT_DEBUG(mSurface && "Surface needs to be set before calling this method\n");
 218
 219   mAdaptorStarted = true;
 220
 221   // Create the scene
 222   PositionSize surfacePositionSize = mSurface->GetPositionSize();
 223   int          windowOrientation   = mSurface->GetSurfaceOrientation();
 224   int          screenOrientation   = mSurface->GetScreenOrientation();
 225
 226   mScene = Dali::Integration::Scene::New(Size(static_cast<float>(surfacePositionSize.width), static_cast<float>(surfacePositionSize.height)), windowOrientation, screenOrientation);
 227
 228   Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation(adaptor);
 229   mAdaptor                                = &adaptorImpl;
 230
 231   // Create an observer for the adaptor lifecycle
 232   mAdaptor->AddObserver(*mLifeCycleObserver);
 233
 234   InitializeDpi();
 235
 236   mSurface->SetAdaptor(*mAdaptor);
 237   mSurface->SetScene(mScene);
 238
 239   // Create the render target
 240   CreateRenderTarget();
 241
 242   OnAdaptorSet(adaptor);
 243 }
 244
 245 void SceneHolder::CreateRenderTarget()
 246 {
 247   Graphics::RenderTargetCreateInfo rtInfo{};
 248   rtInfo
 249     .SetSurface(mSurface.get())
 250     .SetExtent({static_cast<uint32_t>(mSurface->GetPositionSize().width), static_cast<uint32_t>(mSurface->GetPositionSize().height)})
 251     .SetPreTransform(0 | Graphics::RenderTargetTransformFlagBits::TRANSFORM_IDENTITY_BIT);
 252
 253   mScene.SetSurfaceRenderTarget(rtInfo);
 254 }
 255
 256 void SceneHolder::Pause()
 257 {
 258   Reset();
 259
 260   OnPause();
 261 }
 262
 263 void SceneHolder::Resume()
 264 {
 265   Reset();
 266
 267   OnResume();
 268 }
 269
 270 void SceneHolder::SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation)
 271 {
 272   if(DALI_LIKELY(mScene))
 273   {
 274     mScene.SurfaceRotated(width, height, windowOrientation, screenOrientation);
 275   }
 276 }
 277
 278 void SceneHolder::SetRotationCompletedAcknowledgement()
 279 {
 280   if(DALI_LIKELY(mScene))
 281   {
 282     mScene.SetRotationCompletedAcknowledgement();
 283   }
 284 }
 285
 286 void SceneHolder::FeedTouchPoint(Dali::Integration::Point& point, int timeStamp)
 287 {
 288   if(timeStamp < 1)
 289   {
 290     timeStamp = TimeService::GetMilliSeconds();
 291   }
 292
 293   Vector2 convertedPosition = RecalculatePosition(point.GetScreenPosition());
 294   point.SetScreenPosition(convertedPosition);
 295
 296   Integration::TouchEvent                            touchEvent;
 297   Integration::HoverEvent                            hoverEvent;
 298   Integration::TouchEventCombiner::EventDispatchType type = mCombiner.GetNextTouchEvent(point, timeStamp, touchEvent, hoverEvent);
 299   if(type != Integration::TouchEventCombiner::DISPATCH_NONE)
 300   {
 301     DALI_LOG_INFO(gSceneHolderLogFilter, Debug::Verbose, "%d: Device %d: Button state %d (%.2f, %.2f)\n", timeStamp, point.GetDeviceId(), point.GetState(), point.GetScreenPosition().x, point.GetScreenPosition().y);
 302
 303     // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 304     // Keep the handle alive until the core events are processed.
 305     Dali::BaseHandle sceneHolder(this);
 306
 307     // First the touch and/or hover event & related gesture events are queued
 308     if(type == Integration::TouchEventCombiner::DISPATCH_TOUCH || type == Integration::TouchEventCombiner::DISPATCH_BOTH)
 309     {
 310       mScene.QueueEvent(touchEvent);
 311     }
 312
 313     if(type == Integration::TouchEventCombiner::DISPATCH_HOVER || type == Integration::TouchEventCombiner::DISPATCH_BOTH)
 314     {
 315       mScene.QueueEvent(hoverEvent);
 316     }
 317
 318     // Next the events are processed with a single call into Core
 319     mAdaptor->ProcessCoreEvents();
 320   }
 321 }
 322
 323 void SceneHolder::FeedWheelEvent(Dali::Integration::WheelEvent& wheelEvent)
 324 {
 325   // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 326   // Keep the handle alive until the core events are processed.
 327   Dali::BaseHandle sceneHolder(this);
 328
 329   Vector2 convertedPosition = RecalculatePosition(wheelEvent.point);
 330   wheelEvent.point          = convertedPosition;
 331
 332   mScene.QueueEvent(wheelEvent);
 333   mAdaptor->ProcessCoreEvents();
 334 }
 335
 336 void SceneHolder::FeedKeyEvent(Dali::Integration::KeyEvent& keyEvent)
 337 {
 338   Dali::PhysicalKeyboard physicalKeyboard = PhysicalKeyboard::Get();
 339   if(physicalKeyboard)
 340   {
 341     if(!KeyLookup::IsDeviceButton(keyEvent.keyName.c_str()))
 342     {
 343       GetImplementation(physicalKeyboard).KeyReceived(keyEvent.time > 1);
 344     }
 345   }
 346
 347   // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 348   // Keep the handle alive until the core events are processed.
 349   Dali::BaseHandle sceneHolder(this);
 350
 351   // Create send KeyEvent to Core.
 352   mScene.QueueEvent(keyEvent);
 353   mAdaptor->ProcessCoreEvents();
 354 }
 355
 356 void SceneHolder::AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
 357 {
 358   mScene.AddFrameRenderedCallback(std::move(callback), frameId);
 359
 360   DALI_LOG_RELEASE_INFO("SceneHolder::AddFrameRenderedCallback:: Added [%d]\n", frameId);
 361 }
 362
 363 void SceneHolder::AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
 364 {
 365   mScene.AddFramePresentedCallback(std::move(callback), frameId);
 366
 367   DALI_LOG_RELEASE_INFO("SceneHolder::AddFramePresentedCallback:: Added [%d]\n", frameId);
 368 }
 369
 370 Dali::Integration::SceneHolder SceneHolder::Get(Dali::Actor actor)
 371 {
 372   SceneHolder* sceneHolderImpl = nullptr;
 373
 374   if(Internal::Adaptor::Adaptor::IsAvailable())
 375   {
 376     Dali::Internal::Adaptor::Adaptor& adaptor = Internal::Adaptor::Adaptor::GetImplementation(Internal::Adaptor::Adaptor::Get());
 377     sceneHolderImpl                           = adaptor.GetWindow(actor);
 378   }
 379
 380   return Dali::Integration::SceneHolder(sceneHolderImpl);
 381 }
 382
 383 void SceneHolder::Reset()
 384 {
 385   mCombiner.Reset();
 386
 387   // Any touch listeners should be told of the interruption.
 388   Integration::TouchEvent event;
 389   Integration::Point      point;
 390   point.SetState(PointState::INTERRUPTED);
 391   event.AddPoint(point);
 392
 393   // First the touch event & related gesture events are queued
 394   mScene.QueueEvent(event);
 395
 396   // Next the events are processed with a single call into Core
 397   mAdaptor->ProcessCoreEvents();
 398 }
 399
 400 void SceneHolder::InitializeDpi()
 401 {
 402   unsigned int dpiHorizontal, dpiVertical;
 403   dpiHorizontal = dpiVertical = 0;
 404
 405   mSurface->GetDpi(dpiHorizontal, dpiVertical);
 406   mScene.SetDpi(Vector2(static_cast<float>(dpiHorizontal), static_cast<float>(dpiVertical)));
 407
 408   mDpi.SetX(dpiHorizontal);
 409   mDpi.SetY(dpiVertical);
 410 }
 411
 412 } // namespace Adaptor
 413
 414 } // namespace Internal
 415
 416 } // namespace Dali