dali/integration-api/scene.h

   1 #ifndef DALI_SCENE_H
   2 #define DALI_SCENE_H
   3
   4 /*
   5  * Copyright (c) 2020 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 <memory>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/common/vector-wrapper.h>
  26 #include <dali/public-api/math/vector2.h>
  27 #include <dali/public-api/math/vector4.h>
  28 #include <dali/public-api/object/handle.h>
  29
  30 namespace Dali
  31 {
  32 class Actor;
  33 class KeyEvent;
  34 class Layer;
  35 class RenderTaskList;
  36 class TouchEvent;
  37 class WheelEvent;
  38
  39 namespace Internal DALI_INTERNAL
  40 {
  41 class Scene;
  42 }
  43
  44 namespace Integration
  45 {
  46 struct Event;
  47
  48 /**
  49  * @brief
  50  *
  51  * Scene creates a "world" that can be bound to a surface for rendering.
  52  *
  53  */
  54 class DALI_CORE_API Scene : public BaseHandle
  55 {
  56 public:
  57   using EventProcessingFinishedSignalType = Signal<void()>;                        ///< Event Processing finished signal type
  58   using KeyEventSignalType                = Signal<void(const Dali::KeyEvent&)>;   ///< Key event signal type
  59   using KeyEventGeneratedSignalType       = Signal<bool(const Dali::KeyEvent&)>;   ///< key event generated signal type
  60   using TouchEventSignalType              = Signal<void(const Dali::TouchEvent&)>; ///< Touch signal type
  61   using WheelEventSignalType              = Signal<void(const Dali::WheelEvent&)>; ///< WheelEvent signal type
  62
  63   using FrameCallbackContainer = std::vector<std::pair<std::unique_ptr<CallbackBase>, int32_t> >;
  64
  65   /**
  66    * @brief Create an initialized Scene handle.
  67    *
  68    * @param[in] size The size of the set surface for this scene
  69    *
  70    * @return a handle to a newly allocated Dali resource.
  71    */
  72   static Scene New(Size size);
  73
  74   /**
  75    * @brief Downcast an Object handle to Scene handle.
  76    *
  77    * If handle points to a Scene object the downcast produces
  78    * valid handle. If not the returned handle is left uninitialized.
  79    * @param[in] handle to An object
  80    * @return handle to a Scene object or an uninitialized handle
  81    */
  82   static Scene DownCast(BaseHandle handle);
  83
  84   /**
  85    * @brief Create an uninitialized Scene handle.
  86    *
  87    * This can be initialized with Scene::New(). Calling member
  88    * functions with an uninitialized Dali::Object is not allowed.
  89    */
  90   Scene();
  91
  92   /**
  93    * @brief Destructor
  94    *
  95    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  96    */
  97   ~Scene();
  98
  99   /**
 100    * @brief This copy constructor is required for (smart) pointer semantics.
 101    *
 102    * @param [in] handle A reference to the copied handle
 103    */
 104   Scene(const Scene& handle);
 105
 106   /**
 107    * @brief This assignment operator is required for (smart) pointer semantics.
 108    *
 109    * @param [in] rhs  A reference to the copied handle
 110    * @return A reference to this
 111    */
 112   Scene& operator=(const Scene& rhs);
 113
 114   /**
 115    * @brief Adds a child Actor to the Scene.
 116    *
 117    * The child will be referenced.
 118    * @param[in] actor The child
 119    * @pre The actor has been initialized.
 120    * @pre The actor does not have a parent.
 121    */
 122   void Add(Actor actor);
 123
 124   /**
 125    * @brief Removes a child Actor from the Scene.
 126    *
 127    * The child will be unreferenced.
 128    * @param[in] actor The child
 129    * @pre The actor has been added to the stage.
 130    */
 131   void Remove(Actor actor);
 132
 133   /**
 134    * @brief Returns the size of the Scene in pixels as a Vector.
 135    *
 136    * The x component will be the width of the Scene in pixels.
 137    * The y component will be the height of the Scene in pixels.
 138    *
 139    * @return The size of the Scene as a Vector
 140    */
 141   Size GetSize() const;
 142
 143   /**
 144    * Sets horizontal and vertical pixels per inch value that is used by the display
 145    * @param[in] dpi Horizontal and vertical dpi value
 146    */
 147   void SetDpi(Vector2 dpi);
 148
 149   /**
 150    * @brief Retrieves the DPI of the display device to which the scene is connected.
 151    *
 152    * @return The horizontal and vertical DPI
 153    */
 154   Vector2 GetDpi() const;
 155
 156   /**
 157    * @brief Sets the background color.
 158    *
 159    * @param[in] color The new background color
 160    */
 161   void SetBackgroundColor(const Vector4& color);
 162
 163   /**
 164    * @brief Gets the background color of the render　surface.
 165    *
 166    * @return The background color
 167    */
 168   Vector4 GetBackgroundColor() const;
 169
 170   /**
 171    * @brief Retrieves the list of render-tasks.
 172    *
 173    * @return A valid handle to a RenderTaskList
 174    */
 175   Dali::RenderTaskList GetRenderTaskList() const;
 176
 177   /**
 178    * @brief Returns the Scene's Root Layer.
 179    *
 180    * @return The root layer
 181    */
 182   Layer GetRootLayer() const;
 183
 184   /**
 185    * @brief Queries the number of on-stage layers.
 186    *
 187    * Note that a default layer is always provided (count >= 1).
 188    * @return The number of layers
 189    */
 190   uint32_t GetLayerCount() const;
 191
 192   /**
 193    * @brief Retrieves the layer at a specified depth.
 194    *
 195    * @param[in] depth The depth
 196    * @return The layer found at the given depth
 197    * @pre Depth is less than layer count; see GetLayerCount().
 198    */
 199   Layer GetLayer(uint32_t depth) const;
 200
 201   /**
 202    * @brief Informs the scene that the set surface has been resized.
 203    *
 204    * @param[in] width The new width of the set surface
 205    * @param[in] height The new height of the set surface
 206    */
 207   void SurfaceResized(float width, float height);
 208
 209   /**
 210    * @brief Informs the scene that the surface has been replaced.
 211    */
 212   void SurfaceReplaced();
 213
 214   /**
 215    * @brief Discards this Scene from the Core.
 216    */
 217   void Discard();
 218
 219   /**
 220    * @brief Retrieve the Scene that the given actor belongs to.
 221    * @return The Scene.
 222    */
 223   static Integration::Scene Get(Actor actor);
 224
 225   /**
 226    * This function is called when an event is queued.
 227    * @param[in] event A event to queue.
 228    */
 229   void QueueEvent(const Integration::Event& event);
 230
 231   /**
 232    * This function is called by Core when events are processed.
 233    */
 234   void ProcessEvents();
 235
 236   /**
 237    * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
 238    *
 239    * @param[in] callback The function to call
 240    * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
 241    *
 242    * @note A callback of the following type may be used:
 243    * @code
 244    *   void MyFunction( int frameId );
 245    * @endcode
 246    * This callback will be deleted once it is called.
 247    *
 248    * @note Ownership of the callback is passed onto this class.
 249    */
 250   void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 251
 252   /**
 253    * @brief Adds a callback that is called when the frame is displayed on the display.
 254    *
 255    * @param[in] callback The function to call
 256    * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
 257    *
 258    * @note A callback of the following type may be used:
 259    * @code
 260    *   void MyFunction( int frameId );
 261    * @endcode
 262    * This callback will be deleted once it is called.
 263    *
 264    * @note Ownership of the callback is passed onto this class.
 265    */
 266   void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 267
 268   /**
 269    * @brief Gets the callback list that is called when the frame rendering is done by the graphics driver.
 270    *
 271    * @param[out] callbacks The callback list
 272    *
 273    * @note This is called in the update thread.
 274    */
 275   void GetFrameRenderedCallback(FrameCallbackContainer& callbacks);
 276
 277   /**
 278    * @brief Gets the callback list that is called when the frame is displayed on the display.
 279    *
 280    * @param[out] callbacks The callback list
 281    *
 282    * @note This is called in the update thread.
 283    */
 284   void GetFramePresentedCallback(FrameCallbackContainer& callbacks);
 285
 286   /**
 287    * @brief This signal is emitted just after the event processing is finished.
 288    *
 289    * @return The signal to connect to
 290    */
 291   EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
 292
 293   /**
 294    * @brief This signal is emitted when key event is received.
 295    *
 296    * A callback of the following type may be connected:
 297    * @code
 298    *   void YourCallbackName(const KeyEvent& event);
 299    * @endcode
 300    * @return The signal to connect to
 301    */
 302   KeyEventSignalType& KeyEventSignal();
 303
 304   /**
 305    * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
 306    *
 307    * If the control already consumed key event, KeyEventProcessor do not need to Emit keyEvent.
 308    * Therefore, KeyinputManager first checks whether KeyEvent is generated as KeyEventGeneratedSignal.
 309    * After that keyEventProcessor must invoke KeyEvent only if KeyEventGeneratedSignal () is not consumed.
 310    *
 311    * A callback of the following type may be connected:
 312    * @code
 313    *   bool YourCallbackName(const KeyEvent& event);
 314    * @endcode
 315    *
 316    * @return The return is true if KeyEvent is consumed, otherwise false.
 317    */
 318   KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
 319
 320   /**
 321    * @brief This signal is emitted when the screen is touched and when the touch ends
 322    * (i.e. the down & up touch events only).
 323    *
 324    * If there are multiple touch points, then this will be emitted when the first touch occurs and
 325    * then when the last finger is lifted.
 326    * An interrupted event will also be emitted (if it occurs).
 327    * A callback of the following type may be connected:
 328    * @code
 329    *   void YourCallbackName( TouchEvent event );
 330    * @endcode
 331    *
 332    * @return The touch signal to connect to
 333    * @note Motion events are not emitted.
 334    */
 335   TouchEventSignalType& TouchedSignal();
 336
 337   /**
 338    * @brief This signal is emitted when wheel event is received.
 339    *
 340    * A callback of the following type may be connected:
 341    * @code
 342    *   void YourCallbackName(const WheelEvent& event);
 343    * @endcode
 344    * @return The signal to connect to
 345    */
 346   WheelEventSignalType& WheelEventSignal();
 347
 348 public: // Not intended for application developers
 349   /**
 350    * @brief This constructor is used by Dali::New() methods.
 351    *
 352    * @param[in] scene A pointer to an internal Scene resource
 353    */
 354   explicit DALI_INTERNAL Scene(Internal::Scene* scene);
 355 };
 356
 357 } // namespace Integration
 358
 359 } // namespace Dali
 360
 361 #endif // DALI_SCENE_H