1 #ifndef DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H
5 * Copyright (c) 2016 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/common/intrusive-ptr.h>
23 #include <dali/public-api/images/image.h>
24 #include <dali/public-api/images/image-operations.h>
25 #include <dali/devel-api/images/nine-patch-image.h>
26 #include <dali/public-api/rendering/geometry.h>
27 #include <dali/public-api/rendering/sampler.h>
28 #include <dali/public-api/rendering/shader.h>
31 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
43 typedef IntrusivePtr< NPatchVisual > NPatchVisualPtr;
46 * The visual which renders an 9 patch image to the control's quad
48 * The following properties are optional
50 * | %Property Name | Type |
51 * |--------------------------|------------------|
53 * | borderOnly | BOOLEAN
56 class NPatchVisual: public Visual::Base
61 * @brief Create an N-patch visual using an image URL.
63 * The visual will load the image synchronously when the associated actor is put on stage, and destroy the image when it is off stage
65 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
66 * @param[in] imageUrl The URL to 9 patch image resource to use
68 static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const std::string& imageUrl );
71 * @brief Create an N-patch visual with a NinePatchImage resource.
73 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
74 * @param[in] image The NinePatchImage to use
76 static NPatchVisualPtr New( VisualFactoryCache& factoryCache, NinePatchImage image );
78 public: // from Visual
81 * @copydoc Visual::Base::GetNaturalSize
83 virtual void GetNaturalSize( Vector2& naturalSize ) const;
86 * @copydoc Visual::Base::CreatePropertyMap
88 virtual void DoCreatePropertyMap( Property::Map& map ) const;
91 * @copydoc Visual::Base::DoSetProperty
93 virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
96 * @copydoc Visual::Base::DoGetProperty
98 virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
103 * @brief Constructor.
105 * @param[in] factoryCache Reference to the VisualFactoryCache object
107 NPatchVisual( VisualFactoryCache& factoryCache );
110 * @brief A reference counted object may only be deleted by calling Unreference().
112 virtual ~NPatchVisual();
115 * @copydoc Visual::Base::DoSetProperties
117 virtual void DoSetProperties( const Property::Map& propertyMap );
120 * @copydoc Visual::Base::DoSetOnStage
122 virtual void DoSetOnStage( Actor& actor );
125 * @copydoc Visual::Base::DoSetOffStage
127 virtual void DoSetOffStage( Actor& actor );
130 * @copydoc Visual::Base::OnSetTransform
132 virtual void OnSetTransform();
137 * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
139 void InitializeRenderer();
142 * @brief Creates a geometry for this renderer's grid size
144 * @return Returns the created geometry for this renderer's grid size
146 Geometry CreateGeometry();
149 * @brief Creates a shader for this renderer's grid size
151 * @return Returns the created shader for this renderer's grid size
153 Shader CreateShader();
156 * @brief Creates a geometry for the grid size to be used by this visuals' shaders
158 * @param[in] gridSize The grid size of the solid geometry to create
159 * @return Returns the created geometry for the grid size
161 Geometry CreateGeometry( Uint16Pair gridSize );
164 * @brief Creates a geometry with the border only for the grid size to be used by this visuals' shaders
165 * e.g. a 5x4 grid would create a geometry that would look like:
167 * ---------------------
170 * ---------------------
176 * ---------------------
179 * ---------------------
181 * @param[in] gridSize The grid size of the solid geometry to create
182 * @return Returns the created geometry for the grid size
184 Geometry CreateGeometryBorder( Uint16Pair gridSize );
187 * @brief Creates Image from the image url and parses the image for the stretch borders. Will create a error image if the n patch image is invalid
189 * @param[in] nPatchImage The NinePatchImage to base our cropped images and stretch borders from
191 void InitializeFromImage( NinePatchImage nPatchImage );
194 * @brief Creates an error Image to indicate that there was an error in either the image url or the parsing of the image
197 void InitializeFromBrokenImage();
200 * @brief Applies this renderer's image to the sampler to the texture set used for this renderer
202 void ApplyImageToSampler();
205 * @brief Changes the current renderer if the n-patch meta data has changed
207 * @param[in] oldBorderOnly The old flag indicating if the image should omit the centre of the n-patch and only render the border
208 * @param[in] oldGridX The old horizontal grid size of the solid geometry
209 * @param[in] oldGridY The old vertical grid size of the solid geometry
211 void ChangeRenderer( bool oldBorderOnly, size_t oldGridX, size_t oldGridY );
215 NinePatchImage mImage; ///< The image to render if the visual was set from an NinePatchImage, empty otherwise
218 std::string mImageUrl; ///< The url to the image resource to render if the visual was set from an image resource url, empty otherwise
219 NinePatchImage::StretchRanges mStretchPixelsX;
220 NinePatchImage::StretchRanges mStretchPixelsY;
221 ImageDimensions mImageSize;
225 } // namespace Internal
227 } // namespace Toolkit
231 #endif // DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H