1 #ifndef __DALI_TOOLKIT_INTERNAL_CONTROL_RENDERER_H__
2 #define __DALI_TOOLKIT_INTERNAL_CONTROL_RENDERER_H__
5 * Copyright (c) 2015 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.
23 #include <dali/public-api/object/base-object.h>
25 #include <dali-toolkit/devel-api/controls/renderer-factory/renderer-factory.h>
26 #include <dali-toolkit/devel-api/controls/renderer-factory/control-renderer.h>
37 class RendererFactoryCache;
40 * Base class for all Control rendering logic. A control may have multiple control renderers.
42 * Note: The control renderer responds to the the Actor::COLOR by blending it with the 'Multiply' operator.
44 class ControlRenderer : public BaseObject
49 * Initialisation of the renderer, this API should only called by the RendererFactory:
50 * request the geometry and shader from the cache, if not available, create and save to the cache for sharing;
51 * record the property values.
53 * @param[in] factoryCache A pointer pointing to the RendererFactoryCache object
54 * @param[in] propertyMap The properties for the requested ControlRenderer object.
56 virtual void Initialize( RendererFactoryCache& factoryCache, const Property::Map& propertyMap ) = 0;
59 * @copydoc Toolkit::ControlRenderer::SetSize
61 virtual void SetSize( const Vector2& size );
64 * @copydoc Toolkit::ControlRenderer::GetSize
66 const Vector2& GetSize() const;
69 * @copydoc Toolkit::ControlRenderer::GetNaturalSize
71 virtual void GetNaturalSize( Vector2& naturalSize ) const;
74 * ToDo: Add this function to Toolkit::ControlRenderer when it is fully implemented.
76 * Set the clip rectangular of this renderer.
77 * The contents of the renderer will not be visible outside this rectangular.
79 * @param [in] clipRect The clipping rectangular.
81 virtual void SetClipRect( const Rect<int>& clipRect );
84 *ToDo: Add this function to Toolkit::ControlRenderer when it is fully implemented.
86 * Reposition this renderer with a 2D offset.
88 * @param[in] offset The offset to reposition the renderer.
90 virtual void SetOffset( const Vector2& offset );
93 * @copydoc Toolkit::ControlRenderer::SetDepthIndex
95 void SetDepthIndex( float index );
98 * @copydoc Toolkit::ControlRenderer::GetDepthIndex
100 float GetDepthIndex() const;
103 * @copydoc Toolkit::ControlRenderer::SetOnStage
104 * @pre Impl->mGeometry must be created before this method is called
106 void SetOnStage( Actor& actor );
109 * @copydoc Toolkit::ControlRenderer::SetOffStage
111 void SetOffStage( Actor& actor );
114 * @copydoc Toolkit::ControlRenderer::CreatePropertyMap
116 virtual void CreatePropertyMap( Property::Map& map ) const = 0;
121 * @brief Constructor.
126 * @brief A reference counted object may only be deleted by calling Unreference().
128 virtual ~ControlRenderer();
133 * Called by SetOnStage() allowing sub classes to respond to the SetOnStage event
135 * @param[in] actor The actor applying this renderer.
137 virtual void DoSetOnStage( Actor& actor );
140 * Called by SetOffStage() allowing sub classes to respond to the SetOffStage event
142 * @param[in] actor The actor applying this renderer.
144 virtual void DoSetOffStage( Actor& actor );
149 ControlRenderer( const ControlRenderer& renderer );
152 ControlRenderer& operator=( const ControlRenderer& renderer );
160 } // namespace Internal
162 inline const Internal::ControlRenderer& GetImplementation(const Toolkit::ControlRenderer& renderer)
164 DALI_ASSERT_ALWAYS( renderer && "ControlRenderer handle is empty" );
166 const BaseObject& handle = renderer.GetBaseObject();
168 return static_cast<const Internal::ControlRenderer&>(handle);
171 inline Internal::ControlRenderer& GetImplementation(Toolkit::ControlRenderer& renderer)
173 DALI_ASSERT_ALWAYS( renderer && "ControlRenderer handle is empty" );
175 BaseObject& handle = renderer.GetBaseObject();
177 return static_cast<Internal::ControlRenderer&>(handle);
180 } // namespace Toolkit
184 #endif /* __DALI_TOOLKIT_INTERNAL_CONTROL_RENDERER_H___ */