2 * Copyright (c) 2020 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/internal/event/actors/layer-impl.h>
28 #include <dali/internal/event/actors/layer-list.h>
29 #include <dali/internal/event/actors/camera-actor-impl.h>
30 #include <dali/internal/event/common/thread-local-storage.h>
31 #include <dali/internal/event/common/property-notification-manager.h>
32 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
33 #include <dali/internal/event/update/frame-callback-interface-impl.h>
34 #include <dali/internal/update/nodes/node.h>
35 #include <dali/internal/update/manager/scene-graph-frame-callback.h>
36 #include <dali/internal/event/common/object-registry-impl.h>
37 #include <dali/integration-api/platform-abstraction.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>
43 #include <dali/public-api/common/constants.h>
45 using Dali::Internal::SceneGraph::Node;
49 #if defined(DEBUG_ENABLED)
50 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_DEPTH_TIMER" );
65 const char* const SIGNAL_KEY_EVENT = "keyEvent";
66 const char* const SIGNAL_KEY_EVENT_GENERATED = "keyEventGenerated";
67 const char* const SIGNAL_EVENT_PROCESSING_FINISHED = "eventProcessingFinished";
68 const char* const SIGNAL_TOUCHED = "touched";
69 const char* const SIGNAL_WHEEL_EVENT = "wheelEvent";
70 const char* const SIGNAL_CONTEXT_LOST = "contextLost";
71 const char* const SIGNAL_CONTEXT_REGAINED = "contextRegained";
72 const char* const SIGNAL_SCENE_CREATED = "sceneCreated";
74 TypeRegistration mType( typeid(Dali::Stage), typeid(Dali::BaseHandle), nullptr );
76 SignalConnectorType signalConnector1( mType, SIGNAL_KEY_EVENT, &Stage::DoConnectSignal );
77 SignalConnectorType signalConnector2( mType, SIGNAL_EVENT_PROCESSING_FINISHED, &Stage::DoConnectSignal );
78 SignalConnectorType signalConnector4( mType, SIGNAL_WHEEL_EVENT, &Stage::DoConnectSignal );
79 SignalConnectorType signalConnector5( mType, SIGNAL_CONTEXT_LOST, &Stage::DoConnectSignal );
80 SignalConnectorType signalConnector6( mType, SIGNAL_CONTEXT_REGAINED, &Stage::DoConnectSignal );
81 SignalConnectorType signalConnector7( mType, SIGNAL_SCENE_CREATED, &Stage::DoConnectSignal );
82 SignalConnectorType signalConnector8( mType, SIGNAL_KEY_EVENT_GENERATED, &Stage::DoConnectSignal );
83 SignalConnectorType signalConnector9( mType, SIGNAL_TOUCHED, &Stage::DoConnectSignal );
85 } // unnamed namespace
87 StagePtr Stage::New( SceneGraph::UpdateManager& updateManager )
89 return StagePtr( new Stage( updateManager ) );
92 void Stage::Initialize( Scene& scene )
95 mScene->SetBackgroundColor( Dali::DEFAULT_BACKGROUND_COLOR );
96 mScene->EventProcessingFinishedSignal().Connect( this, &Stage::OnEventProcessingFinished );
97 mScene->KeyEventSignal().Connect( this, &Stage::OnKeyEvent );
98 mScene->TouchedSignal().Connect( this, &Stage::OnTouchEvent );
99 mScene->WheelEventSignal().Connect( this, &Stage::OnWheelEvent );
102 StagePtr Stage::GetCurrent()
104 StagePtr stage( nullptr );
105 // no checking in this version
106 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
109 stage = tls->GetCurrentStage();
114 bool Stage::IsInstalled()
116 return ThreadLocalStorage::Created();
119 ObjectRegistry& Stage::GetObjectRegistry()
121 return ThreadLocalStorage::Get().GetObjectRegistry();
124 Layer& Stage::GetRootActor()
126 Dali::Layer rootLayer = GetRootLayer();
127 return GetImplementation( rootLayer );
130 void Stage::Add( Actor& actor )
132 mScene->Add( actor );
135 void Stage::Remove( Actor& actor )
137 mScene->Remove( actor );
140 Vector2 Stage::GetSize() const
142 return mScene->GetSize();
145 RenderTaskList& Stage::GetRenderTaskList() const
147 return mScene->GetRenderTaskList();
150 Actor& Stage::GetDefaultRootActor()
152 return mScene->GetDefaultRootActor();
155 CameraActor& Stage::GetDefaultCameraActor()
157 return mScene->GetDefaultCameraActor();
160 uint32_t Stage::GetLayerCount() const
162 return mScene->GetLayerCount();
165 Dali::Layer Stage::GetLayer( uint32_t depth ) const
167 return mScene->GetLayer( depth );
170 Dali::Layer Stage::GetRootLayer() const
172 return mScene->GetRootLayer();
175 LayerList& Stage::GetLayerList()
177 return mScene->GetLayerList();
180 void Stage::SetBackgroundColor(Vector4 color)
182 mScene->SetBackgroundColor( color );
185 Vector4 Stage::GetBackgroundColor() const
187 return mScene->GetBackgroundColor();
190 Vector2 Stage::GetDpi() const
192 return mScene->GetDpi();
195 void Stage::KeepRendering( float durationSeconds )
197 // Send message to keep rendering
198 KeepRenderingMessage( mUpdateManager, durationSeconds );
201 void Stage::SetRenderingBehavior( DevelStage::Rendering renderingBehavior )
203 if( mRenderingBehavior != renderingBehavior )
205 // Send message to change the rendering behavior
206 SetRenderingBehaviorMessage( mUpdateManager, renderingBehavior );
208 mRenderingBehavior = renderingBehavior;
212 DevelStage::Rendering Stage::GetRenderingBehavior() const
214 return mRenderingBehavior;
217 bool Stage::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
219 bool connected( true );
220 Stage* stage = static_cast< Stage* >(object); // TypeRegistry guarantees that this is the correct type.
222 if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) )
224 stage->KeyEventSignal().Connect( tracker, functor );
226 else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT_GENERATED ) )
228 stage->KeyEventGeneratedSignal().Connect( tracker, functor );
230 else if( 0 == strcmp( signalName.c_str(), SIGNAL_EVENT_PROCESSING_FINISHED ) )
232 stage->EventProcessingFinishedSignal().Connect( tracker, functor );
234 else if( 0 == strcmp( signalName.c_str(), SIGNAL_TOUCHED ) )
236 stage->TouchedSignal().Connect( tracker, functor );
238 else if( 0 == strcmp( signalName.c_str(), SIGNAL_WHEEL_EVENT ) )
240 stage->WheelEventSignal().Connect( tracker, functor );
242 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_LOST ) )
244 stage->ContextLostSignal().Connect( tracker, functor );
246 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_REGAINED ) )
248 stage->ContextRegainedSignal().Connect( tracker, functor );
250 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCENE_CREATED ) )
252 stage->SceneCreatedSignal().Connect( tracker, functor );
256 // signalName does not match any signal
263 void Stage::OnEventProcessingFinished()
265 EmitEventProcessingFinishedSignal();
268 void Stage::OnKeyEvent( const Dali::KeyEvent& event )
270 bool consumed = EmitKeyEventGeneratedSignal( event );
273 EmitKeyEventSignal( event );
277 void Stage::OnTouchEvent( const Dali::TouchEvent& touch )
279 EmitTouchedSignal( touch );
282 void Stage::OnWheelEvent( const Dali::WheelEvent& event )
284 EmitWheelEventSignal( event );
287 void Stage::EmitKeyEventSignal(const KeyEvent& event)
289 // Emit the key event signal when no actor in the stage has gained the key input focus
291 mKeyEventSignal.Emit( event );
294 bool Stage::EmitKeyEventGeneratedSignal(const KeyEvent& event)
296 // Emit the KeyEventGenerated signal when KeyEvent is generated
298 return mKeyEventGeneratedSignal.Emit( event );
301 void Stage::EmitEventProcessingFinishedSignal()
303 mEventProcessingFinishedSignal.Emit();
306 void Stage::EmitTouchedSignal( const Dali::TouchEvent& touch )
308 mTouchedSignal.Emit( touch );
311 void Stage::EmitWheelEventSignal( const WheelEvent& event )
313 // Emit the wheel event signal when no actor in the stage has gained the wheel input focus
315 mWheelEventSignal.Emit( event );
318 void Stage::EmitSceneCreatedSignal()
320 mSceneCreatedSignal.Emit();
323 Dali::Stage::KeyEventSignalType& Stage::KeyEventSignal()
325 return mKeyEventSignal;
328 Dali::DevelStage::KeyEventGeneratedSignalType& Stage::KeyEventGeneratedSignal()
330 return mKeyEventGeneratedSignal;
333 void Stage::AddFrameCallback( FrameCallbackInterface& frameCallback, Actor& rootActor )
335 DALI_ASSERT_ALWAYS( ( ! FrameCallbackInterface::Impl::Get( frameCallback ).IsConnectedToSceneGraph() )
336 && "FrameCallbackInterface implementation already added" );
338 // Create scene-graph object and transfer to UpdateManager
339 OwnerPointer< SceneGraph::FrameCallback > transferOwnership( SceneGraph::FrameCallback::New( frameCallback ) );
340 AddFrameCallbackMessage( mUpdateManager, transferOwnership, rootActor.GetNode() );
343 void Stage::RemoveFrameCallback( FrameCallbackInterface& frameCallback )
345 FrameCallbackInterface::Impl::Get( frameCallback ).Invalidate();
346 RemoveFrameCallbackMessage( mUpdateManager, frameCallback );
349 Dali::Stage::EventProcessingFinishedSignalType& Stage::EventProcessingFinishedSignal()
351 return mEventProcessingFinishedSignal;
354 Dali::Stage::TouchEventSignalType& Stage::TouchedSignal()
356 return mTouchedSignal;
359 Dali::Stage::WheelEventSignalType& Stage::WheelEventSignal()
361 return mWheelEventSignal;
364 Dali::Stage::ContextStatusSignal& Stage::ContextLostSignal()
366 return mContextLostSignal;
369 Dali::Stage::ContextStatusSignal& Stage::ContextRegainedSignal()
371 return mContextRegainedSignal;
374 Dali::Stage::SceneCreatedSignalType& Stage::SceneCreatedSignal()
376 return mSceneCreatedSignal;
379 void Stage::NotifyContextLost()
381 mContextLostSignal.Emit();
384 void Stage::NotifyContextRegained()
386 mContextRegainedSignal.Emit();
389 Stage::Stage( SceneGraph::UpdateManager& updateManager )
390 : mUpdateManager( updateManager ),
392 mKeyEventGeneratedSignal(),
393 mEventProcessingFinishedSignal(),
396 mContextLostSignal(),
397 mContextRegainedSignal(),
398 mSceneCreatedSignal(),
399 mRenderingBehavior( DevelStage::Rendering::IF_REQUIRED )
407 } // namespace Internal