2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali/internal/event/common/stage-impl.h>
24 #include <cstring> // for strcmp
27 #include <dali/integration-api/platform-abstraction.h>
28 #include <dali/internal/event/actors/camera-actor-impl.h>
29 #include <dali/internal/event/actors/layer-impl.h>
30 #include <dali/internal/event/actors/layer-list.h>
31 #include <dali/internal/event/common/object-registry-impl.h>
32 #include <dali/internal/event/common/property-notification-manager.h>
33 #include <dali/internal/event/common/thread-local-storage.h>
34 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
35 #include <dali/internal/event/update/frame-callback-interface-impl.h>
36 #include <dali/internal/update/manager/scene-graph-frame-callback.h>
37 #include <dali/internal/update/nodes/node.h>
38 #include <dali/public-api/common/constants.h>
39 #include <dali/public-api/events/touch-event.h>
40 #include <dali/public-api/object/type-registry.h>
41 #include <dali/public-api/render-tasks/render-task-list.h>
42 #include <dali/public-api/rendering/frame-buffer.h>
44 using Dali::Internal::SceneGraph::Node;
48 #if defined(DEBUG_ENABLED)
49 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_DEPTH_TIMER");
61 static constexpr std::string_view SIGNAL_KEY_EVENT = "keyEvent";
62 static constexpr std::string_view SIGNAL_KEY_EVENT_GENERATED = "keyEventGenerated";
63 static constexpr std::string_view SIGNAL_EVENT_PROCESSING_FINISHED = "eventProcessingFinished";
64 static constexpr std::string_view SIGNAL_TOUCHED = "touched";
65 static constexpr std::string_view SIGNAL_WHEEL_EVENT = "wheelEvent";
66 static constexpr std::string_view SIGNAL_CONTEXT_LOST = "contextLost";
67 static constexpr std::string_view SIGNAL_CONTEXT_REGAINED = "contextRegained";
68 static constexpr std::string_view SIGNAL_SCENE_CREATED = "sceneCreated";
70 TypeRegistration mType(typeid(Dali::Stage), typeid(Dali::BaseHandle), nullptr);
72 SignalConnectorType signalConnector1(mType, std::string(SIGNAL_KEY_EVENT), &Stage::DoConnectSignal);
73 SignalConnectorType signalConnector2(mType, std::string(SIGNAL_EVENT_PROCESSING_FINISHED), &Stage::DoConnectSignal);
74 SignalConnectorType signalConnector4(mType, std::string(SIGNAL_WHEEL_EVENT), &Stage::DoConnectSignal);
75 SignalConnectorType signalConnector5(mType, std::string(SIGNAL_CONTEXT_LOST), &Stage::DoConnectSignal);
76 SignalConnectorType signalConnector6(mType, std::string(SIGNAL_CONTEXT_REGAINED), &Stage::DoConnectSignal);
77 SignalConnectorType signalConnector7(mType, std::string(SIGNAL_SCENE_CREATED), &Stage::DoConnectSignal);
78 SignalConnectorType signalConnector8(mType, std::string(SIGNAL_KEY_EVENT_GENERATED), &Stage::DoConnectSignal);
79 SignalConnectorType signalConnector9(mType, std::string(SIGNAL_TOUCHED), &Stage::DoConnectSignal);
81 } // unnamed namespace
83 StagePtr Stage::New(SceneGraph::UpdateManager& updateManager)
85 return StagePtr(new Stage(updateManager));
88 void Stage::Initialize(Scene& scene)
91 mScene->SetBackgroundColor(Dali::DEFAULT_BACKGROUND_COLOR);
92 mScene->EventProcessingFinishedSignal().Connect(this, &Stage::OnEventProcessingFinished);
93 mScene->KeyEventSignal().Connect(this, &Stage::OnKeyEvent);
94 mScene->TouchedSignal().Connect(this, &Stage::OnTouchEvent);
95 mScene->WheelEventSignal().Connect(this, &Stage::OnWheelEvent);
98 StagePtr Stage::GetCurrent()
100 StagePtr stage(nullptr);
101 // no checking in this version
102 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
105 stage = tls->GetCurrentStage();
110 bool Stage::IsInstalled()
112 return ThreadLocalStorage::Created();
115 ObjectRegistry& Stage::GetObjectRegistry()
117 return ThreadLocalStorage::Get().GetObjectRegistry();
120 Layer& Stage::GetRootActor()
122 Dali::Layer rootLayer = GetRootLayer();
123 return GetImplementation(rootLayer);
126 void Stage::Add(Actor& actor)
131 void Stage::Remove(Actor& actor)
133 mScene->Remove(actor);
136 Vector2 Stage::GetSize() const
138 return mScene->GetSize();
141 RenderTaskList& Stage::GetRenderTaskList() const
143 return mScene->GetRenderTaskList();
146 Actor& Stage::GetDefaultRootActor()
148 return mScene->GetDefaultRootActor();
151 CameraActor& Stage::GetDefaultCameraActor() const
153 return mScene->GetDefaultCameraActor();
156 uint32_t Stage::GetLayerCount() const
158 return mScene->GetLayerCount();
161 Dali::Layer Stage::GetLayer(uint32_t depth) const
163 return mScene->GetLayer(depth);
166 Dali::Layer Stage::GetRootLayer() const
168 return mScene->GetRootLayer();
171 LayerList& Stage::GetLayerList()
173 return mScene->GetLayerList();
176 void Stage::SetBackgroundColor(Vector4 color)
178 mScene->SetBackgroundColor(color);
181 Vector4 Stage::GetBackgroundColor() const
183 return mScene->GetBackgroundColor();
186 Vector2 Stage::GetDpi() const
188 return mScene->GetDpi();
191 void Stage::KeepRendering(float durationSeconds)
193 // Send message to keep rendering
194 KeepRenderingMessage(mUpdateManager, durationSeconds);
197 void Stage::SetRenderingBehavior(DevelStage::Rendering renderingBehavior)
199 if(mRenderingBehavior != renderingBehavior)
201 // Send message to change the rendering behavior
202 SetRenderingBehaviorMessage(mUpdateManager, renderingBehavior);
204 mRenderingBehavior = renderingBehavior;
208 DevelStage::Rendering Stage::GetRenderingBehavior() const
210 return mRenderingBehavior;
213 bool Stage::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
215 bool connected(true);
216 Stage* stage = static_cast<Stage*>(object); // TypeRegistry guarantees that this is the correct type.
217 std::string_view name(signalName);
219 if(name == SIGNAL_KEY_EVENT)
221 stage->KeyEventSignal().Connect(tracker, functor);
223 else if(name == SIGNAL_KEY_EVENT_GENERATED)
225 stage->KeyEventGeneratedSignal().Connect(tracker, functor);
227 else if(name == SIGNAL_EVENT_PROCESSING_FINISHED)
229 stage->EventProcessingFinishedSignal().Connect(tracker, functor);
231 else if(name == SIGNAL_TOUCHED)
233 stage->TouchedSignal().Connect(tracker, functor);
235 else if(name == SIGNAL_WHEEL_EVENT)
237 stage->WheelEventSignal().Connect(tracker, functor);
239 else if(name == SIGNAL_CONTEXT_LOST)
241 stage->ContextLostSignal().Connect(tracker, functor);
243 else if(name == SIGNAL_CONTEXT_REGAINED)
245 stage->ContextRegainedSignal().Connect(tracker, functor);
247 else if(name == SIGNAL_SCENE_CREATED)
249 stage->SceneCreatedSignal().Connect(tracker, functor);
253 // signalName does not match any signal
260 void Stage::OnEventProcessingFinished()
262 EmitEventProcessingFinishedSignal();
265 void Stage::OnKeyEvent(const Dali::KeyEvent& event)
267 bool consumed = EmitKeyEventGeneratedSignal(event);
270 EmitKeyEventSignal(event);
274 void Stage::OnTouchEvent(const Dali::TouchEvent& touch)
276 EmitTouchedSignal(touch);
279 void Stage::OnWheelEvent(const Dali::WheelEvent& event)
281 EmitWheelEventSignal(event);
284 void Stage::EmitKeyEventSignal(const KeyEvent& event)
286 // Emit the key event signal when no actor in the stage has gained the key input focus
288 mKeyEventSignal.Emit(event);
291 bool Stage::EmitKeyEventGeneratedSignal(const KeyEvent& event)
293 // Emit the KeyEventGenerated signal when KeyEvent is generated
295 return mKeyEventGeneratedSignal.Emit(event);
298 void Stage::EmitEventProcessingFinishedSignal()
300 mEventProcessingFinishedSignal.Emit();
303 void Stage::EmitTouchedSignal(const Dali::TouchEvent& touch)
305 mTouchedSignal.Emit(touch);
308 void Stage::EmitWheelEventSignal(const WheelEvent& event)
310 // Emit the wheel event signal when no actor in the stage has gained the wheel input focus
312 mWheelEventSignal.Emit(event);
315 void Stage::EmitSceneCreatedSignal()
317 mSceneCreatedSignal.Emit();
320 Dali::Stage::KeyEventSignalType& Stage::KeyEventSignal()
322 return mKeyEventSignal;
325 Dali::DevelStage::KeyEventGeneratedSignalType& Stage::KeyEventGeneratedSignal()
327 return mKeyEventGeneratedSignal;
330 void Stage::AddFrameCallback(FrameCallbackInterface& frameCallback, Actor& rootActor)
332 DALI_ASSERT_ALWAYS((!FrameCallbackInterface::Impl::Get(frameCallback).IsConnectedToSceneGraph()) && "FrameCallbackInterface implementation already added");
334 // Create scene-graph object and transfer to UpdateManager
335 OwnerPointer<SceneGraph::FrameCallback> transferOwnership(SceneGraph::FrameCallback::New(frameCallback));
336 AddFrameCallbackMessage(mUpdateManager, transferOwnership, rootActor.GetNode());
339 void Stage::RemoveFrameCallback(FrameCallbackInterface& frameCallback)
341 FrameCallbackInterface::Impl::Get(frameCallback).Invalidate();
342 RemoveFrameCallbackMessage(mUpdateManager, frameCallback);
345 Dali::Stage::EventProcessingFinishedSignalType& Stage::EventProcessingFinishedSignal()
347 return mEventProcessingFinishedSignal;
350 Dali::Stage::TouchEventSignalType& Stage::TouchedSignal()
352 return mTouchedSignal;
355 Dali::Stage::WheelEventSignalType& Stage::WheelEventSignal()
357 return mWheelEventSignal;
360 Dali::Stage::ContextStatusSignal& Stage::ContextLostSignal()
362 return mContextLostSignal;
365 Dali::Stage::ContextStatusSignal& Stage::ContextRegainedSignal()
367 return mContextRegainedSignal;
370 Dali::Stage::SceneCreatedSignalType& Stage::SceneCreatedSignal()
372 return mSceneCreatedSignal;
375 void Stage::NotifyContextLost()
377 mContextLostSignal.Emit();
380 void Stage::NotifyContextRegained()
382 mContextRegainedSignal.Emit();
385 Stage::Stage(SceneGraph::UpdateManager& updateManager)
386 : mUpdateManager(updateManager),
388 mKeyEventGeneratedSignal(),
389 mEventProcessingFinishedSignal(),
392 mContextLostSignal(),
393 mContextRegainedSignal(),
394 mSceneCreatedSignal(),
395 mRenderingBehavior(DevelStage::Rendering::IF_REQUIRED)
399 Stage::~Stage() = default;
401 } // namespace Internal