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