#define DALI_LAYER_H
/*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
*
*/
+// EXTERNAL INCLUDES
+#include <cstdint> // uint32_t
+
// INTERNAL INCLUDES
#include <dali/public-api/object/ref-object.h>
#include <dali/public-api/actors/actor.h>
#include <dali/public-api/math/rect.h>
#include <dali/public-api/math/vector3.h>
-#include <dali/public-api/images/frame-buffer-image.h>
namespace Dali
{
* @SINCE_1_0.0
* @see Dali::Layer::SetClippingBox()
*/
-typedef Rect<int> ClippingBox;
+using ClippingBox = Rect<int32_t>;
/**
* @brief Layers provide a mechanism for overlaying groups of actors on top of each other.
*
- * When added to the stage, a layer can be ordered relative to other
- * layers. The bottom layer is at depth zero. The stage provides a default
- * layer for it's children (see Stage::GetRootLayer()).
+ * When added to a scene, a layer can be ordered relative to other
+ * layers. The bottom layer is at depth zero. A scene provides a default
+ * layer for its children.
*
* Layered actors inherit position etc. as normal, but are drawn in an order
* determined by the layers. In case of LAYER_3D, the depth buffer is cleared
* need for it based on the layer's contents; actors in lower layers cannot
* obscure actors in higher layers.
*
- * A layer has either LAYER_2D or LAYER_3D mode. LAYER_2D has better
+ * A layer has either LAYER_UI or LAYER_3D mode. LAYER_UI has better
* performance, the depth test is disabled, and a child actor hides its
* parent actor. LAYER_3D uses the depth test, thus a close actor hides a
- * farther one. LAYER_2D is the default mode and recommended for general
+ * farther one. LAYER_UI is the default mode and recommended for general
* cases. See Layer::Behavior and SetBehavior() for more information.
*
* Layer is a type of Actor, thus can have parent or children actors. A
* | lowerToBottom | @ref LowerToBottom() |
* @SINCE_1_0.0
*/
-class DALI_IMPORT_API Layer : public Actor
+class DALI_CORE_API Layer : public Actor
{
public:
enum
{
CLIPPING_ENABLE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "clippingEnable", type bool @SINCE_1_0.0
- CLIPPING_BOX, ///< name "clippingBox", type Rect<int> @SINCE_1_0.0
- BEHAVIOR, ///< name "behavior", type String @SINCE_1_0.0
+ CLIPPING_BOX, ///< name "clippingBox", type Rect<int32_t> @SINCE_1_0.0
+ BEHAVIOR, ///< name "behavior", type integer or string @SINCE_1_0.0
+
+ /**
+ * @brief The current depth of the layer.
+ * @details Name "depth", type Property::INTEGER. Read-only
+ * @note 0 is the bottom most layer, higher number is on top.
+ * @note Layer should be on the stage. If layer is not added to the stage, the depth is 0.
+ * @SINCE_1_9.16
+ */
+ DEPTH,
+
+ /**
+ * @brief Whether to enable the depth test.
+ * @details Name "depthTest", type Property::BOOLEAN.
+ * @note By default a layer enables depth test if there is more than one opaque actor
+ * or if there is one opaque actor and one, or more, transparent actors in LAYER_3D mode.
+ * However, it's possible to disable the depth test by setting this property to False.
+ * @SINCE_1_9.16
+ */
+ DEPTH_TEST,
+
+ /**
+ * @brief Whether this layer should consume touch (including gestures).
+ * @details Name "consumesTouch", type Property::BOOLEAN.
+ * @note When this is True, any layers behind this layer will not be hit-test.
+ * @SINCE_1_9.16
+ */
+ CONSUMES_TOUCH,
+
+ /**
+ * @brief Whether this layer should consume hover (including gestures).
+ * @details Name "consumesHover", type Property::BOOLEAN.
+ * @note When this is True, any layers behind this layer will not be hit-test.
+ * @SINCE_1_9.16
+ */
+ CONSUMES_HOVER,
};
};
enum Behavior
{
/**
- * @DEPRECATED_1_1.45, use LAYER_UI instead
- * @brief UI control rendering mode.
- * @SINCE_1_0.0
- * @see LAYER_UI
- */
- LAYER_2D,
-
- /**
* @brief UI control rendering mode (default mode).
*
* This mode is designed for UI controls that can overlap. In this
*
* @SINCE_1_1.45
*/
- LAYER_UI = LAYER_2D,
+ LAYER_UI,
/**
* @brief Layer will use depth test.
};
/**
- * @DEPRECATED_1_2.26. Not intended for application use.
- *
- * @brief Enumeration for TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
- * @SINCE_1_0.0
- */
- enum TreeDepthMultiplier
- {
- TREE_DEPTH_MULTIPLIER = 10000,
- };
-
- /**
* @brief The sort function type.
*
* @SINCE_1_0.0
* @param[in] position This is the actor translation from camera
*/
- typedef float (*SortFunctionType)( const Vector3& position );
+ using SortFunctionType = float ( * )( const Vector3& );
/**
* @brief Creates an empty Layer handle.
Layer& operator=(const Layer& rhs);
/**
- * @brief Queries the depth of the layer.
+ * @brief Move constructor.
*
- * 0 is the bottom most layer, higher number is on top.
- * @SINCE_1_0.0
- * @return The current depth of the layer
- * @pre Layer is on the stage.
- * If layer is not added to the stage, returns 0.
+ * @SINCE_1_9.22
+ * @param[in] rhs The layer to move
+ */
+ Layer( Layer&& rhs );
+
+ /**
+ * @brief Move assignment operator.
+ *
+ * @SINCE_1_9.22
+ * @param[in] rhs The layer to move
+ * @return A reference to this
*/
- unsigned int GetDepth() const;
+ Layer& operator=( Layer&& rhs );
/**
* @brief Increments the depth of the layer.
*/
void MoveBelow( Layer target );
- /**
- * @brief Sets the behavior of the layer.
- *
- * @SINCE_1_0.0
- * @param[in] behavior The desired behavior
- */
- void SetBehavior( Behavior behavior );
-
- /**
- * @brief Gets the behavior of the layer.
- *
- * @SINCE_1_0.0
- * @return The behavior of the layer
- */
- Behavior GetBehavior() const;
-
- /**
- * @brief Sets whether clipping is enabled for a layer.
- *
- * Clipping is initially disabled; see also SetClippingBox().
- * @SINCE_1_0.0
- * @param[in] enabled True if clipping is enabled
- *
- * @note When clipping is enabled, the default clipping box is empty (0,0,0,0), which means everything is clipped.
- */
- void SetClipping(bool enabled);
-
- /**
- * @brief Queries whether clipping is enabled for a layer.
- * @SINCE_1_0.0
- * @return True if clipping is enabled
- */
- bool IsClipping() const;
-
- /**
- * @brief Sets the clipping box of a layer, in window coordinates.
- *
- * The contents of the layer will not be visible outside this box, when clipping is
- * enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped.
- * You can only do rectangular clipping using this API in window coordinates.
- * @SINCE_1_0.0
- * @param[in] x The X-coordinate of the top-left corner of the box
- * @param[in] y The Y-coordinate of the top-left corner of the box
- * @param[in] width The width of the box
- * @param[in] height The height of the box
- */
- void SetClippingBox(int x, int y, int width, int height);
-
- /**
- * @brief Sets the clipping box of a layer in window coordinates.
- *
- * The contents of the layer will not be visible outside this box when clipping is
- * enabled. The default clipping box is empty (0,0,0,0).
- * @SINCE_1_0.0
- * @param[in] box The clipping box
- */
- void SetClippingBox(ClippingBox box);
-
- /**
- * @brief Retrieves the clipping box of a layer in window coordinates.
- *
- * @SINCE_1_0.0
- * @return The clipping box
- */
- ClippingBox GetClippingBox() const;
-
- // Depth test
-
- /**
- * @brief Whether to disable the depth test.
- *
- * By default a layer enables depth test if there is more than one opaque actor or if there is one opaque actor and one, or more, transparent actors in LAYER_3D mode.
- * However, it's possible to disable the depth test by calling this method.
- *
- * @SINCE_1_0.0
- * @param[in] disable \e True disables depth test. \e false sets the default behavior
- */
- void SetDepthTestDisabled( bool disable );
-
- /**
- * @brief Retrieves whether depth test is disabled.
- *
- * @SINCE_1_0.0
- * @return \e True if depth test is disabled
- */
- bool IsDepthTestDisabled() const;
-
// Sorting
/**
void SetSortFunction( SortFunctionType function );
/**
- * @brief This allows the user to specify whether this layer should consume touch (including gestures).
- *
- * If set, any layers behind this layer will not be hit-test.
- *
- * @SINCE_1_0.0
- * @param[in] consume Whether the layer should consume touch (including gestures)
- */
- void SetTouchConsumed( bool consume );
-
- /**
- * @brief Retrieves whether the layer consumes touch (including gestures).
- *
- * @SINCE_1_0.0
- * @return @c True if consuming touch, @c false otherwise
- */
- bool IsTouchConsumed() const;
-
- /**
- * @brief This allows the user to specify whether this layer should consume hover.
- *
- * If set, any layers behind this layer will not be hit-test.
- *
- * @SINCE_1_0.0
- * @param[in] consume Whether the layer should consume hover
- */
- void SetHoverConsumed( bool consume );
-
- /**
* @brief Retrieves whether the layer consumes hover.
*
* @SINCE_1_0.0
projects / platform / core / uifw / dali-core.git / blobdiff