1 #ifndef DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H
5 * Copyright (c) 2017 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>
32 #include <dali-toolkit/internal/visuals/visual-url.h>
44 typedef IntrusivePtr< NPatchVisual > NPatchVisualPtr;
47 * The visual which renders an 9 patch image to the control's quad
49 * The following properties are optional
51 * | %Property Name | Type |
52 * |--------------------------|------------------|
54 * | borderOnly | BOOLEAN |
55 * | border | RECTANGLE |
56 * | auxiliaryImage | STRING |
57 * | auxiliaryImageAlpha | FLOAT |
59 class NPatchVisual: public Visual::Base
64 * @brief Create an N-patch visual using an image URL.
66 * The visual will load the image synchronously when the associated actor is put on stage, and destroy the image when it is off stage
68 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
69 * @param[in] imageUrl The URL to 9 patch image resource to use
70 * @param[in] properties A Property::Map containing settings for this visual
71 * @return A smart-pointer to the newly allocated visual.
73 static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl, const Property::Map& properties );
76 * @brief Create an N-patch visual using an image URL.
78 * The visual will load the image synchronously when the associated actor is put on stage, and destroy the image when it is off stage
80 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
81 * @param[in] imageUrl The URL to 9 patch image resource to use
82 * @return A smart-pointer to the newly allocated visual.
84 static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl );
87 * @brief Create an N-patch visual with a NinePatchImage resource.
89 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
90 * @param[in] image The NinePatchImage to use
92 static NPatchVisualPtr New( VisualFactoryCache& factoryCache, NinePatchImage image );
94 public: // from Visual
97 * @copydoc Visual::Base::GetNaturalSize
99 virtual void GetNaturalSize( Vector2& naturalSize );
102 * @copydoc Visual::Base::CreatePropertyMap
104 virtual void DoCreatePropertyMap( Property::Map& map ) const;
107 * @copydoc Visual::Base::CreateInstancePropertyMap
109 virtual void DoCreateInstancePropertyMap( Property::Map& map ) const;
114 * @brief Constructor.
116 * @param[in] factoryCache Reference to the VisualFactoryCache object
118 NPatchVisual( VisualFactoryCache& factoryCache );
121 * @brief A reference counted object may only be deleted by calling Unreference().
123 virtual ~NPatchVisual();
126 * @copydoc Visual::Base::DoSetProperties
128 virtual void DoSetProperties( const Property::Map& propertyMap );
131 * @copydoc Visual::Base::DoSetOnStage
133 virtual void DoSetOnStage( Actor& actor );
136 * @copydoc Visual::Base::DoSetOffStage
138 virtual void DoSetOffStage( Actor& actor );
141 * @copydoc Visual::Base::OnSetTransform
143 virtual void OnSetTransform();
148 * Loads the NPatch image and the Auxiliary image if needed
153 * @brief Creates a geometry for this renderer's grid size
155 * @return Returns the created geometry for this renderer's grid size
157 Geometry CreateGeometry();
160 * @brief Creates a shader for this renderer's grid size
162 * @return Returns the created shader for this renderer's grid size
164 Shader CreateShader();
167 * @brief Applies texture and related uniforms
169 void ApplyTextureAndUniforms();
172 * Helper method to get the default Nine patch geometry from cache or create and store it there
173 * @param subType to use
174 * @return the geometry
176 Geometry GetNinePatchGeometry( VisualFactoryCache::GeometryType subType );
179 * @brief Creates a geometry for the grid size to be used by this visuals' shaders
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 CreateGridGeometry( Uint16Pair gridSize );
187 * @brief Creates a geometry with the border only for the grid size to be used by this visuals' shaders
188 * e.g. a 5x4 grid would create a geometry that would look like:
190 * ---------------------
193 * ---------------------
199 * ---------------------
202 * ---------------------
204 * @param[in] gridSize The grid size of the solid geometry to create
205 * @return Returns the created geometry for the grid size
207 Geometry CreateBorderGeometry( Uint16Pair gridSize );
211 NPatchLoader& mLoader; ///< reference to N patch loader for fast access
212 VisualUrl mImageUrl; ///< The url to the N patch to load
213 VisualUrl mAuxiliaryUrl; ///< An auxiliary image that can be displayed on top of the N-Patch
214 std::size_t mId; ///< id of the N patch (from loader/cache)
215 Devel::PixelBuffer mAuxiliaryPixelBuffer; ///< pixel buffer of the auxiliary mask image
216 bool mBorderOnly; ///< if only border is desired
217 Rect<int> mBorder; ///< The size of the border
218 float mAuxiliaryImageAlpha; ///< The alpha value for the auxiliary image only
221 } // namespace Internal
223 } // namespace Toolkit
227 #endif // DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H