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=3108b5577395f81083053f67e02dc42a2b9a937f;hp=83fd71cfefe19f309e2aed7ef8092b076895698d;hb=a1569d27e91ea58dbfbcdb3692fe10a971d06732;hpb=ddef399f249128bef52cbb79eb321b0bfdaa0ced diff --git a/dali-toolkit/internal/visuals/image/image-visual.h b/dali-toolkit/internal/visuals/image/image-visual.h index 83fd71c..3108b55 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,16 +19,20 @@ */ // EXTERNAL INCLUDES +#include + #include #include #include #include -#include +#include // INTERNAL INCLUDES #include +#include #include #include +#include namespace Dali { @@ -45,21 +49,25 @@ 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, @@ -90,8 +98,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: @@ -158,6 +177,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: /** @@ -203,12 +227,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: @@ -228,9 +257,22 @@ public: */ virtual void UploadCompleted(); + /** + * @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 ); + 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 @@ -238,6 +280,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(); @@ -268,11 +326,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. @@ -283,21 +336,15 @@ private: TextureSet CreateTextureSet( Vector4& textureRect, 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 ); - - /** * Set the value to the uTextureRect uniform * @param[in] textureRect The texture rectangular area. */ void SetTextureRectUniform( const Vector4& textureRect ); /** - * Remove the image from atlas if it is not used anymore. + * Remove texture with valid TextureId */ - void RemoveFromAtlas(const std::string& url); + void RemoveTexture(); /** * Helper method to set individual values by index key. @@ -309,19 +356,29 @@ private: private: Image mImage; - PixelData mPixels; Vector4 mPixelArea; WeakHandle mPlacementActor; 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; - + 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. + bool mOrientationCorrection; ///< true if the image will have it's orientation corrected. }; + + } // namespace Internal } // namespace Toolkit