2 * Copyright (c) 2019 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/events/touch-data.h>
41 #include <dali/public-api/object/type-registry.h>
42 #include <dali/public-api/render-tasks/render-task-list.h>
43 #include <dali/public-api/rendering/frame-buffer.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_TOUCH = "touch";
70 const char* const SIGNAL_WHEEL_EVENT = "wheelEvent";
71 const char* const SIGNAL_CONTEXT_LOST = "contextLost";
72 const char* const SIGNAL_CONTEXT_REGAINED = "contextRegained";
73 const char* const SIGNAL_SCENE_CREATED = "sceneCreated";
75 TypeRegistration mType( typeid(Dali::Stage), typeid(Dali::BaseHandle), NULL );
77 SignalConnectorType signalConnector1( mType, SIGNAL_KEY_EVENT, &Stage::DoConnectSignal );
78 SignalConnectorType signalConnector2( mType, SIGNAL_EVENT_PROCESSING_FINISHED, &Stage::DoConnectSignal );
79 SignalConnectorType signalConnector3( mType, SIGNAL_TOUCHED, &Stage::DoConnectSignal );
80 SignalConnectorType signalConnector4( mType, SIGNAL_WHEEL_EVENT, &Stage::DoConnectSignal );
81 SignalConnectorType signalConnector5( mType, SIGNAL_CONTEXT_LOST, &Stage::DoConnectSignal );
82 SignalConnectorType signalConnector6( mType, SIGNAL_CONTEXT_REGAINED, &Stage::DoConnectSignal );
83 SignalConnectorType signalConnector7( mType, SIGNAL_SCENE_CREATED, &Stage::DoConnectSignal );
84 SignalConnectorType signalConnector8( mType, SIGNAL_KEY_EVENT_GENERATED, &Stage::DoConnectSignal );
85 SignalConnectorType signalConnector9( mType, SIGNAL_TOUCH, &Stage::DoConnectSignal );
87 } // unnamed namespace
89 StagePtr Stage::New( SceneGraph::UpdateManager& updateManager )
91 return StagePtr( new Stage( updateManager ) );
94 void Stage::Initialize( Scene& scene )
97 mScene->SetBackgroundColor( Dali::Stage::DEFAULT_BACKGROUND_COLOR );
98 mScene->EventProcessingFinishedSignal().Connect( this, &Stage::OnEventProcessingFinished );
99 mScene->KeyEventSignal().Connect( this, &Stage::OnKeyEvent );
100 mScene->TouchedSignal().Connect( this, &Stage::OnTouchedEvent );
101 mScene->TouchSignal().Connect( this, &Stage::OnTouchEvent );
102 mScene->WheelEventSignal().Connect( this, &Stage::OnWheelEvent );
105 StagePtr Stage::GetCurrent()
107 StagePtr stage( NULL );
108 // no checking in this version
109 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
112 stage = tls->GetCurrentStage();
117 bool Stage::IsInstalled()
119 return ThreadLocalStorage::Created();
122 ObjectRegistry& Stage::GetObjectRegistry()
124 return ThreadLocalStorage::Get().GetObjectRegistry();
127 Layer& Stage::GetRootActor()
129 Dali::Layer rootLayer = GetRootLayer();
130 return GetImplementation( rootLayer );
133 void Stage::Add( Actor& actor )
135 mScene->Add( actor );
138 void Stage::Remove( Actor& actor )
140 mScene->Remove( actor );
143 Vector2 Stage::GetSize() const
145 return mScene->GetSize();
148 RenderTaskList& Stage::GetRenderTaskList() const
150 return mScene->GetRenderTaskList();
153 Actor& Stage::GetDefaultRootActor()
155 return mScene->GetDefaultRootActor();
158 CameraActor& Stage::GetDefaultCameraActor()
160 return mScene->GetDefaultCameraActor();
163 uint32_t Stage::GetLayerCount() const
165 return mScene->GetLayerCount();
168 Dali::Layer Stage::GetLayer( uint32_t depth ) const
170 return mScene->GetLayer( depth );
173 Dali::Layer Stage::GetRootLayer() const
175 return mScene->GetRootLayer();
178 LayerList& Stage::GetLayerList()
180 return mScene->GetLayerList();
183 void Stage::SetBackgroundColor(Vector4 color)
185 mScene->SetBackgroundColor( color );
188 Vector4 Stage::GetBackgroundColor() const
190 return mScene->GetBackgroundColor();
193 Vector2 Stage::GetDpi() const
195 return mScene->GetDpi();
198 void Stage::KeepRendering( float durationSeconds )
200 // Send message to keep rendering
201 KeepRenderingMessage( mUpdateManager, durationSeconds );
204 void Stage::SetRenderingBehavior( DevelStage::Rendering renderingBehavior )
206 if( mRenderingBehavior != renderingBehavior )
208 // Send message to change the rendering behavior
209 SetRenderingBehaviorMessage( mUpdateManager, renderingBehavior );
211 mRenderingBehavior = renderingBehavior;
215 DevelStage::Rendering Stage::GetRenderingBehavior() const
217 return mRenderingBehavior;
220 bool Stage::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
222 bool connected( true );
223 Stage* stage = static_cast< Stage* >(object); // TypeRegistry guarantees that this is the correct type.
225 if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) )
227 stage->KeyEventSignal().Connect( tracker, functor );
229 else if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT_GENERATED ) )
231 stage->KeyEventGeneratedSignal().Connect( tracker, functor );
233 else if( 0 == strcmp( signalName.c_str(), SIGNAL_EVENT_PROCESSING_FINISHED ) )
235 stage->EventProcessingFinishedSignal().Connect( tracker, functor );
237 else if( 0 == strcmp( signalName.c_str(), SIGNAL_TOUCHED ) )
239 stage->TouchedSignal().Connect( tracker, functor );
241 else if( 0 == strcmp( signalName.c_str(), SIGNAL_TOUCH ) )
243 stage->TouchSignal().Connect( tracker, functor );
245 else if( 0 == strcmp( signalName.c_str(), SIGNAL_WHEEL_EVENT ) )
247 stage->WheelEventSignal().Connect( tracker, functor );
249 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_LOST ) )
251 stage->ContextLostSignal().Connect( tracker, functor );
253 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_REGAINED ) )
255 stage->ContextRegainedSignal().Connect( tracker, functor );
257 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCENE_CREATED ) )
259 stage->SceneCreatedSignal().Connect( tracker, functor );
263 // signalName does not match any signal
270 void Stage::OnEventProcessingFinished()
272 EmitEventProcessingFinishedSignal();
275 void Stage::OnKeyEvent( const Dali::KeyEvent& event )
277 bool consumed = EmitKeyEventGeneratedSignal( event );
280 EmitKeyEventSignal( event );
284 void Stage::OnTouchedEvent( const Dali::TouchEvent& touchEvent )
286 mTouchedSignal.Emit( touchEvent );
289 void Stage::OnTouchEvent( const Dali::TouchData& touch )
291 mTouchSignal.Emit( touch );
294 void Stage::OnWheelEvent( const Dali::WheelEvent& event )
296 EmitWheelEventSignal( event );
299 void Stage::EmitKeyEventSignal(const KeyEvent& event)
301 // Emit the key event signal when no actor in the stage has gained the key input focus
303 mKeyEventSignal.Emit( event );
306 bool Stage::EmitKeyEventGeneratedSignal(const KeyEvent& event)
308 // Emit the KeyEventGenerated signal when KeyEvent is generated
310 return mKeyEventGeneratedSignal.Emit( event );
313 void Stage::EmitEventProcessingFinishedSignal()
315 mEventProcessingFinishedSignal.Emit();
318 void Stage::EmitTouchedSignal( const TouchEvent& touchEvent, const Dali::TouchData& touch )
320 mTouchedSignal.Emit( touchEvent );
321 mTouchSignal.Emit( touch );
324 void Stage::EmitWheelEventSignal( const WheelEvent& event )
326 // Emit the wheel event signal when no actor in the stage has gained the wheel input focus
328 mWheelEventSignal.Emit( event );
331 void Stage::EmitSceneCreatedSignal()
333 mSceneCreatedSignal.Emit();
336 Dali::Stage::KeyEventSignalType& Stage::KeyEventSignal()
338 return mKeyEventSignal;
341 Dali::DevelStage::KeyEventGeneratedSignalType& Stage::KeyEventGeneratedSignal()
343 return mKeyEventGeneratedSignal;
346 void Stage::AddFrameCallback( FrameCallbackInterface& frameCallback, Actor& rootActor )
348 DALI_ASSERT_ALWAYS( ( ! FrameCallbackInterface::Impl::Get( frameCallback ).IsConnectedToSceneGraph() )
349 && "FrameCallbackInterface implementation already added" );
351 // Create scene-graph object and transfer to UpdateManager
352 OwnerPointer< SceneGraph::FrameCallback > transferOwnership( SceneGraph::FrameCallback::New( frameCallback ) );
353 AddFrameCallbackMessage( mUpdateManager, transferOwnership, rootActor.GetNode() );
356 void Stage::RemoveFrameCallback( FrameCallbackInterface& frameCallback )
358 FrameCallbackInterface::Impl::Get( frameCallback ).Invalidate();
359 RemoveFrameCallbackMessage( mUpdateManager, frameCallback );
362 Dali::Stage::EventProcessingFinishedSignalType& Stage::EventProcessingFinishedSignal()
364 return mEventProcessingFinishedSignal;
367 Dali::Stage::TouchedSignalType& Stage::TouchedSignal()
369 DALI_LOG_WARNING( "Deprecated. Use TouchSignal() instead.\n" );
370 return mTouchedSignal;
373 Dali::Stage::TouchSignalType& Stage::TouchSignal()
378 Dali::Stage::WheelEventSignalType& Stage::WheelEventSignal()
380 return mWheelEventSignal;
383 Dali::Stage::ContextStatusSignal& Stage::ContextLostSignal()
385 return mContextLostSignal;
388 Dali::Stage::ContextStatusSignal& Stage::ContextRegainedSignal()
390 return mContextRegainedSignal;
393 Dali::Stage::SceneCreatedSignalType& Stage::SceneCreatedSignal()
395 return mSceneCreatedSignal;
398 void Stage::NotifyContextLost()
400 mContextLostSignal.Emit();
403 void Stage::NotifyContextRegained()
405 mContextRegainedSignal.Emit();
408 Stage::Stage( SceneGraph::UpdateManager& updateManager )
409 : mUpdateManager( updateManager ),
411 mKeyEventGeneratedSignal(),
412 mEventProcessingFinishedSignal(),
416 mContextLostSignal(),
417 mContextRegainedSignal(),
418 mSceneCreatedSignal(),
419 mRenderingBehavior( DevelStage::Rendering::IF_REQUIRED )
427 } // namespace Internal