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 |
54 * | border | RECTANGLE |
57 class NPatchVisual: public Visual::Base
62 * @brief Create an N-patch visual using an image URL.
64 * The visual will load the image synchronously when the associated actor is put on stage, and destroy the image when it is off stage
66 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
67 * @param[in] imageUrl The URL to 9 patch image resource to use
68 * @param[in] properties A Property::Map containing settings for this visual
69 * @return A smart-pointer to the newly allocated visual.
71 static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const std::string& imageUrl, const Property::Map& properties );
74 * @brief Create an N-patch visual using an image URL.
76 * The visual will load the image synchronously when the associated actor is put on stage, and destroy the image when it is off stage
78 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
79 * @param[in] imageUrl The URL to 9 patch image resource to use
80 * @return A smart-pointer to the newly allocated visual.
82 static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const std::string& imageUrl );
85 * @brief Create an N-patch visual with a NinePatchImage resource.
87 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
88 * @param[in] image The NinePatchImage to use
90 static NPatchVisualPtr New( VisualFactoryCache& factoryCache, NinePatchImage image );
92 public: // from Visual
95 * @copydoc Visual::Base::GetNaturalSize
97 virtual void GetNaturalSize( Vector2& naturalSize );
100 * @copydoc Visual::Base::CreatePropertyMap
102 virtual void DoCreatePropertyMap( Property::Map& map ) const;
105 * @copydoc Visual::Base::CreateInstancePropertyMap
107 virtual void DoCreateInstancePropertyMap( Property::Map& map ) const;
112 * @brief Constructor.
114 * @param[in] factoryCache Reference to the VisualFactoryCache object
116 NPatchVisual( VisualFactoryCache& factoryCache );
119 * @brief A reference counted object may only be deleted by calling Unreference().
121 virtual ~NPatchVisual();
124 * @copydoc Visual::Base::DoSetProperties
126 virtual void DoSetProperties( const Property::Map& propertyMap );
129 * @copydoc Visual::Base::DoSetOnStage
131 virtual void DoSetOnStage( Actor& actor );
134 * @copydoc Visual::Base::DoSetOffStage
136 virtual void DoSetOffStage( Actor& actor );
139 * @copydoc Visual::Base::OnSetTransform
141 virtual void OnSetTransform();
146 * @brief Creates a geometry for this renderer's grid size
148 * @return Returns the created geometry for this renderer's grid size
150 Geometry CreateGeometry();
153 * @brief Creates a shader for this renderer's grid size
155 * @return Returns the created shader for this renderer's grid size
157 Shader CreateShader();
160 * @brief Applies texture and related uniforms
162 void ApplyTextureAndUniforms();
165 * Helper method to get the default Nine patch geometry from cache or create and store it there
166 * @param subType to use
167 * @return the geometry
169 Geometry GetNinePatchGeometry( VisualFactoryCache::GeometryType subType );
172 * @brief Creates a geometry for the grid size to be used by this visuals' shaders
174 * @param[in] gridSize The grid size of the solid geometry to create
175 * @return Returns the created geometry for the grid size
177 Geometry CreateGridGeometry( Uint16Pair gridSize );
180 * @brief Creates a geometry with the border only for the grid size to be used by this visuals' shaders
181 * e.g. a 5x4 grid would create a geometry that would look like:
183 * ---------------------
186 * ---------------------
192 * ---------------------
195 * ---------------------
197 * @param[in] gridSize The grid size of the solid geometry to create
198 * @return Returns the created geometry for the grid size
200 Geometry CreateBorderGeometry( Uint16Pair gridSize );
204 NPatchLoader& mLoader; ///< reference to N patch loader for fast access
205 std::string mImageUrl; ///< The url to the N patch to load
206 std::size_t mId; ///< id of the N patch (from loader/cache)
207 bool mBorderOnly; ///< if only border is desired
208 Rect< int > mBorder; ///< The size of the border
211 } // namespace Internal
213 } // namespace Toolkit
217 #endif // DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H