X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Fimage%2Fimage-visual.h;h=87111b7415ad616883f3212c98074b87ef403aa3;hp=c3f2217133837557468ecd2d145c8e11ca77c510;hb=93833d2c76d1cab9da6fce404739e95e093da911;hpb=02318dd256a2edbef78a37cd40e153279385cc94 diff --git a/dali-toolkit/internal/visuals/image/image-visual.h b/dali-toolkit/internal/visuals/image/image-visual.h index c3f2217..87111b7 100644 --- a/dali-toolkit/internal/visuals/image/image-visual.h +++ b/dali-toolkit/internal/visuals/image/image-visual.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_IMAGE_VISUAL_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 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. @@ -18,13 +18,21 @@ * */ -// INTERNAL INCLUDES -#include - // EXTERNAL INCLUDES +#include + +#include #include #include #include +#include + +// INTERNAL INCLUDES +#include +#include +#include +#include +#include namespace Dali { @@ -41,18 +49,36 @@ class ImageVisual; typedef IntrusivePtr< ImageVisual > ImageVisualPtr; /** - * The visual which renders an image to the control's quad + * The visual which renders an image to a quad geometry * * The following properties are optional * - * | %Property Name | Type | - * |--------------------|------------------| - * | url | STRING | - * | fittingMode | STRING | - * | samplingMode | STRING | - * | desiredWidth | INT | - * | desiredHeight | INT | - * | synchronousLoading | BOOLEAN | + * | %Property Name | Type | + * |--------------------|-------------------| + * | url | STRING | + * | alphaMaskUrl | STRING | + * | fittingMode | INTEGER OR STRING | + * | samplingMode | INTEGER OR STRING | + * | desiredWidth | INTEGER | + * | desiredHeight | INTEGER | + * | synchronousLoading | BOOLEAN | + * | pixelArea | VECTOR4 | + * | wrapModeU | INTEGER OR STRING | + * | wrapModeV | INTEGER OR STRING | + * | loadPolicy | INTEGER OR STRING | + * | releasePolicy | INTEGER OR STRING | + * + * where pixelArea is a rectangular area. + * In its Vector4 value, the first two elements indicate the top-left position of the area, + * and the last two elements are the area width and height respectively. + * If not specified, the default value is [0.0, 0.0, 1.0, 1.0], i.e. the entire area of the image. + * + * where wrapModeU and wrapModeV separately decide how the texture should be sampled when the u and v coordinate exceeds the range of 0.0 to 1.0. + * Its value should be one of the following wrap mode: + * "DEFAULT" + * "CLAMP_TO_EDGE" + * "REPEAT" + * "MIRRORED_REPEAT" * * where imageFittingMode should be one of the following fitting modes: * "SHRINK_TO_FIT" @@ -71,29 +97,74 @@ typedef IntrusivePtr< ImageVisual > ImageVisualPtr; * "DONT_CARE" * "DEFAULT" * + * where loadPolicy should be one of the following image loading modes + * "IMMEDIATE" // Loads image even if visual not attached to stage yet + * "ATTACHED" // Only loads image once visual is attached to stage + * + * where releasePolicy should be one of the following policies for when to cache the image + * "DETACHED" // Release image from cache when visual detached from stage + * "DESTROYED" // Keep image in cache until the visual is destroyed + * "NEVER" // Keep image in cache until application ends. + * + * If the Visual is in a LayerUI it will pixel align the image, using a Layer3D will disable pixel alignment. + * Changing layer behaviour between LayerUI to Layer3D whilst the visual is already staged will not have an effect. */ -class ImageVisual: public Visual::Base, public ConnectionTracker +class ImageVisual: public Visual::Base, public ConnectionTracker, public AtlasUploadObserver, public TextureUploadObserver { public: /** - * @brief Constructor. + * @brief Create a new image visual with a URL. + * + * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage * * @param[in] factoryCache The VisualFactoryCache object + * @param[in] imageUrl The URL of the image resource to use + * @param[in] properties A Property::Map containing settings for this visual + * @param[in] size The width and height to fit the loaded image to. + * @param[in] fittingMode The FittingMode of the resource to load + * @param[in] samplingMode The SamplingMode of the resource to load + * @return A smart-pointer to the newly allocated visual. */ - ImageVisual( VisualFactoryCache& factoryCache ); + static ImageVisualPtr New( VisualFactoryCache& factoryCache, + const VisualUrl& imageUrl, + const Property::Map& properties, + ImageDimensions size = ImageDimensions(), + FittingMode::Type fittingMode = FittingMode::DEFAULT, + Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR ); /** - * @brief A reference counted object may only be deleted by calling Unreference(). + * @brief Create a new image visual with a URL. + * + * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage + * + * @param[in] factoryCache The VisualFactoryCache object + * @param[in] imageUrl The URL of the image resource to use + * @param[in] size The width and height to fit the loaded image to. + * @param[in] fittingMode The FittingMode of the resource to load + * @param[in] samplingMode The SamplingMode of the resource to load + * @return A smart-pointer to the newly allocated visual. + */ + static ImageVisualPtr New( VisualFactoryCache& factoryCache, + const VisualUrl& imageUrl, + ImageDimensions size = ImageDimensions(), + FittingMode::Type fittingMode = FittingMode::DEFAULT, + Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR ); + + /** + * @brief Create a new image visual with an Image type. + * + * @param[in] factoryCache The VisualFactoryCache object + * @param[in] image The image to use */ - ~ImageVisual(); + static ImageVisualPtr New( VisualFactoryCache& factoryCache, const Image& image ); public: // from Visual /** * @copydoc Visual::Base::GetNaturalSize */ - virtual void GetNaturalSize( Vector2& naturalSize ) const; + virtual void GetNaturalSize( Vector2& naturalSize ); /** * @copydoc Visual::Base::CreatePropertyMap @@ -101,20 +172,46 @@ public: // from Visual virtual void DoCreatePropertyMap( Property::Map& map ) const; /** - * @copydoc Visual::Base::DoSetProperty + * @copydoc Visual::Base::CreateInstancePropertyMap */ - virtual void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue ); + virtual void DoCreateInstancePropertyMap( Property::Map& map ) const; + +protected: /** - * @copydoc Visual::Base::DoGetProperty + * @brief Constructor with a URL. + * + * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage + * + * @param[in] factoryCache The VisualFactoryCache object + * @param[in] imageUrl The URL of the image resource to use + * @param[in] size The width and height to fit the loaded image to. + * @param[in] fittingMode The FittingMode of the resource to load + * @param[in] samplingMode The SamplingMode of the resource to load */ - virtual Dali::Property::Value DoGetProperty( Dali::Property::Index index ); + ImageVisual( VisualFactoryCache& factoryCache, + const VisualUrl& imageUrl, + ImageDimensions size, + FittingMode::Type fittingMode, + Dali::SamplingMode::Type samplingMode ); -protected: /** - * @copydoc Visual::Base::DoInitialize + * @brief Constructor with an Image type. + * + * @param[in] factoryCache The VisualFactoryCache object + * @param[in] image The image to use */ - virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap ); + ImageVisual( VisualFactoryCache& factoryCache, const Image& image ); + + /** + * @brief A reference counted object may only be deleted by calling Unreference(). + */ + virtual ~ImageVisual(); + + /** + * @copydoc Visual::Base::DoSetProperties + */ + virtual void DoSetProperties( const Property::Map& propertyMap ); /** * @copydoc Visual::Base::DoSetOnStage @@ -126,6 +223,11 @@ protected: */ virtual void DoSetOffStage( Actor& actor ); + /** + * @copydoc Visual::Base::OnSetTransform + */ + virtual void OnSetTransform(); + public: /** @@ -137,32 +239,29 @@ public: static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping ); /** - * @brief Sets the image of this visual to the resource at imageUrl - * The visual will load the Image asynchronously when the associated actor is put on stage, and destroy the image when it is off stage + * @copydoc AtlasUploadObserver::UploadCompleted * - * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor - * @param[in] imageUrl The URL of the image resource to use - * @param[in] size The width and height to fit the loaded image to. - * @param[in] fittingMode The FittingMode of the resource to load - * @param[in] samplingMode The SamplingMode of the resource to load + * 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 SetImage( Actor& actor, - const std::string& imageUrl, - ImageDimensions size=ImageDimensions(), - FittingMode::Type fittingMode = FittingMode::DEFAULT, - Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR ); + virtual void UploadCompleted(); /** - * @brief Sets the image to be rendered by this visual + * @copydoc TextureUploadObserver::UploadCompleted * - * @param[in] actor The Actor the renderer is applied to if, empty if the renderer has not been applied to any Actor - * @param[in] image The image to use + * 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 SetImage( Actor& actor, const Image& image ); + virtual void UploadComplete( bool success, int32_t textureId, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle ); private: /** + * Allocate the mask data when a masking property is defined in the property map + */ + void AllocateMaskData(); + + /** * @brief Applies the image to the texture set used for this renderer * * @param[in] image The Image to apply to the texture set used for this renderer @@ -170,11 +269,17 @@ private: void ApplyImageToSampler( const Image& image ); /** - * @brief Initializes the Dali::Renderer from an image url string - * - * @param[in] imageUrl The image url string to intialize this ImageVisual from + * @brief Load the texture, will try to atlas unless unable or param set to false. + * @param[in, out] atlasing flag if the image has been put in a atlas (true), passing false will not atlas even if possible. + * @param[out] atlasRect if atlasing is used this the texture area of the image in the atlas. + * @param[out] textures resulting texture set from the image loading. + */ + void LoadTexture( bool& atlasing, Vector4& atlasRect, TextureSet& textures ); + + /** + * @brief Initializes the Dali::Renderer from the image url */ - void InitializeRenderer( const std::string& imageUrl ); + void InitializeRenderer(); /** * @brief Initializes the Dali::Renderer from an image handle @@ -185,49 +290,31 @@ private: /** * @brief Creates the Dali::Renderer (potentially from the renderer cache), initializing it - * - * @return Returns the created Dali::Renderer + * @param[in] textures to use */ - Renderer CreateRenderer() const; + void CreateRenderer( TextureSet& textures ); /** * @brief Creates the Dali::Renderer for NativeImage with custom sampler type and prefix, initializing it - * - * @return Returns the created Dali::Renderer + * @param NativeImageRenderer */ - Renderer CreateNativeImageRenderer() const; + void CreateNativeImageRenderer( NativeImage& nativeImage ); /** * @brief Query whether resources requires to be loaded synchronously. - * @return Returns true if synchronoud resource loading is required, false otherwise. + * @return Returns true if synchronous resource loading is required, false otherwise. */ bool IsSynchronousResourceLoading() const; /** - * @brief Do the synchronous resource loading - */ - void DoSynchronousResourceLoading(); - - /** - * Load the image. + * Creates the texture set and adds the texture to it + * @param[out] textureRect The texture area of the texture in the atlas. * @param[in] url The URL of the image resource to use. * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously. + * @param[in] attemptAtlasing If true will attempt atlasing, otherwise create unique texture + * @return the texture set to use */ - Image LoadImage( const std::string& url, bool synchronousLoading ); - - /** - * Load the image and create a texture set to hold the texture, with automatic atlasing applied. - * @param [out] textureRect The texture area of the resource image in the atlas. - * @param[in] url The URL of the image resource to use. - * @param[in] synchronousLoading If true, the resource is loaded synchronously, otherwise asynchronously. - */ - TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading ); - - /** - * Callback function of image resource loading succeed - * @param[in] image The Image content that we attempted to load from mImageUrl - */ - void OnImageLoaded( ResourceImage image ); + TextureSet CreateTextureSet( Vector4& textureRect, bool synchronousLoading, bool attemptAtlasing ); /** * Set the value to the uTextureRect uniform @@ -236,31 +323,42 @@ private: void SetTextureRectUniform( const Vector4& textureRect ); /** - * Clean the renderer from cache, and remove the image from atlas if it is not used anymore + * Remove texture with valid TextureId */ - void CleanCache(const std::string& url); + void RemoveTexture(); /** - * Set shader code for nativeimage if it exists + * Helper method to set individual values by index key. + * @param[in] index The index key of the value + * @param[in] value The value */ - void SetNativeFragmentShaderCode( Dali::NativeImage& nativeImage ); + void DoSetProperty( Property::Index index, const Property::Value& value ); private: + Image mImage; - PixelData mPixels; Vector4 mPixelArea; + WeakHandle mPlacementActor; + VisualUrl mImageUrl; + TextureManager::MaskingDataPointer mMaskingData; - std::string mImageUrl; Dali::ImageDimensions mDesiredSize; - Dali::FittingMode::Type mFittingMode; - Dali::SamplingMode::Type mSamplingMode; - Dali::WrapMode::Type mWrapModeU; - Dali::WrapMode::Type mWrapModeV; - - std::string mNativeFragmentShaderCode; - bool mNativeImageFlag; + TextureManager::TextureId mTextureId; + TextureSet mTextures; + + Dali::FittingMode::Type mFittingMode:3; + Dali::SamplingMode::Type mSamplingMode:4; + Dali::WrapMode::Type mWrapModeU:3; + Dali::WrapMode::Type mWrapModeV:3; + DevelImageVisual::LoadPolicy::Type mLoadPolicy; + DevelImageVisual::ReleasePolicy::Type mReleasePolicy; + Vector4 mAtlasRect; + bool mAttemptAtlasing; ///< If true will attempt atlasing, otherwise create unique texture + bool mLoading; ///< True if the texture is still loading. }; + + } // namespace Internal } // namespace Toolkit