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=c693f0b421c03bcb1f9aaf285341c54b273a6c66;hp=91134377e562b0fc92dc583e663eca7e40948550;hb=70cda53a32b66bcc77619835cc06049635043d91;hpb=05316fdb6779dced99b135c06326ddaeea1fc2ee diff --git a/dali-toolkit/internal/visuals/image/image-visual.h b/dali-toolkit/internal/visuals/image/image-visual.h index 9113437..c693f0b 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,17 +19,21 @@ */ // EXTERNAL INCLUDES +#include + #include #include #include #include -#include +#include // INTERNAL INCLUDES #include #include #include #include +#include +#include namespace Dali { @@ -42,25 +46,30 @@ namespace Toolkit namespace Internal { +class ImageVisualShaderFactory; 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 | INTEGER OR STRING | - * | samplingMode | INTEGER OR STRING | - * | desiredWidth | INTEGER | - * | desiredHeight | INTEGER | - * | synchronousLoading | BOOLEAN | - * | pixelArea | VECTOR4 | - * | wrapModeU | INTEGER OR STRING | - * | wrapModeV | INTEGER OR STRING | + * | %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, @@ -76,7 +85,7 @@ typedef IntrusivePtr< ImageVisual > ImageVisualPtr; * * where imageFittingMode should be one of the following fitting modes: * "SHRINK_TO_FIT" - * "SCALE_TO_FIT" + * "SCALE_TO_FILL" * "FIT_WIDTH" * "FIT_HEIGHT" * "DEFAULT" @@ -91,6 +100,14 @@ 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. @@ -105,6 +122,7 @@ public: * 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] shaderFactory The ImageVisualShaderFactory 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. @@ -113,6 +131,7 @@ public: * @return A smart-pointer to the newly allocated visual. */ static ImageVisualPtr New( VisualFactoryCache& factoryCache, + ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, const Property::Map& properties, ImageDimensions size = ImageDimensions(), @@ -125,6 +144,7 @@ public: * 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] shaderFactory The ImageVisualShaderFactory 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 @@ -132,6 +152,7 @@ public: * @return A smart-pointer to the newly allocated visual. */ static ImageVisualPtr New( VisualFactoryCache& factoryCache, + ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size = ImageDimensions(), FittingMode::Type fittingMode = FittingMode::DEFAULT, @@ -141,9 +162,10 @@ public: * @brief Create a new image visual with an Image type. * * @param[in] factoryCache The VisualFactoryCache object + * @param[in] shaderFactory The ImageVisualShaderFactory object * @param[in] image The image to use */ - static ImageVisualPtr New( VisualFactoryCache& factoryCache, const Image& image ); + static ImageVisualPtr New( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Image& image ); public: // from Visual @@ -162,6 +184,11 @@ public: // from Visual */ 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: /** @@ -170,12 +197,14 @@ protected: * 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] shaderFactory The ImageVisualShaderFactory 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 */ ImageVisual( VisualFactoryCache& factoryCache, + ImageVisualShaderFactory& shaderFactory, const VisualUrl& imageUrl, ImageDimensions size, FittingMode::Type fittingMode, @@ -185,9 +214,10 @@ protected: * @brief Constructor with an Image type. * * @param[in] factoryCache The VisualFactoryCache object + * @param[in] shaderFactory The ImageVisualShaderFactory object * @param[in] image The image to use */ - ImageVisual( VisualFactoryCache& factoryCache, const Image& image ); + ImageVisual( VisualFactoryCache& factoryCache, ImageVisualShaderFactory& shaderFactory, const Image& image ); /** * @brief A reference counted object may only be deleted by calling Unreference(). @@ -207,22 +237,19 @@ protected: /** * @copydoc Visual::Base::DoSetOffStage */ - virtual void DoSetOffStage( Actor& actor ); + virtual void DoSetOffStage( Actor& actor ) ; /** * @copydoc Visual::Base::OnSetTransform */ - virtual void OnSetTransform(); - -public: + virtual void OnSetTransform() ; /** - * Get the standard image rendering shader. - * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object - * @param[in] atlasing Whether texture atlasing is applied. - * @param[in] defaultTextureWrapping Whether the default texture wrap mode is applied. + * @copydoc Visual::Base::IsResourceReady */ - static Shader GetImageShader( VisualFactoryCache& factoryCache, bool atlasing, bool defaultTextureWrapping ); + virtual bool IsResourceReady() const; + +public: /** * @copydoc AtlasUploadObserver::UploadCompleted @@ -230,7 +257,7 @@ 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 @@ -238,11 +265,17 @@ 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 UploadComplete( bool success, TextureSet textureSet, bool usingAtlas, const Vector4& atlasRectangle ); + 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 @@ -250,6 +283,22 @@ private: void ApplyImageToSampler( const Image& image ); /** + * @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 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(); @@ -280,11 +329,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. @@ -301,9 +345,9 @@ private: void SetTextureRectUniform( const Vector4& textureRect ); /** - * Remove the texture if it is not used anymore. + * Remove texture with valid TextureId */ - void RemoveTexture(const std::string& url); + void RemoveTexture(); /** * Helper method to set individual values by index key. @@ -315,22 +359,32 @@ private: private: Image mImage; - PixelData mPixels; Vector4 mPixelArea; WeakHandle mPlacementActor; VisualUrl mImageUrl; + TextureManager::MaskingDataPointer mMaskingData; Dali::ImageDimensions mDesiredSize; TextureManager::TextureId mTextureId; + TextureSet mTextures; + + ImageVisualShaderFactory& mImageVisualShaderFactory; Dali::FittingMode::Type mFittingMode:3; Dali::SamplingMode::Type mSamplingMode:4; Dali::WrapMode::Type mWrapModeU:3; Dali::WrapMode::Type mWrapModeV:3; - bool mAttemptAtlasing:1; ///< If true will attempt atlasing, otherwise create unique texture - bool mTextureLoading:1; ///< True if the texture is being loaded asynchronously, or false when it has loaded. + Dali::Toolkit::ImageVisual::LoadPolicy::Type mLoadPolicy; + Dali::Toolkit::ImageVisual::ReleasePolicy::Type mReleasePolicy; + Vector4 mAtlasRect; + Dali::ImageDimensions mAtlasRectSize; + 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