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-data.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" );
64 const char* const SIGNAL_KEY_EVENT = "keyEvent";
65 const char* const SIGNAL_KEY_EVENT_GENERATED = "keyEventGenerated";
66 const char* const SIGNAL_EVENT_PROCESSING_FINISHED = "eventProcessingFinished";
67 const char* const SIGNAL_TOUCH = "touch";
68 const char* const SIGNAL_WHEEL_EVENT = "wheelEvent";
69 const char* const SIGNAL_CONTEXT_LOST = "contextLost";
70 const char* const SIGNAL_CONTEXT_REGAINED = "contextRegained";
71 const char* const SIGNAL_SCENE_CREATED = "sceneCreated";
73 TypeRegistration mType( typeid(Dali::Stage), typeid(Dali::BaseHandle), NULL );
75 SignalConnectorType signalConnector1( mType, SIGNAL_KEY_EVENT, &Stage::DoConnectSignal );
76 SignalConnectorType signalConnector2( mType, SIGNAL_EVENT_PROCESSING_FINISHED, &Stage::DoConnectSignal );
77 SignalConnectorType signalConnector4( mType, SIGNAL_WHEEL_EVENT, &Stage::DoConnectSignal );
78 SignalConnectorType signalConnector5( mType, SIGNAL_CONTEXT_LOST, &Stage::DoConnectSignal );
79 SignalConnectorType signalConnector6( mType, SIGNAL_CONTEXT_REGAINED, &Stage::DoConnectSignal );
80 SignalConnectorType signalConnector7( mType, SIGNAL_SCENE_CREATED, &Stage::DoConnectSignal );
81 SignalConnectorType signalConnector8( mType, SIGNAL_KEY_EVENT_GENERATED, &Stage::DoConnectSignal );
82 SignalConnectorType signalConnector9( mType, SIGNAL_TOUCH, &Stage::DoConnectSignal );
84 } // unnamed namespace
86 StagePtr Stage::New( SceneGraph::UpdateManager& updateManager )
88 return StagePtr( new Stage( updateManager ) );
91 void Stage::Initialize( Scene& scene )
94 mScene->SetBackgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR );
95 mScene->EventProcessingFinishedSignal().Connect( this, &Stage::OnEventProcessingFinished );
96 mScene->KeyEventSignal().Connect( this, &Stage::OnKeyEvent );
97 mScene->TouchSignal().Connect( this, &Stage::OnTouchEvent );
98 mScene->WheelEventSignal().Connect( this, &Stage::OnWheelEvent );
101 StagePtr Stage::GetCurrent()
103 StagePtr stage( NULL );
104 // no checking in this version
105 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
108 stage = tls->GetCurrentStage();
113 bool Stage::IsInstalled()
115 return ThreadLocalStorage::Created();
118 ObjectRegistry& Stage::GetObjectRegistry()
120 return ThreadLocalStorage::Get().GetObjectRegistry();
123 Layer& Stage::GetRootActor()
125 Dali::Layer rootLayer = GetRootLayer();
126 return GetImplementation( rootLayer );
129 void Stage::Add( Actor& actor )
131 mScene->Add( actor );
134 void Stage::Remove( Actor& actor )
136 mScene->Remove( actor );
139 Vector2 Stage::GetSize() const
141 return mScene->GetSize();
144 RenderTaskList& Stage::GetRenderTaskList() const
146 return mScene->GetRenderTaskList();
149 Actor& Stage::GetDefaultRootActor()
151 return mScene->GetDefaultRootActor();
154 CameraActor& Stage::GetDefaultCameraActor()
156 return mScene->GetDefaultCameraActor();
159 uint32_t Stage::GetLayerCount() const
161 return mScene->GetLayerCount();
164 Dali::Layer Stage::GetLayer( uint32_t depth ) const
166 return mScene->GetLayer( depth );
169 Dali::Layer Stage::GetRootLayer() const
171 return mScene->GetRootLayer();
174 LayerList& Stage::GetLayerList()
176 return mScene->GetLayerList();
179 void Stage::SetBackgroundColor(Vector4 color)
181 mScene->SetBackgroundColor( color );
184 Vector4 Stage::GetBackgroundColor() const
186 return mScene->GetBackgroundColor();
189 Vector2 Stage::GetDpi() const
191 return mScene->GetDpi();
194 void Stage::KeepRendering( float durationSeconds )
196 // Send message to keep rendering
197 KeepRenderingMessage( mUpdateManager, durationSeconds );
200 void Stage::SetRenderingBehavior( DevelStage::Rendering renderingBehavior )
202 if( mRenderingBehavior != renderingBehavior )
204 // Send message to change the rendering behavior
205 SetRenderingBehaviorMessage( mUpdateManager, renderingBehavior );
207 mRenderingBehavior = renderingBehavior;
211 DevelStage::Rendering Stage::GetRenderingBehavior() const
213 return mRenderingBehavior;
216 bool Stage::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
218 bool connected( true );
219 Stage* stage = static_cast< Stage* >(object); // TypeRegistry guarantees that this is the correct type.
221 if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) )
223 stage->KeyEventSignal().Connect( tracker, functor );
225 else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT_GENERATED ) )
227 stage->KeyEventGeneratedSignal().Connect( tracker, functor );
229 else if( 0 == strcmp( signalName.c_str(), SIGNAL_EVENT_PROCESSING_FINISHED ) )
231 stage->EventProcessingFinishedSignal().Connect( tracker, functor );
233 else if( 0 == strcmp( signalName.c_str(), SIGNAL_TOUCH ) )
235 stage->TouchSignal().Connect( tracker, functor );
237 else if( 0 == strcmp( signalName.c_str(), SIGNAL_WHEEL_EVENT ) )
239 stage->WheelEventSignal().Connect( tracker, functor );
241 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_LOST ) )
243 stage->ContextLostSignal().Connect( tracker, functor );
245 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_REGAINED ) )
247 stage->ContextRegainedSignal().Connect( tracker, functor );
249 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCENE_CREATED ) )
251 stage->SceneCreatedSignal().Connect( tracker, functor );
255 // signalName does not match any signal
262 void Stage::OnEventProcessingFinished()
264 EmitEventProcessingFinishedSignal();
267 void Stage::OnKeyEvent( const Dali::KeyEvent& event )
269 bool consumed = EmitKeyEventGeneratedSignal( event );
272 EmitKeyEventSignal( event );
276 void Stage::OnTouchEvent( const Dali::TouchData& touch )
278 mTouchSignal.Emit( touch );
281 void Stage::OnWheelEvent( const Dali::WheelEvent& event )
283 EmitWheelEventSignal( event );
286 void Stage::EmitKeyEventSignal(const KeyEvent& event)
288 // Emit the key event signal when no actor in the stage has gained the key input focus
290 mKeyEventSignal.Emit( event );
293 bool Stage::EmitKeyEventGeneratedSignal(const KeyEvent& event)
295 // Emit the KeyEventGenerated signal when KeyEvent is generated
297 return mKeyEventGeneratedSignal.Emit( event );
300 void Stage::EmitEventProcessingFinishedSignal()
302 mEventProcessingFinishedSignal.Emit();
305 void Stage::EmitTouchedSignal( const Dali::TouchData& touch )
307 mTouchSignal.Emit( touch );
310 void Stage::EmitWheelEventSignal( const WheelEvent& event )
312 // Emit the wheel event signal when no actor in the stage has gained the wheel input focus
314 mWheelEventSignal.Emit( event );
317 void Stage::EmitSceneCreatedSignal()
319 mSceneCreatedSignal.Emit();
322 Dali::Stage::KeyEventSignalType& Stage::KeyEventSignal()
324 return mKeyEventSignal;
327 Dali::DevelStage::KeyEventGeneratedSignalType& Stage::KeyEventGeneratedSignal()
329 return mKeyEventGeneratedSignal;
332 void Stage::AddFrameCallback( FrameCallbackInterface& frameCallback, Actor& rootActor )
334 DALI_ASSERT_ALWAYS( ( ! FrameCallbackInterface::Impl::Get( frameCallback ).IsConnectedToSceneGraph() )
335 && "FrameCallbackInterface implementation already added" );
337 // Create scene-graph object and transfer to UpdateManager
338 OwnerPointer< SceneGraph::FrameCallback > transferOwnership( SceneGraph::FrameCallback::New( frameCallback ) );
339 AddFrameCallbackMessage( mUpdateManager, transferOwnership, rootActor.GetNode() );
342 void Stage::RemoveFrameCallback( FrameCallbackInterface& frameCallback )
344 FrameCallbackInterface::Impl::Get( frameCallback ).Invalidate();
345 RemoveFrameCallbackMessage( mUpdateManager, frameCallback );
348 Dali::Stage::EventProcessingFinishedSignalType& Stage::EventProcessingFinishedSignal()
350 return mEventProcessingFinishedSignal;
353 Dali::Stage::TouchSignalType& Stage::TouchSignal()
358 Dali::Stage::WheelEventSignalType& Stage::WheelEventSignal()
360 return mWheelEventSignal;
363 Dali::Stage::ContextStatusSignal& Stage::ContextLostSignal()
365 return mContextLostSignal;
368 Dali::Stage::ContextStatusSignal& Stage::ContextRegainedSignal()
370 return mContextRegainedSignal;
373 Dali::Stage::SceneCreatedSignalType& Stage::SceneCreatedSignal()
375 return mSceneCreatedSignal;
378 void Stage::NotifyContextLost()
380 mContextLostSignal.Emit();
383 void Stage::NotifyContextRegained()
385 mContextRegainedSignal.Emit();
388 Stage::Stage( SceneGraph::UpdateManager& updateManager )
389 : mUpdateManager( updateManager ),
391 mKeyEventGeneratedSignal(),
392 mEventProcessingFinishedSignal(),
395 mContextLostSignal(),
396 mContextRegainedSignal(),
397 mSceneCreatedSignal(),
398 mRenderingBehavior( DevelStage::Rendering::IF_REQUIRED )
406 } // namespace Internal