X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fintegration-api%2Fscene.h;h=3f2d7ed3a0c3cc059c8e7330333e8de07235c559;hb=refs%2Fchanges%2F44%2F271544%2F2;hp=5258eeccbbfbd5e842e0dfd940346130a05089d8;hpb=8f2a967946b78e26f6de4f3a22cd657a71ed039f;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/integration-api/scene.h b/dali/integration-api/scene.h old mode 100755 new mode 100644 index 5258eec..3f2d7ed --- a/dali/integration-api/scene.h +++ b/dali/integration-api/scene.h @@ -2,7 +2,7 @@ #define DALI_SCENE_H /* - * Copyright (c) 2020 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,29 +18,36 @@ * */ +// EXTERNAL INCLUDES +#include + // INTERNAL INCLUDES -#include +#include #include #include +#include namespace Dali { - class Actor; -struct KeyEvent; +class KeyEvent; class Layer; class RenderTaskList; -class TouchData; -struct WheelEvent; +class TouchEvent; +class WheelEvent; namespace Internal DALI_INTERNAL { - class Scene; +class Scene; } -namespace Integration +namespace Graphics { +class RenderTarget; +} +namespace Integration +{ struct Event; /** @@ -52,20 +59,24 @@ struct Event; class DALI_CORE_API Scene : public BaseHandle { public: - typedef Signal< void () > EventProcessingFinishedSignalType; ///< Event Processing finished signal type - typedef Signal< void (const Dali::KeyEvent&) > KeyEventSignalType; ///< Key event signal type - typedef Signal< bool (const Dali::KeyEvent&) > KeyEventGeneratedSignalType; ///< key event generated signal type - typedef Signal< void (const Dali::TouchData&) > TouchSignalType; ///< Touch signal type - typedef Signal< void (const Dali::WheelEvent&) > WheelEventSignalType; ///< Touched signal type + using EventProcessingFinishedSignalType = Signal; ///< Event Processing finished signal type + using KeyEventSignalType = Signal; ///< Key event signal type + using KeyEventGeneratedSignalType = Signal; ///< key event generated signal type + using TouchEventSignalType = Signal; ///< Touch signal type + using WheelEventSignalType = Signal; ///< WheelEvent signal type + using WheelEventGeneratedSignalType = Signal; ///< WheelEvent generated signal type + + using FrameCallbackContainer = std::vector, int32_t> >; /** * @brief Create an initialized Scene handle. * * @param[in] size The size of the set surface for this scene + * @param[in] orientation The rotated angle of the set surface for this scene * * @return a handle to a newly allocated Dali resource. */ - static Scene New( Size size ); + static Scene New(Size size, int32_t orientation = 0); /** * @brief Downcast an Object handle to Scene handle. @@ -75,7 +86,7 @@ public: * @param[in] handle to An object * @return handle to a Scene object or an uninitialized handle */ - static Scene DownCast( BaseHandle handle ); + static Scene DownCast(BaseHandle handle); /** * @brief Create an uninitialized Scene handle. @@ -140,7 +151,7 @@ public: * Sets horizontal and vertical pixels per inch value that is used by the display * @param[in] dpi Horizontal and vertical dpi value */ - void SetDpi( Vector2 dpi ); + void SetDpi(Vector2 dpi); /** * @brief Retrieves the DPI of the display device to which the scene is connected. @@ -154,7 +165,7 @@ public: * * @param[in] color The new background color */ - void SetBackgroundColor( const Vector4& color ); + void SetBackgroundColor(const Vector4& color); /** * @brief Gets the background color of the render　surface. @@ -192,17 +203,15 @@ public: * @return The layer found at the given depth * @pre Depth is less than layer count; see GetLayerCount(). */ - Layer GetLayer( uint32_t depth ) const; + Layer GetLayer(uint32_t depth) const; /** * @brief Informs the scene that the set surface has been resized. * * @param[in] width The new width of the set surface * @param[in] height The new height of the set surface - * @param[in] orientation The orientation of the surface - * @param[in] forceUpdate The flag to update force */ - void SurfaceResized( float width, float height, int orientation, bool forceUpdate ); + void SurfaceResized(float width, float height); /** * @brief Informs the scene that the surface has been replaced. @@ -215,16 +224,23 @@ public: void Discard(); /** + * @brief Sets the render target for the surface. + * + * @param[in] renderTarget The render target for the surface + */ + void SetSurfaceRenderTarget(Graphics::RenderTarget* renderTarget); + + /** * @brief Retrieve the Scene that the given actor belongs to. * @return The Scene. */ - static Integration::Scene Get( Actor actor ); + static Integration::Scene Get(Actor actor); /** * This function is called when an event is queued. * @param[in] event A event to queue. */ - void QueueEvent( const Integration::Event& event ); + void QueueEvent(const Integration::Event& event); /** * This function is called by Core when events are processed. @@ -232,6 +248,109 @@ public: void ProcessEvents(); /** + * @brief Adds a callback that is called when the frame rendering is done by the graphics driver. + * + * @param[in] callback The function to call + * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called. + * + * @note A callback of the following type may be used: + * @code + * void MyFunction( int32_t frameId ); + * @endcode + * This callback will be deleted once it is called. + * + * @note Ownership of the callback is passed onto this class. + */ + void AddFrameRenderedCallback(std::unique_ptr callback, int32_t frameId); + + /** + * @brief Adds a callback that is called when the frame is displayed on the display. + * + * @param[in] callback The function to call + * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called. + * + * @note A callback of the following type may be used: + * @code + * void MyFunction( int32_t frameId ); + * @endcode + * This callback will be deleted once it is called. + * + * @note Ownership of the callback is passed onto this class. + */ + void AddFramePresentedCallback(std::unique_ptr callback, int32_t frameId); + + /** + * @brief Gets the callback list that is called when the frame rendering is done by the graphics driver. + * + * @param[out] callbacks The callback list + * + * @note This is called in the update thread. + */ + void GetFrameRenderedCallback(FrameCallbackContainer& callbacks); + + /** + * @brief Gets the callback list that is called when the frame is displayed on the display. + * + * @param[out] callbacks The callback list + * + * @note This is called in the update thread. + */ + void GetFramePresentedCallback(FrameCallbackContainer& callbacks); + + /** + * @brief Informs the scene that the set surface has been rotated. + * + * @param[in] width The width of rotated surface + * @param[in] height The height of rotated surface + * @param[in] orientation The orientation of rotated surface + */ + void SurfaceRotated(float width, float height, int32_t orientation); + + /** + * @brief Gets the current surface orientation. It gets the value from the scene object. + * + * @return The current surface orientation. + */ + int32_t GetCurrentSurfaceOrientation() const; + + /** + * @brief Gets the current surface rectangle. It gets the value from the scene object. + * + * @return The current surface rectangle + */ + const Rect& GetCurrentSurfaceRect() const; + + /** + * Query wheter the surface rect is changed or not. + * @return true if the surface rect is changed. + */ + bool IsSurfaceRectChanged() const; + + /** + * @brief Send message to acknowledge for completing window rotation with current window orientation. + * + * If this function is called, the message is sent to render thread, then mSurfaceRectChanged in scene-graph-scene is set with true. + * After that, render thread checks whether window rotation event is received, mSurfaceRectChanged and the neccessary flag are set. + * If they are all true, rotation done function is called to complete window rotation. + */ + void SetRotationCompletedAcknowledgement(); + + /** + * @brief Query wheter is set to acknowledge for completing surface rotation. + * @return true it should be acknowledged. + * + * If SetRotationCompletedAcknowledgement() is called and the related message is received to scene-graph-scene, + * then mSurfaceRectChanged in scene-graph-scene is set with true. + * + * When this function is called, the mSurfaceRectChanged in scene-graph-scene is return. + * Then, the flag will be reset. + * + * @note This function should be not called the application's main thread. + * Because this function should be called in windwow surface's postrender() function to complete window rotation manually. + */ + bool IsRotationCompletedAcknowledgementSet() const; + + /** * @brief This signal is emitted just after the event processing is finished. * * @return The signal to connect to @@ -274,13 +393,13 @@ public: * An interrupted event will also be emitted (if it occurs). * A callback of the following type may be connected: * @code - * void YourCallbackName( TouchData event ); + * void YourCallbackName( TouchEvent event ); * @endcode * * @return The touch signal to connect to * @note Motion events are not emitted. */ - TouchSignalType& TouchSignal(); + TouchEventSignalType& TouchedSignal(); /** * @brief This signal is emitted when wheel event is received. @@ -293,8 +412,24 @@ public: */ WheelEventSignalType& WheelEventSignal(); -public: // Not intended for application developers + /** + * @brief When a custom wheel event occurs, it need to process the focused actor first. + * + * Therefore, KeyboardFocusManager first checks whether WheelEvent is generated as WheelEventGeneratedSignal. + * After that wheelEventProcessor must invoke WheelEvent only if wheelEventGeneratedSignal () is not consumed. + * + * This is only valid for custom wheel events. + * + * A callback of the following type may be connected: + * @code + * bool YourCallbackName(const WheelEvent& event); + * @endcode + * + * @return The return is true if WheelEvent is consumed, otherwise false. + */ + WheelEventGeneratedSignalType& WheelEventGeneratedSignal(); +public: // Not intended for application developers /** * @brief This constructor is used by Dali::New() methods. *