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>
26 #include <dali/integration-api/system-overlay.h>
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/actor-attachments/camera-attachment-impl.h>
31 #include <dali/internal/event/common/system-overlay-impl.h>
32 #include <dali/internal/event/common/thread-local-storage.h>
33 #include <dali/internal/event/common/property-notification-manager.h>
34 #include <dali/internal/event/render-tasks/render-task-list-impl.h>
35 #include <dali/internal/update/nodes/node.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/render-tasks/render-task-list.h>
41 #ifdef DYNAMICS_SUPPORT
42 #include <dali/internal/event/dynamics/dynamics-world-config-impl.h>
43 #include <dali/internal/event/dynamics/dynamics-world-impl.h>
44 #include <dali/integration-api/dynamics/dynamics-factory-intf.h>
45 #include <dali/integration-api/dynamics/dynamics-world-settings.h>
48 using Dali::Internal::SceneGraph::Node;
59 const float DEFAULT_STEREO_BASE( 65.0f );
61 } // unnamed namespace
63 StagePtr Stage::New( AnimationPlaylist& playlist,
64 PropertyNotificationManager& propertyNotificationManager,
65 SceneGraph::UpdateManager& updateManager,
66 NotificationManager& notificationManager )
68 return StagePtr( new Stage( playlist, propertyNotificationManager, updateManager, notificationManager ) );
71 void Stage::Initialize()
73 mObjectRegistry = ObjectRegistry::New();
75 // Create the ordered list of layers
76 mLayerList = LayerList::New( *this, false/*not system-level*/ );
78 // The stage owns the default layer
79 mRootLayer = Layer::NewRoot( *this, *mLayerList, mUpdateManager, false/*not system-level*/ );
80 mRootLayer->SetName("RootLayer");
82 // Create the default camera actor first; this is needed by the RenderTaskList
83 CreateDefaultCameraActor();
85 // Create the list of render-tasks
86 mRenderTaskList = RenderTaskList::New( mUpdateManager, *this, false/*not system-level*/ );
88 // Create the default render-task
89 Dali::RenderTask defaultRenderTask = mRenderTaskList->CreateTask();
92 void Stage::Uninitialize()
94 // Remove actors added to SystemOverlay
95 delete mSystemOverlay;
96 mSystemOverlay = NULL;
100 Remove(*(mDefaultCamera.Get()));
105 // we are closing down so just delete the root, no point emit disconnect
106 // signals or send messages to update
111 StagePtr Stage::GetCurrent()
113 return ThreadLocalStorage::Get().GetCurrentStage();
116 bool Stage::IsInstalled()
118 return ThreadLocalStorage::Created();
121 ObjectRegistry& Stage::GetObjectRegistry()
123 return *mObjectRegistry;
126 Layer& Stage::GetRootActor()
131 SceneGraph::UpdateManager& Stage::GetUpdateManager()
133 return mUpdateManager;
136 EventToUpdate& Stage::GetUpdateInterface()
138 return mUpdateManager.GetEventToUpdate();
141 AnimationPlaylist& Stage::GetAnimationPlaylist()
143 return mAnimationPlaylist;
146 PropertyNotificationManager& Stage::GetPropertyNotificationManager()
148 return mPropertyNotificationManager;
151 void Stage::Add( Actor& actor )
153 mRootLayer->Add( actor );
156 void Stage::Remove( Actor& actor )
158 mRootLayer->Remove( actor );
161 void Stage::SetSize(float width, float height)
163 // Internally we want to report the actual size of the stage.
165 mSize.height = height;
167 // Calculates the aspect ratio, near and far clipping planes, field of view and camera Z position.
168 mDefaultCamera->SetPerspectiveProjection( mSize );
170 // The depth of the stage gets set to the maximun of these values
171 mRootLayer->SetSize( mSize );
173 // Repeat for SystemOverlay actors
176 mSystemOverlay->GetImpl()->SetSize( mSize.width, mSize.height );
179 SetDefaultSurfaceRectMessage( mUpdateManager, Rect<int>( 0, 0, width, height ) );
182 Vector2 Stage::GetSize() const
187 RenderTaskList& Stage::GetRenderTaskList() const
189 return *mRenderTaskList;
192 void Stage::CreateDefaultCameraActor()
194 // The default camera attributes and position is such that
195 // children of the default layer, can be positioned at (0,0) and
196 // be at the top-left of the viewport.
197 mDefaultCamera = CameraActor::New( Size::ZERO );
198 mDefaultCamera->SetParentOrigin(ParentOrigin::CENTER);
199 Add(*(mDefaultCamera.Get()));
202 Actor& Stage::GetDefaultRootActor()
207 CameraActor& Stage::GetDefaultCameraActor()
209 return *mDefaultCamera;
212 unsigned int Stage::GetLayerCount() const
214 return mLayerList->GetLayerCount();
217 Dali::Layer Stage::GetLayer( unsigned int depth ) const
219 return Dali::Layer(mLayerList->GetLayer( depth ));
222 Dali::Layer Stage::GetRootLayer() const
224 return Dali::Layer( mRootLayer.Get() );
227 LayerList& Stage::GetLayerList()
232 Integration::SystemOverlay& Stage::GetSystemOverlay()
234 // Lazily create system-level if requested
235 if( !mSystemOverlay )
237 mSystemOverlay = new Integration::SystemOverlay( SystemOverlay::New( *this ) );
238 DALI_ASSERT_ALWAYS( NULL != mSystemOverlay && "Failed to create system overlay" );
240 mSystemOverlay->GetImpl()->SetSize( mSize.width, mSize.height );
243 return *mSystemOverlay;
246 SystemOverlay* Stage::GetSystemOverlayInternal()
248 SystemOverlay* overlay( NULL );
252 overlay = mSystemOverlay->GetImpl();
258 void Stage::SetViewMode( ViewMode viewMode )
260 if( mViewMode != viewMode )
262 DALI_LOG_INFO( Debug::Filter::gActor, Debug::Concise, "View mode changed from %d to %d\n", mViewMode, viewMode);
264 if( mViewMode == MONO )
266 mDefaultCamera->SetRotation( Degree( 180.0f ), Vector3::YAXIS );
267 mRenderTaskList->GetTask(0).SetSourceActor( Dali::Actor() );
269 //Create camera and RenderTask for left eye
270 mLeftCamera = CameraActor::New( Size::ZERO );
271 mLeftCamera->SetParentOrigin( ParentOrigin::CENTER );
272 mDefaultCamera->Add( *mLeftCamera.Get() );
273 mLeftRenderTask = mRenderTaskList->CreateTask();
274 mLeftRenderTask.SetCameraActor( Dali::CameraActor( mLeftCamera.Get() ) );
275 mLeftCamera->SetType( Dali::Camera::FREE_LOOK );
277 //Create camera and RenderTask for right eye
278 mRightCamera = CameraActor::New( Size::ZERO );
279 mRightCamera->SetParentOrigin( ParentOrigin::CENTER );
280 mDefaultCamera->Add( *mRightCamera.Get() );
281 mRightRenderTask = mRenderTaskList->CreateTask();
282 mRightRenderTask.SetClearColor( Vector4( 1.0f,0.0f,0.0f,1.0f));
284 mRightRenderTask.SetCameraActor( Dali::CameraActor( mRightCamera.Get() ) );
285 mRightCamera->SetType( Dali::Camera::FREE_LOOK );
289 mViewMode = viewMode;
295 // delete extra stereoscopic render tasks and cameras
296 mRenderTaskList->RemoveTask( mLeftRenderTask );
297 mDefaultCamera->Remove( *mLeftCamera.Get() );
298 mLeftRenderTask.Reset();
300 mRenderTaskList->RemoveTask( mRightRenderTask );
301 mDefaultCamera->Remove( *mRightCamera.Get() );
302 mRightRenderTask.Reset();
303 mRightCamera.Reset();
305 mDefaultCamera->SetRotation( Degree( 0.0f ), Vector3::YAXIS );
306 mDefaultCamera->SetType( Dali::Camera::LOOK_AT_TARGET );
307 mRenderTaskList->GetTask(0).SetSourceActor( Dali::Layer(mRootLayer.Get()) );
311 case STEREO_HORIZONTAL:
313 //Stereo mode with horizontal split is for landscape mode. That's the reason for the cameras being rotated
314 //Top camera renders the scene as seen from the right eye and bottom camera as seen from left.
316 //Calculate separation in pixels along vertical axis ( mStereoBase is defined in millimetres )
317 const float stereoBase( ( (mStereoBase / 25.4f) * GetDpi().y ) * 0.5f );
319 //Calculate aspect ratio
320 float aspect = mSize.width / (mSize.height * 0.5f);
322 mLeftCamera->SetPerspectiveProjection( mSize, Vector2( 0.0f,stereoBase) );
323 mLeftCamera->SetAspectRatio( aspect );
324 mLeftCamera->SetRotation( Degree(-90.0f), Vector3::ZAXIS );
325 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
326 mLeftRenderTask.SetViewport( Viewport(0, mSize.height * 0.5f, mSize.width, mSize.height * 0.5f) );
328 mRightCamera->SetPerspectiveProjection( mSize, Vector2( 0.0, -stereoBase) );
329 mRightCamera->SetAspectRatio( aspect );
330 mRightCamera->SetRotation( Degree(-90.0f), Vector3::ZAXIS );
331 mRightCamera->SetPosition( Vector3(-stereoBase, 0.0f, 0.0f ) );
332 mRightRenderTask.SetViewport( Viewport(0, 0, mSize.width, mSize.height * 0.5f ) );
336 case STEREO_VERTICAL:
338 //Calculate separation in pixels along horizontal axis
339 const float stereoBase( ( (mStereoBase / 25.4f) * GetDpi().x ) * 0.5f );
341 //Recalculate fov based on viewport size
342 const float fov = 2.0f * std::atan( mSize.y / (2.0f * std::max( mSize.x*0.5f, mSize.y )) );
344 mLeftCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(stereoBase,0.0f) );
345 mLeftCamera->SetFieldOfView( fov );
346 mLeftCamera->SetRotation( Degree(0.0f), Vector3::ZAXIS );
347 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
348 mLeftRenderTask.SetViewport( Viewport(0, 0, mSize.width * 0.5f, mSize.height ) );
350 mRightCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(-stereoBase,0.0f) );
351 mRightCamera->SetFieldOfView( fov );
352 mRightCamera->SetRotation( Degree(0.0f), Vector3::ZAXIS );
353 mRightCamera->SetPosition( Vector3( -stereoBase, 0.0f, 0.0f ) );
354 mRightRenderTask.SetViewport( Viewport(mSize.width * 0.5f, 0, mSize.width * 0.5f, mSize.height ) );
358 case STEREO_INTERLACED:
366 ViewMode Stage::GetViewMode() const
371 void Stage::SetStereoBase( float stereoBase )
373 if( ! Equals( mStereoBase, stereoBase ) )
375 DALI_LOG_INFO( Debug::Filter::gActor, Debug::Concise, "old( %.2f) new(%.2f)", mStereoBase, stereoBase );
376 mStereoBase = stereoBase;
380 case STEREO_HORIZONTAL:
382 stereoBase = mStereoBase / 25.4f * GetDpi().y * 0.5f;
383 float aspect = mSize.width / (mSize.height * 0.5f);
385 mLeftCamera->SetPerspectiveProjection( mSize, Vector2( 0.0, stereoBase) );
386 mLeftCamera->SetAspectRatio( aspect );
387 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
389 mRightCamera->SetPerspectiveProjection( mSize, Vector2( 0.0, -stereoBase) );
390 mRightCamera->SetAspectRatio( aspect );
391 mRightCamera->SetPosition( Vector3(-stereoBase, 0.0f, 0.0f ) );
395 case STEREO_VERTICAL:
397 stereoBase = mStereoBase / 25.4f * GetDpi().x * 0.5f;
398 const float fov = 2.0f * std::atan( mSize.y / (2.0f * std::max( mSize.x*0.5f, mSize.y )) );
400 mLeftCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(stereoBase,0.0f) );
401 mLeftCamera->SetFieldOfView( fov );
402 mLeftCamera->SetPosition( Vector3( stereoBase, 0.0f, 0.0f ) );
404 mRightCamera->SetPerspectiveProjection( Size( mSize.x * 0.5f, mSize.y ), Vector2(-stereoBase,0.0f) );
405 mRightCamera->SetFieldOfView( fov );
406 mRightCamera->SetPosition( Vector3(-stereoBase, 0.0f, 0.0f ) );
416 float Stage::GetStereoBase() const
421 void Stage::SetBackgroundColor(Vector4 color)
423 // Cache for public GetBackgroundColor()
424 mBackgroundColor = color;
426 // Send message to change color in next frame
427 SetBackgroundColorMessage( mUpdateManager, color );
430 Vector4 Stage::GetBackgroundColor() const
432 return mBackgroundColor;
435 Vector2 Stage::GetDpi() const
440 void Stage::SetDpi(Vector2 dpi)
445 #ifdef DYNAMICS_SUPPORT
447 DynamicsNotifier& Stage::GetDynamicsNotifier()
449 return mDynamicsNotifier;
452 DynamicsWorldPtr Stage::InitializeDynamics(DynamicsWorldConfigPtr config)
454 if( !mDynamicsFactory )
456 mDynamicsFactory = ThreadLocalStorage::Get().GetPlatformAbstraction().GetDynamicsFactory();
459 if( mDynamicsFactory && !mDynamicsWorld )
461 if( mDynamicsFactory->InitializeDynamics( *(config->GetSettings()) ) )
463 mDynamicsWorld = DynamicsWorld::New();
464 mDynamicsWorld->Initialize( *this, *mDynamicsFactory, config );
467 return mDynamicsWorld;
470 DynamicsWorldPtr Stage::GetDynamicsWorld()
472 return mDynamicsWorld;
475 void Stage::TerminateDynamics()
479 mDynamicsWorld->Terminate(*this);
480 mDynamicsWorld = NULL;
484 #endif // DYNAMICS_SUPPORT
486 void Stage::KeepRendering( float durationSeconds )
488 // Send message to keep rendering
489 KeepRenderingMessage( mUpdateManager, durationSeconds );
492 void Stage::EmitKeyEventSignal(const KeyEvent& event)
494 // Emit the key event signal when no actor in the stage has gained the key input focus
496 mKeyEventSignal.Emit( event );
499 void Stage::EmitEventProcessingFinishedSignal()
501 mEventProcessingFinishedSignal.Emit();
504 void Stage::EmitTouchedSignal( const TouchEvent& touch )
506 mTouchedSignal.Emit( touch );
510 void Stage::EmitSceneCreatedSignal()
512 mSceneCreatedSignal.Emit();
515 Dali::Stage::KeyEventSignalType& Stage::KeyEventSignal()
517 return mKeyEventSignal;
520 Dali::Stage::EventProcessingFinishedSignalType& Stage::EventProcessingFinishedSignal()
522 return mEventProcessingFinishedSignal;
525 Dali::Stage::TouchedSignalType& Stage::TouchedSignal()
527 return mTouchedSignal;
530 Dali::Stage::ContextStatusSignal& Stage::ContextLostSignal()
532 return mContextLostSignal;
535 Dali::Stage::ContextStatusSignal& Stage::ContextRegainedSignal()
537 return mContextRegainedSignal;
540 Dali::Stage::SceneCreatedSignalType& Stage::SceneCreatedSignal()
542 return mSceneCreatedSignal;
545 void Stage::NotifyContextLost()
547 mContextLostSignal.Emit();
550 void Stage::NotifyContextRegained()
552 mContextRegainedSignal.Emit();
555 Stage::Stage( AnimationPlaylist& playlist,
556 PropertyNotificationManager& propertyNotificationManager,
557 SceneGraph::UpdateManager& updateManager,
558 NotificationManager& notificationManager )
559 : mAnimationPlaylist( playlist ),
560 mPropertyNotificationManager(propertyNotificationManager),
561 mUpdateManager(updateManager),
562 mNotificationManager(notificationManager),
563 mSize(Vector2::ZERO),
564 mBackgroundColor(Dali::Stage::DEFAULT_BACKGROUND_COLOR),
566 mStereoBase( DEFAULT_STEREO_BASE ),
567 #ifdef DYNAMICS_SUPPORT
568 mDynamicsFactory(NULL),
576 delete mSystemOverlay;
578 mObjectRegistry.Reset();
581 } // namespace Internal