X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fcommon%2Fstage.h;h=2925cc37f6a606ba5ccea86d3a6e76c453c972cb;hb=baad1726f5f7f05d98da7ca591f24dbe3c49dab2;hp=c782456e48e396a02c70f3a4807b9e2d385a406d;hpb=d894f394cfdeea4e482b0666fe25d6039dca6bcb;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/common/stage.h b/dali/public-api/common/stage.h index c782456..2925cc3 100644 --- a/dali/public-api/common/stage.h +++ b/dali/public-api/common/stage.h @@ -1,8 +1,8 @@ -#ifndef __DALI_STAGE_H__ -#define __DALI_STAGE_H__ +#ifndef DALI_STAGE_H +#define DALI_STAGE_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 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,6 +18,9 @@ * */ +// EXTERNAL INCLUDES +#include // uint32_t + // INTERNAL INCLUDES #include #include @@ -37,6 +40,7 @@ class Stage; class Actor; class Layer; class ObjectRegistry; +class TouchData; class RenderTaskList; struct Vector2; struct Vector3; @@ -48,6 +52,24 @@ struct WheelEvent; /** * @brief The Stage is a top-level object used for displaying a tree of Actors. * + * Stage is a top-level object that represents the entire screen. + * It is used for displaying a hierarchy of actors managed by the scene graph structure, + * which means an actor inherits a position relative to its parent, + * and can be moved in relation to this point. + * + * The stage instance is a singleton object (the only instance of its class during the + * lifetime of the program). You can get it using a static function. + * + * To display the contents of an actor, it must be added to a stage. + * The following example shows how to connect a new actor to the stage: + * @code + * Actor actor = Actor::New(); + * Stage::GetCurrent().Add( actor ); + * @endcode + * + * The stage has a 2D size that matches the size of the application window. + * The default unit 1 is 1 pixel with the default camera. + * * Multiple stage/window support is not currently provided. * * Signals @@ -62,16 +84,17 @@ struct WheelEvent; * | sceneCreated | @ref SceneCreatedSignal() | * @SINCE_1_0.0 */ -class DALI_IMPORT_API Stage : public BaseHandle +class DALI_CORE_API Stage : public BaseHandle { public: - typedef Signal< void (const KeyEvent&)> KeyEventSignalType; ///< Key event signal type @SINCE_1_0.0 - typedef Signal< void () > EventProcessingFinishedSignalType; ///< Event Processing finished signal type @SINCE_1_0.0 - typedef Signal< void (const TouchEvent&)> TouchedSignalType; ///< Touched signal type @SINCE_1_0.0 - typedef Signal< void (const WheelEvent&)> WheelEventSignalType; ///< Touched signal type @SINCE_1_0.0 - typedef Signal< void () > ContextStatusSignal; ///< Context status signal type @SINCE_1_0.0 - typedef Signal< void () > SceneCreatedSignalType; ///< Scene created signal type @SINCE_1_0.0 + typedef Signal< void (const KeyEvent&) > KeyEventSignalType; ///< Key event signal type @SINCE_1_0.0 + typedef Signal< void () > EventProcessingFinishedSignalType; ///< Event Processing finished signal type @SINCE_1_0.0 + typedef Signal< void (const TouchEvent&) > TouchedSignalType; ///< @DEPRECATED_1_1.37 @brief Touched signal type @SINCE_1_0.0 + typedef Signal< void (const TouchData&) > TouchSignalType; ///< Touch signal type @SINCE_1_1.37 + typedef Signal< void (const WheelEvent&) > WheelEventSignalType; ///< Touched signal type @SINCE_1_0.0 + typedef Signal< void () > ContextStatusSignal; ///< Context status signal type @SINCE_1_0.0 + typedef Signal< void () > SceneCreatedSignalType; ///< Scene created signal type @SINCE_1_0.0 static const Vector4 DEFAULT_BACKGROUND_COLOR; ///< Default black background. static const Vector4 DEBUG_BACKGROUND_COLOR; ///< Green background, useful when debugging. @@ -85,23 +108,23 @@ public: Stage(); /** - * @brief Get the current Stage. + * @brief Gets the current Stage. * * @SINCE_1_0.0 - * @return The current stage or an empty handle if Core has not been created or has been already destroyed. + * @return The current stage or an empty handle if the internal core has not been created or has been already destroyed */ static Stage GetCurrent(); /** - * @brief Query whether the Stage exists; this should only return false during or after destruction of Dali core. + * @brief Queries whether the Stage exists; this should only return false during or after destruction of Dali core. * * @SINCE_1_0.0 - * @return True when it's safe to call Stage::GetCurrent(). + * @return True when it's safe to call Stage::GetCurrent() */ static bool IsInstalled(); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -112,7 +135,7 @@ public: * @brief This copy constructor is required for (smart) pointer semantics. * * @SINCE_1_0.0 - * @param [in] handle A reference to the copied handle + * @param[in] handle A reference to the copied handle */ Stage(const Stage& handle); @@ -120,7 +143,7 @@ public: * @brief This assignment operator is required for (smart) pointer semantics. * * @SINCE_1_0.0 - * @param [in] rhs A reference to the copied handle + * @param[in] rhs A reference to the copied handle * @return A reference to this */ Stage& operator=(const Stage& rhs); @@ -132,7 +155,7 @@ public: * * The child will be referenced. * @SINCE_1_0.0 - * @param [in] actor The child. + * @param[in] actor The child * @pre The actor has been initialized. * @pre The actor does not have a parent. */ @@ -143,7 +166,7 @@ public: * * The child will be unreferenced. * @SINCE_1_0.0 - * @param [in] actor The child. + * @param[in] actor The child * @pre The actor has been added to the stage. */ void Remove(Actor& actor); @@ -151,84 +174,84 @@ public: /** * @brief Returns the size of the Stage in pixels as a Vector. * - * The x component will be the width of the Stage in pixels - * The y component will be the height of the Stage in pixels - * The z component will be the distance between far and near planes + * The x component will be the width of the Stage in pixels. + * The y component will be the height of the Stage in pixels. + * The z component will be the distance between far and near planes. * @SINCE_1_0.0 - * @return The size of the Stage as a Vector. + * @return The size of the Stage as a Vector */ Vector2 GetSize() const; // Render Tasks /** - * @brief Retrieve the list of render-tasks. + * @brief Retrieves the list of render-tasks. * * @SINCE_1_0.0 - * @return A valid handle to a RenderTaskList. + * @return A valid handle to a RenderTaskList */ RenderTaskList GetRenderTaskList() const; // Layers /** - * @brief Query the number of on-stage layers. + * @brief Queries the number of on-stage layers. * * Note that a default layer is always provided (count >= 1). * @SINCE_1_0.0 - * @return The number of layers. + * @return The number of layers */ - unsigned int GetLayerCount() const; + uint32_t GetLayerCount() const; /** - * @brief Retrieve the layer at a specified depth. + * @brief Retrieves the layer at a specified depth. * * @SINCE_1_0.0 - * @param[in] depth The depth. - * @return The layer found at the given depth. - * @pre depth is less than layer count; see GetLayerCount(). + * @param[in] depth The depth + * @return The layer found at the given depth + * @pre Depth is less than layer count; see GetLayerCount(). */ - Layer GetLayer(unsigned int depth) const; + Layer GetLayer(uint32_t depth) const; /** * @brief Returns the Stage's Root Layer. * * @SINCE_1_0.0 - * @return The root layer. + * @return The root layer */ Layer GetRootLayer() const; // Background color /** - * @brief Set the background color of the stage. + * @brief Sets the background color of the stage. * * @SINCE_1_0.0 - * @param[in] color The new background color. + * @param[in] color The new background color */ void SetBackgroundColor(Vector4 color); /** - * @brief Retrieve the background color of the stage. + * @brief Retrieves the background color of the stage. * * @SINCE_1_0.0 - * @return The background color. + * @return The background color */ Vector4 GetBackgroundColor() const; /** - * @brief Retrieve the DPI of the display device to which the stage is connected. + * @brief Retrieves the DPI of the display device to which the stage is connected. * * @SINCE_1_0.0 - * @return the horizontal and vertical DPI + * @return The horizontal and vertical DPI */ Vector2 GetDpi() const; /** - * @brief Get the Object registry. + * @brief Gets the Object registry. * * @SINCE_1_0.0 - * @return The object registry. + * @return The object registry */ ObjectRegistry GetObjectRegistry() const; @@ -237,10 +260,10 @@ public: /** * @brief Keep rendering for at least the given amount of time. * - * By default Dali will stop rendering when no Actor positions are being set, and when no animations are running etc. + * By default, Dali will stop rendering when no Actor positions are being set, and when no animations are running etc. * This method is useful to force screen refreshes e.g. when updating a NativeImage. * @SINCE_1_0.0 - * @param durationSeconds to keep rendering, 0 means render at least one more frame + * @param[in] durationSeconds Time to keep rendering, 0 means render at least one more frame */ void KeepRendering( float durationSeconds ); @@ -254,7 +277,7 @@ public: * void YourCallbackName(const KeyEvent& event); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ KeyEventSignalType& KeyEventSignal(); @@ -262,27 +285,46 @@ public: * @brief This signal is emitted just after the event processing is finished. * * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ EventProcessingFinishedSignalType& EventProcessingFinishedSignal(); /** + * @DEPRECATED_1_1.37 Use TouchSignal() instead. * @brief This signal is emitted when the screen is touched and when the touch ends * (i.e. the down & up touch events only). * * If there are multiple touch points, then this will be emitted when the first touch occurs and * then when the last finger is lifted. - * An interrupted event will also be emitted. + * An interrupted event will also be emitted (if it occurs). * A callback of the following type may be connected: * @code * void YourCallbackName(const TouchEvent& event); * @endcode * * @SINCE_1_0.0 - * @return The touch signal to connect to. + * @return The touch signal to connect to * @note Motion events are not emitted. */ - TouchedSignalType& TouchedSignal(); + TouchedSignalType& TouchedSignal() DALI_DEPRECATED_API; + + /** + * @brief This signal is emitted when the screen is touched and when the touch ends + * (i.e. the down & up touch events only). + * + * If there are multiple touch points, then this will be emitted when the first touch occurs and + * then when the last finger is lifted. + * An interrupted event will also be emitted (if it occurs). + * A callback of the following type may be connected: + * @code + * void YourCallbackName( TouchData event ); + * @endcode + * + * @SINCE_1_1.37 + * @return The touch signal to connect to + * @note Motion events are not emitted. + */ + TouchSignalType& TouchSignal(); /** * @brief This signal is emitted when wheel event is received. @@ -292,7 +334,7 @@ public: * void YourCallbackName(const WheelEvent& event); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ WheelEventSignalType& WheelEventSignal(); @@ -300,25 +342,27 @@ public: * @brief This signal is emitted when the GL context is lost (Platform specific behaviour). * * If the application is responsible for handling context loss, it should listen to - * this signal and tear down UI components when recieved. + * this signal and tear down UI components when received. * @SINCE_1_0.0 - * @return The ContextLost signal to connect to. + * @return The context lost signal to connect to */ ContextStatusSignal& ContextLostSignal(); /** * @brief This signal is emitted when the GL context is regained (Platform specific - * behaviour). + * behavior). * * If the application is responsible for handling context loss, it should listen to * this signal and rebuild UI components on receipt. * @SINCE_1_0.0 - * @return The ContextRegained signal to connect to. + * @return The context regained signal to connect to */ ContextStatusSignal& ContextRegainedSignal(); /** - * @brief This signal is emitted after the initial scene is created. It will be triggered after the + * @brief This signal is emitted after the initial scene is created. + * + * It will be triggered after the * application init signal. * * A callback of the following type may be connected: @@ -326,19 +370,21 @@ public: * void YourCallbackName(); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ SceneCreatedSignalType& SceneCreatedSignal(); public: // Not intended for application developers + /// @cond internal /** - * @brief This constructor is used by Dali GetCurrent() methods. + * @brief This constructor is used by Stage::GetCurrent() methods. * * @SINCE_1_0.0 - * @param [in] stage A pointer to a Dali resource + * @param[in] stage A pointer to a Dali resource */ explicit DALI_INTERNAL Stage(Internal::Stage* stage); + /// @endcond }; /** @@ -347,4 +393,4 @@ public: // Not intended for application developers } // namespace Dali -#endif // __DALI_STAGE_H__ +#endif // DALI_STAGE_H