adaptors/integration-api/adaptor.h

   1 #ifndef __DALI_INTEGRATION_ADAPTOR_H__
   2 #define __DALI_INTEGRATION_ADAPTOR_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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/signals/callback.h>
  23 #include <dali/public-api/signals/dali-signal.h>
  24 #include <dali/public-api/math/rect.h>
  25 #include <dali/public-api/events/touch-event.h>
  26 #include <dali/public-api/common/view-mode.h>
  27
  28 // INTERNAL INCLUDES
  29
  30
  31 #ifdef DALI_ADAPTOR_COMPILATION  // full path doesn't exist until adaptor is installed so we have to use relative
  32 // @todo Make dali-adaptor code folder structure mirror the folder structure installed to dali-env
  33 #include <window.h>
  34 #include <application-configuration.h>
  35 #else
  36 #include <dali/public-api/adaptor-framework/window.h>
  37 #include <dali/public-api/adaptor-framework/application-configuration.h>
  38 #endif
  39
  40
  41 namespace Dali
  42 {
  43
  44 class RenderSurface;
  45
  46 namespace Internal
  47 {
  48 namespace Adaptor
  49 {
  50 class Adaptor;
  51 }
  52 }
  53
  54 /**
  55  * @brief An Adaptor object is used to initialize and control how Dali runs.
  56  *
  57  * It provides a lifecycle interface that allows the application
  58  * writer to provide their own main loop and other platform related
  59  * features.
  60  *
  61  * The Adaptor class provides a means for initialising the resources required by the Dali::Core.
  62  *
  63  * When dealing with platform events, the application writer MUST ensure that Dali is called in a
  64  * thread-safe manner.
  65  *
  66  * As soon as the Adaptor class is created and started, the application writer can initialise their
  67  * Dali::Actor objects straight away or as required by the main loop they intend to use (there is no
  68  * need to wait for an initialise signal as per the Dali::Application class).
  69  *
  70  * The Adaptor does emit a Resize signal which informs the user when the surface is resized.
  71  * Tizen and Linux Adaptors should follow the example below:
  72  *
  73  * @code
  74  * void CreateProgram(DaliAdaptor& adaptor)
  75  * {
  76  *   // Create Dali components...
  77  *   // Can instantiate adaptor here instead, if required
  78  * }
  79  *
  80  * int main ()
  81  * {
  82  *   // Initialise platform
  83  *   MyPlatform.Init();
  84  *
  85  *   // Create an 800 by 1280 window positioned at (0,0).
  86  *   Dali::PositionSize positionSize(0, 0, 800, 1280);
  87  *   Dali::Window window = Dali::Window::New( positionSize, "My Application" );
  88  *
  89  *   // Create an adaptor which uses that window for rendering
  90  *   Dali::Adaptor adaptor = Dali::Adaptor::New( window );
  91  *   adaptor.Start();
  92  *
  93  *   CreateProgram(adaptor);
  94  *   // Or use this as a callback function depending on the platform initialisation sequence.
  95  *
  96  *   // Start Main Loop of your platform
  97  *   MyPlatform.StartMainLoop();
  98  *
  99  *   return 0;
 100  * }
 101  * @endcode
 102  *
 103  * If required, you can also connect class member functions to a signal:
 104  *
 105  * @code
 106  * MyApplication application;
 107  * adaptor.ResizedSignal().Connect(&application, &MyApplication::Resize);
 108  * @endcode
 109  *
 110  * @see RenderSurface
 111  */
 112 class DALI_IMPORT_API Adaptor
 113 {
 114 public:
 115
 116   typedef Signal< void (Adaptor&) > AdaptorSignalType; ///< Generic Type for adaptor signals
 117
 118 public:
 119   /**
 120    * @brief Create a new adaptor using the window.
 121    *
 122    * @param[in] window The window to draw onto
 123    * @return a reference to the adaptor handle
 124    */
 125   static Adaptor& New( Window window );
 126
 127   /**
 128    * @brief Create a new adaptor using the window.
 129    *
 130    * @param[in] window The window to draw onto
 131    * @param[in] configuration The context loss configuration.
 132    * @return a reference to the adaptor handle
 133    */
 134   static Adaptor& New( Window window, Configuration::ContextLoss configuration );
 135
 136   /**
 137    * @brief Create a new adaptor using render surface.
 138    *
 139    * @param[in] nativeWindow native window handle
 140    * @param[in] surface The surface to draw onto
 141    * @return a reference to the adaptor handle
 142    */
 143   static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface );
 144
 145   /**
 146    * @brief Create a new adaptor using render surface.
 147    *
 148    * @param[in] nativeWindow native window handle
 149    * @param[in] surface The surface to draw onto
 150    * @param[in] configuration The context loss configuration.
 151    * @return a reference to the adaptor handle
 152    */
 153   static Adaptor& New( Any nativeWindow, const Dali::RenderSurface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
 154
 155   /**
 156    * @brief Virtual Destructor.
 157    */
 158   virtual ~Adaptor();
 159
 160 public:
 161
 162   /**
 163    * @brief Starts the Adaptor.
 164    */
 165   void Start();
 166
 167   /**
 168    * @brief Pauses the Adaptor.
 169    */
 170   void Pause();
 171
 172   /**
 173    * @brief Resumes the Adaptor, if previously paused.
 174    *
 175    * @note If the adaptor is not paused, this does not do anything.
 176    */
 177   void Resume();
 178
 179   /**
 180    * @brief Stops the Adaptor.
 181    */
 182   void Stop();
 183
 184   /**
 185    * @brief Ensures that the function passed in is called from the main loop when it is idle.
 186    * @note Function must be called from the main event thread only.
 187    *
 188    * A callback of the following type may be used:
 189    * @code
 190    *   void MyFunction();
 191    * @endcode
 192    *
 193    * @param[in] callback The function to call.
 194    * @return true if added successfully, false otherwise
 195    *
 196    * @note Ownership of the callback is passed onto this class.
 197    */
 198   bool AddIdle( CallbackBase* callback );
 199
 200   /**
 201    * @brief Replaces the rendering surface
 202    *
 203    * @param[in] nativeWindow native window handle
 204    * @param[in] surface to use
 205    */
 206   void ReplaceSurface( Any nativeWindow, Dali::RenderSurface& surface );
 207
 208   /**
 209    * @brief Get the render surface the adaptor is using to render to.
 210    *
 211    * @return reference to current render surface
 212    */
 213   RenderSurface& GetSurface();
 214
 215   /**
 216    * @brief Gets native window handle
 217    *
 218    * @return Native window handle
 219    */
 220   Any GetNativeWindowHandle();
 221
 222   /**
 223    * @brief Release any locks the surface may hold.
 224    *
 225    * For example, after compositing an offscreen surface, use this method to allow
 226    * rendering to continue.
 227    */
 228   void ReleaseSurfaceLock();
 229
 230   /**
 231    * @brief Set the number of frames per render.
 232    *
 233    * This enables an application to deliberately render with a reduced FPS.
 234    * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
 235    * Suggest this is a power of two:
 236    * 1 - render each vsync frame
 237    * 2 - render every other vsync frame
 238    * 4 - render every fourth vsync frame
 239    * 8 - render every eighth vsync frame
 240    */
 241   void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
 242
 243   /**
 244    * @brief Set whether the frame count per render is managed using the hardware VSync or
 245    * manually timed.
 246    *
 247    * @param[in] useHardware True if the hardware VSync should be used
 248    */
 249   void SetUseHardwareVSync(bool useHardware);
 250
 251   /**
 252    * @brief Returns a reference to the instance of the adaptor used by the current thread.
 253    *
 254    * @return A reference to the adaptor.
 255    * @pre The adaptor has been initialised.
 256    * @note This is only valid in the main thread.
 257    */
 258   static Adaptor& Get();
 259
 260   /**
 261    * @brief Checks whether the adaptor is available.
 262    *
 263    * @return true, if it is available, false otherwise.
 264    */
 265   static bool IsAvailable();
 266
 267   /**
 268    * @brief Call this method to notify Dali when scene is created and initialized.
 269    *
 270    * Notify Adaptor that the scene has been created.
 271    */
 272   void NotifySceneCreated();
 273
 274   /**
 275    * @brief Call this method to notify Dali when the system language changes.
 276    *
 277    * Use this only when NOT using Dali::Application, As Application created using
 278    * Dali::Application will automatically receive notification of language change.
 279    * When Dali::Application is not used, the application developer should
 280    * use app-core to receive language change notifications and should update Dali
 281    * by calling this method.
 282    */
 283   void NotifyLanguageChanged();
 284
 285   /**
 286    * @brief Sets minimum distance in pixels that the fingers must move towards/away from each other in order to
 287    * trigger a pinch gesture
 288    *
 289    * @param[in] distance The minimum pinch distance in pixels
 290    */
 291   void SetMinimumPinchDistance(float distance);
 292
 293   /**
 294    * @brief Feed a touch point to the adaptor.
 295    *
 296    * @param[in] point touch point
 297    * @param[in] timeStamp time value of event
 298    */
 299   void FeedTouchPoint( TouchPoint& point, int timeStamp );
 300
 301   /**
 302    * @brief Feed a wheel event to the adaptor.
 303    *
 304    * @param[in]  wheelEvent wheel event
 305    */
 306   void FeedWheelEvent( WheelEvent& wheelEvent );
 307
 308   /**
 309    * @brief Feed a key event to the adaptor.
 310    *
 311    * @param[in] keyEvent The key event holding the key information.
 312    */
 313   void FeedKeyEvent( KeyEvent& keyEvent );
 314
 315   /**
 316    * @copydoc Dali::Core::SceneCreated();
 317    */
 318   void SceneCreated();
 319
 320   /**
 321    * @copydoc Dali::Application::SetViewMode();
 322    */
 323   void SetViewMode( ViewMode viewMode );
 324
 325   /**
 326    * @copydoc Dali::Application::SetStereoBase();
 327    */
 328   void SetStereoBase( float stereoBase );
 329
 330 public:  // Signals
 331
 332   /**
 333    * @brief The user should connect to this signal if they need to perform any
 334    * special activities when the surface Dali is being rendered on is resized.
 335    *
 336    * @return The signal to connect to
 337    */
 338   AdaptorSignalType& ResizedSignal();
 339
 340   /**
 341    * @brief This signal is emitted when the language is changed on the device.
 342    *
 343    * @return The signal to connect to
 344    */
 345   AdaptorSignalType& LanguageChangedSignal();
 346
 347 private:
 348
 349   // Undefined
 350   Adaptor(const Adaptor&);
 351   Adaptor& operator=(Adaptor&);
 352
 353 private:
 354
 355   /**
 356    * @brief Create an uninitialized Adaptor.
 357    */
 358   Adaptor();
 359
 360   Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
 361   friend class Internal::Adaptor::Adaptor;
 362 };
 363
 364 } // namespace Dali
 365
 366 #endif // __DALI_INTEGRATION_ADAPTOR_H__