Merge "Allows debug builds to be enabled for GBS builds" into devel/master
[platform/core/uifw/dali-core.git] / dali / internal / common / core-impl.h
1 #ifndef __DALI_INTERNAL_CORE_H__
2 #define __DALI_INTERNAL_CORE_H__
3
4 /*
5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali/public-api/object/ref-object.h>
23 #include <dali/integration-api/context-notifier.h>
24 #include <dali/internal/common/owner-pointer.h>
25 #include <dali/internal/event/animation/animation-playlist-declarations.h>
26 #include <dali/internal/event/common/stage-def.h>
27 #include <dali/internal/update/resources/resource-manager-declarations.h>
28 #include <dali/public-api/common/view-mode.h>
29 #include <dali/integration-api/resource-policies.h>
30
31 namespace Dali
32 {
33
34 namespace Integration
35 {
36 class RenderController;
37 class PlatformAbstraction;
38 class GestureManager;
39 class GlAbstraction;
40 class GlSyncAbstraction;
41 class SystemOverlay;
42 class UpdateStatus;
43 class RenderStatus;
44 struct Event;
45 struct TouchData;
46 }
47
48 namespace Internal
49 {
50
51 class NotificationManager;
52 class AnimationPlaylist;
53 class PropertyNotificationManager;
54 class EventProcessor;
55 class GestureEventProcessor;
56 class ResourceClient;
57 class ResourceManager;
58 class ImageFactory;
59 class ShaderFactory;
60 class TouchResampler;
61 class RelayoutController;
62
63 namespace SceneGraph
64 {
65 class UpdateManager;
66 class RenderManager;
67 class DiscardQueue;
68 class TextureCacheDispatcher;
69 }
70
71 /**
72  * Internal class for Dali::Integration::Core
73  */
74 class Core
75 {
76 public:
77
78   /**
79    * Create and initialise a new Core instance
80    */
81   Core( Integration::RenderController& renderController,
82         Integration::PlatformAbstraction& platform,
83         Integration::GlAbstraction& glAbstraction,
84         Integration::GlSyncAbstraction& glSyncAbstraction,
85         Integration::GestureManager& gestureManager,
86         ResourcePolicy::DataRetention dataRetentionPolicy );
87
88   /**
89    * Destructor
90    */
91   ~Core();
92
93   /**
94    * @copydoc Dali::Integration::Core::GetContextNotifier()
95    */
96   Integration::ContextNotifierInterface* GetContextNotifier();
97
98   /**
99    * @copydoc Dali::Integration::Core::ContextCreated()
100    */
101   void ContextCreated();
102
103   /**
104    * @copydoc Dali::Integration::Core::ContextDestroyed()
105    */
106   void ContextDestroyed();
107
108   /**
109    * @copydoc Dali::Integration::Core::RecoverFromContextLoss()
110    */
111   void RecoverFromContextLoss();
112
113   /**
114    * @copydoc Dali::Integration::Core::SurfaceResized(unsigned int, unsigned int)
115    */
116   void SurfaceResized(unsigned int width, unsigned int height);
117
118   /**
119    * @copydoc Dali::Integration::Core::SetDpi(unsigned int, unsigned int)
120    */
121   void SetDpi(unsigned int dpiHorizontal, unsigned int dpiVertical);
122
123   /**
124    * @copydoc Dali::Integration::Core::SetMinimumFrameTimeInterval(unsigned int)
125    */
126   void SetMinimumFrameTimeInterval(unsigned int interval);
127
128   /**
129    * @copydoc Dali::Integration::Core::Update()
130    */
131   void Update( float elapsedSeconds, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds, Integration::UpdateStatus& status );
132
133   /**
134    * @copydoc Dali::Integration::Core::Render()
135    */
136   void Render( Integration::RenderStatus& status );
137
138   /**
139    * @copydoc Dali::Integration::Core::Suspend()
140    */
141   void Suspend();
142
143   /**
144    * @copydoc Dali::Integration::Core::Resume()
145    */
146   void Resume();
147
148   /**
149    * @copydoc Dali::Integration::Core::SceneCreated()
150    */
151   void SceneCreated();
152
153   /**
154    * @copydoc Dali::Integration::Core::QueueEvent(const Integration::Event&)
155    */
156   void QueueEvent( const Integration::Event& event );
157
158   /**
159    * @copydoc Dali::Integration::Core::ProcessEvents()
160    */
161   void ProcessEvents();
162
163   /**
164    * @copydoc Dali::Integration::Core::GetMaximumUpdateCount()
165    */
166   unsigned int GetMaximumUpdateCount() const;
167
168   /**
169    * @copydoc Dali::Integration::Core::GetSystemOverlay()
170    */
171   Integration::SystemOverlay& GetSystemOverlay();
172
173   // Stereoscopy
174
175   /**
176    * @copydoc Dali::Integration::Core::SetViewMode()
177    */
178   void SetViewMode( ViewMode viewMode );
179
180   /**
181    * @copydoc Dali::Integration::Core::GetViewMode()
182    */
183   ViewMode GetViewMode() const;
184
185   /**
186    * @copydoc Dali::Integration::Core::SetStereoBase()
187    */
188   void SetStereoBase( float stereoBase );
189
190   /**
191    * @copydoc Dali::Integration::Core::GetStereoBase()
192    */
193   float GetStereoBase() const;
194
195 private:  // for use by ThreadLocalStorage
196
197   /**
198    * Returns the current stage.
199    * @return A smart-pointer to the current stage.
200    */
201   StagePtr GetCurrentStage();
202
203   /**
204    * Returns the platform abstraction.
205    * @return A reference to the platform abstraction.
206    */
207   Integration::PlatformAbstraction& GetPlatform();
208
209   /**
210    * Returns the update manager.
211    * @return A reference to the update manager.
212    */
213   SceneGraph::UpdateManager& GetUpdateManager();
214
215   /**
216    * Returns the render manager.
217    * @return A reference to the render manager.
218    */
219   SceneGraph::RenderManager& GetRenderManager();
220
221   /**
222    * Returns the notification manager.
223    * @return A reference to the Notification Manager.
224    */
225   NotificationManager& GetNotificationManager();
226
227   /**
228    * Returns the Resource Manager.
229    * @return A reference to the Resource Manager.
230    */
231   ResourceManager& GetResourceManager();
232
233   /**
234    * Returns the Resource client.
235    * @return A reference to the Resource Client.
236    */
237   ResourceClient& GetResourceClient();
238
239   /**
240    * Returns the Image factory
241    * @return A reference to the Image factory.
242    */
243   ImageFactory& GetImageFactory();
244
245   /**
246    * Returns the Shader factory
247    * @return A reference to the Shader binary factory.
248    */
249   ShaderFactory& GetShaderFactory();
250
251   /**
252    * Returns the gesture event processor.
253    * @return A reference to the gesture event processor.
254    */
255   GestureEventProcessor& GetGestureEventProcessor();
256
257   /**
258    * Return the relayout controller
259    * @Return Return a reference to the relayout controller
260    */
261   RelayoutController& GetRelayoutController();
262
263 private:
264
265   /**
266    * Undefined copy and assignment operators
267    */
268   Core(const Core& core);  // No definition
269   Core& operator=(const Core& core);  // No definition
270
271   /**
272    * Create Thread local storage
273    */
274   void CreateThreadLocalStorage();
275
276 private:
277
278   Integration::RenderController&            mRenderController;            ///< Reference to Render controller to tell it to keep rendering
279   Integration::PlatformAbstraction&         mPlatform;                    ///< The interface providing platform specific services.
280
281   IntrusivePtr<Stage>                       mStage;                       ///< The current stage
282   GestureEventProcessor*                    mGestureEventProcessor;       ///< The gesture event processor
283   EventProcessor*                           mEventProcessor;              ///< The event processor
284   SceneGraph::UpdateManager*                mUpdateManager;               ///< Update manager
285   SceneGraph::RenderManager*                mRenderManager;               ///< Render manager
286   SceneGraph::DiscardQueue*                 mDiscardQueue;                ///< Used to cleanup nodes & resources when no longer in use.
287   SceneGraph::TextureCacheDispatcher*       mTextureCacheDispatcher;      ///< Used to send messages to TextureCache
288   LockedResourceQueue*                      mTextureUploadedQueue;        ///< Stores resource ids which require post processing after render
289   NotificationManager*                      mNotificationManager;         ///< Notification manager
290   AnimationPlaylistOwner                    mAnimationPlaylist;           ///< For 'Fire and forget' animation support
291   OwnerPointer<PropertyNotificationManager> mPropertyNotificationManager; ///< For safe signal emmision of property changed notifications
292   ImageFactory*                             mImageFactory;                ///< Image resource factory
293   ShaderFactory*                            mShaderFactory;               ///< Shader resource factory
294   ResourceClient*                           mResourceClient;              ///< Asynchronous Resource Loading
295   ResourceManager*                          mResourceManager;             ///< Asynchronous Resource Loading
296   IntrusivePtr< RelayoutController >        mRelayoutController;          ///< Size negotiation relayout controller
297
298   bool                                      mIsActive         : 1;        ///< Whether Core is active or suspended
299   bool                                      mProcessingEvent  : 1;        ///< True during ProcessEvents()
300
301   friend class ThreadLocalStorage;
302
303 };
304
305 } // namespace Internal
306
307 } // namespace Dali
308
309 #endif // __DALI_INTERNAL_CORE_H__