#define DALI_INTERNAL_LAYER_H
/*
- * Copyright (c) 2018 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2024 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.
*/
// INTERNAL INCLUDES
-#include <dali/public-api/actors/layer.h>
-#include <dali/internal/event/actors/actor-impl.h>
#include <dali/internal/event/actors/actor-declarations.h>
+#include <dali/internal/event/actors/actor-impl.h>
+#include <dali/public-api/actors/layer.h>
namespace Dali
{
-
namespace Internal
{
-
class LayerList;
namespace SceneGraph
{
class UpdateManager;
class Layer;
-}
+} // namespace SceneGraph
-typedef Dali::ClippingBox ClippingBox;
+using ClippingBox = Dali::ClippingBox;
-class Layer : public Actor
+class Layer : public Actor, public ConnectionTracker
{
public:
-
/**
* @copydoc Dali::Layer::ZValue(const Vector3&, float)
*
* @param[in] layerList The layer will be added to this ordered list.
* @return A smart-pointer to the newly allocated Actor.
*/
- static LayerPtr NewRoot( LayerList& layerList );
+ static LayerPtr NewRoot(LayerList& layerList);
/**
* @copydoc Dali::Internal::Actor::OnInitialize
*/
- void OnInitialize();
+ void OnInitialize() override;
/**
* Query the current depth of the layer
/**
* @copydoc Dali::Layer::RaiseAbove
*/
- void RaiseAbove( const Internal::Layer& target );
+ void RaiseAbove(const Internal::Layer& target);
/**
* @copydoc Dali::Layer::LowerBelow
*/
- void LowerBelow( const Internal::Layer& target );
+ void LowerBelow(const Internal::Layer& target);
/**
* @copydoc Dali::Layer::RaiseToTop
/**
* @copydoc Dali::Layer::MoveAbove
*/
- void MoveAbove( const Internal::Layer& target );
+ void MoveAbove(const Internal::Layer& target);
/**
* @copydoc Dali::Layer::MoveAbove
*/
- void MoveBelow( const Internal::Layer& target );
+ void MoveBelow(const Internal::Layer& target);
/**
* @copydoc Dali::Layer::SetClipping()
/**
* @copydoc Dali::Layer::SetBehavior()
*/
- void SetBehavior( Dali::Layer::Behavior behavior );
+ void SetBehavior(Dali::Layer::Behavior behavior);
/**
* @copydoc Dali::Layer::GetBehavior()
/**
* @copydoc Dali::Layer::SetDepthTestDisabled()
*/
- void SetDepthTestDisabled( bool disable );
+ void SetDepthTestDisabled(bool disable);
/**
* @copydoc Dali::Layer::IsDepthTestDisabled()
/**
* @copydoc Dali::Layer::SetTouchConsumed()
*/
- void SetTouchConsumed( bool consume );
+ void SetTouchConsumed(bool consume);
/**
* @copydoc Dali::Layer::IsTouchConsumed()
/**
* @copydoc Dali::Layer::SetHoverConsumed()
*/
- void SetHoverConsumed( bool consume );
+ void SetHoverConsumed(bool consume);
/**
* @copydoc Dali::Layer::IsHoverConsumed()
/**
* Helper function to get the scene object.
- * This should only be called by Stage
+ *
* @return the scene object for the layer.
*/
- const SceneGraph::Layer& GetSceneLayerOnStage() const;
+ const SceneGraph::Layer& GetSceneGraphLayer() const;
/**
* @copydoc Dali::Internal::Actor::DoAction()
static bool DoAction(BaseObject* object, const std::string& actionName, const Property::Map& attributes);
public: // Default property extensions from Object
-
/**
* @copydoc Dali::Internal::Object::SetDefaultProperty()
*/
- virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
+ void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue) override;
/**
* @copydoc Dali::Internal::Object::GetDefaultProperty()
*/
- virtual Property::Value GetDefaultProperty( Property::Index index ) const;
+ Property::Value GetDefaultProperty(Property::Index index) const override;
/**
* @copydoc Dali::Internal::Object::GetDefaultProperty()
*/
- virtual Property::Value GetDefaultPropertyCurrentValue( Property::Index index ) const;
+ Property::Value GetDefaultPropertyCurrentValue(Property::Index index) const override;
protected:
-
/**
* Construct a new layer.
* @param[in] type Either Actor::LAYER or Actor::ROOT_LAYER if this is the root actor.
* @param[in] layer the scene graph layer
*/
- Layer( Actor::DerivedType type, const SceneGraph::Layer& layer );
+ Layer(Actor::DerivedType type, const SceneGraph::Layer& layer);
/**
* A reference counted object may only be deleted by calling Unreference()
*/
- virtual ~Layer();
+ ~Layer() override;
private: // From Actor
-
/**
* From Actor.
*/
- virtual void OnStageConnectionInternal();
+ void OnSceneConnectionInternal() override;
/**
* From Actor.
*/
- virtual void OnStageDisconnectionInternal();
+ void OnSceneDisconnectionInternal() override;
private:
+ /**
+ * @brief Callback when Layer is touched
+ *
+ * @param[in] actor Layer touched
+ * @param[in] touch Touch information
+ * @return True if the touch is consumed.
+ */
+ bool OnTouched(Dali::Actor actor, const Dali::TouchEvent& touch);
- LayerList* mLayerList; ///< Only valid when layer is on-stage
+ LayerList* mLayerList; ///< Only valid when layer is on-scene
// These properties not animatable; the actor side has the most up-to-date values
- ClippingBox mClippingBox; ///< The clipping box, in window coordinates
- Dali::Layer::SortFunctionType mSortFunction; ///< Used to sort semi-transparent geometry
+ ClippingBox mClippingBox; ///< The clipping box, in window coordinates
+ Dali::Layer::SortFunctionType mSortFunction; ///< Used to sort semi-transparent geometry
- Dali::Layer::Behavior mBehavior; ///< Behavior of the layer
-
- bool mIsClipping:1; ///< True when clipping is enabled
- bool mDepthTestDisabled:1; ///< Whether depth test is disabled.
- bool mTouchConsumed:1; ///< Whether we should consume touch (including gesture).
- bool mHoverConsumed:1; ///< Whether we should consume hover.
+ Dali::Layer::Behavior mBehavior; ///< Behavior of the layer
+ bool mIsClipping : 1; ///< True when clipping is enabled
+ bool mDepthTestDisabled : 1; ///< Whether depth test is disabled.
+ bool mTouchConsumed : 1; ///< Whether we should consume touch (including gesture).
+ bool mHoverConsumed : 1; ///< Whether we should consume hover.
};
} // namespace Internal
} // namespace Dali
-
#endif // DALI_INTERNAL_LAYER_H