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