dali-toolkit/internal/visuals/npatch/npatch-visual.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  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>
  28
  29 // INTERNAL INCLUDES
  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>
  33
  34 namespace Dali
  35 {
  36
  37 namespace Toolkit
  38 {
  39
  40 namespace Internal
  41 {
  42
  43 class NPatchVisual;
  44 typedef IntrusivePtr< NPatchVisual > NPatchVisualPtr;
  45
  46 /**
  47  * The visual which renders an 9 patch image to the control's quad
  48  *
  49  * The following properties are optional
  50  *
  51  * | %Property Name           | Type             |
  52  * |--------------------------|------------------|
  53  * | url                      | STRING           |
  54  * | borderOnly               | BOOLEAN          |
  55  * | border                   | RECTANGLE        |
  56  * | auxiliaryImage           | STRING           |
  57  * | auxiliaryImageAlpha      | FLOAT            |
  58  */
  59 class NPatchVisual: public Visual::Base, public TextureUploadObserver
  60 {
  61 public:
  62
  63   /**
  64    * @brief Create an N-patch visual using an image URL.
  65    *
  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
  67    *
  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.
  72    */
  73   static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl, const Property::Map& properties );
  74
  75   /**
  76    * @brief Create an N-patch visual using an image URL.
  77    *
  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
  79    *
  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.
  83    */
  84   static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl );
  85
  86 public:  // from Visual
  87
  88   /**
  89    * @copydoc Visual::Base::GetNaturalSize
  90    */
  91   void GetNaturalSize( Vector2& naturalSize ) override;
  92
  93   /**
  94    * @copydoc Visual::Base::CreatePropertyMap
  95    */
  96   void DoCreatePropertyMap( Property::Map& map ) const override;
  97
  98   /**
  99    * @copydoc Visual::Base::CreateInstancePropertyMap
 100    */
 101   void DoCreateInstancePropertyMap( Property::Map& map ) const override;
 102
 103 protected:
 104
 105   /**
 106    * @brief Constructor.
 107    *
 108    * @param[in] factoryCache Reference to the VisualFactoryCache object
 109    */
 110   NPatchVisual( VisualFactoryCache& factoryCache );
 111
 112   /**
 113    * @brief A reference counted object may only be deleted by calling Unreference().
 114    */
 115   virtual ~NPatchVisual();
 116
 117   /**
 118    * @copydoc Visual::Base::DoSetProperties
 119    */
 120   void DoSetProperties( const Property::Map& propertyMap ) override;
 121
 122   /**
 123    * @copydoc Visual::Base::DoSetOnScene
 124    */
 125   void DoSetOnScene( Actor& actor ) override;
 126
 127   /**
 128    * @copydoc Visual::Base::DoSetOffScene
 129    */
 130   void DoSetOffScene( Actor& actor ) override;
 131
 132   /**
 133    * @copydoc Visual::Base::OnSetTransform
 134    */
 135   void OnSetTransform() override;
 136
 137 private:
 138
 139   /**
 140    * Loads the NPatch image and the Auxiliary image if needed
 141    */
 142   void LoadImages();
 143
 144   /**
 145    * @brief Creates a geometry for this renderer's grid size
 146    *
 147    * @return Returns the created geometry for this renderer's grid size
 148    */
 149   Geometry CreateGeometry();
 150
 151   /**
 152    * @brief Creates a shader for this renderer's grid size
 153    *
 154    * @return Returns the created shader for this renderer's grid size
 155    */
 156   Shader CreateShader();
 157
 158   /**
 159    * @brief Applies texture and related uniforms
 160    */
 161   void ApplyTextureAndUniforms();
 162
 163   /**
 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
 167    */
 168   Geometry GetNinePatchGeometry( VisualFactoryCache::GeometryType subType );
 169
 170   /**
 171    * @brief Creates a geometry for the grid size to be used by this visuals' shaders
 172    *
 173    * @param[in] gridSize The grid size of the solid geometry to create
 174    * @return Returns the created geometry for the grid size
 175    */
 176   Geometry CreateGridGeometry( Uint16Pair gridSize );
 177
 178   /**
 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:
 181    *
 182    *   ---------------------
 183    *   |  /|  /|  /|  /|  /|
 184    *   |/  |/  |/  |/  |/  |
 185    *   ---------------------
 186    *   |  /|           |  /|
 187    *   |/  |           |/  |
 188    *   -----           -----
 189    *   |  /|           |  /|
 190    *   |/  |           |/  |
 191    *   ---------------------
 192    *   |  /|  /|  /|  /|  /|
 193    *   |/  |/  |/  |/  |/  |
 194    *   ---------------------
 195    *
 196    * @param[in] gridSize The grid size of the solid geometry to create
 197    * @return Returns the created geometry for the grid size
 198    */
 199   Geometry CreateBorderGeometry( Uint16Pair gridSize );
 200
 201   /**
 202    * @brief Creates a renderer by using loaded resource.
 203    */
 204   void SetResource();
 205
 206 private:
 207
 208   /**
 209    * @copydoc TextureUploadObserver::UploadCompleted
 210    *
 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.
 213    */
 214   void UploadComplete( bool loadSuccess, int32_t textureId, TextureSet textureSet, bool useAtlasing, const Vector4& atlasRect, bool preMultiplied ) override {}
 215
 216   /**
 217    * @copydoc TextureUploadObserver::LoadComplete
 218    *
 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.
 221    */
 222   void LoadComplete( bool loadSuccess, Devel::PixelBuffer pixelBuffer, const VisualUrl& url, bool preMultiplied ) override;
 223
 224 private:
 225
 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
 235 };
 236
 237 } // namespace Internal
 238
 239 } // namespace Toolkit
 240
 241 } // namespace Dali
 242
 243 #endif // DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H