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 uint32_t SceneHolder::GetId() const
 126 {
 127   return mId;
 128 }
 129
 130 std::string SceneHolder::GetName() const
 131 {
 132   return mName;
 133 }
 134
 135 bool SceneHolder::IsVisible() const
 136 {
 137   return mVisible;
 138 }
 139
 140 Dali::Integration::Scene SceneHolder::GetScene()
 141 {
 142   return mScene;
 143 }
 144
 145 Uint16Pair SceneHolder::GetDpi() const
 146 {
 147   return mDpi;
 148 }
 149
 150 void SceneHolder::SetSurface(Dali::RenderSurfaceInterface* surface)
 151 {
 152   mSurface.reset(surface);
 153
 154   mScene.SurfaceReplaced();
 155
 156   PositionSize surfacePositionSize = surface->GetPositionSize();
 157
 158   SurfaceResized(static_cast<float>(surfacePositionSize.width), static_cast<float>(surfacePositionSize.height));
 159
 160   InitializeDpi();
 161
 162   mSurface->SetAdaptor(*mAdaptor);
 163   mSurface->SetScene(mScene);
 164
 165   // Recreate the render target
 166   CreateRenderTarget();
 167
 168   OnSurfaceSet(surface);
 169 }
 170
 171 void SceneHolder::SurfaceResized(float width, float height)
 172 {
 173   if(DALI_LIKELY(mScene))
 174   {
 175     mScene.SurfaceResized(width, height);
 176   }
 177
 178   mSurface->SetFullSwapNextFrame();
 179
 180   // Recreate the render target
 181   CreateRenderTarget();
 182 }
 183
 184 Dali::RenderSurfaceInterface* SceneHolder::GetSurface() const
 185 {
 186   return mSurface.get();
 187 }
 188
 189 void SceneHolder::SetBackgroundColor(const Vector4& color)
 190 {
 191   if(mScene)
 192   {
 193     mScene.SetBackgroundColor(color);
 194
 195     mSurface->SetFullSwapNextFrame();
 196   }
 197 }
 198
 199 Vector4 SceneHolder::GetBackgroundColor() const
 200 {
 201   return mScene ? mScene.GetBackgroundColor() : Color::BLACK;
 202 }
 203
 204 void SceneHolder::SetAdaptor(Dali::Adaptor& adaptor)
 205 {
 206   // Avoid doing this more than once
 207   if(mAdaptorStarted)
 208   {
 209     return;
 210   }
 211
 212   DALI_ASSERT_DEBUG(mSurface && "Surface needs to be set before calling this method\n");
 213
 214   mAdaptorStarted = true;
 215
 216   // Create the scene
 217   PositionSize surfacePositionSize = mSurface->GetPositionSize();
 218   int          windowOrientation   = mSurface->GetSurfaceOrientation();
 219   int          screenOrientation   = mSurface->GetScreenOrientation();
 220
 221   mScene = Dali::Integration::Scene::New(Size(static_cast<float>(surfacePositionSize.width), static_cast<float>(surfacePositionSize.height)), windowOrientation, screenOrientation);
 222
 223   Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation(adaptor);
 224   mAdaptor                                = &adaptorImpl;
 225
 226   // Create an observer for the adaptor lifecycle
 227   mAdaptor->AddObserver(*mLifeCycleObserver);
 228
 229   InitializeDpi();
 230
 231   mSurface->SetAdaptor(*mAdaptor);
 232   mSurface->SetScene(mScene);
 233
 234   // Create the render target
 235   CreateRenderTarget();
 236
 237   OnAdaptorSet(adaptor);
 238 }
 239
 240 void SceneHolder::CreateRenderTarget()
 241 {
 242   Graphics::RenderTargetCreateInfo rtInfo{};
 243   rtInfo
 244     .SetSurface(mSurface.get())
 245     .SetExtent({static_cast<uint32_t>(mSurface->GetPositionSize().width), static_cast<uint32_t>(mSurface->GetPositionSize().height)})
 246     .SetPreTransform(0 | Graphics::RenderTargetTransformFlagBits::TRANSFORM_IDENTITY_BIT);
 247
 248   mScene.SetSurfaceRenderTarget(rtInfo);
 249 }
 250
 251 void SceneHolder::Pause()
 252 {
 253   Reset();
 254
 255   OnPause();
 256 }
 257
 258 void SceneHolder::Resume()
 259 {
 260   Reset();
 261
 262   OnResume();
 263 }
 264
 265 void SceneHolder::SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation)
 266 {
 267   if(DALI_LIKELY(mScene))
 268   {
 269     mScene.SurfaceRotated(width, height, windowOrientation, screenOrientation);
 270   }
 271 }
 272
 273 void SceneHolder::SetRotationCompletedAcknowledgement()
 274 {
 275   if(DALI_LIKELY(mScene))
 276   {
 277     mScene.SetRotationCompletedAcknowledgement();
 278   }
 279 }
 280
 281 void SceneHolder::FeedTouchPoint(Dali::Integration::Point& point, int timeStamp)
 282 {
 283   if(timeStamp < 1)
 284   {
 285     timeStamp = TimeService::GetMilliSeconds();
 286   }
 287
 288   Vector2 convertedPosition = RecalculatePosition(point.GetScreenPosition());
 289   point.SetScreenPosition(convertedPosition);
 290
 291   Integration::TouchEvent                            touchEvent;
 292   Integration::HoverEvent                            hoverEvent;
 293   Integration::TouchEventCombiner::EventDispatchType type = mCombiner.GetNextTouchEvent(point, timeStamp, touchEvent, hoverEvent);
 294   if(type != Integration::TouchEventCombiner::DISPATCH_NONE)
 295   {
 296     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);
 297
 298     // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 299     // Keep the handle alive until the core events are processed.
 300     Dali::BaseHandle sceneHolder(this);
 301
 302     // First the touch and/or hover event & related gesture events are queued
 303     if(type == Integration::TouchEventCombiner::DISPATCH_TOUCH || type == Integration::TouchEventCombiner::DISPATCH_BOTH)
 304     {
 305       mScene.QueueEvent(touchEvent);
 306     }
 307
 308     if(type == Integration::TouchEventCombiner::DISPATCH_HOVER || type == Integration::TouchEventCombiner::DISPATCH_BOTH)
 309     {
 310       mScene.QueueEvent(hoverEvent);
 311     }
 312
 313     // Next the events are processed with a single call into Core
 314     mAdaptor->ProcessCoreEvents();
 315   }
 316 }
 317
 318 void SceneHolder::FeedWheelEvent(Dali::Integration::WheelEvent& wheelEvent)
 319 {
 320   // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 321   // Keep the handle alive until the core events are processed.
 322   Dali::BaseHandle sceneHolder(this);
 323
 324   Vector2 convertedPosition = RecalculatePosition(wheelEvent.point);
 325   wheelEvent.point          = convertedPosition;
 326
 327   mScene.QueueEvent(wheelEvent);
 328   mAdaptor->ProcessCoreEvents();
 329 }
 330
 331 void SceneHolder::FeedKeyEvent(Dali::Integration::KeyEvent& keyEvent)
 332 {
 333   Dali::PhysicalKeyboard physicalKeyboard = PhysicalKeyboard::Get();
 334   if(physicalKeyboard)
 335   {
 336     if(!KeyLookup::IsDeviceButton(keyEvent.keyName.c_str()))
 337     {
 338       GetImplementation(physicalKeyboard).KeyReceived(keyEvent.time > 1);
 339     }
 340   }
 341
 342   // Signals can be emitted while processing core events, and the scene holder could be deleted in the signal callback.
 343   // Keep the handle alive until the core events are processed.
 344   Dali::BaseHandle sceneHolder(this);
 345
 346   // Create send KeyEvent to Core.
 347   mScene.QueueEvent(keyEvent);
 348   mAdaptor->ProcessCoreEvents();
 349 }
 350
 351 void SceneHolder::AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
 352 {
 353   mScene.AddFrameRenderedCallback(std::move(callback), frameId);
 354
 355   DALI_LOG_RELEASE_INFO("SceneHolder::AddFrameRenderedCallback:: Added [%d]\n", frameId);
 356 }
 357
 358 void SceneHolder::AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId)
 359 {
 360   mScene.AddFramePresentedCallback(std::move(callback), frameId);
 361
 362   DALI_LOG_RELEASE_INFO("SceneHolder::AddFramePresentedCallback:: Added [%d]\n", frameId);
 363 }
 364
 365 Dali::Integration::SceneHolder SceneHolder::Get(Dali::Actor actor)
 366 {
 367   SceneHolder* sceneHolderImpl = nullptr;
 368
 369   if(Internal::Adaptor::Adaptor::IsAvailable())
 370   {
 371     Dali::Internal::Adaptor::Adaptor& adaptor = Internal::Adaptor::Adaptor::GetImplementation(Internal::Adaptor::Adaptor::Get());
 372     sceneHolderImpl                           = adaptor.GetWindow(actor);
 373   }
 374
 375   return Dali::Integration::SceneHolder(sceneHolderImpl);
 376 }
 377
 378 void SceneHolder::Reset()
 379 {
 380   mCombiner.Reset();
 381
 382   // Any touch listeners should be told of the interruption.
 383   Integration::TouchEvent event;
 384   Integration::Point      point;
 385   point.SetState(PointState::INTERRUPTED);
 386   event.AddPoint(point);
 387
 388   // First the touch event & related gesture events are queued
 389   mScene.QueueEvent(event);
 390
 391   // Next the events are processed with a single call into Core
 392   mAdaptor->ProcessCoreEvents();
 393 }
 394
 395 void SceneHolder::InitializeDpi()
 396 {
 397   unsigned int dpiHorizontal, dpiVertical;
 398   dpiHorizontal = dpiVertical = 0;
 399
 400   mSurface->GetDpi(dpiHorizontal, dpiVertical);
 401   mScene.SetDpi(Vector2(static_cast<float>(dpiHorizontal), static_cast<float>(dpiVertical)));
 402
 403   mDpi.SetX(dpiHorizontal);
 404   mDpi.SetY(dpiVertical);
 405 }
 406
 407 } // namespace Adaptor
 408
 409 } // namespace Internal
 410
 411 } // namespace Dali