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 );
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 Creates a geometry for this renderer's grid size
139 * @return Returns the created geometry for this renderer's grid size
141 Geometry CreateGeometry();
144 * @brief Creates a shader for this renderer's grid size
146 * @return Returns the created shader for this renderer's grid size
148 Shader CreateShader();
151 * @brief Applies texture and related uniforms
153 void ApplyTextureAndUniforms();
156 * Helper method to get the default Nine patch geometry from cache or create and store it there
157 * @param subType to use
158 * @return the geometry
160 Geometry GetNinePatchGeometry( VisualFactoryCache::GeometryType subType );
163 * @brief Creates a geometry for the grid size to be used by this visuals' shaders
165 * @param[in] gridSize The grid size of the solid geometry to create
166 * @return Returns the created geometry for the grid size
168 Geometry CreateGridGeometry( Uint16Pair gridSize );
171 * @brief Creates a geometry with the border only for the grid size to be used by this visuals' shaders
172 * e.g. a 5x4 grid would create a geometry that would look like:
174 * ---------------------
177 * ---------------------
183 * ---------------------
186 * ---------------------
188 * @param[in] gridSize The grid size of the solid geometry to create
189 * @return Returns the created geometry for the grid size
191 Geometry CreateBorderGeometry( Uint16Pair gridSize );
195 NPatchLoader& mLoader; ///< reference to N patch loader for fast access
196 std::string mImageUrl; ///< The url to the N patch to load
197 std::size_t mId; ///< id of the N patch (from loader/cache)
198 bool mBorderOnly; ///< if only border is desired
202 } // namespace Internal
204 } // namespace Toolkit
208 #endif // DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H