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