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