dali/integration-api/scene.h

   1 #ifndef DALI_SCENE_H
   2 #define DALI_SCENE_H
   3
   4 /*
   5  * Copyright (c) 2022 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/graphics-api/graphics-controller.h>
  26 #include <dali/graphics-api/graphics-render-target-create-info.h>
  27 #include <dali/public-api/common/vector-wrapper.h>
  28 #include <dali/public-api/math/vector2.h>
  29 #include <dali/public-api/math/vector4.h>
  30 #include <dali/public-api/object/handle.h>
  31
  32 namespace Dali
  33 {
  34 class Actor;
  35 class KeyEvent;
  36 class Layer;
  37 class RenderTaskList;
  38 class TouchEvent;
  39 class WheelEvent;
  40
  41 namespace Internal DALI_INTERNAL
  42 {
  43 class Scene;
  44 }
  45
  46 namespace Graphics
  47 {
  48 class RenderTarget;
  49 }
  50
  51 namespace Integration
  52 {
  53 struct Event;
  54
  55 /**
  56  * @brief
  57  *
  58  * Scene creates a "world" that can be bound to a surface for rendering.
  59  *
  60  */
  61 class DALI_CORE_API Scene : public BaseHandle
  62 {
  63 public:
  64   using EventProcessingFinishedSignalType = Signal<void()>;                        ///< Event Processing finished signal type
  65   using KeyEventSignalType                = Signal<void(const Dali::KeyEvent&)>;   ///< Key event signal type
  66   using KeyEventGeneratedSignalType       = Signal<bool(const Dali::KeyEvent&)>;   ///< key event generated signal type
  67   using TouchEventSignalType              = Signal<void(const Dali::TouchEvent&)>; ///< Touch signal type
  68   using WheelEventSignalType              = Signal<void(const Dali::WheelEvent&)>; ///< WheelEvent signal type
  69   using WheelEventGeneratedSignalType     = Signal<bool(const Dali::WheelEvent&)>; ///< WheelEvent generated signal type
  70
  71   using FrameCallbackContainer = std::vector<std::pair<std::unique_ptr<CallbackBase>, int32_t> >;
  72
  73   /**
  74    * @brief Create an initialized Scene handle.
  75    *
  76    * @param[in] size The size of the set surface for this scene
  77    * @param[in] windowOrientation The rotated angle of the set surface for this scene
  78    * @param[in] screenOrientation The rotated angle of the screen
  79    *
  80    * @return a handle to a newly allocated Dali resource.
  81    */
  82   static Scene New(Size size, int32_t windowOrientation = 0, int32_t screenOrientation = 0);
  83
  84   /**
  85    * @brief Downcast an Object handle to Scene handle.
  86    *
  87    * If handle points to a Scene object the downcast produces
  88    * valid handle. If not the returned handle is left uninitialized.
  89    * @param[in] handle to An object
  90    * @return handle to a Scene object or an uninitialized handle
  91    */
  92   static Scene DownCast(BaseHandle handle);
  93
  94   /**
  95    * @brief Create an uninitialized Scene handle.
  96    *
  97    * This can be initialized with Scene::New(). Calling member
  98    * functions with an uninitialized Dali::Object is not allowed.
  99    */
 100   Scene();
 101
 102   /**
 103    * @brief Destructor
 104    *
 105    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 106    */
 107   ~Scene();
 108
 109   /**
 110    * @brief This copy constructor is required for (smart) pointer semantics.
 111    *
 112    * @param [in] handle A reference to the copied handle
 113    */
 114   Scene(const Scene& handle);
 115
 116   /**
 117    * @brief This assignment operator is required for (smart) pointer semantics.
 118    *
 119    * @param [in] rhs  A reference to the copied handle
 120    * @return A reference to this
 121    */
 122   Scene& operator=(const Scene& rhs);
 123
 124   /**
 125    * @brief Adds a child Actor to the Scene.
 126    *
 127    * The child will be referenced.
 128    * @param[in] actor The child
 129    * @pre The actor has been initialized.
 130    * @pre The actor does not have a parent.
 131    */
 132   void Add(Actor actor);
 133
 134   /**
 135    * @brief Removes a child Actor from the Scene.
 136    *
 137    * The child will be unreferenced.
 138    * @param[in] actor The child
 139    * @pre The actor has been added to the stage.
 140    */
 141   void Remove(Actor actor);
 142
 143   /**
 144    * @brief Returns the size of the Scene in pixels as a Vector.
 145    *
 146    * The x component will be the width of the Scene in pixels.
 147    * The y component will be the height of the Scene in pixels.
 148    *
 149    * @return The size of the Scene as a Vector
 150    */
 151   Size GetSize() const;
 152
 153   /**
 154    * Sets horizontal and vertical pixels per inch value that is used by the display
 155    * @param[in] dpi Horizontal and vertical dpi value
 156    */
 157   void SetDpi(Vector2 dpi);
 158
 159   /**
 160    * @brief Retrieves the DPI of the display device to which the scene is connected.
 161    *
 162    * @return The horizontal and vertical DPI
 163    */
 164   Vector2 GetDpi() const;
 165
 166   /**
 167    * @brief Sets the background color.
 168    *
 169    * @param[in] color The new background color
 170    */
 171   void SetBackgroundColor(const Vector4& color);
 172
 173   /**
 174    * @brief Gets the background color of the render　surface.
 175    *
 176    * @return The background color
 177    */
 178   Vector4 GetBackgroundColor() const;
 179
 180   /**
 181    * @brief Retrieves the list of render-tasks.
 182    *
 183    * @return A valid handle to a RenderTaskList
 184    */
 185   Dali::RenderTaskList GetRenderTaskList() const;
 186
 187   /**
 188    * @brief Returns the Scene's Root Layer.
 189    *
 190    * @return The root layer
 191    */
 192   Layer GetRootLayer() const;
 193
 194   /**
 195    * @brief Queries the number of on-stage layers.
 196    *
 197    * Note that a default layer is always provided (count >= 1).
 198    * @return The number of layers
 199    */
 200   uint32_t GetLayerCount() const;
 201
 202   /**
 203    * @brief Retrieves the layer at a specified depth.
 204    *
 205    * @param[in] depth The depth
 206    * @return The layer found at the given depth
 207    * @pre Depth is less than layer count; see GetLayerCount().
 208    */
 209   Layer GetLayer(uint32_t depth) const;
 210
 211   /**
 212    * @brief Informs the scene that the set surface has been resized.
 213    *
 214    * @param[in] width The new width of the set surface
 215    * @param[in] height The new height of the set surface
 216    */
 217   void SurfaceResized(float width, float height);
 218
 219   /**
 220    * @brief Informs the scene that the surface has been replaced.
 221    */
 222   void SurfaceReplaced();
 223
 224   /**
 225    * @brief Discards this Scene from the Core.
 226    */
 227   void Discard();
 228
 229   /**
 230    * @brief Sets the render target for the surface.
 231    *
 232    * @param[in] renderTarget The render target create info for the surface
 233    */
 234   void SetSurfaceRenderTarget(const Graphics::RenderTargetCreateInfo& createInfo);
 235
 236   /**
 237    * @brief Retrieve the Scene that the given actor belongs to.
 238    * @return The Scene.
 239    */
 240   static Integration::Scene Get(Actor actor);
 241
 242   /**
 243    * This function is called when an event is queued.
 244    * @param[in] event A event to queue.
 245    */
 246   void QueueEvent(const Integration::Event& event);
 247
 248   /**
 249    * This function is called by Core when events are processed.
 250    */
 251   void ProcessEvents();
 252
 253   /**
 254    * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
 255    *
 256    * @param[in] callback The function to call
 257    * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
 258    *
 259    * @note A callback of the following type may be used:
 260    * @code
 261    *   void MyFunction( int32_t frameId );
 262    * @endcode
 263    * This callback will be deleted once it is called.
 264    *
 265    * @note Ownership of the callback is passed onto this class.
 266    */
 267   void AddFrameRenderedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 268
 269   /**
 270    * @brief Adds a callback that is called when the frame is displayed on the display.
 271    *
 272    * @param[in] callback The function to call
 273    * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
 274    *
 275    * @note A callback of the following type may be used:
 276    * @code
 277    *   void MyFunction( int32_t frameId );
 278    * @endcode
 279    * This callback will be deleted once it is called.
 280    *
 281    * @note Ownership of the callback is passed onto this class.
 282    */
 283   void AddFramePresentedCallback(std::unique_ptr<CallbackBase> callback, int32_t frameId);
 284
 285   /**
 286    * @brief Gets the callback list that is called when the frame rendering is done by the graphics driver.
 287    *
 288    * @param[out] callbacks The callback list
 289    *
 290    * @note This is called in the update thread.
 291    */
 292   void GetFrameRenderedCallback(FrameCallbackContainer& callbacks);
 293
 294   /**
 295    * @brief Gets the callback list that is called when the frame is displayed on the display.
 296    *
 297    * @param[out] callbacks The callback list
 298    *
 299    * @note This is called in the update thread.
 300    */
 301   void GetFramePresentedCallback(FrameCallbackContainer& callbacks);
 302
 303   /**
 304    * @brief Informs the scene that the set surface has been rotated.
 305    *
 306    * @param[in] width The width of rotated surface
 307    * @param[in] height The height of rotated surface
 308    * @param[in] windowOrientation the current window orientation
 309    * @param[in] screenOrientation the current screen orientation
 310    */
 311   void SurfaceRotated(float width, float height, int32_t windowOrientation, int32_t screenOrientation);
 312
 313   /**
 314    * @brief Gets the current surface orientation. It gets the value from the scene object.
 315    *
 316    * @return The current surface orientation.
 317    */
 318   int32_t GetCurrentSurfaceOrientation() const;
 319
 320   /**
 321    * @brief Gets the current screen orientation. It gets the value from the scene object.
 322    *
 323    * @return The current screen orientation.
 324    */
 325   int32_t GetCurrentScreenOrientation() const;
 326
 327   /**
 328    * @brief Gets the current surface rectangle. It gets the value from the scene object.
 329    *
 330    * @return The current surface rectangle
 331    */
 332   const Rect<int32_t>& GetCurrentSurfaceRect() const;
 333
 334   /**
 335    * Query wheter the surface rect is changed or not.
 336    * @return true if the surface rect is changed.
 337    */
 338   bool IsSurfaceRectChanged() const;
 339
 340   /**
 341    * @brief Send message to acknowledge for completing window rotation with current window orientation.
 342    *
 343    * If this function is called, the message is sent to render thread, then mSurfaceRectChanged in scene-graph-scene is set with true.
 344    * After that, render thread checks whether window rotation event is received, mSurfaceRectChanged and the neccessary flag are set.
 345    * If they are all true, rotation done function is called to complete window rotation.
 346    */
 347   void SetRotationCompletedAcknowledgement();
 348
 349   /**
 350    * @brief Query wheter is set to acknowledge for completing surface rotation.
 351    * @return true it should be acknowledged.
 352    *
 353    * If SetRotationCompletedAcknowledgement() is called and the related message is received to scene-graph-scene,
 354    * then mSurfaceRectChanged in scene-graph-scene is set with true.
 355    *
 356    * When this function is called, the mSurfaceRectChanged in scene-graph-scene is return.
 357    * Then, the flag will be reset.
 358    *
 359    * @note This function should be not called the application's main thread.
 360    * Because this function should be called in windwow surface's postrender() function to complete window rotation manually.
 361    */
 362   bool IsRotationCompletedAcknowledgementSet() const;
 363
 364   /**
 365    * @brief This signal is emitted just after the event processing is finished.
 366    *
 367    * @return The signal to connect to
 368    */
 369   EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
 370
 371   /**
 372    * @brief This signal is emitted when key event is received.
 373    *
 374    * A callback of the following type may be connected:
 375    * @code
 376    *   void YourCallbackName(const KeyEvent& event);
 377    * @endcode
 378    * @return The signal to connect to
 379    */
 380   KeyEventSignalType& KeyEventSignal();
 381
 382   /**
 383    * @brief The user would connect to this signal to get a KeyEvent when KeyEvent is generated.
 384    *
 385    * If the control already consumed key event, KeyEventProcessor do not need to Emit keyEvent.
 386    * Therefore, KeyinputManager first checks whether KeyEvent is generated as KeyEventGeneratedSignal.
 387    * After that keyEventProcessor must invoke KeyEvent only if KeyEventGeneratedSignal () is not consumed.
 388    *
 389    * A callback of the following type may be connected:
 390    * @code
 391    *   bool YourCallbackName(const KeyEvent& event);
 392    * @endcode
 393    *
 394    * @return The return is true if KeyEvent is consumed, otherwise false.
 395    */
 396   KeyEventGeneratedSignalType& KeyEventGeneratedSignal();
 397
 398   /**
 399    * @brief The user would connect to this signal to intercept a KeyEvent at window.
 400    *
 401    * Intercepts KeyEvents in the window before dispatching KeyEvents to the control.
 402    * If a KeyEvent is consumed, no KeyEvent is delivered to the control.
 403    *
 404    * A callback of the following type may be connected:
 405    * @code
 406    *   bool YourCallbackName(const KeyEvent& event);
 407    * @endcode
 408    *
 409    * @return The return is true if KeyEvent is consumed, otherwise false.
 410    */
 411   KeyEventGeneratedSignalType& InterceptKeyEventSignal();
 412
 413   /**
 414    * @brief This signal is emitted when the screen is touched and when the touch ends
 415    * (i.e. the down & up touch events only).
 416    *
 417    * If there are multiple touch points, then this will be emitted when the first touch occurs and
 418    * then when the last finger is lifted.
 419    * An interrupted event will also be emitted (if it occurs).
 420    * A callback of the following type may be connected:
 421    * @code
 422    *   void YourCallbackName( TouchEvent event );
 423    * @endcode
 424    *
 425    * @return The touch signal to connect to
 426    * @note Motion events are not emitted.
 427    */
 428   TouchEventSignalType& TouchedSignal();
 429
 430   /**
 431    * @brief This signal is emitted when wheel event is received.
 432    *
 433    * A callback of the following type may be connected:
 434    * @code
 435    *   void YourCallbackName(const WheelEvent& event);
 436    * @endcode
 437    * @return The signal to connect to
 438    */
 439   WheelEventSignalType& WheelEventSignal();
 440
 441   /**
 442    * @brief When a custom wheel event occurs, it need to process the focused actor first.
 443    *
 444    * Therefore, KeyboardFocusManager first checks whether WheelEvent is generated as WheelEventGeneratedSignal.
 445    * After that wheelEventProcessor must invoke WheelEvent only if wheelEventGeneratedSignal () is not consumed.
 446    *
 447    * This is only valid for custom wheel events.
 448    *
 449    * A callback of the following type may be connected:
 450    * @code
 451    *   bool YourCallbackName(const WheelEvent& event);
 452    * @endcode
 453    *
 454    * @return The return is true if WheelEvent is consumed, otherwise false.
 455    */
 456   WheelEventGeneratedSignalType& WheelEventGeneratedSignal();
 457
 458 public: // Not intended for application developers
 459   /**
 460    * @brief This constructor is used by Dali::New() methods.
 461    *
 462    * @param[in] scene A pointer to an internal Scene resource
 463    */
 464   explicit DALI_INTERNAL Scene(Internal::Scene* scene);
 465 };
 466
 467 } // namespace Integration
 468
 469 } // namespace Dali
 470
 471 #endif // DALI_SCENE_H