1 #ifndef __DALI_INTERNAL_LAYER_H__
2 #define __DALI_INTERNAL_LAYER_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/actors/layer.h>
23 #include <dali/internal/event/actors/actor-impl.h>
24 #include <dali/internal/event/actors/actor-declarations.h>
40 typedef Dali::ClippingBox ClippingBox;
42 class Layer : public Actor
47 * @brief This sort function sorts translucent actors according to the Z-value in view space.
49 * This is useful for 2D user interfaces.
51 * This is the default sorting function.
53 * We return a negative z value as in our translation, a low z means that it should
54 * be sorted further away and a high z means that it should be closer.
55 * @param[in] position position of actor in view space
56 * @param[in] sortModifier additional sort modifer
59 static float ZValue(const Vector3& position, float sortModifier)
61 // inlined so we avoid a function call when sorting renderers
62 return position.z + sortModifier;
67 * @return A smart-pointer to the newly allocated Layer.
69 static LayerPtr New();
72 * Create a new root layer; this is typically owned by the stage.
73 * @param[in] layerList The layer will be added to this ordered list.
74 * @param[in] manager The update manager to install a root node with.
75 * @param[in] systemLevel True if using the SystemOverlay API; see Integration::GetSystemOverlay() for more details.
76 * @return A smart-pointer to the newly allocated Actor.
78 static LayerPtr NewRoot( LayerList& layerList, SceneGraph::UpdateManager& manager, bool systemLevel );
81 * @copydoc Dali::Internal::Actor::OnInitialize
86 * Query the current depth of the layer
88 unsigned int GetDepth() const;
91 * @copydoc Dali::Layer::Raise
96 * @copydoc Dali::Layer::Lower
101 * @copydoc Dali::Layer::RaiseAbove
103 void RaiseAbove( const Internal::Layer& target );
106 * @copydoc Dali::Layer::LowerBelow
108 void LowerBelow( const Internal::Layer& target );
111 * @copydoc Dali::Layer::RaiseToTop
116 * @copydoc Dali::Layer::LowerToBottom
118 void LowerToBottom();
121 * @copydoc Dali::Layer::MoveAbove
123 void MoveAbove( const Internal::Layer& target );
126 * @copydoc Dali::Layer::MoveAbove
128 void MoveBelow( const Internal::Layer& target );
131 * @copydoc Dali::Layer::SetClipping()
133 void SetClipping(bool enabled);
136 * @copydoc Dali::Layer::IsClipping()
138 bool IsClipping() const
140 return mIsClipping; // Actor-side has most up-to-date value
144 * @copydoc Dali::Layer::SetClippingBox()
146 void SetClippingBox(int x, int y, int width, int height);
149 * @copydoc Dali::Layer::GetClippingBox()
151 const Dali::ClippingBox& GetClippingBox() const
153 return mClippingBox; // Actor-side has most up-to-date value
157 * @copydoc Dali::Layer::SetDepthTestDisabled()
159 void SetDepthTestDisabled( bool disable );
162 * @copydoc Dali::Layer::IsDepthTestDisabled()
164 bool IsDepthTestDisabled() const;
167 * @copydoc Dali::Layer::SetSortFunction()
169 void SetSortFunction(Dali::Layer::SortFunctionType function);
172 * @copydoc Dali::Layer::SetTouchConsumed()
174 void SetTouchConsumed( bool consume );
177 * @copydoc Dali::Layer::IsTouchConsumed()
179 bool IsTouchConsumed() const;
182 * @copydoc Dali::Layer::SetHoverConsumed()
184 void SetHoverConsumed( bool consume );
187 * @copydoc Dali::Layer::IsHoverConsumed()
189 bool IsHoverConsumed() const;
192 * Helper function to get the scene object.
193 * This should only be called by Stage
194 * @return the scene object for the layer.
196 const SceneGraph::Layer& GetSceneLayerOnStage() const;
199 * @copydoc Dali::Internal::Actor::DoAction()
201 static bool DoAction(BaseObject* object, const std::string& actionName, const std::vector<Property::Value>& attributes);
203 public: // Default property extensions from Object
205 * @copydoc Dali::Internal::Object::GetDefaultPropertyCount()
207 virtual unsigned int GetDefaultPropertyCount() const;
210 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndices()
212 virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
215 * @copydoc Dali::Internal::Object::GetDefaultPropertyName()
217 virtual const char* GetDefaultPropertyName(Property::Index index) const;
220 * @copydoc Dali::Internal::Object::GetDefaultPropertyIndex()
222 virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
225 * @copydoc Dali::Internal::Object::IsDefaultPropertyWritable()
227 virtual bool IsDefaultPropertyWritable(Property::Index index) const;
230 * @copydoc Dali::Internal::Object::IsDefaultPropertyAnimatable()
232 virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
235 * @copydoc Dali::Internal::Object::IsDefaultPropertyAConstraintInput()
237 virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
240 * @copydoc Dali::Internal::Object::GetDefaultPropertyType()
242 virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
245 * @copydoc Dali::Internal::Object::SetDefaultProperty()
247 virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
250 * @copydoc Dali::Internal::Object::GetDefaultProperty()
252 virtual Property::Value GetDefaultProperty( Property::Index index ) const;
257 * Construct a new layer.
258 * @param[in] type Either Actor::LAYER or Actor::ROOT_LAYER if this is the root actor.
260 Layer( Actor::DerivedType type );
263 * A reference counted object may only be deleted by calling Unreference()
267 private: // From Actor
270 * From Actor; create a node to represent the layer in the scene-graph.
271 * @return A newly allocated layer node.
273 virtual SceneGraph::Node* CreateNode() const;
278 virtual void OnStageConnectionInternal();
283 virtual void OnStageDisconnectionInternal();
287 LayerList* mLayerList; ///< Only valid when layer is on-stage
289 // These properties not animatable; the actor side has the most up-to-date values
290 ClippingBox mClippingBox; ///< The clipping box, in window coordinates
291 Dali::Layer::SortFunctionType mSortFunction; ///< Used to sort semi-transparent geometry
293 bool mIsClipping:1; ///< True when clipping is enabled
294 bool mDepthTestDisabled:1; ///< Whether depth test is disabled.
295 bool mTouchConsumed:1; ///< Whether we should consume touch (including gesture).
296 bool mHoverConsumed:1; ///< Whether we should consume hover.
300 } // namespace Internal
302 // Helpers for public-api forwarding methods
304 inline Internal::Layer& GetImplementation(Dali::Layer& layer)
306 DALI_ASSERT_ALWAYS(layer && "Layer handle is empty");
308 BaseObject& handle = layer.GetBaseObject();
310 return static_cast<Internal::Layer&>(handle);
313 inline const Internal::Layer& GetImplementation(const Dali::Layer& layer)
315 DALI_ASSERT_ALWAYS(layer && "Layer handle is empty");
317 const BaseObject& handle = layer.GetBaseObject();
319 return static_cast<const Internal::Layer&>(handle);
325 #endif //__DALI_INTERNAL_LAYER_H__