1 #ifndef DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H
5 * Copyright (c) 2020 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-operations.h>
24 #include <dali/public-api/rendering/geometry.h>
25 #include <dali/public-api/rendering/sampler.h>
26 #include <dali/public-api/rendering/shader.h>
27 #include <dali/public-api/object/weak-handle.h>
30 #include <dali-toolkit/internal/visuals/texture-upload-observer.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, public TextureUploadObserver
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 );
86 public: // from Visual
89 * @copydoc Visual::Base::GetNaturalSize
91 void GetNaturalSize( Vector2& naturalSize ) override;
94 * @copydoc Visual::Base::CreatePropertyMap
96 void DoCreatePropertyMap( Property::Map& map ) const override;
99 * @copydoc Visual::Base::CreateInstancePropertyMap
101 void DoCreateInstancePropertyMap( Property::Map& map ) const override;
106 * @brief Constructor.
108 * @param[in] factoryCache Reference to the VisualFactoryCache object
110 NPatchVisual( VisualFactoryCache& factoryCache );
113 * @brief A reference counted object may only be deleted by calling Unreference().
115 virtual ~NPatchVisual();
118 * @copydoc Visual::Base::DoSetProperties
120 void DoSetProperties( const Property::Map& propertyMap ) override;
123 * @copydoc Visual::Base::DoSetOnScene
125 void DoSetOnScene( Actor& actor ) override;
128 * @copydoc Visual::Base::DoSetOffScene
130 void DoSetOffScene( Actor& actor ) override;
133 * @copydoc Visual::Base::OnSetTransform
135 void OnSetTransform() override;
140 * Loads the NPatch image and the Auxiliary image if needed
145 * @brief Creates a geometry for this renderer's grid size
147 * @return Returns the created geometry for this renderer's grid size
149 Geometry CreateGeometry();
152 * @brief Creates a shader for this renderer's grid size
154 * @return Returns the created shader for this renderer's grid size
156 Shader CreateShader();
159 * @brief Applies texture and related uniforms
161 void ApplyTextureAndUniforms();
164 * Helper method to get the default Nine patch geometry from cache or create and store it there
165 * @param subType to use
166 * @return the geometry
168 Geometry GetNinePatchGeometry( VisualFactoryCache::GeometryType subType );
171 * @brief Creates a geometry for the grid size to be used by this visuals' shaders
173 * @param[in] gridSize The grid size of the solid geometry to create
174 * @return Returns the created geometry for the grid size
176 Geometry CreateGridGeometry( Uint16Pair gridSize );
179 * @brief Creates a geometry with the border only for the grid size to be used by this visuals' shaders
180 * e.g. a 5x4 grid would create a geometry that would look like:
182 * ---------------------
185 * ---------------------
191 * ---------------------
194 * ---------------------
196 * @param[in] gridSize The grid size of the solid geometry to create
197 * @return Returns the created geometry for the grid size
199 Geometry CreateBorderGeometry( Uint16Pair gridSize );
202 * @brief Creates a renderer by using loaded resource.
209 * @copydoc TextureUploadObserver::UploadCompleted
211 * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
212 * This callback is the place to add the renderer as it would be called once the loading is finished.
214 void UploadComplete( bool loadSuccess, int32_t textureId, TextureSet textureSet, bool useAtlasing, const Vector4& atlasRect, bool preMultiplied ) override {}
217 * @copydoc TextureUploadObserver::LoadComplete
219 * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
220 * This callback is the place to add the renderer as it would be called once the loading is finished.
222 void LoadComplete( bool loadSuccess, Devel::PixelBuffer pixelBuffer, const VisualUrl& url, bool preMultiplied ) override;
226 WeakHandle<Actor> mPlacementActor; ///< Weakhandle to contain Actor during texture loading
227 NPatchLoader& mLoader; ///< reference to N patch loader for fast access
228 VisualUrl mImageUrl; ///< The url to the N patch to load
229 VisualUrl mAuxiliaryUrl; ///< An auxiliary image that can be displayed on top of the N-Patch
230 std::size_t mId; ///< id of the N patch (from loader/cache)
231 Devel::PixelBuffer mAuxiliaryPixelBuffer; ///< pixel buffer of the auxiliary mask image
232 bool mBorderOnly; ///< if only border is desired
233 Rect<int> mBorder; ///< The size of the border
234 float mAuxiliaryImageAlpha; ///< The alpha value for the auxiliary image only
237 } // namespace Internal
239 } // namespace Toolkit
243 #endif // DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H