2 * Copyright (c) 2014 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/system-overlay.h>
28 #include <dali/internal/event/actors/layer-impl.h>
29 #include <dali/internal/event/actors/layer-list.h>
30 #include <dali/internal/event/actors/camera-actor-impl.h>
31 #include <dali/internal/event/actor-attachments/camera-attachment-impl.h>
32 #include <dali/internal/event/common/system-overlay-impl.h>
33 #include <dali/internal/event/common/thread-local-storage.h>
34 #include <dali/internal/event/common/property-notification-manager.h>
35 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
36 #include <dali/internal/update/nodes/node.h>
37 #include <dali/internal/event/common/object-registry-impl.h>
38 #include <dali/integration-api/platform-abstraction.h>
39 #include <dali/public-api/common/constants.h>
40 #include <dali/public-api/object/type-registry.h>
41 #include <dali/public-api/render-tasks/render-task-list.h>
43 #ifdef DYNAMICS_SUPPORT
44 #include <dali/internal/event/dynamics/dynamics-world-config-impl.h>
45 #include <dali/internal/event/dynamics/dynamics-world-impl.h>
46 #include <dali/integration-api/dynamics/dynamics-factory-intf.h>
47 #include <dali/integration-api/dynamics/dynamics-world-settings.h>
50 using Dali::Internal::SceneGraph::Node;
61 const float DEFAULT_STEREO_BASE( 65.0f );
65 const char* const SIGNAL_KEY_EVENT = "key-event";
66 const char* const SIGNAL_EVENT_PROCESSING_FINISHED = "event-processing-finished";
67 const char* const SIGNAL_TOUCHED = "touched";
68 const char* const SIGNAL_CONTEXT_LOST = "context-lost";
69 const char* const SIGNAL_CONTEXT_REGAINED = "context-regained";
70 const char* const SIGNAL_SCENE_CREATED = "scene-created";
72 TypeRegistration mType( typeid(Dali::Stage), typeid(Dali::BaseHandle), NULL );
74 SignalConnectorType signalConnector1( mType, SIGNAL_KEY_EVENT, &Stage::DoConnectSignal );
75 SignalConnectorType signalConnector2( mType, SIGNAL_EVENT_PROCESSING_FINISHED, &Stage::DoConnectSignal );
76 SignalConnectorType signalConnector3( mType, SIGNAL_TOUCHED, &Stage::DoConnectSignal );
77 SignalConnectorType signalConnector4( mType, SIGNAL_CONTEXT_LOST, &Stage::DoConnectSignal );
78 SignalConnectorType signalConnector5( mType, SIGNAL_CONTEXT_REGAINED, &Stage::DoConnectSignal );
79 SignalConnectorType signalConnector6( mType, SIGNAL_SCENE_CREATED, &Stage::DoConnectSignal );
81 } // unnamed namespace
83 StagePtr Stage::New( AnimationPlaylist& playlist,
84 PropertyNotificationManager& propertyNotificationManager,
85 SceneGraph::UpdateManager& updateManager,
86 NotificationManager& notificationManager )
88 return StagePtr( new Stage( playlist, propertyNotificationManager, updateManager, notificationManager ) );
91 void Stage::Initialize()
93 mObjectRegistry = ObjectRegistry::New();
95 // Create the ordered list of layers
96 mLayerList = LayerList::New( mUpdateManager, false/*not system-level*/ );
98 // The stage owns the default layer
99 mRootLayer = Layer::NewRoot( *mLayerList, mUpdateManager, false/*not system-level*/ );
100 mRootLayer->SetName("RootLayer");
102 // Create the default camera actor first; this is needed by the RenderTaskList
103 CreateDefaultCameraActor();
105 // Create the list of render-tasks
106 mRenderTaskList = RenderTaskList::New( *this, *this, false/*not system-level*/ );
108 // Create the default render-task
109 Dali::RenderTask defaultRenderTask = mRenderTaskList->CreateTask();
112 void Stage::Uninitialize()
114 // Remove actors added to SystemOverlay
115 delete mSystemOverlay;
116 mSystemOverlay = NULL;
120 Remove(*(mDefaultCamera.Get()));
125 // we are closing down so just delete the root, no point emit disconnect
126 // signals or send messages to update
131 StagePtr Stage::GetCurrent()
133 StagePtr stage( NULL );
134 // no checking in this version
135 ThreadLocalStorage* tls = ThreadLocalStorage::GetInternal();
138 stage = tls->GetCurrentStage();
143 bool Stage::IsInstalled()
145 return ThreadLocalStorage::Created();
148 ObjectRegistry& Stage::GetObjectRegistry()
150 return *mObjectRegistry;
153 void Stage::RegisterObject( Dali::BaseObject* object )
155 mObjectRegistry->RegisterObject( object );
158 void Stage::UnregisterObject( Dali::BaseObject* object )
160 mObjectRegistry->UnregisterObject( object );
163 Layer& Stage::GetRootActor()
168 AnimationPlaylist& Stage::GetAnimationPlaylist()
170 return mAnimationPlaylist;
173 PropertyNotificationManager& Stage::GetPropertyNotificationManager()
175 return mPropertyNotificationManager;
178 void Stage::Add( Actor& actor )
180 mRootLayer->Add( actor );
183 void Stage::Remove( Actor& actor )
185 mRootLayer->Remove( actor );
188 void Stage::SetSize(float width, float height)
190 // Internally we want to report the actual size of the stage.
192 mSize.height = height;
194 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
195 mDefaultCamera->SetPerspectiveProjection( mSize );
197 // The depth of the stage gets set to the maximun of these values
198 mRootLayer->SetSize( mSize );
200 // Repeat for SystemOverlay actors
203 mSystemOverlay->GetImpl()->SetSize( mSize.width, mSize.height );
206 SetDefaultSurfaceRectMessage( mUpdateManager, Rect<int>( 0, 0, width, height ) );
209 Vector2 Stage::GetSize() const
214 RenderTaskList& Stage::GetRenderTaskList() const
216 return *mRenderTaskList;
219 void Stage::CreateDefaultCameraActor()
221 // The default camera attributes and position is such that
222 // children of the default layer, can be positioned at (0,0) and
223 // be at the top-left of the viewport.
224 mDefaultCamera = CameraActor::New( Size::ZERO );
225 mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
226 Add(*(mDefaultCamera.Get()));
229 Actor& Stage::GetDefaultRootActor()
234 CameraActor& Stage::GetDefaultCameraActor()
236 return *mDefaultCamera;
239 unsigned int Stage::GetLayerCount() const
241 return mLayerList->GetLayerCount();
244 Dali::Layer Stage::GetLayer( unsigned int depth ) const
246 return Dali::Layer(mLayerList->GetLayer( depth ));
249 Dali::Layer Stage::GetRootLayer() const
251 return Dali::Layer( mRootLayer.Get() );
254 LayerList& Stage::GetLayerList()
259 Integration::SystemOverlay& Stage::GetSystemOverlay()
261 // Lazily create system-level if requested
262 if( !mSystemOverlay )
264 mSystemOverlay = new Integration::SystemOverlay( SystemOverlay::New( *this ) );
265 DALI_ASSERT_ALWAYS( NULL != mSystemOverlay && "Failed to create system overlay" );
267 mSystemOverlay->GetImpl()->SetSize( mSize.width, mSize.height );
270 return *mSystemOverlay;
273 SystemOverlay* Stage::GetSystemOverlayInternal()
275 SystemOverlay* overlay( NULL );
279 overlay = mSystemOverlay->GetImpl();
285 void Stage::SetViewMode( ViewMode viewMode )
287 if( mViewMode != viewMode )
289 DALI_LOG_INFO( Debug::Filter::gActor, Debug::Concise, "View mode changed from %d to %d\n", mViewMode, viewMode);
291 if( mViewMode == MONO )
293 mDefaultCamera->SetOrientation( Dali::ANGLE_180, Vector3::YAXIS );
294 mRenderTaskList->GetTask(0).SetSourceActor( Dali::Actor() );
296 //Create camera and RenderTask for left eye
297 mLeftCamera = CameraActor::New( Size::ZERO );
298 mLeftCamera->SetParentOrigin( ParentOrigin::CENTER );
299 mDefaultCamera->Add( *mLeftCamera.Get() );
300 mLeftRenderTask = mRenderTaskList->CreateTask();
301 mLeftRenderTask.SetCameraActor( Dali::CameraActor( mLeftCamera.Get() ) );
302 mLeftCamera->SetType( Dali::Camera::FREE_LOOK );
304 //Create camera and RenderTask for right eye
305 mRightCamera = CameraActor::New( Size::ZERO );
306 mRightCamera->SetParentOrigin( ParentOrigin::CENTER );
307 mDefaultCamera->Add( *mRightCamera.Get() );
308 mRightRenderTask = mRenderTaskList->CreateTask();
309 mRightRenderTask.SetClearColor( Vector4( 1.0f,0.0f,0.0f,1.0f));
311 mRightRenderTask.SetCameraActor( Dali::CameraActor( mRightCamera.Get() ) );
312 mRightCamera->SetType( Dali::Camera::FREE_LOOK );
316 mViewMode = viewMode;
322 // delete extra stereoscopic render tasks and cameras
323 mRenderTaskList->RemoveTask( mLeftRenderTask );
324 mDefaultCamera->Remove( *mLeftCamera.Get() );
325 mLeftRenderTask.Reset();
327 mRenderTaskList->RemoveTask( mRightRenderTask );
328 mDefaultCamera->Remove( *mRightCamera.Get() );
329 mRightRenderTask.Reset();
330 mRightCamera.Reset();
331 mDefaultCamera->SetOrientation( Dali::ANGLE_0, Vector3::YAXIS );
332 mDefaultCamera->SetType( Dali::Camera::LOOK_AT_TARGET );
333 mRenderTaskList->GetTask(0).SetSourceActor( Dali::Layer(mRootLayer.Get()) );
337 case STEREO_HORIZONTAL:
339 //Stereo mode with horizontal split is for landscape mode. That's the reason for the cameras being rotated
340 //Top camera renders the scene as seen from the right eye and bottom camera as seen from left.
342 //Calculate separation in pixels along vertical axis ( mStereoBase is defined in millimetres )
343 const float stereoBase( ( (mStereoBase / 25.4f) * GetDpi().y ) * 0.5f );
345 //Calculate aspect ratio
346 float aspect = mSize.width / (mSize.height * 0.5f);
348 mLeftCamera->SetPerspectiveProjection( mSize, Vector2( 0.0f,stereoBase) );
349 mLeftCamera->SetAspectRatio( aspect );
351 mLeftCamera->SetOrientation( -Dali::ANGLE_90, Vector3::ZAXIS );
352 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
353 mLeftRenderTask.SetViewport( Viewport(0, mSize.height * 0.5f, mSize.width, mSize.height * 0.5f) );
355 mRightCamera->SetPerspectiveProjection( mSize, Vector2( 0.0, -stereoBase) );
356 mRightCamera->SetAspectRatio( aspect );
357 mRightCamera->SetOrientation( -Dali::ANGLE_90, Vector3::ZAXIS );
358 mRightCamera->SetPosition( Vector3(-stereoBase, 0.0f, 0.0f ) );
359 mRightRenderTask.SetViewport( Viewport(0, 0, mSize.width, mSize.height * 0.5f ) );
363 case STEREO_VERTICAL:
365 //Calculate separation in pixels along horizontal axis
366 const float stereoBase( ( (mStereoBase / 25.4f) * GetDpi().x ) * 0.5f );
368 //Recalculate fov based on viewport size
369 const float fov = 2.0f * std::atan( mSize.y / (2.0f * std::max( mSize.x*0.5f, mSize.y )) );
371 mLeftCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(stereoBase,0.0f) );
372 mLeftCamera->SetFieldOfView( fov );
373 mLeftCamera->SetOrientation( Dali::ANGLE_0, Vector3::ZAXIS );
374 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
375 mLeftRenderTask.SetViewport( Viewport(0, 0, mSize.width * 0.5f, mSize.height ) );
377 mRightCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(-stereoBase,0.0f) );
378 mRightCamera->SetFieldOfView( fov );
379 mRightCamera->SetOrientation( Dali::ANGLE_0, Vector3::ZAXIS );
380 mRightCamera->SetPosition( Vector3( -stereoBase, 0.0f, 0.0f ) );
381 mRightRenderTask.SetViewport( Viewport(mSize.width * 0.5f, 0, mSize.width * 0.5f, mSize.height ) );
385 case STEREO_INTERLACED:
393 ViewMode Stage::GetViewMode() const
398 void Stage::SetStereoBase( float stereoBase )
400 if( ! Equals( mStereoBase, stereoBase ) )
402 DALI_LOG_INFO( Debug::Filter::gActor, Debug::Concise, "old( %.2f) new(%.2f)", mStereoBase, stereoBase );
403 mStereoBase = stereoBase;
407 case STEREO_HORIZONTAL:
409 stereoBase = mStereoBase / 25.4f * GetDpi().y * 0.5f;
410 float aspect = mSize.width / (mSize.height * 0.5f);
412 mLeftCamera->SetPerspectiveProjection( mSize, Vector2( 0.0, stereoBase) );
413 mLeftCamera->SetAspectRatio( aspect );
414 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
416 mRightCamera->SetPerspectiveProjection( mSize, Vector2( 0.0, -stereoBase) );
417 mRightCamera->SetAspectRatio( aspect );
418 mRightCamera->SetPosition( Vector3(-stereoBase, 0.0f, 0.0f ) );
422 case STEREO_VERTICAL:
424 stereoBase = mStereoBase / 25.4f * GetDpi().x * 0.5f;
425 const float fov = 2.0f * std::atan( mSize.y / (2.0f * std::max( mSize.x*0.5f, mSize.y )) );
427 mLeftCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(stereoBase,0.0f) );
428 mLeftCamera->SetFieldOfView( fov );
429 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
431 mRightCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(-stereoBase,0.0f) );
432 mRightCamera->SetFieldOfView( fov );
433 mRightCamera->SetPosition( Vector3(-stereoBase, 0.0f, 0.0f ) );
443 float Stage::GetStereoBase() const
448 void Stage::SetBackgroundColor(Vector4 color)
450 // Cache for public GetBackgroundColor()
451 mBackgroundColor = color;
453 // Send message to change color in next frame
454 SetBackgroundColorMessage( mUpdateManager, color );
457 Vector4 Stage::GetBackgroundColor() const
459 return mBackgroundColor;
462 Vector2 Stage::GetDpi() const
467 void Stage::SetDpi(Vector2 dpi)
472 #ifdef DYNAMICS_SUPPORT
474 DynamicsNotifier& Stage::GetDynamicsNotifier()
476 return mDynamicsNotifier;
479 DynamicsWorldPtr Stage::InitializeDynamics(DynamicsWorldConfigPtr config)
481 if( !mDynamicsFactory )
483 mDynamicsFactory = ThreadLocalStorage::Get().GetPlatformAbstraction().GetDynamicsFactory();
486 if( mDynamicsFactory && !mDynamicsWorld )
488 if( mDynamicsFactory->InitializeDynamics( *(config->GetSettings()) ) )
490 mDynamicsWorld = DynamicsWorld::New();
491 mDynamicsWorld->Initialize( *this, *mDynamicsFactory, config );
494 return mDynamicsWorld;
497 DynamicsWorldPtr Stage::GetDynamicsWorld()
499 return mDynamicsWorld;
502 void Stage::TerminateDynamics()
506 mDynamicsWorld->Terminate(*this);
507 mDynamicsWorld = NULL;
511 #endif // DYNAMICS_SUPPORT
513 void Stage::KeepRendering( float durationSeconds )
515 // Send message to keep rendering
516 KeepRenderingMessage( mUpdateManager, durationSeconds );
519 bool Stage::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
521 bool connected( true );
522 Stage* stage = dynamic_cast<Stage*>(object);
524 if( 0 == strcmp( signalName.c_str(), SIGNAL_KEY_EVENT ) )
526 stage->KeyEventSignal().Connect( tracker, functor );
528 else if( 0 == strcmp( signalName.c_str(), SIGNAL_EVENT_PROCESSING_FINISHED ) )
530 stage->EventProcessingFinishedSignal().Connect( tracker, functor );
532 else if( 0 == strcmp( signalName.c_str(), SIGNAL_TOUCHED ) )
534 stage->TouchedSignal().Connect( tracker, functor );
536 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_LOST ) )
538 stage->ContextLostSignal().Connect( tracker, functor );
540 else if( 0 == strcmp( signalName.c_str(), SIGNAL_CONTEXT_REGAINED ) )
542 stage->ContextRegainedSignal().Connect( tracker, functor );
544 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCENE_CREATED ) )
546 stage->SceneCreatedSignal().Connect( tracker, functor );
550 // signalName does not match any signal
557 void Stage::EmitKeyEventSignal(const KeyEvent& event)
559 // Emit the key event signal when no actor in the stage has gained the key input focus
561 mKeyEventSignal.Emit( event );
564 void Stage::EmitEventProcessingFinishedSignal()
566 mEventProcessingFinishedSignal.Emit();
569 void Stage::EmitTouchedSignal( const TouchEvent& touch )
571 mTouchedSignal.Emit( touch );
575 void Stage::EmitSceneCreatedSignal()
577 mSceneCreatedSignal.Emit();
580 Dali::Stage::KeyEventSignalType& Stage::KeyEventSignal()
582 return mKeyEventSignal;
585 Dali::Stage::EventProcessingFinishedSignalType& Stage::EventProcessingFinishedSignal()
587 return mEventProcessingFinishedSignal;
590 Dali::Stage::TouchedSignalType& Stage::TouchedSignal()
592 return mTouchedSignal;
595 Dali::Stage::ContextStatusSignal& Stage::ContextLostSignal()
597 return mContextLostSignal;
600 Dali::Stage::ContextStatusSignal& Stage::ContextRegainedSignal()
602 return mContextRegainedSignal;
605 Dali::Stage::SceneCreatedSignalType& Stage::SceneCreatedSignal()
607 return mSceneCreatedSignal;
610 void Stage::NotifyContextLost()
612 mContextLostSignal.Emit();
615 void Stage::NotifyContextRegained()
617 mContextRegainedSignal.Emit();
620 Stage::Stage( AnimationPlaylist& playlist,
621 PropertyNotificationManager& propertyNotificationManager,
622 SceneGraph::UpdateManager& updateManager,
623 NotificationManager& notificationManager )
624 : mAnimationPlaylist( playlist ),
625 mPropertyNotificationManager(propertyNotificationManager),
626 mUpdateManager(updateManager),
627 mNotificationManager(notificationManager),
628 mSize(Vector2::ZERO),
629 mBackgroundColor(Dali::Stage::DEFAULT_BACKGROUND_COLOR),
631 mStereoBase( DEFAULT_STEREO_BASE ),
632 #ifdef DYNAMICS_SUPPORT
633 mDynamicsFactory(NULL),
639 SceneGraph::UpdateManager& Stage::GetUpdateManager()
641 return mUpdateManager;
644 unsigned int* Stage::ReserveMessageSlot( std::size_t size, bool updateScene )
646 return mUpdateManager.ReserveMessageSlot( size, updateScene );
649 BufferIndex Stage::GetEventBufferIndex() const
651 return mUpdateManager.GetEventBufferIndex();
656 delete mSystemOverlay;
658 mObjectRegistry.Reset();
661 } // namespace Internal