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-toolkit/internal/visuals/visual-base-impl.h>
25 #include <dali/public-api/images/image.h>
26 #include <dali/public-api/images/image-operations.h>
27 #include <dali/public-api/images/nine-patch-image.h>
28 #include <dali/public-api/rendering/geometry.h>
29 #include <dali/public-api/rendering/sampler.h>
30 #include <dali/public-api/rendering/shader.h>
42 * The visual which renders an 9 patch image to the control's quad
44 * The following properties are optional
46 * | %Property Name | Type |
47 * |--------------------------|------------------|
49 * | borderOnly | BOOLEAN
52 class NPatchVisual: public Visual::Base
59 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
61 NPatchVisual( VisualFactoryCache& factoryCache );
64 * @brief A reference counted object may only be deleted by calling Unreference().
68 public: // from Visual
71 * @copydoc Visual::Base::GetNaturalSize
73 virtual void GetNaturalSize( Vector2& naturalSize ) const;
76 * @copydoc Visual::Base::CreatePropertyMap
78 virtual void DoCreatePropertyMap( Property::Map& map ) const;
83 * @copydoc Visual::Base::DoInitialize
85 virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
88 * @copydoc Visual::Base::DoSetOnStage
90 virtual void DoSetOnStage( Actor& actor );
93 * @copydoc Visual::Base::DoSetOffStage
95 virtual void DoSetOffStage( Actor& actor );
100 * @brief Sets the 9 patch image of this visual to the resource at imageUrl
101 * The visual will load the image synchronously when the associated actor is put on stage, and destroy the image when it is off stage
103 * @param[in] imageUrl The URL to 9 patch image resource to use
104 * @param[in] borderOnly A Flag to indicate if the image should omit the centre of the n-patch and only render the border
106 void SetImage( const std::string& imageUrl, bool borderOnly = false );
109 * @brief Sets the 9 patch image of this viusal to the 9 patch image
111 * @param[in] image The NinePatchImage to use
112 * @param[in] borderOnly A Flag to indicate if the image should omit the centre of the n-patch and only render the border
114 void SetImage( NinePatchImage image, bool borderOnly = false );
119 * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
121 void InitializeRenderer();
124 * @brief Creates a geometry for this renderer's grid size
126 * @return Returns the created geometry for this renderer's grid size
128 Geometry CreateGeometry();
131 * @brief Creates a shader for this renderer's grid size
133 * @return Returns the created shader for this renderer's grid size
135 Shader CreateShader();
138 * @brief Creates a geometry for the grid size to be used by this visuals' shaders
140 * @param[in] gridSize The grid size of the solid geometry to create
141 * @return Returns the created geometry for the grid size
143 Geometry CreateGeometry( Uint16Pair gridSize );
146 * @brief Creates a geometry with the border only for the grid size to be used by this visuals' shaders
147 * e.g. a 5x4 grid would create a geometry that would look like:
149 * ---------------------
152 * ---------------------
158 * ---------------------
161 * ---------------------
163 * @param[in] gridSize The grid size of the solid geometry to create
164 * @return Returns the created geometry for the grid size
166 Geometry CreateGeometryBorder( Uint16Pair gridSize );
169 * @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
171 * @param[in] nPatchImage The NinePatchImage to base our cropped images and stretch borders from
173 void InitializeFromImage( NinePatchImage nPatchImage );
176 * @brief Creates an error Image to indicate that there was an error in either the image url or the parsing of the image
179 void InitializeFromBrokenImage();
182 * @brief Applies this renderer's image to the sampler to the texture set used for this renderer
184 void ApplyImageToSampler();
187 * @brief Changes the current renderer if the n-patch meta data has changed
189 * @param[in] oldBorderOnly The old flag indicating if the image should omit the centre of the n-patch and only render the border
190 * @param[in] oldGridX The old horizontal grid size of the solid geometry
191 * @param[in] oldGridY The old vertical grid size of the solid geometry
193 void ChangeRenderer( bool oldBorderOnly, size_t oldGridX, size_t oldGridY );
197 NinePatchImage mImage; ///< The image to render if the visual was set from an NinePatchImage, empty otherwise
200 std::string mImageUrl; ///< The url to the image resource to render if the visual was set from an image resource url, empty otherwise
201 NinePatchImage::StretchRanges mStretchPixelsX;
202 NinePatchImage::StretchRanges mStretchPixelsY;
203 ImageDimensions mImageSize;
207 } // namespace Internal
209 } // namespace Toolkit
213 #endif // DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H