#define DALI_TOOLKIT_INTERNAL_N_PATCH_VISUAL_H
/*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// EXTERNAL INCLUDES
#include <dali/public-api/common/intrusive-ptr.h>
-#include <dali/public-api/images/image.h>
#include <dali/public-api/images/image-operations.h>
-#include <dali/devel-api/images/nine-patch-image.h>
#include <dali/public-api/rendering/geometry.h>
#include <dali/public-api/rendering/sampler.h>
#include <dali/public-api/rendering/shader.h>
+#include <dali/public-api/object/weak-handle.h>
// INTERNAL INCLUDES
+#include <dali-toolkit/public-api/visuals/image-visual-properties.h>
+#include <dali-toolkit/internal/visuals/texture-upload-observer.h>
#include <dali-toolkit/internal/visuals/visual-base-impl.h>
+#include <dali-toolkit/internal/visuals/visual-url.h>
namespace Dali
{
* | %Property Name | Type |
* |--------------------------|------------------|
* | url | STRING |
- * | borderOnly | BOOLEAN
- *
+ * | borderOnly | BOOLEAN |
+ * | border | RECTANGLE |
+ * | auxiliaryImage | STRING |
+ * | auxiliaryImageAlpha | FLOAT |
*/
-class NPatchVisual: public Visual::Base
+class NPatchVisual: public Visual::Base, public TextureUploadObserver
{
public:
/**
- * @brief Create a new n-patch visual.
+ * @brief Create an N-patch visual using an image URL.
+ *
+ * The visual will load the image synchronously when the associated actor is put on stage, and destroy the image when it is off stage
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
+ * @param[in] imageUrl The URL to 9 patch image resource to use
+ * @param[in] properties A Property::Map containing settings for this visual
* @return A smart-pointer to the newly allocated visual.
*/
- static NPatchVisualPtr New( VisualFactoryCache& factoryCache );
+ static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl, const Property::Map& properties );
/**
* @brief Create an N-patch visual using an image URL.
*
* @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
* @param[in] imageUrl The URL to 9 patch image resource to use
- * @param[in] borderOnly A Flag to indicate if the image should omit the centre of the n-patch and only render the border
- */
- static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const std::string& imageUrl, bool borderOnly = false );
-
- /**
- * @brief Create an N-patch visual with a NinePatchImage resource.
- *
- * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
- * @param[in] image The NinePatchImage to use
- * @param[in] borderOnly A Flag to indicate if the image should omit the centre of the n-patch and only render the border
+ * @return A smart-pointer to the newly allocated visual.
*/
- static NPatchVisualPtr New( VisualFactoryCache& factoryCache, NinePatchImage image, bool borderOnly = false );
+ static NPatchVisualPtr New( VisualFactoryCache& factoryCache, const VisualUrl& imageUrl );
public: // from Visual
/**
* @copydoc Visual::Base::GetNaturalSize
*/
- virtual void GetNaturalSize( Vector2& naturalSize ) const;
+ void GetNaturalSize( Vector2& naturalSize ) override;
/**
* @copydoc Visual::Base::CreatePropertyMap
*/
- virtual void DoCreatePropertyMap( Property::Map& map ) const;
-
- /**
- * @copydoc Visual::Base::DoSetProperty
- */
- virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
+ void DoCreatePropertyMap( Property::Map& map ) const override;
/**
- * @copydoc Visual::Base::DoGetProperty
+ * @copydoc Visual::Base::CreateInstancePropertyMap
*/
- virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index );
+ void DoCreateInstancePropertyMap( Property::Map& map ) const override;
protected:
/**
* @brief Constructor.
*
- * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
- * @param[in] borderOnly A Flag to indicate if the image should omit the centre of the n-patch and only render the border
+ * @param[in] factoryCache Reference to the VisualFactoryCache object
*/
- NPatchVisual( VisualFactoryCache& factoryCache, bool borderOnly = false );
+ NPatchVisual( VisualFactoryCache& factoryCache );
/**
* @brief A reference counted object may only be deleted by calling Unreference().
virtual ~NPatchVisual();
/**
- * @copydoc Visual::Base::DoInitialize
+ * @copydoc Visual::Base::DoSetProperties
+ */
+ void DoSetProperties( const Property::Map& propertyMap ) override;
+
+ /**
+ * @copydoc Visual::Base::DoSetOnScene
*/
- virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
+ void DoSetOnScene( Actor& actor ) override;
/**
- * @copydoc Visual::Base::DoSetOnStage
+ * @copydoc Visual::Base::DoSetOffScene
*/
- virtual void DoSetOnStage( Actor& actor );
+ void DoSetOffScene( Actor& actor ) override;
/**
- * @copydoc Visual::Base::DoSetOffStage
+ * @copydoc Visual::Base::OnSetTransform
*/
- virtual void DoSetOffStage( Actor& actor );
+ void OnSetTransform() override;
private:
/**
- * @brief Initialize the renderer with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
+ * Loads the NPatch image and the Auxiliary image if needed
*/
- void InitializeRenderer();
+ void LoadImages();
/**
* @brief Creates a geometry for this renderer's grid size
Shader CreateShader();
/**
+ * @brief Applies texture and related uniforms
+ */
+ void ApplyTextureAndUniforms();
+
+ /**
+ * Helper method to get the default Nine patch geometry from cache or create and store it there
+ * @param subType to use
+ * @return the geometry
+ */
+ Geometry GetNinePatchGeometry( VisualFactoryCache::GeometryType subType );
+
+ /**
* @brief Creates a geometry for the grid size to be used by this visuals' shaders
*
* @param[in] gridSize The grid size of the solid geometry to create
* @return Returns the created geometry for the grid size
*/
- Geometry CreateGeometry( Uint16Pair gridSize );
+ Geometry CreateGridGeometry( Uint16Pair gridSize );
/**
* @brief Creates a geometry with the border only for the grid size to be used by this visuals' shaders
* @param[in] gridSize The grid size of the solid geometry to create
* @return Returns the created geometry for the grid size
*/
- Geometry CreateGeometryBorder( Uint16Pair gridSize );
+ Geometry CreateBorderGeometry( Uint16Pair gridSize );
/**
- * @brief Creates Image from the image url and parses the image for the stretch borders. Will create a error image if the n patch image is invalid
- *
- * @param[in] nPatchImage The NinePatchImage to base our cropped images and stretch borders from
+ * @brief Creates a renderer by using loaded resource.
*/
- void InitializeFromImage( NinePatchImage nPatchImage );
+ void SetResource();
- /**
- * @brief Creates an error Image to indicate that there was an error in either the image url or the parsing of the image
- *
- */
- void InitializeFromBrokenImage();
+private:
/**
- * @brief Applies this renderer's image to the sampler to the texture set used for this renderer
+ * @copydoc TextureUploadObserver::UploadCompleted
+ *
+ * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
+ * This callback is the place to add the renderer as it would be called once the loading is finished.
*/
- void ApplyImageToSampler();
+ void UploadComplete( bool loadSuccess, int32_t textureId, TextureSet textureSet, bool useAtlasing, const Vector4& atlasRect, bool preMultiplied ) override;
/**
- * @brief Changes the current renderer if the n-patch meta data has changed
+ * @copydoc TextureUploadObserver::LoadComplete
*
- * @param[in] oldBorderOnly The old flag indicating if the image should omit the centre of the n-patch and only render the border
- * @param[in] oldGridX The old horizontal grid size of the solid geometry
- * @param[in] oldGridY The old vertical grid size of the solid geometry
+ * To avoid rendering garbage pixels, renderer should be added to actor after the resources are ready.
+ * This callback is the place to add the renderer as it would be called once the loading is finished.
*/
- void ChangeRenderer( bool oldBorderOnly, size_t oldGridX, size_t oldGridY );
+ void LoadComplete( bool loadSuccess, Devel::PixelBuffer pixelBuffer, const VisualUrl& url, bool preMultiplied ) override;
private:
-
- NinePatchImage mImage; ///< The image to render if the visual was set from an NinePatchImage, empty otherwise
- Image mCroppedImage;
-
- std::string mImageUrl; ///< The url to the image resource to render if the visual was set from an image resource url, empty otherwise
- NinePatchImage::StretchRanges mStretchPixelsX;
- NinePatchImage::StretchRanges mStretchPixelsY;
- ImageDimensions mImageSize;
- bool mBorderOnly;
+ WeakHandle<Actor> mPlacementActor; ///< Weakhandle to contain Actor during texture loading
+ NPatchLoader& mLoader; ///< reference to N patch loader for fast access
+ VisualUrl mImageUrl; ///< The url to the N patch to load
+ VisualUrl mAuxiliaryUrl; ///< An auxiliary image that can be displayed on top of the N-Patch
+ NPatchData::NPatchDataId mId; ///< id of the N patch (from loader/cache)
+ Devel::PixelBuffer mAuxiliaryPixelBuffer; ///< pixel buffer of the auxiliary mask image
+ bool mBorderOnly; ///< if only border is desired
+ Rect<int> mBorder; ///< The size of the border
+ float mAuxiliaryImageAlpha; ///< The alpha value for the auxiliary image only
+ Toolkit::ImageVisual::ReleasePolicy::Type mReleasePolicy; ///< The release policy to determine when an image should no longer be cached.
};
} // namespace Internal
projects / platform / core / uifw / dali-toolkit.git / blobdiff