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=6e48997f95a080c9f301f0f21c4664c37c664b19;hp=e34d011d69e57c3fc3627a91ea96ff53df6f3381;hb=da65da5fdaa792402702730ed32c5e5a5428d516;hpb=89ae5b785c2eb8276d5fb350004414bc3fab8a2d diff --git a/dali-toolkit/internal/visuals/image/image-visual.h b/dali-toolkit/internal/visuals/image/image-visual.h index e34d011..6e48997 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) 2016 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. @@ -19,15 +19,21 @@ */ // EXTERNAL INCLUDES +#include + #include #include #include #include -#include +#include // INTERNAL INCLUDES -#include #include +#include +#include +#include +#include +#include namespace Dali { @@ -44,22 +50,41 @@ 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 | + * | orientationCorrection | BOOLEAN | + * + * 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" - * "SCALE_TO_FIT" + * "SCALE_TO_FILL" * "FIT_WIDTH" * "FIT_HEIGHT" * "DEFAULT" @@ -74,8 +99,19 @@ 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, public AtlasUploadObserver +class ImageVisual: public Visual::Base, public ConnectionTracker, public AtlasUploadObserver, public TextureUploadObserver { public: @@ -86,12 +122,33 @@ public: * * @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. */ static ImageVisualPtr New( VisualFactoryCache& factoryCache, - const std::string& imageUrl, + const VisualUrl& imageUrl, + const Property::Map& properties, + ImageDimensions size = ImageDimensions(), + FittingMode::Type fittingMode = FittingMode::DEFAULT, + Dali::SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR ); + + /** + * @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 ); @@ -116,6 +173,16 @@ public: // from Visual */ virtual void DoCreatePropertyMap( Property::Map& map ) const; + /** + * @copydoc Visual::Base::CreateInstancePropertyMap + */ + virtual void DoCreateInstancePropertyMap( Property::Map& map ) const; + + /** + * @copydoc Visual::Base::OnDoAction + */ + virtual void OnDoAction( const Dali::Property::Index actionName, const Dali::Property::Value& attributes ) override; + protected: /** @@ -130,7 +197,7 @@ protected: * @param[in] samplingMode The SamplingMode of the resource to load */ ImageVisual( VisualFactoryCache& factoryCache, - const std::string& imageUrl, + const VisualUrl& imageUrl, ImageDimensions size, FittingMode::Type fittingMode, Dali::SamplingMode::Type samplingMode ); @@ -161,12 +228,17 @@ protected: /** * @copydoc Visual::Base::DoSetOffStage */ - virtual void DoSetOffStage( Actor& actor ); + virtual void DoSetOffStage( Actor& actor ) ; /** * @copydoc Visual::Base::OnSetTransform */ - virtual void OnSetTransform(); + virtual void OnSetTransform() ; + + /** + * @copydoc Visual::Base::IsResourceReady + */ + virtual bool IsResourceReady() const; public: @@ -184,11 +256,25 @@ public: * 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. */ - virtual void UploadCompleted(); + virtual void UploadCompleted() override; + + /** + * @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. + */ + virtual void UploadComplete( bool success, int32_t textureId, TextureSet textureSet, + bool usingAtlas, const Vector4& atlasRectangle, bool preMultiplied ) override; 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 @@ -196,11 +282,25 @@ 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. + * @param[in] orientationCorrection flag determines if orientation correction should be performed + * @param[in] forceReload flag determines if the texture should be reloaded from its source or use the cached texture. */ - void InitializeRenderer( const std::string& imageUrl ); + void LoadTexture( bool& atlasing, Vector4& atlasRect, TextureSet& textures, bool orientationCorrection, TextureManager::ReloadPolicy forceReload ); + + /** + * @brief Checks if atlasing should be attempted + * @return bool returns true if atlasing can be attempted. + */ + bool AttemptAtlasing(); + + /** + * @brief Initializes the Dali::Renderer from the image url + */ + void InitializeRenderer(); /** * @brief Initializes the Dali::Renderer from an image handle @@ -228,11 +328,6 @@ private: bool IsSynchronousResourceLoading() const; /** - * @brief Load the resource synchronously - */ - void LoadResourceSynchronously(); - - /** * 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. @@ -240,13 +335,7 @@ private: * @param[in] attemptAtlasing If true will attempt atlasing, otherwise create unique texture * @return the texture set to use */ - TextureSet CreateTextureSet( Vector4& textureRect, const std::string& url, bool synchronousLoading, bool attemptAtlasing ); - - /** - * 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 @@ -255,26 +344,43 @@ 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(); + + /** + * Helper method to set individual values by index key. + * @param[in] index The index key of the value + * @param[in] value The value + */ + void DoSetProperty( Property::Index index, const Property::Value& value ); private: Image mImage; - PixelData mPixels; Vector4 mPixelArea; WeakHandle mPlacementActor; - std::string mImageUrl; + VisualUrl mImageUrl; + TextureManager::MaskingDataPointer mMaskingData; Dali::ImageDimensions mDesiredSize; + 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; - + Dali::Toolkit::ImageVisual::LoadPolicy::Type mLoadPolicy; + Dali::Toolkit::ImageVisual::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. + bool mOrientationCorrection; ///< true if the image will have it's orientation corrected. }; + + } // namespace Internal } // namespace Toolkit